Word.CustomPropertyCollection class

Contains the collection of Word.CustomProperty objects.

[ API set: WordApi 1.3 ]

Extends
OfficeExtension.ClientObject

Properties

items

Gets the loaded child items in this collection.

Methods

add(key, value)

Creates a new or sets an existing custom property.

[ API set: WordApi 1.3 ]

deleteAll()

Deletes all custom properties in this collection.

[ API set: WordApi 1.3 ]

getCount()

Gets the count of custom properties.

[ API set: WordApi 1.3 ]

getItem(key)

Gets a custom property object by its key, which is case-insensitive. Throws if the custom property does not exist.

[ API set: WordApi 1.3 ]

getItemOrNullObject(key)

Gets a custom property object by its key, which is case-insensitive. Returns a null object if the custom property does not exist.

[ API set: WordApi 1.3 ]

load(option)

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

toJSON()
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 needed to have added the object to the tracked object collection when the object was first created.

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

items

Gets the loaded child items in this collection.

readonly items: Word.CustomProperty[];
Property Value
Word.CustomProperty[]

Examples

await Word.run(async (context) => {
    let properties = context.document.properties.customProperties;
    properties.load("key,type,value");

    await context.sync();
    for (var i = 0; i < properties.items.length; i++)
        console.log("Property Name:" + properties.items[i].key + ";Type=" + properties.items[i].type + "; Property Value=" + properties.items[i].value);
});

Method Details

add(key, value)

Creates a new or sets an existing custom property.

[ API set: WordApi 1.3 ]

add(key: string, value: any): Word.CustomProperty;
Parameters
key
string

Required. The custom property's key, which is case-insensitive.

value
any

Required. The custom property's value.

Returns
Word.CustomProperty

Examples

await Word.run(async (context) => {
    context.document.properties.customProperties.add("Numeric Property", 1234);

    await context.sync();
    console.log("Property added");
});
await Word.run(async (context) => {
    context.document.properties.customProperties.add("String Property", "Hello World!");

    await context.sync();
    console.log("Property added");
});

deleteAll()

Deletes all custom properties in this collection.

[ API set: WordApi 1.3 ]

deleteAll(): void;
Returns
void

getCount()

Gets the count of custom properties.

[ API set: WordApi 1.3 ]

getCount(): OfficeExtension.ClientResult<number>;
Returns
OfficeExtension.ClientResult<number>

getItem(key)

Gets a custom property object by its key, which is case-insensitive. Throws if the custom property does not exist.

[ API set: WordApi 1.3 ]

getItem(key: string): Word.CustomProperty;
Parameters
key
string

The key that identifies the custom property object.

Returns
Word.CustomProperty

getItemOrNullObject(key)

Gets a custom property object by its key, which is case-insensitive. Returns a null object if the custom property does not exist.

[ API set: WordApi 1.3 ]

getItemOrNullObject(key: string): Word.CustomProperty;
Parameters
key
string

Required. The key that identifies the custom property object.

Returns
Word.CustomProperty

load(option)

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

load(option?: string | string[]): Word.CustomPropertyCollection;
Parameters
option
string | string[]

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

Returns
Word.CustomPropertyCollection
Remarks

In addition to this signature, this method has the following signatures:

load(option?: { select?: string; expand?: string; }): Word.CustomPropertyCollection - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Word.CustomPropertyCollection - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items.

toJSON()

toJSON(): Word.Interfaces.CustomPropertyCollectionData;
Returns
Word.Interfaces.CustomPropertyCollectionData

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 needed to have added the object to the tracked object collection when the object was first created.

track(): Word.CustomPropertyCollection;
Returns
Word.CustomPropertyCollection

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.CustomPropertyCollection;
Returns
Word.CustomPropertyCollection