word.interfaces.fieldloadoptions.yml

### YamlMime:TSType
name: Word.Interfaces.FieldLoadOptions
uid: 'word!Word.Interfaces.FieldLoadOptions:interface'
package: word!
fullName: Word.Interfaces.FieldLoadOptions
summary: Represents a field.
remarks: '\[ [API set: WordApi 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: $all
    uid: 'word!Word.Interfaces.FieldLoadOptions#$all:member'
    package: word!
    fullName: $all
    summary: >-
      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`<!-- -->).
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: '$all?: boolean;'
      return:
        type: boolean
  - name: code
    uid: 'word!Word.Interfaces.FieldLoadOptions#code:member'
    package: word!
    fullName: code
    summary: Specifies the field's code instruction.
    remarks: |-
      \[ [API set: WordApi 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]

      Note: The ability to set the code was introduced in WordApi 1.5.
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'code?: boolean;'
      return:
        type: boolean
  - name: parentBody
    uid: 'word!Word.Interfaces.FieldLoadOptions#parentBody:member'
    package: word!
    fullName: parentBody
    summary: Gets the parent body of the field.
    remarks: '\[ [API set: WordApi 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'parentBody?: Word.Interfaces.BodyLoadOptions;'
      return:
        type: '<xref uid="word!Word.Interfaces.BodyLoadOptions:interface" />'
  - name: parentContentControl
    uid: 'word!Word.Interfaces.FieldLoadOptions#parentContentControl:member'
    package: word!
    fullName: parentContentControl
    summary: >-
      Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content
      control.
    remarks: '\[ [API set: WordApi 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'parentContentControl?: Word.Interfaces.ContentControlLoadOptions;'
      return:
        type: '<xref uid="word!Word.Interfaces.ContentControlLoadOptions:interface" />'
  - name: parentContentControlOrNullObject
    uid: 'word!Word.Interfaces.FieldLoadOptions#parentContentControlOrNullObject:member'
    package: word!
    fullName: parentContentControlOrNullObject
    summary: >-
      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](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)<!--
      -->.
    remarks: '\[ [API set: WordApi 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;'
      return:
        type: '<xref uid="word!Word.Interfaces.ContentControlLoadOptions:interface" />'
  - name: parentTable
    uid: 'word!Word.Interfaces.FieldLoadOptions#parentTable:member'
    package: word!
    fullName: parentTable
    summary: Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table.
    remarks: '\[ [API set: WordApi 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'parentTable?: Word.Interfaces.TableLoadOptions;'
      return:
        type: '<xref uid="word!Word.Interfaces.TableLoadOptions:interface" />'
  - name: parentTableCell
    uid: 'word!Word.Interfaces.FieldLoadOptions#parentTableCell:member'
    package: word!
    fullName: parentTableCell
    summary: Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell.
    remarks: '\[ [API set: WordApi 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'parentTableCell?: Word.Interfaces.TableCellLoadOptions;'
      return:
        type: '<xref uid="word!Word.Interfaces.TableCellLoadOptions:interface" />'
  - name: parentTableCellOrNullObject
    uid: 'word!Word.Interfaces.FieldLoadOptions#parentTableCellOrNullObject:member'
    package: word!
    fullName: parentTableCellOrNullObject
    summary: >-
      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](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)<!--
      -->.
    remarks: '\[ [API set: WordApi 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;'
      return:
        type: '<xref uid="word!Word.Interfaces.TableCellLoadOptions:interface" />'
  - name: parentTableOrNullObject
    uid: 'word!Word.Interfaces.FieldLoadOptions#parentTableOrNullObject:member'
    package: word!
    fullName: parentTableOrNullObject
    summary: >-
      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](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)<!--
      -->.
    remarks: '\[ [API set: WordApi 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;'
      return:
        type: '<xref uid="word!Word.Interfaces.TableLoadOptions:interface" />'
  - name: result
    uid: 'word!Word.Interfaces.FieldLoadOptions#result:member'
    package: word!
    fullName: result
    summary: Gets the field's result data.
    remarks: '\[ [API set: WordApi 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'result?: Word.Interfaces.RangeLoadOptions;'
      return:
        type: '<xref uid="word!Word.Interfaces.RangeLoadOptions:interface" />'