All Classes Namespaces Functions Properties Pages
Public Member Functions | Properties | List of all members
DocumentSearchCriteria Class Reference

Represents the values for search documents. More...

Public Member Functions

 DocumentSearchCriteria ()
 Initializes a new instance of the DocumentSearchCriteria class. More...
 

Properties

DateTime CreatedAtFrom [get, set]
 Gets or sets lower bound for search by CreatedAt property value. More...
 
DateTime CreatedAtTo [get, set]
 Gets or sets upper bound for search by CreatedAt property value. More...
 
DocumentTypeIdentity DocumentType [get, set]
 Gets or sets condition for search by DocumentType property value. More...
 
DateTime FinishedAtFrom [get, set]
 Gets or sets lower bound for search by FinishedAt property value. More...
 
DateTime FinishedAtTo [get, set]
 Gets or sets upper bound for search by FinishedAt property value. More...
 
DateTime LastAccessedAtFrom [get, set]
 Gets or sets lower bound for search by LastAccessedAt property value. More...
 
DateTime LastAccessedAtTo [get, set]
 Gets or sets upper bound for search by LastAccessedAt property value. More...
 
long MaxResults [get, set]
 Gets or sets limit on the quantity of documents in result set. More...
 
int NumberOfPagesFrom [get, set]
 Gets or sets lower bound for search by pages quantity in document. More...
 
int NumberOfPagesTo [get, set]
 Gets or sets upper bound for pages quantity in document. More...
 

Description

Represents the values for search documents.

Constructor & Destructor Documentation

Initializes a new instance of the DocumentSearchCriteria class.

Property Documentation

DateTime CreatedAtFrom
getset

Gets or sets lower bound for search by CreatedAt property value.

Result set will contain documents with CreatedAt property value greater or equal to that bound. UTC format is used.

DateTime CreatedAtTo
getset

Gets or sets upper bound for search by CreatedAt property value.

Result set will contain documents with CreatedAt property value less or equal to that bound. UTC format is used.

DocumentTypeIdentity DocumentType
getset

Gets or sets condition for search by DocumentType property value.

Result set will contain folders with specified DocumentType property value: Id, Name, Version.

DateTime FinishedAtFrom
getset

Gets or sets lower bound for search by FinishedAt property value.

Result set will contain documents with FinishedAt property value greater or equal to that bound. UTC format is used. FinishedAt property can be used in other KTA processes such as document retention policy. Please refer to KTA designer documentation for more info.

DateTime FinishedAtTo
getset

Gets or sets upper bound for search by FinishedAt property value.

Result set will contain documents with FinishedAt property value less or equal to that bound. UTC format is used. FinishedAt property can be used in other KTA processes such as document retention policy. Please refer to KTA designer documentation for more info.

DateTime LastAccessedAtFrom
getset

Gets or sets lower bound for search by LastAccessedAt property value.

Result set will contain documents with LastAccessedAt property value greater or equal to that bound. UTC format is used.

DateTime LastAccessedAtTo
getset

Gets or sets upper bound for search by LastAccessedAt property value.

Result set will contain documents with LastAccessedAt property value less or equal to that bound. UTC format is used.

long MaxResults
getset

Gets or sets limit on the quantity of documents in result set.

If null, the result will contain unlimited quantity of existing documents matching other search criteria.

int NumberOfPagesFrom
getset

Gets or sets lower bound for search by pages quantity in document.

Result set will contain documents with pages quantity greater or equal to that bound.

int NumberOfPagesTo
getset

Gets or sets upper bound for pages quantity in document.

Result set will contain documents with pages quantity less or equal to that bound.