SyncronizedEPTDocument Methods Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

The SyncronizedEPTDocument type exposes the following members.

Methods

  Name Description
Public method Add
Adds an entry with the specified name and value to the EPT field collection
(Overrides EPTXmlEditableParserAdd(String, String).)
Public method Approve
Approves a saved document.
Protected method BaseAdd
Adds an entry with the specified name and value to the EPT field collection
(Inherited from EPTXmlParser.)
Protected method BaseClear
Removes all the fields and their values
(Inherited from EPTXmlParser.)
Protected method BaseRemove
Removes a field in the EPT field collection
(Inherited from EPTXmlParser.)
Protected method BaseSet
Sets the value of an entry in the collection of EPT fields
(Inherited from EPTXmlParser.)
Protected method CheckIn
Checks in a document. The document must exist.
Protected method CheckOut
Checks out the document. A document must exist i CS in order to be checked out
Public method Clear
Removes all entires in the EPT field collection. When schema bound, the use of this method will generate an exception.
(Overrides EPTXmlEditableParserClear.)
Public method Close
Closes the object and checks in the document if needed.
Public method Equals(Object)
Determines whether the specified Object is an EPTXmlParser that has the same content as the current EPTXmlParser.
(Inherited from EPTXmlParser.)
Public method Equals(EPTXmlParser)
Determines whether the specified EPTXmlParser has the same content as the current EPTXmlParser.
(Inherited from EPTXmlParser.)
Public method ExistsField
Determines whether a field exists or not
(Inherited from EPTXmlParser.)
Protected method Finalize (Inherited from Object.)
Public method Get(Int32)
Gets the values at the specified index of the EPT field collection combined into one comma-separated list.
(Inherited from EPTXmlParser.)
Public method Get(String)
Gets the values associated with the specified field from the the EPT field collection combined into one comma-separated list.
(Inherited from EPTXmlParser.)
Public method GetAsDateTime
Returns the value as a DateTime of a specified Content Studio EPT field.
(Inherited from EPTXmlTextParser.)
Public method GetAsInt32
Returns the value as an Int32 of a specified Content Studio EPT field.
(Inherited from EPTXmlTextParser.)
Public method GetAsString(String)
Returns the value, as as String of a specified Content Studio EPT field.
(Inherited from EPTXmlTextParser.)
Public method GetAsString(String, Boolean)
Returns the value, as as String of a specified Content Studio EPT field with option to remove any embedded html markup.
(Inherited from EPTXmlTextParser.)
Public method GetEnumerator
Returns an enumerator that iterates through a collection.
(Inherited from EPTXmlParser.)
Public method GetField
Returns the field name at a specific location
(Inherited from EPTXmlParser.)
Public method GetFieldCount(Int32)
Returns the number of fields with the specified name or index
(Inherited from EPTXmlEditableParser.)
Public method GetFieldCount(String)
Returns the number of fields with the specified name or index
(Inherited from EPTXmlEditableParser.)
Public method GetFieldIndex
Gets the zero-based index of a field.
(Inherited from EPTXmlParser.)
Public method GetHashCode
Gets the hash code for this EPTXmlParser.

A developer can use this value to compare the content of two different instances of an EPTXmlParser.

(Inherited from EPTXmlParser.)
Public method GetHashCodeForField(Int32)
Gets the hash code for a specific field based on its ordinal number.
(Inherited from EPTXmlParser.)
Public method GetHashCodeForField(String)
Gets the hash code for a specific field.
(Inherited from EPTXmlParser.)
Public method GetMetaCount
Returns the number of Content Studio meta data fields.
Public method GetMetaFieldAsDateTime
Returns the value, as a DateTime, of a specified Content Studio meta data field that exists for every EPT document.
Public method GetMetaFieldAsInteger
Returns the value, as an Int32, of a specified Content Studio meta data field that exists for every EPT document.
Public method GetMetaFieldAsString
Returns the value, as a String, of a specified Content Studio meta data field that exists for every EPT document.
Public method GetSchema
Gets the schema.
Public method GetType (Inherited from Object.)
Public method GetValues(Int32)
Returns an array of all values that exists for a field
(Inherited from EPTXmlParser.)
Public method GetValues(String)
Gets the values at the specified field of the EPT field collection.
(Inherited from EPTXmlParser.)
Public method IsChangedField
Determines whether the value of a field has been changed or touched in any way.
Public method IsEmptyField
Determines if a field is non-existing or has a value that is empty or null.
(Inherited from EPTXmlParser.)
Protected method Load
Loads the storage with new EPT data.
(Inherited from EPTXmlParser.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Remove
Removes a field in the EPT fields collection. When schema bound, the use of this method will generate an exception.
(Overrides EPTXmlEditableParserRemove(String).)
Public method Save
Saves the content of the document loaded. If the document does not exist it will be created, otherwise it will be updated.
Public method Save(CSDocument)
Saves the content of the document loaded with an option to change or specify document properties. If the document does not exist it will be created, otherwise it will be updated.
Public method Set(String, String)
Sets the value of an entry in the EPT field collection.
(Overrides EPTXmlEditableParserSet(String, String).)
Public method Set(String, Int32, String)
Sets the value of an entry in the EPT field collection.
(Overrides EPTXmlEditableParserSet(String, Int32, String).)
Protected method SetCategory
Sets the category id of this instance. This value can only be set if the CategoryID property is zero.
(Inherited from EPTXmlTextParser.)
Protected method SetDocument
Sets the document id of this instance. This value can only be set if the DocumentID property is zero.
(Inherited from EPTXmlTextParser.)
Protected method Tidy
Fixes the EPT document so its fields will be in conformance with the EPT schema.
Protected method Tidy(Boolean)
Fixes the EPT document so its fields will be in conformance with the EPT schema.
Public method ToPlainText
This method gets the EPT data as plain text with all Xml markup removed and using the specified options.
(Inherited from EPTXmlTextParser.)
Public method ToString
Returns the EPT xml using the default UTF-8 encoding
(Inherited from EPTXmlTextParser.)
Public method ToString(Encoding)
Returns the EPT xml as a string encoded with the specified encoding.
(Inherited from EPTXmlTextParser.)
Public method ToString(Boolean)
Gets the content of this Ept document in the Xml format with an option to return only changed fields. The Xml is encoded using the UTF-8 encoding.
Public method ToString(Boolean, Encoding)
Gets the content of this Ept document in the Xml format with an option to return only changed fields and a specific encoding.
Public method Code example TryGetValue(String, String)
Gets the value associated with the specified field name.
(Inherited from EPTXmlParser.)
Public method Code example TryGetValue(String, String, Boolean)
Gets the value associated with the specified field name.
(Inherited from EPTXmlParser.)
Public method ValidateContent
Validates the content against the schema. Only useful when schema bound.
Public method Code example Write(Stream)
Writes the full Xml content of the Ept document to the supplied System.IO.Stream using the default UTF-8 encoding.
(Inherited from EPTXmlTextParser.)
Public method Code example Write(Stream, Encoding)
Writes the full Xml content of the Ept document to the supplied System.IO.Stream using the supplied encoding.
(Inherited from EPTXmlTextParser.)
Public method Code example Write(Stream, Boolean)
Writes the content of this Ept document to the specified output stream with an option to include changed fields only. The content is written using the default UTF-8 encoding.
Public method Code example Write(Stream, Boolean, Encoding)
Writes the content of this Ept document to the specified output stream with an option to include changed fields only and a specific encoding.
Public method WritePlainText(Stream, String, Boolean)
Writes the content of the document as plain text to a Stream using specified options and the Unicode encoding
(Inherited from EPTXmlTextParser.)
Public method WritePlainText(TextWriter, String, Boolean)
Writes the content of the document as plain using the supplied a TextWriter, with the specified options.
(Inherited from EPTXmlTextParser.)
Public method WritePlainText(StringBuilder, String, Boolean)
Writes the content of the document as plain text to a StringBuilder using specified options.
(Inherited from EPTXmlTextParser.)
Public method WritePlainText(Stream, String, Boolean, Encoding)
Writes the content of the document as plain text to a Stream using the specified options and a specific encoding
(Inherited from EPTXmlTextParser.)
Top
See Also

Reference