Word.Interfaces.InlinePictureLoadOptions interface
Represents an inline picture.
Properties
| $all | Specifying |
| alt |
Specifies a string that represents the alternative text associated with the inline image. |
| alt |
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. |
| lock |
Specifies whether the inline image retains its original proportions when you resize it. |
| paragraph | Gets the parent paragraph that contains the inline image. |
| parent |
Gets the content control that contains the inline image. Throws an |
| width | Specifies a number that describes the width of the inline image. |
Property Details
$all
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).
$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
altTextTitle
Specifies a string that contains the title for the inline image.
altTextTitle?: boolean;Property Value
boolean
Remarks
height
Specifies a number that describes the height of the inline image.
height?: boolean;Property Value
boolean
Remarks
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
lockAspectRatio
Specifies whether the inline image retains its original proportions when you resize it.
lockAspectRatio?: boolean;Property Value
boolean
Remarks
paragraph
Gets the parent paragraph that contains the inline image.
paragraph?: Word.Interfaces.ParagraphLoadOptions;Property Value
Remarks
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
Remarks
width
Specifies a number that describes the width of the inline image.
width?: boolean;Property Value
boolean