Excel.CustomPropertyCollection class
Contains the collection of custom properties.
- Extends
Remarks
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 error if the custom property does not exist. |
| get |
Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then this method returns 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 |
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: Excel.CustomProperty[];Property Value
Method Details
add(key, value)
Creates a new or sets an existing custom property.
add(key: string, value: any): Excel.CustomProperty;Parameters
- key
-
string
Required. The custom property's key, which is case-insensitive. The key is limited to 255 characters outside of Excel on the web (larger keys are automatically trimmed to 255 characters on other platforms).
- value
-
any
Required. The custom property's value. The value is limited to 255 characters outside of Excel on the web (larger values are automatically trimmed to 255 characters on other platforms).
Returns
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/custom-properties.yaml
await Excel.run(async (context) => {
// Get the key/value pair from the task pane.
const userKey = $("#key").text();
const userValue = $("#value").text();
// Add the custom property.
const customDocProperties = context.workbook.properties.custom;
customDocProperties.add(userKey, userValue);
await context.sync();
console.log(`Successfully set custom document property ${userKey}:${userValue}.`);
});
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 error if the custom property does not exist.
getItem(key: string): Excel.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 returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
getItemOrNullObject(key: string): Excel.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?: Excel.Interfaces.CustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomPropertyCollection;Parameters
- options
-
Excel.Interfaces.CustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
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[]): Excel.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): Excel.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 is passed to it.) Whereas the original Excel.CustomPropertyCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.CustomPropertyCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): Excel.Interfaces.CustomPropertyCollectionData;Returns
Office Add-ins