Word.Interfaces.InlinePictureLoadOptions interface

Represents an inline picture.

[ API set: WordApi 1.1 ]

Properties

$all
altTextDescription

Gets or sets a string that represents the alternative text associated with the inline image.

[ API set: WordApi 1.1 ]

altTextTitle

Gets or sets a string that contains the title for the inline image.

[ API set: WordApi 1.1 ]

height

Gets or sets a number that describes the height of the inline image.

[ API set: WordApi 1.1 ]

hyperlink

Gets or sets a hyperlink on the image. Use a '#' to separate the address part from the optional location part.

[ API set: WordApi 1.1 ]

imageFormat

Gets the format of the inline image. Read-only.

[ API set: WordApi BETA (PREVIEW ONLY) ]

lockAspectRatio

Gets or sets a value that indicates whether the inline image retains its original proportions when you resize it.

[ API set: WordApi 1.1 ]

paragraph

Gets the parent paragraph that contains the inline image.

[ API set: WordApi 1.2 ]

parentContentControl

Gets the content control that contains the inline image. Throws an error if there isn't a parent content control.

[ API set: WordApi 1.1 ]

parentContentControlOrNullObject

Gets the content control that contains the inline image. Returns a null object if there isn't a parent content control.

[ API set: WordApi 1.3 ]

parentTable

Gets the table that contains the inline image. Throws an error if it is not contained in a table.

[ API set: WordApi 1.3 ]

parentTableCell

Gets the table cell that contains the inline image. Throws an error if it is not contained in a table cell.

[ API set: WordApi 1.3 ]

parentTableCellOrNullObject

Gets the table cell that contains the inline image. Returns a null object if it is not contained in a table cell.

[ API set: WordApi 1.3 ]

parentTableOrNullObject

Gets the table that contains the inline image. Returns a null object if it is not contained in a table.

[ API set: WordApi 1.3 ]

width

Gets or sets a number that describes the width of the inline image.

[ API set: WordApi 1.1 ]

Property Details

$all

$all?: boolean;

Property Value

boolean

altTextDescription

Gets or sets a string that represents the alternative text associated with the inline image.

[ API set: WordApi 1.1 ]

altTextDescription?: boolean;

Property Value

boolean

altTextTitle

Gets or sets a string that contains the title for the inline image.

[ API set: WordApi 1.1 ]

altTextTitle?: boolean;

Property Value

boolean

height

Gets or sets a number that describes the height of the inline image.

[ API set: WordApi 1.1 ]

height?: boolean;

Property Value

boolean

Gets or sets a hyperlink on the image. Use a '#' to separate the address part from the optional location part.

[ API set: WordApi 1.1 ]

hyperlink?: boolean;

Property Value

boolean

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.

Gets the format of the inline image. Read-only.

[ API set: WordApi BETA (PREVIEW ONLY) ]

imageFormat?: boolean;

Property Value

boolean

lockAspectRatio

Gets or sets a value that indicates whether the inline image retains its original proportions when you resize it.

[ API set: WordApi 1.1 ]

lockAspectRatio?: boolean;

Property Value

boolean

paragraph

Gets the parent paragraph that contains the inline image.

[ API set: WordApi 1.2 ]

paragraph?: Word.Interfaces.ParagraphLoadOptions;

Property Value

parentContentControl

Gets the content control that contains the inline image. Throws an error if there isn't a parent content control.

[ API set: WordApi 1.1 ]

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

Property Value

parentContentControlOrNullObject

Gets the content control that contains the inline image. Returns a null object if there isn't a parent content control.

[ API set: WordApi 1.3 ]

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

Property Value

parentTable

Gets the table that contains the inline image. Throws an error if it is not contained in a table.

[ API set: WordApi 1.3 ]

parentTable?: Word.Interfaces.TableLoadOptions;

Property Value

parentTableCell

Gets the table cell that contains the inline image. Throws an error if it is not contained in a table cell.

[ API set: WordApi 1.3 ]

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

Property Value

parentTableCellOrNullObject

Gets the table cell that contains the inline image. Returns a null object if it is not contained in a table cell.

[ API set: WordApi 1.3 ]

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

Property Value

parentTableOrNullObject

Gets the table that contains the inline image. Returns a null object if it is not contained in a table.

[ API set: WordApi 1.3 ]

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

Property Value

width

Gets or sets a number that describes the width of the inline image.

[ API set: WordApi 1.1 ]

width?: boolean;

Property Value

boolean