Class ResultListQuery
Base query definition for a result list
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public class ResultListQuery : objectConstructors
ResultListQuery()
Creates a new instance of this class
Declaration
public ResultListQuery()Properties
AdditionalResultFields
Define addition result fields to retrieve
Declaration
public List<string> AdditionalResultFields { get; set; }Property Value
| Type | Description |
|---|---|
| List<System.String> |
CalculateTotalCount
Indicates if total count of the documents should be calculated. If it is false the return value will be the number of requested items and indication if there are more items available.
Declaration
public bool CalculateTotalCount { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Count
Number of result documents to be retrieved in one block
Declaration
public int Count { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
ExcludeDefaultSystemFields
Specifies whether the default system/additional fields should be returned.
Declaration
public bool ExcludeDefaultSystemFields { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
FlagConditions
Condition that filter documents by its flags
Declaration
public FlagConditions FlagConditions { get; set; }Property Value
| Type | Description |
|---|---|
| FlagConditions |
IncludeSuggestions
Gets or sets a value indicating whether Intellix suggestions to be included.
Declaration
public bool IncludeSuggestions { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
SortOrder
Gets or sets the fields which are returned by this query.
Declaration
public List<SortedField> SortOrder { get; set; }Property Value
| Type | Description |
|---|---|
| List<SortedField> |
Remarks
Depending on the server's choice, there might be more fields included, like some system fields. If this field is null then all fields are returned.
Start
Start index of result document
Declaration
public int Start { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
WithoutLinks
Specifies whether the links are filled in the result.
Declaration
public bool WithoutLinks { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |