word.interfaces.bodyloadoptions.yml

### YamlMime:TSType
name: Word.Interfaces.BodyLoadOptions
uid: 'word!Word.Interfaces.BodyLoadOptions:interface'
package: word!
fullName: Word.Interfaces.BodyLoadOptions
summary: Represents the body of a document or a section.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: $all
    uid: 'word!Word.Interfaces.BodyLoadOptions#$all:member'
    package: word!
    fullName: $all
    summary: >-
      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`<!-- -->).
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: '$all?: boolean;'
      return:
        type: boolean
  - name: font
    uid: 'word!Word.Interfaces.BodyLoadOptions#font:member'
    package: word!
    fullName: font
    summary: 'Gets the text format of the body. Use this to get and set font name, size, color and other properties.'
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'font?: Word.Interfaces.FontLoadOptions;'
      return:
        type: '<xref uid="word!Word.Interfaces.FontLoadOptions:interface" />'
  - name: parentBody
    uid: 'word!Word.Interfaces.BodyLoadOptions#parentBody:member'
    package: word!
    fullName: parentBody
    summary: >-
      Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws an
      `ItemNotFound` error if there isn't a parent body.
    remarks: '\[ [API set: WordApi 1.3](/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: parentBodyOrNullObject
    uid: 'word!Word.Interfaces.BodyLoadOptions#parentBodyOrNullObject:member'
    package: word!
    fullName: parentBodyOrNullObject
    summary: >-
      Gets the parent body of the body. For example, a table cell body's parent body could be a header. If there isn't a
      parent body, 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.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions;'
      return:
        type: '<xref uid="word!Word.Interfaces.BodyLoadOptions:interface" />'
  - name: parentContentControl
    uid: 'word!Word.Interfaces.BodyLoadOptions#parentContentControl:member'
    package: word!
    fullName: parentContentControl
    summary: >-
      Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content
      control.
    remarks: '\[ [API set: WordApi 1.1](/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.BodyLoadOptions#parentContentControlOrNullObject:member'
    package: word!
    fullName: parentContentControlOrNullObject
    summary: >-
      Gets the content control that contains the body. 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.3](/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: parentSection
    uid: 'word!Word.Interfaces.BodyLoadOptions#parentSection:member'
    package: word!
    fullName: parentSection
    summary: Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'parentSection?: Word.Interfaces.SectionLoadOptions;'
      return:
        type: '<xref uid="word!Word.Interfaces.SectionLoadOptions:interface" />'
  - name: parentSectionOrNullObject
    uid: 'word!Word.Interfaces.BodyLoadOptions#parentSectionOrNullObject:member'
    package: word!
    fullName: parentSectionOrNullObject
    summary: >-
      Gets the parent section of the body. If there isn't a parent section, 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.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions;'
      return:
        type: '<xref uid="word!Word.Interfaces.SectionLoadOptions:interface" />'
  - name: style
    uid: 'word!Word.Interfaces.BodyLoadOptions#style:member'
    package: word!
    fullName: style
    summary: >-
      Specifies the style name for the body. Use this property for custom styles and localized style names. To use the
      built-in styles that are portable between locales, see the "styleBuiltIn" property.
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'style?: boolean;'
      return:
        type: boolean
  - name: styleBuiltIn
    uid: 'word!Word.Interfaces.BodyLoadOptions#styleBuiltIn:member'
    package: word!
    fullName: styleBuiltIn
    summary: >-
      Specifies the built-in style name for the body. Use this property for built-in styles that are portable between
      locales. To use custom styles or localized style names, see the "style" property.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'styleBuiltIn?: boolean;'
      return:
        type: boolean
  - name: text
    uid: 'word!Word.Interfaces.BodyLoadOptions#text:member'
    package: word!
    fullName: text
    summary: Gets the text of the body. Use the insertText method to insert text.
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'text?: boolean;'
      return:
        type: boolean
  - name: type
    uid: 'word!Word.Interfaces.BodyLoadOptions#type:member'
    package: word!
    fullName: type
    summary: >-
      Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional
      types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordAPIOnline 1.1 and later.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'type?: boolean;'
      return:
        type: boolean