CustomProperty
CustomProperty class
Represents a custom property which store name and value pairs of arbitrary user-defined data for worksheet.
class CustomProperty;
Properties
| Property | Type | Description |
|---|---|---|
| name | string | Returns or sets the name of the object. |
| value | string | Returns or sets the value of the custom property. |
| binaryValue | Uint8Array | Gets and sets the binary value of the custom property. |
Methods
| Method | Description |
|---|---|
| getName() | @deprecated. Please use the ’name’ property instead. Returns or sets the name of the object. |
| setName(string) | @deprecated. Please use the ’name’ property instead. Returns or sets the name of the object. |
| getValue() | @deprecated. Please use the ‘value’ property instead. Returns or sets the value of the custom property. |
| setValue(string) | @deprecated. Please use the ‘value’ property instead. Returns or sets the value of the custom property. |
| getBinaryValue() | @deprecated. Please use the ‘binaryValue’ property instead. Gets and sets the binary value of the custom property. |
| setBinaryValue(Uint8Array) | @deprecated. Please use the ‘binaryValue’ property instead. Gets and sets the binary value of the custom property. |
| isNull() | Checks whether the implementation object is null. |
name
Returns or sets the name of the object.
name : string;
value
Returns or sets the value of the custom property.
value : string;
binaryValue
Gets and sets the binary value of the custom property.
binaryValue : Uint8Array;
getName()
@deprecated. Please use the ’name’ property instead. Returns or sets the name of the object.
getName() : string;
setName(string)
@deprecated. Please use the ’name’ property instead. Returns or sets the name of the object.
setName(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getValue()
@deprecated. Please use the ‘value’ property instead. Returns or sets the value of the custom property.
getValue() : string;
setValue(string)
@deprecated. Please use the ‘value’ property instead. Returns or sets the value of the custom property.
setValue(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getBinaryValue()
@deprecated. Please use the ‘binaryValue’ property instead. Gets and sets the binary value of the custom property.
getBinaryValue() : Uint8Array;
setBinaryValue(Uint8Array)
@deprecated. Please use the ‘binaryValue’ property instead. Gets and sets the binary value of the custom property.
setBinaryValue(value: Uint8Array) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number[] | The value to set. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;