MetadataOptions

MetadataOptions class

Represents the options of loading metadata of the file.

class MetadataOptions;

Constructors

ConstructorDescription
constructor(MetadataType)Creates an options of loading the metadata.

Properties

PropertyTypeDescription
metadataTypeMetadataTypeReadonly. Gets and sets the type of the metadata which is loading.
passwordstringRepresents Workbook file encryption password.
keyLengthnumberThe key length.

Methods

MethodDescription
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:

ParameterTypeDescription
metadataTypeMetadataTypeThe 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

MetadataType

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:

ParameterTypeDescription
valuestringThe 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:

ParameterTypeDescription
valuenumberThe value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;