Excel.CustomProperty class

Represents a custom property.

[ API set: ExcelApi 1.7 ]

Extends

Properties

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

key

The key of the custom property. The key is limited to 255 characters outside of Excel on the web (larger keys are automatically trimmed to 255 characters on other platforms).

[ API set: ExcelApi 1.7 ]

type

The type of the value used for the custom property.

[ API set: ExcelApi 1.7 ]

value

The value of the custom property. The value is limited to 255 characters outside of Excel on the web (larger values are automatically trimmed to 255 characters on other platforms).

[ API set: ExcelApi 1.7 ]

Methods

delete()

Deletes the custom property.

[ API set: ExcelApi 1.7 ]

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.CustomProperty object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.CustomPropertyData) 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

key

The key of the custom property. The key is limited to 255 characters outside of Excel on the web (larger keys are automatically trimmed to 255 characters on other platforms).

[ API set: ExcelApi 1.7 ]

readonly key: string;

Property Value

string

type

The type of the value used for the custom property.

[ API set: ExcelApi 1.7 ]

readonly type: Excel.DocumentPropertyType | "Number" | "Boolean" | "Date" | "String" | "Float";

Property Value

Excel.DocumentPropertyType | "Number" | "Boolean" | "Date" | "String" | "Float"

value

The value of the custom property. The value is limited to 255 characters outside of Excel on the web (larger values are automatically trimmed to 255 characters on other platforms).

[ API set: ExcelApi 1.7 ]

value: any;

Property Value

any

Method Details

delete()

Deletes the custom property.

[ API set: ExcelApi 1.7 ]

delete(): void;

Returns

void

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.CustomPropertyLoadOptions): Excel.CustomProperty;

Parameters

options
Excel.Interfaces.CustomPropertyLoadOptions

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

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?: {
            select?: string;
            expand?: string;
        }): Excel.CustomProperty;

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

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.CustomPropertyUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties
Excel.Interfaces.CustomPropertyUpdateData

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

Remarks

This method has the following additional signature:

set(properties: Excel.CustomProperty): void

set(properties)

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

set(properties: Excel.CustomProperty): void;

Parameters

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

toJSON(): Excel.Interfaces.CustomPropertyData;

Returns