DocumentComponentSupport.DocList Method (ConnectionId, SessionId, CategoryId, Int32, DocumentComponentSupport.DocListSortorder, DateTime, Boolean)

DocumentComponentSupportDocList Method (ConnectionId, SessionId, CategoryId, Int32, DocumentComponentSupportDocListSortorder, DateTime, Boolean)

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 Document List component uses this method.

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

Syntax

Copy

public string DocList(
	ConnectionId connectionId,
	SessionId sessionId,
	CategoryId categoryId,
	int returnCount,
	DocumentComponentSupportDocListSortorder sortorder,
	DateTime dateCriteria,
	bool withContent
)

Public Function DocList ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	categoryId As CategoryId,
	returnCount As Integer,
	sortorder As DocumentComponentSupportDocListSortorder,
	dateCriteria As DateTime,
	withContent As Boolean
) As String

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).
categoryId: Type: ContentStudio.DocumentCategoryId
The category to list documents from
returnCount: Type: SystemInt32
Indicates the maximum number of documents to return
sortorder: Type: ContentStudio.DocumentDocumentComponentSupportDocListSortorder
Indicates how the list should be sorted.
dateCriteria: 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.
withContent: Type: SystemBoolean
Set to true to return the document content as well. Normally this parameter should be false

Return Value

Type: String
Xml

Copy

<root>
 <status>0</status>
 <statustext>Success</statustext>
  <list elementid="" elementname="" publishdate="" filename="" introduction="" unitname="" unitid="" categoryid="" modulename="" categoryname="" createdby="" modifiedby="" content="" presentationtemplateid="" modifieddate="" imagesavailable=""/>
  <!-- more list nodes can follow -->
</root>

(Data was intentionally left out)

Exceptions

Exception	Condition
CSException	A business rule was violated in the underlying Content Studio database
SqlException	An 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.

Reference

DocumentComponentSupport Class

DocList Overload

ContentStudio.Document Namespace