Word.Interfaces.InlinePictureLoadOptions interface

Package:

word

Represents an inline picture.

Remarks

[ API set: WordApi 1.1 ]

Properties

$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).
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.
imageFormat	Gets the format of the inline image.
lockAspectRatio	Specifies a value that indicates whether the inline image retains its original proportions when you resize it.
paragraph	Gets the parent paragraph that contains the inline image.
parentContentControl	Gets the content control that contains the inline image. Throws an ItemNotFound error if there isn't a parent content control.
parentContentControlOrNullObject	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.
parentTable	Gets the table that contains the inline image. Throws an ItemNotFound error if it isn't contained in a table.
parentTableCell	Gets the table cell that contains the inline image. Throws an ItemNotFound error if it isn't contained in a table cell.
parentTableCellOrNullObject	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.
parentTableOrNullObject	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.
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

[ 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 ]

imageFormat

Gets the format of the inline image.

imageFormat?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 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 ]

paragraph

Gets the parent paragraph that contains the inline image.

paragraph?: Word.Interfaces.ParagraphLoadOptions;

Property Value

Word.Interfaces.ParagraphLoadOptions

Remarks

[ API set: WordApi 1.2 ]

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 ]

parentContentControlOrNullObject

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

Word.Interfaces.ContentControlLoadOptions

Remarks

[ API set: WordApi 1.3 ]

parentTable

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

Word.Interfaces.TableLoadOptions

Remarks

[ API set: WordApi 1.3 ]

parentTableCell

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

Word.Interfaces.TableCellLoadOptions

Remarks

[ API set: WordApi 1.3 ]

parentTableCellOrNullObject

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

Word.Interfaces.TableCellLoadOptions

Remarks

[ API set: WordApi 1.3 ]

parentTableOrNullObject

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

Word.Interfaces.TableLoadOptions

Remarks

[ API set: WordApi 1.3 ]

width

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

width?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]