Excel.WorksheetCustomPropertyCollection class
Contains the collection of worksheet-level custom property.
- 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) | Adds a new custom property that maps to the provided key. This overwrites existing custom properties with that key. |
| get |
Gets the number of custom properties on this worksheet. |
| 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.WorksheetCustomProperty[];Property Value
Method Details
add(key, value)
Adds a new custom property that maps to the provided key. This overwrites existing custom properties with that key.
add(key: string, value: string): Excel.WorksheetCustomProperty;Parameters
- key
-
string
The key that identifies the custom property object. It is case-insensitive.The key is limited to 255 characters (larger values will cause an InvalidArgument error to be thrown.)
- value
-
string
The value of this custom property.
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 customWorksheetProperties = context.workbook.worksheets.getActiveWorksheet().customProperties;
customWorksheetProperties.add(userKey, userValue);
await context.sync();
console.log(`Successfully set custom worksheet property ${userKey}:${userValue}.`);
});
getCount()
Gets the number of custom properties on this worksheet.
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.WorksheetCustomProperty;Parameters
- key
-
string
The key that identifies the custom property object. It is case-insensitive.
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.WorksheetCustomProperty;Parameters
- key
-
string
The key that identifies the custom property object. It is case-insensitive.
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.WorksheetCustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WorksheetCustomPropertyCollection;Parameters
- options
-
Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions & 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.WorksheetCustomPropertyCollection;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.WorksheetCustomPropertyCollection;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.WorksheetCustomPropertyCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.WorksheetCustomPropertyCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): Excel.Interfaces.WorksheetCustomPropertyCollectionData;Returns
Office Add-ins