DocumentComponentSupportDocListForInsert Method (ConnectionId, SessionId, CategoryId, DocumentId, DocumentId, Int32, DocumentComponentSupportDocListSortorder, DateTime) Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Returns a list of documents and properties optionally filtered on a specific document creator. The Insert multiple documents component uses this method.

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

public string DocListForInsert(
	ConnectionId connectionId,
	SessionId sessionId,
	CategoryId categoryId,
	DocumentId ownerDocumentId,
	DocumentId presentationTemplateId,
	int returnCount,
	DocumentComponentSupportDocListSortorder sortorder,
	DateTime dateCriteria


Type: ContentStudioConnectionId
A value that identifies the web site
Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
Type: ContentStudio.DocumentCategoryId
The category to list documents from.
Type: ContentStudio.DocumentDocumentId
A document whose creator will be used as filter constraint for the call. If this parameter is specified only documents with the same creator will be returned. Set to zero to return all documents.
Type: ContentStudio.DocumentDocumentId
A presentation template to use. Set to zero if not applicable or to use default presentation template
Type: SystemInt32
Indicates the maximum number of documents to return
Type: ContentStudio.DocumentDocumentComponentSupportDocListSortorder
Indicates how the list should be sorted.
Type: SystemDateTime
A DateTime that is compared with the publish date of the listed documents. Can be used when previewing documents in time. Pass MinValue to use the current date.

Return Value

Type: String
    <cs_document elementid="" elementname="" filename="" categoryid="" modulename="" categoryname="" presentationtemplateid="" imagesavailable=""/>
    <!-- more document can follow -->
(Data was intentionally left out)

CSExceptionA business rule was violated in the underlying Content Studio database
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

Supports anonymous calls. Any user can call this method but BROWSE permission on the document is required.
See Also