Word.InlinePicture class
Represents an inline picture.
- Extends
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/15-images/insert-and-get-pictures.yaml
// Inserts an image anchored to the last paragraph.
await Word.run(async (context) => {
context.document.body.paragraphs
.getLast()
.insertParagraph("", "After")
.insertInlinePictureFromBase64(base64Image, "End");
await context.sync();
});
Properties
| 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. |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| 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. |
| image |
Gets the format of the inline image. |
| lock |
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. |
| parent |
Gets the content control that contains the inline image. Throws an |
| parent |
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 |
| parent |
Gets the table that contains the inline image. Throws an |
| parent |
Gets the table cell that contains the inline image. Throws an |
| parent |
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 |
| parent |
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 |
| width | Specifies a number that describes the width of the inline image. |
Methods
| delete() | Deletes the inline picture from the document. |
| get |
Gets the Base64-encoded string representation of the inline image. |
| get |
Gets the next inline image. Throws an |
| get |
Gets the next inline image. If this inline image is the last one, then this method will return an object with its |
| get |
Gets the picture, or the starting or ending point of the picture, as a range. |
| insert |
Inserts a break at the specified location in the main document. |
| insert |
Wraps the inline picture with a rich text content control. |
| insert |
Inserts a document at the specified location. |
| insert |
Inserts HTML at the specified location. |
| insert |
Inserts an inline picture at the specified location. |
| insert |
Inserts OOXML at the specified location. |
| insert |
Inserts a paragraph at the specified location. |
| insert |
Inserts text at the specified location. |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| select(selection |
Selects the inline picture. This causes Word to scroll to the selection. |
| select(selection |
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 |
| 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're using this object across |
| 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'll need to call |
Property Details
altTextDescription
Specifies a string that represents the alternative text associated with the inline image.
altTextDescription: string;Property Value
string
Remarks
altTextTitle
Specifies a string that contains the title for the inline image.
altTextTitle: string;Property Value
string
Remarks
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
Specifies a number that describes the height of the inline image.
height: number;Property Value
number
Remarks
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
imageFormat
Gets the format of the inline image.
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: WordApiDesktop 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
// Gets the first image in the document.
await Word.run(async (context) => {
const firstPicture: Word.InlinePicture = context.document.body.inlinePictures.getFirst();
firstPicture.load("width, height, imageFormat");
await context.sync();
console.log(`Image dimensions: ${firstPicture.width} x ${firstPicture.height}`, `Image format: ${firstPicture.imageFormat}`);
// Get the image encoded as Base64.
const base64 = firstPicture.getBase64ImageSrc();
await context.sync();
console.log(base64.value);
});
lockAspectRatio
Specifies a value that indicates 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.
readonly paragraph: Word.Paragraph;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.
readonly parentContentControl: Word.ContentControl;Property Value
Remarks
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.
readonly parentContentControlOrNullObject: Word.ContentControl;Property Value
Remarks
parentTable
Gets the table that contains the inline image. Throws an ItemNotFound error if it isn't contained in a table.
readonly parentTable: Word.Table;Property Value
Remarks
parentTableCell
Gets the table cell that contains the inline image. Throws an ItemNotFound error if it isn't contained in a table cell.
readonly parentTableCell: Word.TableCell;Property Value
Remarks
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.
readonly parentTableCellOrNullObject: Word.TableCell;Property Value
Remarks
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.
readonly parentTableOrNullObject: Word.Table;Property Value
Remarks
width
Specifies a number that describes the width of the inline image.
width: number;Property Value
number
Remarks
Method Details
delete()
Deletes the inline picture from the document.
delete(): void;Returns
void
Remarks
getBase64ImageSrc()
Gets the Base64-encoded string representation of the inline image.
getBase64ImageSrc(): OfficeExtension.ClientResult<string>;Returns
OfficeExtension.ClientResult<string>
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/15-images/insert-and-get-pictures.yaml
// Gets the first image in the document.
await Word.run(async (context) => {
const firstPicture: Word.InlinePicture = context.document.body.inlinePictures.getFirst();
firstPicture.load("width, height, imageFormat");
await context.sync();
console.log(`Image dimensions: ${firstPicture.width} x ${firstPicture.height}`, `Image format: ${firstPicture.imageFormat}`);
// 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 ItemNotFound error if this inline image is the last one.
getNext(): Word.InlinePicture;Returns
Remarks
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. If this inline image is the last one, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
getNextOrNullObject(): Word.InlinePicture;Returns
Remarks
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.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;Parameters
Optional. The range location must be 'Whole', 'Start', or 'End'.
Returns
Remarks
insertBreak(breakType, insertLocation)
Inserts a break at the specified location in the main document.
insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void;Parameters
- breakType
-
Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line"
Required. The break type to add.
Returns
void
Remarks
insertContentControl()
Wraps the inline picture with a rich text content control.
insertContentControl(): Word.ContentControl;Returns
Remarks
insertFileFromBase64(base64File, insertLocation)
Inserts a document at the specified location.
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;Parameters
- base64File
-
string
Required. The Base64-encoded content of a .docx file.
Returns
Remarks
Note: Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario.
insertHtml(html, insertLocation)
Inserts HTML at the specified location.
insertHtml(html: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;Parameters
- html
-
string
Required. The HTML to be inserted.
Returns
Remarks
insertInlinePictureFromBase64(base64EncodedImage, insertLocation)
Inserts an inline picture at the specified location.
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.before | Word.InsertLocation.after | "Replace" | "Before" | "After"): Word.InlinePicture;Parameters
- base64EncodedImage
-
string
Required. The Base64-encoded image to be inserted.
Required. The value must be 'Replace', 'Before', or 'After'.
Returns
Remarks
insertOoxml(ooxml, insertLocation)
Inserts OOXML at the specified location.
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;Parameters
- ooxml
-
string
Required. The OOXML to be inserted.
Returns
Remarks
insertParagraph(paragraphText, insertLocation)
Inserts a paragraph at the specified location.
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;Parameters
- paragraphText
-
string
Required. The paragraph text to be inserted.
Returns
Remarks
insertText(text, insertLocation)
Inserts text at the specified location.
insertText(text: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;Parameters
- text
-
string
Required. Text to be inserted.
Returns
Remarks
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
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
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
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's 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're 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'll need to call context.sync() before the memory release takes effect.
untrack(): Word.InlinePicture;Returns
Office Add-ins