MetadataOptions
MetadataOptions class
Represents the options of loading metadata of the file.
class MetadataOptions;
Constructors
Constructor | Description |
---|---|
constructor(MetadataType) | Creates an options of loading the metadata. |
Properties
Property | Type | Description |
---|---|---|
metadataType | MetadataType | Readonly. Gets and sets the type of the metadata which is loading. |
password | string | Represents Workbook file encryption password. |
keyLength | number | The key length. |
Methods
Method | Description |
---|---|
getMetadataType() | @deprecated. Please use the ‘metadataType’ property instead. Gets and sets the type of the metadata which is loading. |
getPassword() | @deprecated. Please use the ‘password’ property instead. Represents Workbook file encryption password. |
setPassword(string) | @deprecated. Please use the ‘password’ property instead. Represents Workbook file encryption password. |
getKeyLength() | @deprecated. Please use the ‘keyLength’ property instead. The key length. |
setKeyLength(number) | @deprecated. Please use the ‘keyLength’ property instead. The key length. |
isNull() | Checks whether the implementation object is null. |
constructor(MetadataType)
Creates an options of loading the metadata.
constructor(metadataType: MetadataType);
Parameters:
Parameter | Type | Description |
---|---|---|
metadataType | MetadataType | The type of metadata. |
metadataType
Readonly. Gets and sets the type of the metadata which is loading.
metadataType : MetadataType;
password
Represents Workbook file encryption password.
password : string;
keyLength
The key length.
keyLength : number;
getMetadataType()
@deprecated. Please use the ‘metadataType’ property instead. Gets and sets the type of the metadata which is loading.
getMetadataType() : MetadataType;
Returns
getPassword()
@deprecated. Please use the ‘password’ property instead. Represents Workbook file encryption password.
getPassword() : string;
setPassword(string)
@deprecated. Please use the ‘password’ property instead. Represents Workbook file encryption password.
setPassword(value: string) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | string | The value to set. |
getKeyLength()
@deprecated. Please use the ‘keyLength’ property instead. The key length.
getKeyLength() : number;
setKeyLength(number)
@deprecated. Please use the ‘keyLength’ property instead. The key length.
setKeyLength(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;