Word.CustomPropertyCollection class
Contains the collection of Word.CustomProperty objects.
- Extends
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/read-write-custom-document-properties.yaml
await Word.run(async (context) => {
const properties: Word.CustomPropertyCollection = context.document.properties.customProperties;
properties.load("key,type,value");
await context.sync();
for (let 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);
});
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| items | Gets the loaded child items in this collection. |
Methods
| add(key, value) | Creates a new or sets an existing custom property. |
| delete |
Deletes all custom properties in this collection. |
| get |
Gets the count of custom properties. |
| get |
Gets a custom property object by its key, which is case-insensitive. Throws an |
| get |
Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then this method will return an object with its |
| 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 |
| 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
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
items
Gets the loaded child items in this collection.
readonly items: Word.CustomProperty[];Property Value
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/read-write-custom-document-properties.yaml
await Word.run(async (context) => {
const properties: Word.CustomPropertyCollection = context.document.properties.customProperties;
properties.load("key,type,value");
await context.sync();
for (let 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.
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
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/read-write-custom-document-properties.yaml
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.
deleteAll(): void;Returns
void
Remarks
getCount()
Gets the count of custom properties.
getCount(): OfficeExtension.ClientResult<number>;Returns
OfficeExtension.ClientResult<number>
Remarks
getItem(key)
Gets a custom property object by its key, which is case-insensitive. Throws an ItemNotFound error if the custom property doesn't exist.
getItem(key: string): Word.CustomProperty;Parameters
- key
-
string
The key that identifies the custom property object.
Returns
Remarks
getItemOrNullObject(key)
Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
getItemOrNullObject(key: string): Word.CustomProperty;Parameters
- key
-
string
Required. The key that identifies the custom property object.
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.CustomPropertyCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomPropertyCollection;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.CustomPropertyCollection;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?: OfficeExtension.LoadOption): Word.CustomPropertyCollection;Parameters
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
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.CustomPropertyCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.CustomPropertyCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): Word.Interfaces.CustomPropertyCollectionData;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.CustomPropertyCollection;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.CustomPropertyCollection;Returns
Office Add-ins