Word.Interfaces.InlinePictureLoadOptions interface

Package:

word

Represents an inline picture.

Remarks

[ API set: WordApi 1.1 ]

Properties

$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).
altTextDescription	Specifies a string that represents the alternative text associated with the inline image.
altTextTitle	Specifies a string that contains the title for the inline image.
height	Specifies a number that describes the height of the inline image.
hyperlink	Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part.
lockAspectRatio	Specifies a value that indicates whether the inline image retains its original proportions when you resize it.
parentContentControl	Gets the content control that contains the inline image. Throws an ItemNotFound error if there isn't a parent content control.
width	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

Specifies a string that represents the alternative text associated with the inline image.

altTextDescription?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

altTextTitle

Specifies a string that contains the title for the inline image.

altTextTitle?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

height

Specifies a number that describes the height of the inline image.

height?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

hyperlink

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

hyperlink?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

lockAspectRatio

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

lockAspectRatio?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

parentContentControl

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

Word.Interfaces.ContentControlLoadOptions

Remarks

[ API set: WordApi 1.1 ]

width

Specifies a number that describes the width of the inline image.

width?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]