Word.Interfaces.FieldLoadOptions interface
Represents a field.
Remarks
Important: To learn more about which fields can be inserted, see the Word.Range.insertField API introduced in requirement set 1.5. Support for managing fields is similar to what's available in the Word UI. However, while the Word UI on the web primarily only supports fields as read-only (see Field codes in Word for the web), the Addin field is editable. To learn more about Word UI clients that more fully support fields, see the product list at the beginning of Insert, edit, and view fields in Word.
Properties
| $all | Specifying |
| code | Specifies the field's code instruction. |
| data | Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is |
| kind | Gets the field's kind. |
| locked | Specifies whether the field is locked. |
| parent |
Gets the parent body of the field. |
| parent |
Gets the content control that contains the field. Throws an |
| parent |
Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its |
| parent |
Gets the table that contains the field. Throws an |
| parent |
Gets the table cell that contains the field. Throws an |
| parent |
Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return an object with its |
| parent |
Gets the table that contains the field. If it isn't contained in a table, then this method will return an object with its |
| result | Gets the field's result data. |
| show |
Specifies whether the field codes are displayed for the specified field. |
| type | Gets the field's type. |
Property Details
$all
Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
$all?: boolean;Property Value
boolean
code
Specifies the field's code instruction.
code?: boolean;Property Value
boolean
Remarks
Note: The ability to set the code was introduced in WordApi 1.5.
data
Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is null and it will throw a general exception when code attempts to set it.
data?: boolean;Property Value
boolean
Remarks
kind
locked
Specifies whether the field is locked. true if the field is locked, false otherwise.
locked?: boolean;Property Value
boolean
Remarks
parentBody
Gets the parent body of the field.
parentBody?: Word.Interfaces.BodyLoadOptions;Property Value
Remarks
parentContentControl
Gets the content control that contains the field. Throws an ItemNotFound error if there isn't a parent content control.
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;Property Value
Remarks
parentContentControlOrNullObject
Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;Property Value
Remarks
parentTable
Gets the table that contains the field. Throws an ItemNotFound error if it isn't contained in a table.
parentTable?: Word.Interfaces.TableLoadOptions;Property Value
Remarks
parentTableCell
Gets the table cell that contains the field. Throws an ItemNotFound error if it isn't contained in a table cell.
parentTableCell?: Word.Interfaces.TableCellLoadOptions;Property Value
Remarks
parentTableCellOrNullObject
Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;Property Value
Remarks
parentTableOrNullObject
Gets the table that contains the field. If it isn't contained in a table, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;Property Value
Remarks
result
Gets the field's result data.
result?: Word.Interfaces.RangeLoadOptions;Property Value
Remarks
showCodes
Specifies whether the field codes are displayed for the specified field. true if the field codes are displayed, false otherwise.
showCodes?: boolean;Property Value
boolean
Remarks
type
Office Add-ins