SyncronizedEPTDocument Constructor (ConnectionId, SessionId, DocumentId, SchemaFieldCollection) Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Constructs a new instance of the SyncronizedEPTDocument class from an existing Content Studio document with schema binding on. The document is checked out to be prepared for editing.

Namespace: ContentStudio.Document.EPT
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax

public SyncronizedEPTDocument(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId,
	SchemaFieldCollection schema
)

Parameters

connectionId
Type: ContentStudioConnectionId
A value that identifies the web site
sessionId
Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
documentId
Type: ContentStudio.DocumentDocumentId
The identifier of an existing EPT document to open.
schema
Type: ContentStudio.Document.EPTSchemaFieldCollection
A SchemaFieldCollection object that defines the schema to bind to.
Exceptions

ExceptionCondition
CSPermissionDeniedExceptionThe caller has no permission to perform the requested action
CSInvalidSessionExceptionThe session is invalid
CSDocumentNotFoundExceptionThe document could not be found
XmlExceptionThe document contains invalid xml.
CSException
NumberMeaning
1017Invalid object type: The document is not a EPT document.
1809The document is already checked out by %UserName%
1811The document is protected
1820Can not check out the document. It has been sent for revision by %UserName%
1829No writable content exists
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

READ permission on the document is required.
Remarks

This overloaded constructor can optimize performance when doing a series of updates or creation of documents that share the same EPT schema and schema binding is desired. Content Studio does not have to request, load and parse the schema between each document.
Note
No control is made to ensure that the supplied schema is connected to the category of the document passed in. This makes it possible to share the same schema between different categories but, as a downside, this behavior exposes the possibility to use an incompatible schema for the document thus make it possible to save worthless data into the document and wipe out existing valid data.
See Also

Reference