ContentStudio.Document.EPT Namespace Content Studio 5.7 SDK
Content Studio Web Content Management System

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

This namespace contains classes that works with the EPT (Edit and Presentation Templates) sub system in Content Studio. A common task that is contained within this namespace is the Xml index system and the possibility to query its content and high level classes to work with EPT documents in an object oriented way.
Classes

  Class Description
Public class EPT
Manages the base of the EPT system
Public class EPTEmailValidator
This class implements the IValidator interface and performs email validation
Public class EptFieldName
Represents a string that contains a ept field name.
Public class EptFieldNameConverter
This class handles conversion between EptFieldNames and strings.
Public class EptMetaFieldName
Specifies the names of the Content Studio meta data fields. This class was added in Content Studio 5.6.
Public class EptMetaFieldNameWorkflow
Specifies the names of the Content Studio Workflow meta data fields. This class was added in Content Studio 5.6.
Public class EPTPersNrValidator
This class implements the IValidator interface and performs Swedish personal number validation
Public class EPTSchema
This class handles schemas used for EPT documents.
Public class EptSchemaCreator
Defines methods that generates an Xsd schema that represents a passed in Content Studio EPT-document.
Public class EptXdrSchemaCreator
Defines methods that generates an Xdr schema that represents a passed in Content Studio EPT-document.
Public class Code example EPTXmlEditableParser
The EPTXmlEditableParser class extends the EPTXmlTextParser by adding editing capabilities.
Public class EPTXmlParser
This class acts as a base class for the a specialized parser for Content Studio EPT Xml documents.
Public class EptXmlParserEventArgs
Provides data for the EptFieldAdded and the EptFieldRemoved events.
Public class EptXmlParserOnBeforeEventArgs
Provides data for the EptFieldValueChangingEventHandler events.
Public class Code example EPTXmlTextParser
Provides a read-only implementation of the EPTXmlParser class that enables the caller to read EPT field names and values in an efficient way.
Public class Code example SchemaFieldCollection
This class implements a collection of fields in a Content Studio EPT schema. It also facilitates the work with EPT schemas in Content Studio.
Public class Code example SyncronizedEPTDocument
The SyncronizedEPTDocument class extends the EPTXmlEditableParser by supplying synchronizing support directly with Content Studio.
Public class Code example XmlFilter
This class derives from the XmlFilterObject base class and provides a simplified way of performing Xml filter query operations against the Content Studio Xml index.
Public class XmlFilteringFieldDefinition
This class is used with Xml filtering and defines a field to filter on or return data for.
Public class XmlFilterObject
This class acts as base class for classes that performs query operations against the Content Studio xml index.
Public class Code example XmlFilterReader
Provides a way of reading a forward-only stream of rows from an XmlFilter query. This class cannot be inherited.
Public class XmlIndexData
This class is used to save data to the Xml index and to re-index documents
Public class XmlIndexQuery
This class handles filter queries against the Content Studio xml index. XmlIndexQuery is one of the most important classes in Content Studio for web developers implementing their site using the EPT technology.
A code example has been provided with the documentation for one of the overloaded versions of the Query method.
Public class XmlIndexTags
This class handles registered Xml index tags in the Xml index
Interfaces

  Interface Description
Public interface Code example IEptXmlParserEvents
The IEPTXmlParserEvents interface defines events implemented by all classes that inherits the EPTXmlParser base class.
Public interface IValidator
Extern code that implements this interface can perform custom validations that are called by Content Studio.
Delegates

  Delegate Description
Public delegate EptFieldAddedEventHandler
Represents the method that will handle the EptFieldAdded event raised when a field is added to an EPTXmlParser.
Public delegate EptFieldRemovedEventHandler
Represents the method that will handle the EptFieldRemoved event raised when a field is added to an EPTXmlParser.
Public delegate EptFieldValueChangedEventHandler
Represents the method that will handle the EptFieldValueChanged event raised when a field is added to an EPTXmlParser.
Public delegate EptFieldValueChangingEventHandler
Represents the method that will handle the EptFieldValueChanging event raised when a field is about to be changed in an EPTXmlParser.
Enumerations

  Enumeration Description
Public enumeration TemplateTypes
Specifies the different template types used in Content Studio
Public enumeration XmlIndexQueryQueryAggregate
Defines possible aggregate functionality with an Xml filter query
Public enumeration XmlIndexQueryQueryDataTypes
Defines the data type used by the fields in the XmlIndexQuery Query filter method