Class DocumentIndexField

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

public class DocumentIndexField : DocumentIndexFieldValueBase

Inheritance

object

DocumentIndexFieldValueBase

DocumentIndexField

Inherited Members

DocumentIndexFieldValueBase.Item

DocumentIndexFieldValueBase.ItemElementName

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

DocumentIndexFieldExtensions.RemoveDiscouragedCharacters(DocumentIndexField)

DocumentIndexFieldExtensions.ReplaceDiscouragedCharacters(DocumentIndexField, string)

Constructors

DocumentIndexField()

Creates a new instance of this class

public DocumentIndexField()

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

IsNull

Indicates whether the field value is null or non-null.

public bool IsNull { get; set; }

Property Value

Type	Description
bool

PointAndShootInfo

Contains one rectangle value for scalar field values and one or more values for keyword fields.

public PointAndShootInfo PointAndShootInfo { get; set; }

Property Value

Type	Description
PointAndShootInfo

ReadOnly

Indicates whether this field is readonly or not.

public bool ReadOnly { get; set; }

Property Value

Type	Description
bool

Remarks

The value of this property can depend on the document. There might be documents which have a certain field set as read only while other documents have these fields writable.

Methods

Create(string, DocumentIndexFieldKeywords)

Creates a keyword field with the specified field name.

public static DocumentIndexField Create(string fieldName, DocumentIndexFieldKeywords value)

Parameters

Type	Name	Description
string	fieldName	Name of the field.
DocumentIndexFieldKeywords	value	The value.

Returns

Type	Description
DocumentIndexField	The new field.

Create(string, DateTime)

Creates a DateTime field with the specified field name.

public static DocumentIndexField Create(string fieldName, DateTime value)

Parameters

Type	Name	Description
string	fieldName	Name of the field.
DateTime	value	The value.

Returns

Type	Description
DocumentIndexField	The new field.

Create(string, decimal)

Creates a decimal field with the specified field name.

public static DocumentIndexField Create(string fieldName, decimal value)

Parameters

Type	Name	Description
string	fieldName	Name of the field.
decimal	value	The value.

Returns

Type	Description
DocumentIndexField	The new field.

Create(string, int)

Creates an integer field with the specified field name.

public static DocumentIndexField Create(string fieldName, int value)

Parameters

Type	Name	Description
string	fieldName	Name of the field.
int	value	The value.

Returns

Type	Description
DocumentIndexField	The new field.

Create(string, string)

Creates a string field with the specified field name.

public static DocumentIndexField Create(string fieldName, string value)

Parameters

Type	Name	Description
string	fieldName	Name of the field.
string	value	The value.

Returns

Type	Description
DocumentIndexField	The new field.

CreateDate(string, DocumentIndexFieldKeywords)

Creates a keyword field with the specified field name.

[Obsolete("Use Create instead. The spelling of the method name is wrong.")]
public static DocumentIndexField CreateDate(string fieldName, DocumentIndexFieldKeywords value)

Parameters

Type	Name	Description
string	fieldName	Name of the field.
DocumentIndexFieldKeywords	value	The value.

Returns

Type	Description
DocumentIndexField	The new field.

CreateDate(string, DateTime)

Creates a date field with the specified field name.

public static DocumentIndexField CreateDate(string fieldName, DateTime value)

Parameters

Type	Name	Description
string	fieldName	Name of the field.
DateTime	value	The value.

Returns

Type	Description
DocumentIndexField	The new field.

CreateDate(string, decimal)

Creates a date field with the specified field name.

[Obsolete("Use Create instead. The spelling of the method name is wrong.")]
public static DocumentIndexField CreateDate(string fieldName, decimal value)

Parameters

Type	Name	Description
string	fieldName	Name of the field.
decimal	value	The value.

Returns

Type	Description
DocumentIndexField	The new field.

CreateDate(string, int)

Creates a date field with the specified field name.

[Obsolete("Use Create instead. The spelling of the method name is wrong.")]
public static DocumentIndexField CreateDate(string fieldName, int value)

Parameters

Type	Name	Description
string	fieldName	Name of the field.
int	value	The value.

Returns

Type	Description
DocumentIndexField	The new field.

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()