InlinePictureCollection Object (JavaScript API for Word)

Word 2016, Word for iPad, Word for Mac, Word Online

Contains a collection of inlinePicture objects.

Properties

Property Type Description Req. Set
items InlinePicture[] A collection of inlinePicture objects. Read-only. 1.1

Relationships

None

Methods

Method Return Type Description Req. Set
getFirst() InlinePicture Gets the first inline image in this collection. Throws if this collection is empty. 1.3
getFirstOrNullObject() InlinePicture Gets the first inline image in this collection. Returns a null object if this collection is empty. 1.3
getItem(index: number) InlinePicture Gets an inline picture object by its index in the collection. 1.1
load(param: object) void Fills the proxy object created in JavaScript layer with property and object values specified in the parameter. 1.1

Method Details

getFirst()

Gets the first inline image in this collection. Throws if this collection is empty.

Syntax

inlinePictureCollectionObject.getFirst();

Parameters

None

Returns

InlinePicture

getFirstOrNullObject()

Gets the first inline image in this collection. Returns a null object if this collection is empty.

Syntax

inlinePictureCollectionObject.getFirstOrNullObject();

Parameters

None

Returns

InlinePicture

getItem(index: number)

Gets an inline picture object by its index in the collection.

Syntax

inlinePictureCollectionObject.getItem(index);

Parameters

Parameter Type Description
index number A number that identifies the index location of an inline picture object.

Returns

InlinePicture

load(param: object)

Fills the proxy object created in JavaScript layer with property and object values specified in the parameter.

Syntax

object.load(param);

Parameters

Parameter Type Description
param object Optional. Accepts parameter and relationship names as delimited string or an array. Or, provide loadOption object.

Returns

void