Show / Hide Table of Contents

    Class DocumentLinkExpressionQuery

    Query definition for a result list of a document link

    Inheritance
    System.Object
    DocumentLinkExpressionQuery
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: DocuWare.Platform.ServerClient
    Assembly: DocuWare.Platform.ServerClient.dll
    Syntax
    public class DocumentLinkExpressionQuery

    Constructors

    DocumentLinkExpressionQuery()

    Creates a new instance of this class

    Declaration
    public DocumentLinkExpressionQuery()

    Properties

    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

    Condition

    Gets or sets the conditions which are checked to obtain the search result.

    Declaration
    public List<DialogExpressionCondition> Condition { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<DialogExpressionCondition>

    Count

    Number of result documents to be retrieved in one block

    Declaration
    public int Count { get; set; }
    Property Value
    Type Description
    System.Int32

    Operation

    Specifies the operation between the conditions.

    Declaration
    public DialogExpressionOperation Operation { get; set; }
    Property Value
    Type Description
    DialogExpressionOperation

    ResultFields

    Define index fields to be retrieved in the result. (If empty - all fields are returned)

    Declaration
    public List<string> ResultFields { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<System.String>
    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. I it's empty, then only system fields will be returned.

    SortOrder

    Sets the fields that the result will be sorted by.

    Declaration
    public List<SortedField> SortOrder { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<SortedField>

    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
    About Us Contact Imprint Terms Data privacy
    © 2024 DocuWare Corporation powered by DocFX Back to top