Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
An object that defines a result and paging information
READ permission on the category that forms the list definition is required to search the list of documents. Anonymous calls are supported.
[This is preliminary documentation and is subject to change.]
Search for documents that exists in a defined list.
Namespace: ContentStudio.Document.Listing
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public IPagedResult<ListDefDocument> SearchDocumentsInList( ConnectionId connectionId, SessionId sessionId, Nullable<Guid> listDefId, string searchArg, int pageSize, int pageIndex, string sortExpression, string fileExtensionFilter )
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). - listDefId
- Type: SystemNullableGuid
An identifier to the list to search documents in. Use null to search in any list. - searchArg
- Type: SystemString
The search argument. - pageSize
- Type: SystemInt32
The size of the pages to read. If this parameter is less than 1 PageSize will be 0 which is unlimited. - pageIndex
- Type: SystemInt32
The index of the data page with a maximum size defined in the pageSize. First page is zero (0) - sortExpression
- Type: SystemString
The sort expression e.g. "[ModifiedDate]DESC" - if invalid or null the default sort order is used. - fileExtensionFilter
- Type: SystemString
The file extension filter in the format '.ext1,.ext2'. If null or empty, the filter is ignored. Only used for uploaded files and when a specific list is supplied.
Return Value
Type: IPagedResultListDefDocumentAn object that defines a result and paging information
Exceptions
Exception | Condition |
---|---|
CSInvalidSessionException | |
CSInvalidParameterException | The filter query or the defined fields are not correct |
NotSupportedException | The list is not based on an EPT category |
ArgumentException | The search filter is invalid - {0} is missing - or the fileExtensionFilter is invalid. |
SqlException |
Content Studio permissions
Remarks
This method was added in Content Studio 5.6
If the list is filtered the filter and the search filter of the list are combined. In order to work there must be a search filter defined on the list and this filter must include at least one formatting placeholder with index = 0 - i.e. {0}.
See Also