Word.InlinePicture class

Represents an inline picture.

Extends

Remarks

[ API set: WordApi 1.1 ]

Properties

altTextDescription

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

altTextTitle

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

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

height

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

hyperlink

Gets or sets 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. Read-only.

lockAspectRatio

Gets or sets 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. Read-only.

parentContentControl

Gets the content control that contains the inline image. Throws an error if there isn't a parent content control. Read-only.

parentContentControlOrNullObject

Gets the content control that contains the inline image. Returns a null object if there isn't a parent content control. Read-only.

parentTable

Gets the table that contains the inline image. Throws an error if it is not contained in a table. Read-only.

parentTableCell

Gets the table cell that contains the inline image. Throws an error if it is not contained in a table cell. Read-only.

parentTableCellOrNullObject

Gets the table cell that contains the inline image. Returns a null object if it is not contained in a table cell. Read-only.

parentTableOrNullObject

Gets the table that contains the inline image. Returns a null object if it is not contained in a table. Read-only.

width

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

Methods

delete()

Deletes the inline picture from the document.

getBase64ImageSrc()

Gets the base64 encoded string representation of the inline image.

getNext()

Gets the next inline image. Throws an error if this inline image is the last one.

getNextOrNullObject()

Gets the next inline image. Returns a null object if this inline image is the last one.

getRange(rangeLocation)

Gets the picture, or the starting or ending point of the picture, as a range.

getRange(rangeLocationString)

Gets the picture, or the starting or ending point of the picture, as a range.

insertBreak(breakType, insertLocation)

Inserts a break at the specified location in the main document.

insertBreak(breakTypeString, insertLocation)

Inserts a break at the specified location in the main document.

insertContentControl()

Wraps the inline picture with a rich text content control.

insertFileFromBase64(base64File, insertLocation)

Inserts a document at the specified location.

insertFileFromBase64(base64File, insertLocationString)

Inserts a document at the specified location.

insertHtml(html, insertLocation)

Inserts HTML at the specified location.

insertHtml(html, insertLocationString)

Inserts HTML at the specified location.

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

Inserts an inline picture at the specified location.

insertInlinePictureFromBase64(base64EncodedImage, insertLocationString)

Inserts an inline picture at the specified location.

insertOoxml(ooxml, insertLocation)

Inserts OOXML at the specified location.

insertOoxml(ooxml, insertLocationString)

Inserts OOXML at the specified location.

insertParagraph(paragraphText, insertLocation)

Inserts a paragraph at the specified location.

insertParagraph(paragraphText, insertLocationString)

Inserts a paragraph at the specified location.

insertText(text, insertLocation)

Inserts text at the specified location.

insertText(text, insertLocationString)

Inserts text at the specified location.

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

select(selectionMode)

Selects the inline picture. This causes Word to scroll to the selection.

select(selectionModeString)

Selects the inline picture. This causes Word to scroll to the selection.

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Word.InlinePicture object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.InlinePictureData) that contains shallow copies of any loaded child properties from the original object.

track()

Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.

untrack()

Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call context.sync() before the memory release takes effect.

Property Details

altTextDescription

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

altTextDescription: string;

Property Value

string

Remarks

[ API set: WordApi 1.1 ]

altTextTitle

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

altTextTitle: string;

Property Value

string

Remarks

[ API set: WordApi 1.1 ]

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

height

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

height: number;

Property Value

number

Remarks

[ API set: WordApi 1.1 ]

Gets or sets 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

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.

readonly 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: WordApi BETA (PREVIEW ONLY) ]

lockAspectRatio

Gets or sets 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. Read-only.

readonly paragraph: Word.Paragraph;

Property Value

Remarks

[ API set: WordApi 1.2 ]

parentContentControl

Gets the content control that contains the inline image. Throws an error if there isn't a parent content control. Read-only.

readonly parentContentControl: Word.ContentControl;

Property Value

Remarks

[ API set: WordApi 1.1 ]

parentContentControlOrNullObject

Gets the content control that contains the inline image. Returns a null object if there isn't a parent content control. Read-only.

readonly parentContentControlOrNullObject: Word.ContentControl;

Property Value

Remarks

[ API set: WordApi 1.3 ]

parentTable

Gets the table that contains the inline image. Throws an error if it is not contained in a table. Read-only.

readonly parentTable: Word.Table;

Property Value

Remarks

[ API set: WordApi 1.3 ]

parentTableCell

Gets the table cell that contains the inline image. Throws an error if it is not contained in a table cell. Read-only.

readonly parentTableCell: Word.TableCell;

Property Value

Remarks

[ API set: WordApi 1.3 ]

parentTableCellOrNullObject

Gets the table cell that contains the inline image. Returns a null object if it is not contained in a table cell. Read-only.

readonly parentTableCellOrNullObject: Word.TableCell;

Property Value

Remarks

[ API set: WordApi 1.3 ]

parentTableOrNullObject

Gets the table that contains the inline image. Returns a null object if it is not contained in a table. Read-only.

readonly parentTableOrNullObject: Word.Table;

Property Value

Remarks

[ API set: WordApi 1.3 ]

width

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

width: number;

Property Value

number

Remarks

[ API set: WordApi 1.1 ]

Method Details

delete()

Deletes the inline picture from the document.

delete(): void;

Returns

void

Remarks

[ API set: WordApi 1.2 ]

getBase64ImageSrc()

Gets the base64 encoded string representation of the inline image.

getBase64ImageSrc(): OfficeExtension.ClientResult<string>;

Returns

Remarks

[ API set: WordApi 1.1 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/15-images/insert-and-get-pictures.yaml
// Get the first image in the document.
await Word.run(async (context) => {
  const firstPicture = context.document.body.inlinePictures.getFirst();
  firstPicture.load("width, height");

  await context.sync();
  console.log(`Image dimensions: ${firstPicture.width} x ${firstPicture.height}`);
  // Get the image encoded as base64.
  const base64 = firstPicture.getBase64ImageSrc();

  await context.sync();
  console.log(base64.value);
});

getNext()

Gets the next inline image. Throws an error if this inline image is the last one.

getNext(): Word.InlinePicture;

Returns

Remarks

[ API set: WordApi 1.3 ]

Examples

// To use this snippet, add an inline picture to the document and assign it an alt text title.
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the first inline picture.
    const firstPicture = context.document.body.inlinePictures.getFirstOrNullObject();

    // Queue a command to load the alternative text title of the picture.
    firstPicture.load('altTextTitle');

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    if (firstPicture.isNullObject) {
        console.log('There are no inline pictures in this document.')
    } else {
        console.log(firstPicture.altTextTitle);
    }
}); 

getNextOrNullObject()

Gets the next inline image. Returns a null object if this inline image is the last one.

getNextOrNullObject(): Word.InlinePicture;

Returns

Remarks

[ API set: WordApi 1.3 ]

Examples

// To use this snippet, add an inline picture to the document and assign it an alt text title.
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the first inline picture.
    const firstPicture = context.document.body.inlinePictures.getFirstOrNullObject();

    // Queue a command to load the alternative text title of the picture.
    firstPicture.load('altTextTitle');

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    if (firstPicture.isNullObject) {
        console.log('There are no inline pictures in this document.')
    } else {
        console.log(firstPicture.altTextTitle);
    }
}); 

getRange(rangeLocation)

Gets the picture, or the starting or ending point of the picture, as a range.

getRange(rangeLocation?: Word.RangeLocation): Word.Range;

Parameters

rangeLocation
Word.RangeLocation

Optional. The range location must be 'Whole', 'Start', or 'End'.

Returns

Remarks

[ API set: WordApi 1.3 ]

getRange(rangeLocationString)

Gets the picture, or the starting or ending point of the picture, as a range.

getRange(rangeLocationString?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;

Parameters

rangeLocationString

"Whole" | "Start" | "End" | "Before" | "After" | "Content"

Optional. The range location must be 'Whole', 'Start', or 'End'.

Returns

Remarks

[ API set: WordApi 1.3 ]

insertBreak(breakType, insertLocation)

Inserts a break at the specified location in the main document.

insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;

Parameters

breakType
Word.BreakType

Required. The break type to add.

insertLocation
Word.InsertLocation

Required. The value must be 'Before' or 'After'.

Returns

void

Remarks

[ API set: WordApi 1.2 ]

insertBreak(breakTypeString, insertLocation)

Inserts a break at the specified location in the main document.

insertBreak(breakTypeString: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;

Parameters

breakTypeString

"Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line"

Required. The break type to add.

insertLocation

"Before" | "After" | "Start" | "End" | "Replace"

Required. The value must be 'Before' or 'After'.

Returns

void

Remarks

[ API set: WordApi 1.2 ]

insertContentControl()

Wraps the inline picture with a rich text content control.

insertContentControl(): Word.ContentControl;

Returns

Remarks

[ API set: WordApi 1.1 ]

insertFileFromBase64(base64File, insertLocation)

Inserts a document at the specified location.

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;

Parameters

base64File

string

Required. The base64 encoded content of a .docx file.

insertLocation
Word.InsertLocation

Required. The value must be 'Before' or 'After'.

Returns

Remarks

[ API set: WordApi 1.2 ]

insertFileFromBase64(base64File, insertLocationString)

Inserts a document at the specified location.

insertFileFromBase64(base64File: string, insertLocationString: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;

Parameters

base64File

string

Required. The base64 encoded content of a .docx file.

insertLocationString

"Before" | "After" | "Start" | "End" | "Replace"

Required. The value must be 'Before' or 'After'.

Returns

Remarks

[ API set: WordApi 1.2 ]

insertHtml(html, insertLocation)

Inserts HTML at the specified location.

insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;

Parameters

html

string

Required. The HTML to be inserted.

insertLocation
Word.InsertLocation

Required. The value must be 'Before' or 'After'.

Returns

Remarks

[ API set: WordApi 1.2 ]

insertHtml(html, insertLocationString)

Inserts HTML at the specified location.

insertHtml(html: string, insertLocationString: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;

Parameters

html

string

Required. The HTML to be inserted.

insertLocationString

"Before" | "After" | "Start" | "End" | "Replace"

Required. The value must be 'Before' or 'After'.

Returns

Remarks

[ API set: WordApi 1.2 ]

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

Inserts an inline picture at the specified location.

insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;

Parameters

base64EncodedImage

string

Required. The base64 encoded image to be inserted.

insertLocation
Word.InsertLocation

Required. The value must be 'Replace', 'Before', or 'After'.

Returns

Remarks

[ API set: WordApi 1.2 ]

insertInlinePictureFromBase64(base64EncodedImage, insertLocationString)

Inserts an inline picture at the specified location.

insertInlinePictureFromBase64(base64EncodedImage: string, insertLocationString: "Before" | "After" | "Start" | "End" | "Replace"): Word.InlinePicture;

Parameters

base64EncodedImage

string

Required. The base64 encoded image to be inserted.

insertLocationString

"Before" | "After" | "Start" | "End" | "Replace"

Required. The value must be 'Replace', 'Before', or 'After'.

Returns

Remarks

[ API set: WordApi 1.2 ]

insertOoxml(ooxml, insertLocation)

Inserts OOXML at the specified location.

insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;

Parameters

ooxml

string

Required. The OOXML to be inserted.

insertLocation
Word.InsertLocation

Required. The value must be 'Before' or 'After'.

Returns

Remarks

[ API set: WordApi 1.2 ]

insertOoxml(ooxml, insertLocationString)

Inserts OOXML at the specified location.

insertOoxml(ooxml: string, insertLocationString: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;

Parameters

ooxml

string

Required. The OOXML to be inserted.

insertLocationString

"Before" | "After" | "Start" | "End" | "Replace"

Required. The value must be 'Before' or 'After'.

Returns

Remarks

[ API set: WordApi 1.2 ]

insertParagraph(paragraphText, insertLocation)

Inserts a paragraph at the specified location.

insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;

Parameters

paragraphText

string

Required. The paragraph text to be inserted.

insertLocation
Word.InsertLocation

Required. The value must be 'Before' or 'After'.

Returns

Remarks

[ API set: WordApi 1.2 ]

insertParagraph(paragraphText, insertLocationString)

Inserts a paragraph at the specified location.

insertParagraph(paragraphText: string, insertLocationString: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;

Parameters

paragraphText

string

Required. The paragraph text to be inserted.

insertLocationString

"Before" | "After" | "Start" | "End" | "Replace"

Required. The value must be 'Before' or 'After'.

Returns

Remarks

[ API set: WordApi 1.2 ]

insertText(text, insertLocation)

Inserts text at the specified location.

insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;

Parameters

text

string

Required. Text to be inserted.

insertLocation
Word.InsertLocation

Required. The value must be 'Before' or 'After'.

Returns

Remarks

[ API set: WordApi 1.2 ]

insertText(text, insertLocationString)

Inserts text at the specified location.

insertText(text: string, insertLocationString: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;

Parameters

text

string

Required. Text to be inserted.

insertLocationString

"Before" | "After" | "Start" | "End" | "Replace"

Required. The value must be 'Before' or 'After'.

Returns

Remarks

[ API set: WordApi 1.2 ]

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: Word.Interfaces.InlinePictureLoadOptions): Word.InlinePicture;

Parameters

options
Word.Interfaces.InlinePictureLoadOptions

Provides options for which properties of the object to load.

Returns

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Word.InlinePicture;

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.InlinePicture;

Parameters

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

select(selectionMode)

Selects the inline picture. This causes Word to scroll to the selection.

select(selectionMode?: Word.SelectionMode): void;

Parameters

selectionMode
Word.SelectionMode

Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.

Returns

void

Remarks

[ API set: WordApi 1.2 ]

select(selectionModeString)

Selects the inline picture. This causes Word to scroll to the selection.

select(selectionModeString?: "Select" | "Start" | "End"): void;

Parameters

selectionModeString

"Select" | "Start" | "End"

Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default.

Returns

void

Remarks

[ API set: WordApi 1.2 ]

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.InlinePictureUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties
Word.Interfaces.InlinePictureUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Word.InlinePicture): void;

Parameters

properties
Word.InlinePicture

Returns

void

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Word.InlinePicture object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.InlinePictureData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Word.Interfaces.InlinePictureData;

Returns

track()

Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.

track(): Word.InlinePicture;

Returns

untrack()

Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call context.sync() before the memory release takes effect.

untrack(): Word.InlinePicture;

Returns