Word.Interfaces.InlinePictureCollectionLoadOptions interface
Contains a collection of Word.InlinePicture objects.
Remarks
Properties
| $all | Specifying |
| alt |
For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the inline image. |
| alt |
For EACH ITEM in the collection: Specifies a string that contains the title for the inline image. |
| height | For EACH ITEM in the collection: Specifies a number that describes the height of the inline image. |
| hyperlink | For EACH ITEM in the collection: Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. |
| image |
For EACH ITEM in the collection: Gets the format of the inline image. |
| lock |
For EACH ITEM in the collection: Specifies a value that indicates whether the inline image retains its original proportions when you resize it. |
| paragraph | For EACH ITEM in the collection: Gets the parent paragraph that contains the inline image. |
| parent |
For EACH ITEM in the collection: Gets the content control that contains the inline image. Throws an |
| parent |
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 |
| parent |
For EACH ITEM in the collection: Gets the table that contains the inline image. Throws an |
| parent |
For EACH ITEM in the collection: Gets the table cell that contains the inline image. Throws an |
| parent |
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 |
| parent |
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 |
| width | For EACH ITEM in the collection: Specifies a number that describes the width of the inline image. |
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
altTextDescription
For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the inline image.
altTextDescription?: boolean;Property Value
boolean
Remarks
altTextTitle
For EACH ITEM in the collection: Specifies a string that contains the title for the inline image.
altTextTitle?: boolean;Property Value
boolean
Remarks
height
For EACH ITEM in the collection: Specifies a number that describes the height of the inline image.
height?: boolean;Property Value
boolean
Remarks
hyperlink
For EACH ITEM in the collection: Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part.
hyperlink?: boolean;Property Value
boolean
Remarks
imageFormat
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: Gets the format of the inline image.
imageFormat?: boolean;Property Value
boolean
Remarks
lockAspectRatio
For EACH ITEM in the collection: Specifies a value that indicates whether the inline image retains its original proportions when you resize it.
lockAspectRatio?: boolean;Property Value
boolean
Remarks
paragraph
For EACH ITEM in the collection: Gets the parent paragraph that contains the inline image.
paragraph?: Word.Interfaces.ParagraphLoadOptions;Property Value
Remarks
parentContentControl
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.
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;Property Value
Remarks
parentContentControlOrNullObject
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.
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;Property Value
Remarks
parentTable
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.
parentTable?: Word.Interfaces.TableLoadOptions;Property Value
Remarks
parentTableCell
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.
parentTableCell?: Word.Interfaces.TableCellLoadOptions;Property Value
Remarks
parentTableCellOrNullObject
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.
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;Property Value
Remarks
parentTableOrNullObject
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.
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;Property Value
Remarks
width
For EACH ITEM in the collection: Specifies a number that describes the width of the inline image.
width?: 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