Edit

Share via

Word.RepeatingSectionItemCollection class

Package:
word

Represents a collection of Word.RepeatingSectionItem objects in a Word document.

Extends
OfficeExtension.ClientObject

Remarks

[ API set: WordApiDesktop 1.3 ]

Properties

context

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

Methods

getItemAt(index)

Returns an individual repeating section item.
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.
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.RepeatingSectionItemCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.RepeatingSectionItemCollectionData) 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'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.
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.

Property Details

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

Word.RequestContext

Method Details

getItemAt(index)

Returns an individual repeating section item.

getItemAt(index: number): Word.RepeatingSectionItem;

Parameters

index

number

The index of the item to retrieve.

Returns

Word.RepeatingSectionItem

A RepeatingSectionItem object representing the item at the specified index.

Remarks

[ API set: WordApiDesktop 1.3 ]

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.RepeatingSectionItemCollection;

Parameters

propertyNames

string | string[]

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

Returns

Word.RepeatingSectionItemCollection

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.RepeatingSectionItemCollection;

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

Word.RepeatingSectionItemCollection

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.RepeatingSectionItemCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.RepeatingSectionItemCollectionData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): {
            [key: string]: string;
        };

Returns

{ [key: string]: string; }

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.RepeatingSectionItemCollection;

Returns

Word.RepeatingSectionItemCollection

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.RepeatingSectionItemCollection;

Returns

Word.RepeatingSectionItemCollection