Excel.WorksheetCustomProperty class

Package:

excel

Represents a worksheet-level custom property.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.12 ]

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
key	Gets the key of the custom property. Custom property keys are case-insensitive. The key is limited to 255 characters (larger values will cause an InvalidArgument error to be thrown.)
value	Gets or sets the value of the custom property.

Methods

delete()	Deletes the custom property.
load(options)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
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.
set(properties, options)	Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties)	Sets multiple properties on the object at the same time, based on an existing loaded object.
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.WorksheetCustomProperty object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.WorksheetCustomPropertyData) that contains shallow copies of any loaded child properties from the original object.

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

Excel.RequestContext

key

Gets the key of the custom property. Custom property keys are case-insensitive. The key is limited to 255 characters (larger values will cause an InvalidArgument error to be thrown.)

readonly key: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.12 ]

value

Gets or sets the value of the custom property.

value: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.12 ]

Method Details

delete()

Deletes the custom property.

delete(): void;

Returns

void

Remarks

[ API set: ExcelApi 1.12 ]

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.WorksheetCustomPropertyLoadOptions): Excel.WorksheetCustomProperty;

Parameters

options

Excel.Interfaces.WorksheetCustomPropertyLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.WorksheetCustomProperty

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

Parameters

propertyNames

string | string[]

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

Returns

Excel.WorksheetCustomProperty

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;
        }): Excel.WorksheetCustomProperty;

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

Excel.WorksheetCustomProperty

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.WorksheetCustomPropertyUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties

Excel.Interfaces.WorksheetCustomPropertyUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options

OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.WorksheetCustomProperty): void;

Parameters

properties

Excel.WorksheetCustomProperty

Returns

void

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

toJSON(): Excel.Interfaces.WorksheetCustomPropertyData;

Returns

Excel.Interfaces.WorksheetCustomPropertyData