Word.Interfaces.InlinePictureData interface

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

Properties

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 ]

width

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

[ API set: WordApi 1.1 ]

Property Details

altTextDescription

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

[ API set: WordApi 1.1 ]

altTextDescription?: string;

Property Value

string

altTextTitle

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

[ API set: WordApi 1.1 ]

altTextTitle?: string;

Property Value

string

height

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

[ API set: WordApi 1.1 ]

height?: number;

Property Value

number

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

Property Value

string

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?: 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"

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

width

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

[ API set: WordApi 1.1 ]

width?: number;

Property Value

number