ExcelScript.WorksheetCustomProperty interface

Package:

ExcelScript

Represents a worksheet-level custom property.

Methods

delete()	Deletes the custom property.
getKey()	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.)
getValue()	Gets or sets the value of the custom property.
setValue(value)	Gets or sets the value of the custom property.

Method Details

delete()

Deletes the custom property.

delete(): void;

Returns

void

getKey()

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.)

getKey(): string;

Returns

string

getValue()

Gets or sets the value of the custom property.

getValue(): string;

Returns

string

setValue(value)

Gets or sets the value of the custom property.

setValue(value: string): void;

Parameters

value

string

Returns

void