ExcelScript.CustomProperty interface

  • Reference
Package:
ExcelScript

Represents a custom property.

Methods

delete()

Deletes the custom property.
getKey()

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

The type of the value used for the custom property.
getValue()

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

Method Details

delete()

Deletes the custom property.

delete(): void;

Returns

void

getKey()

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

getKey(): string;

Returns

string

getType()

The type of the value used for the custom property.

getType(): DocumentPropertyType;

Returns

ExcelScript.DocumentPropertyType

getValue()

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

getValue(): any;

Returns

any

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

setValue(value: any): void;

Parameters

value

any

Returns

void