Word.Interfaces.FieldCollectionLoadOptions interface
Contains a collection of Word.Field objects.
Remarks
Properties
| $all | Specifying |
| code | For EACH ITEM in the collection: Specifies the field's code instruction. |
| data | For EACH ITEM in the collection: 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. |
| kind | For EACH ITEM in the collection: Gets the field's kind. |
| locked | For EACH ITEM in the collection: Specifies whether the field is locked. |
| parent |
For EACH ITEM in the collection: Gets the parent body of the field. |
| parent |
For EACH ITEM in the collection: Gets the content control that contains the field. Throws an |
| parent |
For EACH ITEM in the collection: 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 |
For EACH ITEM in the collection: Gets the table that contains the field. Throws an |
| parent |
For EACH ITEM in the collection: Gets the table cell that contains the field. Throws an |
| parent |
For EACH ITEM in the collection: 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 |
For EACH ITEM in the collection: 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 | For EACH ITEM in the collection: Gets the field's result data. |
| show |
For EACH ITEM in the collection: Specifies whether the field codes are displayed for the specified field. |
| type | For EACH ITEM in the collection: Gets the field's type. |
Property Details
$all
Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
$all?: boolean;Property Value
boolean
code
For EACH ITEM in the collection: 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
For EACH ITEM in the collection: 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
For EACH ITEM in the collection: Gets the field's kind.
kind?: boolean;Property Value
boolean
Remarks
locked
For EACH ITEM in the collection: Specifies whether the field is locked. true if the field is locked, false otherwise.
locked?: boolean;Property Value
boolean
Remarks
parentBody
For EACH ITEM in the collection: Gets the parent body of the field.
parentBody?: Word.Interfaces.BodyLoadOptions;Property Value
Remarks
parentContentControl
For EACH ITEM in the collection: 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
For EACH ITEM in the collection: 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
For EACH ITEM in the collection: 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
For EACH ITEM in the collection: 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
For EACH ITEM in the collection: 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
For EACH ITEM in the collection: 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
For EACH ITEM in the collection: Gets the field's result data.
result?: Word.Interfaces.RangeLoadOptions;Property Value
Remarks
showCodes
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
For EACH ITEM in the collection: 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
For EACH ITEM in the collection: Gets the field's type.
type?: boolean;Property Value
boolean
Remarks
Office Add-ins
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for