Content Studio Web Content Management System
SystemObject
ContentStudio.Document.EPTEPTXmlParser
ContentStudio.Document.EPTEPTXmlTextParser
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Top
Top
Top
Top
Top
[This is preliminary documentation and is subject to change.]
This class acts as a base class for the a specialized parser for Content Studio EPT Xml documents.
Inheritance Hierarchy
ContentStudio.Document.EPTEPTXmlParser
ContentStudio.Document.EPTEPTXmlTextParser
Namespace: ContentStudio.Document.EPT
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
The EPTXmlParser type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | EPTXmlParser |
Creates a new EPTXmlParser and creates the underlying data store.
|
Properties
| Name | Description | |
|---|---|---|
 | Count |
Gets the number of unique field names in the EPT field collection.
|
| Fields |
Returns an array of all field names
|
| HasFields |
Gets a value that indicates whether the EPT collection has any fields or not.
|
| ItemInt32 |
When implemented in inheriting classes gets the entry at the specified index of the the fields collection.
|
| ItemString |
When implemented in inheriting classes gets or sets the entry with the specified key in the fields collection.
|
| ReadOnly |
Indicates whether the collection of fields is read-only or not.
|
Methods
| Name | Description | |
|---|---|---|
| BaseAdd |
Adds an entry with the specified name and value to the EPT field collection
|
| BaseClear |
Removes all the fields and their values
|
| BaseRemove |
Removes a field in the EPT field collection
|
| BaseSet |
Sets the value of an entry in the collection of EPT fields
|
 | Equals(Object) |
Determines whether the specified Object is an EPTXmlParser that has
the same content as the current EPTXmlParser.
(Overrides ObjectEquals(Object).) |
| Equals(EPTXmlParser) |
Determines whether the specified EPTXmlParser
has the same content as the current EPTXmlParser.
|
| ExistsField |
Determines whether a field exists or not
|
| Finalize | (Inherited from Object.) |
| Get(Int32) |
Gets the values at the specified index of the EPT field collection combined into one comma-separated list.
|
| Get(String) |
Gets the values associated with the specified field from the the EPT field collection combined into one comma-separated list.
|
| GetEnumerator |
Returns an enumerator that iterates through a collection.
|
| GetField |
Returns the field name at a specific location
|
| GetFieldIndex |
Gets the zero-based index of a field.
|
| GetHashCode |
Gets the hash code for this EPTXmlParser.
(Overrides ObjectGetHashCode.)A developer can use this value to compare the content of two different instances of an EPTXmlParser. |
| GetHashCodeForField(Int32) |
Gets the hash code for a specific field based on its ordinal number.
|
| GetHashCodeForField(String) |
Gets the hash code for a specific field.
|
| GetType | (Inherited from Object.) |
| GetValues(Int32) |
Returns an array of all values that exists for a field
|
| GetValues(String) |
Gets the values at the specified field of the EPT field collection.
|
| IsEmptyField |
Determines if a field is non-existing or has a value that is empty or null.
|
| Load |
Loads the storage with new EPT data.
|
| MemberwiseClone | (Inherited from Object.) |
| ToString | (Inherited from Object.) |
 | TryGetValue(String, String) |
Gets the value associated with the specified field name.
|
| TryGetValue(String, String, Boolean) |
Gets the value associated with the specified field name.
|
Events
| Name | Description | |
|---|---|---|
 | EptFieldAdded |
Occurs when an EPT field is added.
|
| EptFieldRemoved |
Occurs when an EPT field is removed.
|
| EptFieldValueChanged |
Occurs when a the value of a field changes.
|
| EptFieldValueChanging |
Occurs when a field value is about to be changed.
|
Fields
| Name | Description | |
|---|---|---|
  | BaseNodeName |
Defines the name of the base element in the Content Studio EPT Xml.
This node is the direct child of the base node and contains all the field elements.
|
| CSMetaDataPrefix |
Defines the prefix used for every CS meta data field.
Fields that have this prefix in their names are added by CS server and are ignored when saving a document.
|
| RootNodeName |
Defines the name of the root element in the Content Studio EPT Xml.
|
| WFMetaDataPrefix |
Defines the prefix used for every Workflow meta data field added automatically when Workflow server is involved.
Fields that have this prefix in their names are added by CS server and are ignored when saving a document.
|
See Also