Class DocumentIndexField
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public class DocumentIndexField : DocumentIndexFieldValueBaseConstructors
DocumentIndexField()
Creates a new instance of this class
Declaration
public DocumentIndexField()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 |
IsNull
Indicates whether the field value is null or non-null.
Declaration
public bool IsNull { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
PointAndShootInfo
Contains one rectangle value for scalar field values and one or more values for keyword fields.
Declaration
public PointAndShootInfo PointAndShootInfo { get; set; }Property Value
| Type | Description |
|---|---|
| PointAndShootInfo |
ReadOnly
Indicates whether this field is readonly or not.
Declaration
public bool ReadOnly { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
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, DateTime)
Creates a
Declaration
public static DocumentIndexField Create(string fieldName, DateTime value)Parameters
| Type | Name | Description |
|---|---|---|
| System.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.
Declaration
public static DocumentIndexField Create(string fieldName, Decimal value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | fieldName | Name of the field. |
| Decimal | value | The value. |
Returns
| Type | Description |
|---|---|
| DocumentIndexField | The new field. |
Create(String, DocumentIndexFieldKeywords)
Creates a keyword field with the specified field name.
Declaration
public static DocumentIndexField Create(string fieldName, DocumentIndexFieldKeywords value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | fieldName | Name of the field. |
| DocumentIndexFieldKeywords | value | The value. |
Returns
| Type | Description |
|---|---|
| DocumentIndexField | The new field. |
Create(String, Int32)
Creates an integer field with the specified field name.
Declaration
public static DocumentIndexField Create(string fieldName, int value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | fieldName | Name of the field. |
| System.Int32 | value | The value. |
Returns
| Type | Description |
|---|---|
| DocumentIndexField | The new field. |
Create(String, String)
Creates a string field with the specified field name.
Declaration
public static DocumentIndexField Create(string fieldName, string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | fieldName | Name of the field. |
| System.String | value | The value. |
Returns
| Type | Description |
|---|---|
| DocumentIndexField | The new field. |
CreateDate(String, DateTime)
Creates a date field with the specified field name.
Declaration
public static DocumentIndexField CreateDate(string fieldName, DateTime value)Parameters
| Type | Name | Description |
|---|---|---|
| System.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.
Declaration
public static DocumentIndexField CreateDate(string fieldName, Decimal value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | fieldName | Name of the field. |
| Decimal | value | The value. |
Returns
| Type | Description |
|---|---|
| DocumentIndexField | The new field. |
CreateDate(String, DocumentIndexFieldKeywords)
Creates a keyword field with the specified field name.
Declaration
public static DocumentIndexField CreateDate(string fieldName, DocumentIndexFieldKeywords value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | fieldName | Name of the field. |
| DocumentIndexFieldKeywords | value | The value. |
Returns
| Type | Description |
|---|---|
| DocumentIndexField | The new field. |
CreateDate(String, Int32)
Creates a date field with the specified field name.
Declaration
public static DocumentIndexField CreateDate(string fieldName, int value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | fieldName | Name of the field. |
| System.Int32 | value | The value. |
Returns
| Type | Description |
|---|---|
| DocumentIndexField | The new field. |
ToString()
Returns a
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| System.String | A |