Class TableResultHeader

Header for a column table result from document query

Inheritance

System.Object

TableResultHeader

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class TableResultHeader : object

Constructors

TableResultHeader()

Creates a new instance of this class

Declaration

public TableResultHeader()

Fields

FieldNameAnnotationEtag

The name of the field for annotation etag.

Declaration

public const string FieldNameAnnotationEtag = null

Field Value

Type	Description
System.String

FieldNameCabinetname

The name of the field for file cabinet name.

Declaration

public const string FieldNameCabinetname = null

Field Value

Type	Description
System.String

FieldNameCreatedAtLocalTimeZone

The name of the field for the date created at the local time zone of the client.

Declaration

public const string FieldNameCreatedAtLocalTimeZone = null

Field Value

Type	Description
System.String

FieldNameDocumentIntellixUrl

The name of the field for document intellix URL.

Declaration

public const string FieldNameDocumentIntellixUrl = null

Field Value

Type	Description
System.String

FieldNameDocumentTitle

The name of the field for thumbnail etag.

Declaration

public const string FieldNameDocumentTitle = null

Field Value

Type	Description
System.String

FieldNameFirstSectionId

The name of the field for first section identifier.

Declaration

public const string FieldNameFirstSectionId = null

Field Value

Type	Description
System.String

FieldNameHasAppendedDocuments

The name of the field for whether the document has appended documents.

Declaration

public const string FieldNameHasAppendedDocuments = null

Field Value

Type	Description
System.String

FieldNameIsCheckedOut

The name of the field for whether the document is checked out.

Declaration

public const string FieldNameIsCheckedOut = null

Field Value

Type	Description
System.String

FieldNameIsCold

The name of the field for whether it is a cold document.

Declaration

public const string FieldNameIsCold = null

Field Value

Type	Description
System.String

FieldNameIsCopyRightProtected

The name of the field for whether the document is right protected.

Declaration

public const string FieldNameIsCopyRightProtected = null

Field Value

Type	Description
System.String

FieldNameIsDbRecord

The name of the field for whether the document is database record.

Declaration

public const string FieldNameIsDbRecord = null

Field Value

Type	Description
System.String

FieldNameIsDeleted

The name of the field for whether the document is deleted.

Declaration

public const string FieldNameIsDeleted = null

Field Value

Type	Description
System.String

FieldNameIsEmail

The name of the field for whether the document is email.

Declaration

public const string FieldNameIsEmail = null

Field Value

Type	Description
System.String

FieldNameIsProtected

The name of the field for whether the document is protected.

Declaration

public const string FieldNameIsProtected = null

Field Value

Type	Description
System.String

FieldNameIsVoiceAvailable

The name of the field for whether the document has voice annotation.

Declaration

public const string FieldNameIsVoiceAvailable = null

Field Value

Type	Description
System.String

FieldNameRenditionEtag

The name of the field for rendition etag.

Declaration

public const string FieldNameRenditionEtag = null

Field Value

Type	Description
System.String

FieldNameTextPreview

The name of the field for text preview.

Declaration

public const string FieldNameTextPreview = null

Field Value

Type	Description
System.String

FieldNameTotalPageCount

The name of the field for total page count.

Declaration

public const string FieldNameTotalPageCount = null

Field Value

Type	Description
System.String

FieldNameVersionStatus

The name of the field for the version status of the document.

Declaration

public const string FieldNameVersionStatus = null

Field Value

Type	Description
System.String

Properties

FieldLabel

Contains the label of the field.

Declaration

public string FieldLabel { get; set; }

Property Value

Type	Description
System.String

FieldName

Contains the internal name of the field.

Declaration

public string FieldName { get; set; }

Property Value

Type	Description
System.String

IsDocumentName

Indicates whether the field is document name

Declaration

public bool IsDocumentName { get; set; }

Property Value

Type	Description
System.Boolean

Kind

Kind of the field. System, index or additional (calculated fields like total page count, special values like text preview etc.).

Declaration

public TableResultFieldKind Kind { get; set; }

Property Value

Type	Description
TableResultFieldKind

Type

Declaration

public string Type { get; set; }

Property Value

Type	Description
System.String

Methods

GetItemChoiceType()

Gets the type of the item choice.

Declaration

public ItemChoiceType GetItemChoiceType()

Returns

Type	Description
ItemChoiceType

ToString()

Returns a that represents this instance.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A that represents this instance.