Content Studio Web Content Management System
SystemObject
ContentStudio.Document.EPTSchemaFieldCollection
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Top
Top
Top
The following code snippet obtains the Xml schema for an EPT document category and displays its fields and the schema itself.
(It is assumed to be executed on a Content Studio aspx page)
[This is preliminary documentation and is subject to change.]
This class implements a collection of fields in a Content Studio EPT schema. It also facilitates the work with EPT schemas in Content Studio.
Inheritance Hierarchy
ContentStudio.Document.EPTSchemaFieldCollection
Namespace: ContentStudio.Document.EPT
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
The SchemaFieldCollection type exposes the following members.
Constructors
Name | Description | |
---|---|---|
SchemaFieldCollection |
Loads the schema for the actual category.
|
Properties
Name | Description | |
---|---|---|
Count |
Returns the number of schema field names in the collection.
| |
EditTemplate |
Gets the identifier of the edit template that defines the schema.
| |
EditTemplateCategory |
Gets the identifier of the category where the edit template that defines the schema is located.
| |
EPTDocumentCategory |
Gets the identifier of the category where the schema is used.
| |
Item |
Gets a field at a specified location
| |
SchemaXml |
Returns the underlying Xml Schema as Xml.
|
Methods
Name | Description | |
---|---|---|
Equals | (Inherited from Object.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
IsSchemaField |
Gets a value that indicates whether the field exists in the schema or not.
| |
ToString | (Inherited from Object.) |
Examples
C#
int EPTCategory = 168; //This category must be an EPT document category ContentStudio.Document.EPT.SchemaFieldCollection shmacoll = new ContentStudio.Document.EPT.SchemaFieldCollection(CS_ConnectionId, CS_UserSessionId, EPTCategory); //Write a list of the schema fields Response.Write ("<ul>"); foreach(string S in shmacoll) Response.Write ("<li>" + S + "</li>"); Response.Write ("</ul><br />"); //Write the schema as well Response.Write (Server.HtmlEncode(shmacoll.SchemaXml));
Visual Basic
Dim EPTCategory As Integer = 168 'This category must be an EPT document category Dim shmacoll As New _ ContentStudio.Document.EPT.SchemaFieldCollection(CS_ConnectionId, CS_UserSessionId, EPTCategory) 'Write a list of the schema fields Response.Write ("<ul>") For Each S As String In shmacoll Response.Write ("<li>" & S & "</li>") Next Response.Write ("</ul><br />") 'Write the schema as well Response.Write (Server.HtmlEncode(shmacoll.SchemaXml))
See Also