word.interfaces.inlinepicturecollectionloadoptions.yml

### YamlMime:TSType
name: Word.Interfaces.InlinePictureCollectionLoadOptions
uid: 'word!Word.Interfaces.InlinePictureCollectionLoadOptions:interface'
package: word!
fullName: Word.Interfaces.InlinePictureCollectionLoadOptions
summary: 'Contains a collection of [Word.InlinePicture](xref:word!Word.InlinePicture: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.InlinePictureCollectionLoadOptions#$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: altTextDescription
    uid: 'word!Word.Interfaces.InlinePictureCollectionLoadOptions#altTextDescription:member'
    package: word!
    fullName: altTextDescription
    summary: >-
      For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the
      inline image.
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'altTextDescription?: boolean;'
      return:
        type: boolean
  - name: altTextTitle
    uid: 'word!Word.Interfaces.InlinePictureCollectionLoadOptions#altTextTitle:member'
    package: word!
    fullName: altTextTitle
    summary: 'For EACH ITEM in the collection: Specifies a string that contains the title for the inline image.'
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'altTextTitle?: boolean;'
      return:
        type: boolean
  - name: height
    uid: 'word!Word.Interfaces.InlinePictureCollectionLoadOptions#height:member'
    package: word!
    fullName: height
    summary: 'For EACH ITEM in the collection: Specifies a number that describes the height of the inline image.'
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'height?: boolean;'
      return:
        type: boolean
  - name: hyperlink
    uid: 'word!Word.Interfaces.InlinePictureCollectionLoadOptions#hyperlink:member'
    package: word!
    fullName: hyperlink
    summary: >-
      For EACH ITEM in the collection: Specifies a hyperlink on the image. Use a '\#' to separate the address part from
      the optional location part.
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'hyperlink?: boolean;'
      return:
        type: boolean
  - name: lockAspectRatio
    uid: 'word!Word.Interfaces.InlinePictureCollectionLoadOptions#lockAspectRatio:member'
    package: word!
    fullName: lockAspectRatio
    summary: >-
      For EACH ITEM in the collection: Specifies a value that indicates whether the inline image retains its original
      proportions when you resize it.
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'lockAspectRatio?: boolean;'
      return:
        type: boolean
  - name: paragraph
    uid: 'word!Word.Interfaces.InlinePictureCollectionLoadOptions#paragraph:member'
    package: word!
    fullName: paragraph
    summary: 'For EACH ITEM in the collection: Gets the parent paragraph that contains the inline image.'
    remarks: '\[ [API set: WordApi 1.2](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'paragraph?: Word.Interfaces.ParagraphLoadOptions;'
      return:
        type: '<xref uid="word!Word.Interfaces.ParagraphLoadOptions:interface" />'
  - name: parentContentControl
    uid: 'word!Word.Interfaces.InlinePictureCollectionLoadOptions#parentContentControl:member'
    package: word!
    fullName: parentContentControl
    summary: >-
      For EACH ITEM in the collection: Gets the content control that contains the inline image. 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.InlinePictureCollectionLoadOptions#parentContentControlOrNullObject:member'
    package: word!
    fullName: parentContentControlOrNullObject
    summary: >-
      For EACH ITEM in the collection: Gets the content control that contains the inline image. 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.InlinePictureCollectionLoadOptions#parentTable:member'
    package: word!
    fullName: parentTable
    summary: >-
      For EACH ITEM in the collection: Gets the table that contains the inline image. 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.InlinePictureCollectionLoadOptions#parentTableCell:member'
    package: word!
    fullName: parentTableCell
    summary: >-
      For EACH ITEM in the collection: Gets the table cell that contains the inline image. 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.InlinePictureCollectionLoadOptions#parentTableCellOrNullObject:member'
    package: word!
    fullName: parentTableCellOrNullObject
    summary: >-
      For EACH ITEM in the collection: Gets the table cell that contains the inline image. 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.InlinePictureCollectionLoadOptions#parentTableOrNullObject:member'
    package: word!
    fullName: parentTableOrNullObject
    summary: >-
      For EACH ITEM in the collection: Gets the table that contains the inline image. 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: width
    uid: 'word!Word.Interfaces.InlinePictureCollectionLoadOptions#width:member'
    package: word!
    fullName: width
    summary: 'For EACH ITEM in the collection: Specifies a number that describes the width of the inline image.'
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'width?: boolean;'
      return:
        type: boolean