クラス: CustomDocPropsManager

Spread.Sheets.CustomDocPropsManager

Table of contents

コンストラクタ

• constructor

メソッド

• add
• all
• clear
• get
• remove

コンストラクタ

constructor

• new CustomDocPropsManager(workbook)

カスタムドキュメントプロパティのマネージャを表します。すべてのドキュメントのカスタムプロパティを管理できます。

パラメータ

メソッド

add

▸ add(propName, value, isLinkTarget?): void

カスタムドキュメントプロパティを設定します。

実例

spread.docProps.customDocPropsManager.add('prop1', '1');
spread.docProps.customDocPropsManager.add('prop2', 'CellAlias', true);

パラメータ

戻り値

void

all

▸ all(props?): undefined | ICustomDocumentProperty[]

カスタムドキュメントプロパティを取得または設定します。

実例

spread.docProps.customDocPropsManager.all([{ name: 'prop1', value: '1' }]);
spread.docProps.customDocPropsManager.all();

パラメータ

戻り値

undefined | ICustomDocumentProperty[]

カスタムドキュメントプロパティ。

clear

▸ clear(): void

カスタムドキュメントプロパティをクリアします。

実例

spread.docProps.customDocPropsManager.clear();

戻り値

void

get

▸ get(propName): undefined | ICustomDocumentProperty

カスタムドキュメントプロパティをプロパティ名で取得します。

実例

spread.docProps.customDocPropsManager.all([{ name: 'prop1', value: '1' }]);
spread.docProps.customDocPropsManager.get('prop1');

パラメータ

戻り値

undefined | ICustomDocumentProperty

カスタムドキュメントプロパティ。

remove

▸ remove(propName): void

カスタムドキュメントプロパティをプロパティ名で削除します。

実例

spread.docProps.customDocPropsManager.remove('prop1');

パラメータ

戻り値

void