Class Field
Represents a Field.
Inherited Members
Namespace: DRIT.Document
Assembly: DRIT.Document.dll
Syntax
public class FieldProperties
FieldInstruction
Gets or sets field instruction.
Declaration
public string FieldInstruction { get; set; }Property Value
| Type | Description |
|---|---|
| string |
FieldType
The parsed field type, derived from FieldInstruction. Returns None when the instruction is empty or the type cannot be determined.
Declaration
public FieldType FieldType { get; }Property Value
| Type | Description |
|---|---|
| FieldType |
HasComplexFieldBegin
Gets or sets has complex field begin.
Declaration
public bool HasComplexFieldBegin { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
HasComplexFieldEnd
Gets or sets has complex field end.
Declaration
public bool HasComplexFieldEnd { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
HasComplexFieldSeparator
Gets or sets has complex field separator.
Declaration
public bool HasComplexFieldSeparator { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
IsDirty
Gets or sets is dirty.
Declaration
public bool IsDirty { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
IsLocked
Gets or sets is locked.
Declaration
public bool IsLocked { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Result
The displayed result text of the field (the content between the field separator and end). Populated during read or after Update(Document) is called.
Declaration
public string Result { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Methods
Update(Document)
Recomputes Result from the field instruction using the supplied document as context. Locked fields are not updated.
Declaration
public bool Update(Document document)Parameters
| Type | Name | Description |
|---|---|---|
| Document | document | The document that owns this field. |
Returns
| Type | Description |
|---|---|
| bool |
|