Retrieves the Documents from the passed DocumentArchive.
Namespace:
EPiServer.Community.DocumentArchive.DataAssembly: EPiServer.Community.DocumentArchive (in EPiServer.Community.DocumentArchive.dll) Version: 4.1.517.358
Syntax
| C# |
|---|
protected internal virtual PagedCollectionResultSet GetDocuments( DocumentArchive archive, EntityStatus status, int page, int pageSize, params ContentSortOrder[] sortOrder ) |
Parameters
- archive
- Type: EPiServer.Community.DocumentArchive..::.DocumentArchive
The DocumentArchive that contains the document(s)
- status
- Type: EPiServer.Common..::.EntityStatus
A set of EntityStatuses by which to filter the returned items.
- page
- Type: System..::.Int32
The page of the record to display. The first page is 1.
- pageSize
- Type: System..::.Int32
The desired page size of the returned record. This is the maximum number of items that will be returned.
- sortOrder
- Type: array<
EPiServer.Community.DocumentArchive..::.ContentSortOrder
>[]()[]
The way the items should be sorted before being returned. Insert null to return them by date
Return Value
A PagedCollectionResultSet of Documents
Exceptions
| Exception | Condition |
|---|---|
| System..::.ArgumentNullException | Is thrown when archive is null. |
| System..::.ArgumentOutOfRangeException | Is thrown when page is less than 1. |