word.interfaces.rangecollectionloadoptions.yml

### YamlMime:TSType
name: Word.Interfaces.RangeCollectionLoadOptions
uid: 'word!Word.Interfaces.RangeCollectionLoadOptions:interface'
package: word!
fullName: Word.Interfaces.RangeCollectionLoadOptions
summary: 'Contains a collection of [Word.Range](xref:word!Word.Range:class) objects.'
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.RangeCollectionLoadOptions#$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.RangeCollectionLoadOptions#font:member'
    package: word!
    fullName: font
    summary: >-
      For EACH ITEM in the collection: Gets the text format of the range. 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: hyperlink
    uid: 'word!Word.Interfaces.RangeCollectionLoadOptions#hyperlink:member'
    package: word!
    fullName: hyperlink
    summary: >-
      For EACH ITEM in the collection: Gets the first hyperlink in the range, or sets a hyperlink on the range. All
      hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '\#' to separate the address
      part from the optional location part.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'hyperlink?: boolean;'
      return:
        type: boolean
  - name: isEmpty
    uid: 'word!Word.Interfaces.RangeCollectionLoadOptions#isEmpty:member'
    package: word!
    fullName: isEmpty
    summary: 'For EACH ITEM in the collection: Checks whether the range length is zero.'
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'isEmpty?: boolean;'
      return:
        type: boolean
  - name: parentBody
    uid: 'word!Word.Interfaces.RangeCollectionLoadOptions#parentBody:member'
    package: word!
    fullName: parentBody
    summary: 'For EACH ITEM in the collection: Gets the parent body of the range.'
    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: parentContentControl
    uid: 'word!Word.Interfaces.RangeCollectionLoadOptions#parentContentControl:member'
    package: word!
    fullName: parentContentControl
    summary: >-
      For EACH ITEM in the collection: Gets the currently supported content control that contains the range. 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.RangeCollectionLoadOptions#parentContentControlOrNullObject:member'
    package: word!
    fullName: parentContentControlOrNullObject
    summary: >-
      For EACH ITEM in the collection: Gets the currently supported content control that contains the range. 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: parentTable
    uid: 'word!Word.Interfaces.RangeCollectionLoadOptions#parentTable:member'
    package: word!
    fullName: parentTable
    summary: >-
      For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it
      isn't contained in a table.
    remarks: '\[ [API set: WordApi 1.3](/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.RangeCollectionLoadOptions#parentTableCell:member'
    package: word!
    fullName: parentTableCell
    summary: >-
      For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it
      isn't contained in a table cell.
    remarks: '\[ [API set: WordApi 1.3](/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.RangeCollectionLoadOptions#parentTableCellOrNullObject:member'
    package: word!
    fullName: parentTableCellOrNullObject
    summary: >-
      For EACH ITEM in the collection: Gets the table cell that contains the range. 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.3](/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.RangeCollectionLoadOptions#parentTableOrNullObject:member'
    package: word!
    fullName: parentTableOrNullObject
    summary: >-
      For EACH ITEM in the collection: Gets the table that contains the range. 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.3](/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: style
    uid: 'word!Word.Interfaces.RangeCollectionLoadOptions#style:member'
    package: word!
    fullName: style
    summary: >-
      For EACH ITEM in the collection: Specifies the style name for the range. 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.RangeCollectionLoadOptions#styleBuiltIn:member'
    package: word!
    fullName: styleBuiltIn
    summary: >-
      For EACH ITEM in the collection: Specifies the built-in style name for the range. 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.RangeCollectionLoadOptions#text:member'
    package: word!
    fullName: text
    summary: 'For EACH ITEM in the collection: Gets the text of the range.'
    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