Word.Interfaces.InlinePictureData interface

Package:

word

An interface describing the data returned by calling inlinePicture.toJSON().

Properties

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.
width	Specifies a number that describes the width of the inline image.

Property Details

altTextDescription

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

altTextDescription?: string;

Property Value

string

Remarks

[ API set: WordApi 1.1 ]

altTextTitle

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

altTextTitle?: string;

Property Value

string

Remarks

[ API set: WordApi 1.1 ]

height

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

height?: number;

Property Value

number

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?: string;

Property Value

string

Remarks

[ API set: WordApi 1.1 ]

imageFormat

Gets the format of the inline image.

imageFormat?: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg";

Property Value

Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"

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 ]

width

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

width?: number;

Property Value

number

Remarks

[ API set: WordApi 1.1 ]