Interface ICustomProperty

A property a user or an application added to the workbook: a name and a value. Saved with the workbook; it affects nothing else.

Remarks

Shaped after Office Scripts' CustomProperty.

See

IDocumentProperties.getCustom

interface ICustomProperty {
    delete(): void;
    getKey(): string;
    getLinkTarget(): string | null;
    getType(): ICustomProperty.Type;
    getValue(): string | number | boolean | Date;
    setValue(value: string | number | boolean | Date): void;
    toJSON(): ICustomProperty.JSON;
}

Index

Methods

delete getKey getLinkTarget getType getValue setValue toJSON

Methods

delete

delete(): void

Removes the property from the workbook.

Returns void

getKey

getKey(): string

The property's name. Unique within the workbook, ignoring case.

Returns string

getLinkTarget

getLinkTarget(): string | null

The defined name the value is linked to ("Link to content"), or null when it is not linked.

Returns string | null

Remarks
VBA's DocumentProperty.LinkSource. Carried from the file: SheetXL does not refresh the value from the name, and setValue keeps the link.

getType

getType(): ICustomProperty.Type

The kind of value, chosen by setValue from the value it is given.

Returns ICustomProperty.Type

getValue

getValue(): string | number | boolean | Date

The property's value. A ICustomProperty.Type.Date property returns a Date.

Returns string | number | boolean | Date

setValue

setValue(value: string | number | boolean | Date): void
Sets getValue, and with it getType: a whole number that fits in 32 bits is a ICustomProperty.Type.Number, any other number a ICustomProperty.Type.Float.
Parameters
- value: string | number | boolean | Date
Returns void

toJSON

toJSON(): ICustomProperty.JSON

For persisting.

Returns ICustomProperty.JSON