Class TableResultHeader

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

Header for a column table result from document query

[Hawk]
public class TableResultHeader

Inheritance

object

TableResultHeader

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

TableResultHeader()

Creates a new instance of this class

public TableResultHeader()

Fields

FieldNameAnnotationEtag

The name of the field for annotation etag.

public const string FieldNameAnnotationEtag = "@AnnotationEtag"

Field Value

Type	Description
string

FieldNameCabinetname

The name of the field for file cabinet name.

public const string FieldNameCabinetname = "@CABINETNAME"

Field Value

Type	Description
string

FieldNameCreatedAtLocalTimeZone

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

public const string FieldNameCreatedAtLocalTimeZone = "@CreatedAtLocalTimeZone"

Field Value

Type	Description
string

FieldNameDocumentIntellixUrl

The name of the field for document intellix URL.

public const string FieldNameDocumentIntellixUrl = "@DocumentIntellixUrl"

Field Value

Type	Description
string

FieldNameDocumentTitle

The name of the field for document title.

public const string FieldNameDocumentTitle = "@DocumentTitle"

Field Value

Type	Description
string

FieldNameExternalContentLocation

The name of the field for external content location.

public const string FieldNameExternalContentLocation = "@ExternalContentLocation"

Field Value

Type	Description
string

FieldNameFirstSectionId

The name of the field for first section identifier.

public const string FieldNameFirstSectionId = "@FirstSectionId"

Field Value

Type	Description
string

FieldNameHasAppendedDocuments

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

public const string FieldNameHasAppendedDocuments = "@HasAppendedDocuments"

Field Value

Type	Description
string

FieldNameIsCheckedOut

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

public const string FieldNameIsCheckedOut = "@IsCheckedOut"

Field Value

Type	Description
string

FieldNameIsCold

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

public const string FieldNameIsCold = "@IsCold"

Field Value

Type	Description
string

FieldNameIsCopyRightProtected

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

public const string FieldNameIsCopyRightProtected = "@IsCopyRightProtected"

Field Value

Type	Description
string

FieldNameIsDbRecord

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

public const string FieldNameIsDbRecord = "@IsDbRecord"

Field Value

Type	Description
string

FieldNameIsDeleted

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

public const string FieldNameIsDeleted = "@IsDeleted"

Field Value

Type	Description
string

FieldNameIsEmail

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

public const string FieldNameIsEmail = "@IsEmail"

Field Value

Type	Description
string

FieldNameIsProtected

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

public const string FieldNameIsProtected = "@IsProtected"

Field Value

Type	Description
string

FieldNameIsVoiceAvailable

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

public const string FieldNameIsVoiceAvailable = "@IsVoiceAvailable"

Field Value

Type	Description
string

FieldNameRenditionEtag

The name of the field for rendition etag.

public const string FieldNameRenditionEtag = "@RenditionEtag"

Field Value

Type	Description
string

FieldNameTextPreview

The name of the field for text preview.

public const string FieldNameTextPreview = "@TEXTPREVIEW"

Field Value

Type	Description
string

FieldNameTotalPageCount

The name of the field for total page count.

public const string FieldNameTotalPageCount = "@TOTALPAGES"

Field Value

Type	Description
string

FieldNameVersionStatus

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

public const string FieldNameVersionStatus = "@VersionStatus"

Field Value

Type	Description
string

Properties

FieldLabel

Contains the label of the field.

public string FieldLabel { get; set; }

Property Value

Type	Description
string

FieldName

Contains the internal name of the field.

public string FieldName { get; set; }

Property Value

Type	Description
string

IsDocumentName

Indicates whether the field is document name

public bool IsDocumentName { get; set; }

Property Value

Type	Description
bool

Kind

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

public TableResultFieldKind Kind { get; set; }

Property Value

Type	Description
TableResultFieldKind

Type

public string Type { get; set; }

Property Value

Type	Description
string

Methods

GetItemChoiceType()

Gets the type of the item choice.

public ItemChoiceType GetItemChoiceType()

Returns

Type	Description
ItemChoiceType

Exceptions

Type	Condition
ArgumentException	Invalid header type!

ToString()

Returns a String that represents this instance.

public override string ToString()

Returns

Type	Description
string	A String that represents this instance.

Overrides

Object.ToString()