Class ResultListQuery

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

Base query definition for a result list

public class ResultListQuery

Inheritance

object

ResultListQuery

Derived

DialogExpression

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ResultListQuery()

Creates a new instance of this class

public ResultListQuery()

Properties

AdditionalResultFields

Define addition result fields to retrieve

public List<string> AdditionalResultFields { get; set; }

Property Value

Type	Description
List<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.

public bool CalculateTotalCount { get; set; }

Property Value

Type	Description
bool

Count

Number of result documents to be retrieved in one block

public int Count { get; set; }

Property Value

Type	Description
int

ExcludeDefaultSystemFields

Specifies whether the default system/additional fields should be returned.

public bool ExcludeDefaultSystemFields { get; set; }

Property Value

Type	Description
bool

FlagConditions

Condition that filter documents by its flags

public FlagConditions FlagConditions { get; set; }

Property Value

Type	Description
FlagConditions

IncludeSuggestions

Gets or sets a value indicating whether Intellix suggestions to be included.

public bool IncludeSuggestions { get; set; }

Property Value

Type	Description
bool

SortOrder

Gets or sets the fields which are returned by this query.

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

public int Start { get; set; }

Property Value

Type	Description
int

WithoutLinks

Specifies whether the links are filled in the result.

public bool WithoutLinks { get; set; }

Property Value

Type	Description
bool