Excel.SensitivityLabel class
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
ブックの秘密度ラベルを表します。
- Extends
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
メソッド
| get |
ユーザーのブックに存在する現在のラベル情報を取得します。 現在のブックに秘密度ラベルがない場合は、 |
| toJSON() | API オブジェクトが |
| try |
ユーザーのブックで指定された秘密度ラベルに更新を試みます。 |
プロパティの詳細
context
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;
プロパティ値
メソッドの詳細
getCurrentOrNullObject()
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
ユーザーのブックに存在する現在のラベル情報を取得します。 現在のブックに秘密度ラベルがない場合は、 isNullObject プロパティが true に設定されているオブジェクトが返されます。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getCurrentOrNullObject(): Excel.SensitivityLabelDetails;
返品
現在の SensitivityLabelDetails オブジェクト。
注釈
toJSON()
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.SensitivityLabel オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.SensitivityLabelData として型指定) を返します。
toJSON(): {
[key: string]: string;
};
返品
{ [key: string]: string; }
tryToUpdate(labelId)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
ユーザーのブックで指定された秘密度ラベルに更新を試みます。
tryToUpdate(labelId: string): OfficeExtension.ClientResult<Excel.SensitivityLabelUpdateResult>;
パラメーター
- labelId
-
string
適用するラベルの ID。
返品
SensitivityLabelUpdateResult オブジェクト。