Field
Field class
Contains elements that specify functions and formulas inserted in the shape’s text.
Constructors
| Name | Description |
|---|---|
| Field | Constructor. |
Properties
| Name | Type | Description |
|---|---|---|
| IX | int | The zero-based index of the element within its parent element. |
| Del | int | A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted loca |
| Value | Value | It contains the value for a text field. |
| DisplayValue | String | Gets the formatted string value of this field . |
| EditMode | DoubleValue | Reserved for future use. |
| Format | Value | Format element specifies the formatting for a text field that is a string, number, date or time, duration, or currency. |
| Type | TypeField | Type specifies a data type for the text field value. |
| UICat | DoubleValue | Specifies the category of an inserted field in versions of Microsoft Visio earlier than Visio 2000. |
| UICod | DoubleValue | Specifies the code of an inserted field in versions of Microsoft Visio earlier than Visio 2000. |
| UIFmt | DoubleValue | Specifies the format of an inserted field in versions of Microsoft Visio earlier than Visio 2000. |
| Calendar | Calendar | Determines the calendar that is used for custom properties, text fields, and element formulas. |
| ObjectKind | ObjectKind | Indicates the type of text field. |
Methods
| Name | Description |
|---|---|
| deepClone | Creates deep copy of this instance. |
Field()
Constructor.
Field.IX property
The zero-based index of the element within its parent element.
Type: int
Field.Del property
A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally. The value of the property is BOOL integer constant.
Type: int
Field.Value property
It contains the value for a text field.
Type: Value
Field.DisplayValue property
Gets the formatted string value of this field .
Type: String
Field.EditMode property
Reserved for future use.
Type: DoubleValue
Field.Format property
Format element specifies the formatting for a text field that is a string, number, date or time, duration, or currency. The text field type is specified in the corresponding Type element.
Type: Value
Field.Type property
Type specifies a data type for the text field value.
Type: TypeField
Field.UICat property
Specifies the category of an inserted field in versions of Microsoft Visio earlier than Visio 2000.
Type: DoubleValue
Field.UICod property
Specifies the code of an inserted field in versions of Microsoft Visio earlier than Visio 2000.
Type: DoubleValue
Field.UIFmt property
Specifies the format of an inserted field in versions of Microsoft Visio earlier than Visio 2000.
Type: DoubleValue
Field.Calendar property
Determines the calendar that is used for custom properties, text fields, and element formulas.
Type: Calendar
Field.ObjectKind property
Indicates the type of text field.
Type: ObjectKind
deepClone()
Creates deep copy of this instance.