Excel.SensitivityLabelDetails class

パッケージ:
excel

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

Excel で使用可能な秘密度ラベルのプロパティを表します。

Extends
OfficeExtension.ClientObject

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

使用元

プロパティ

children

秘密度ラベルのサブラベルを取得します。 ラベルにサブラベルがない場合に null を返します。
color

秘密度ラベルの色を取得します。
context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
id

秘密度ラベルの一意識別子 (GUID) を取得します。
isEnabled

ラベルが有効かどうかを示す値を取得します。
name

秘密度ラベルの名前を取得します。
order

秘密度ラベルの優先度を取得し、最も低い優先度は 0 です。
protectionType

このラベルによって提供される保護の種類を示す値を取得します。
siteId

秘密度ラベルが属するテナントの一意識別子 (GUID) を取得します。
tooltip

秘密度ラベルの説明を取得します。

メソッド

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
toJSON()

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.SensitivityLabelDetails オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.SensitivityLabelDetailsData と型指定) を返します。

プロパティの詳細

children

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

秘密度ラベルのサブラベルを取得します。 ラベルにサブラベルがない場合に null を返します。

readonly children: SensitivityLabelDetailsCollection | null;

プロパティ値

Excel.SensitivityLabelDetailsCollection | null

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

color

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

秘密度ラベルの色を取得します。

readonly color: string;

プロパティ値

string

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

context

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

Excel.RequestContext

id

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

秘密度ラベルの一意識別子 (GUID) を取得します。

readonly id: string;

プロパティ値

string

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

isEnabled

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

ラベルが有効かどうかを示す値を取得します。

readonly isEnabled: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

name

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

秘密度ラベルの名前を取得します。

readonly name: string;

プロパティ値

string

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

order

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

秘密度ラベルの優先度を取得し、最も低い優先度は 0 です。

readonly order: number;

プロパティ値

number

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

protectionType

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

このラベルによって提供される保護の種類を示す値を取得します。

readonly protectionType: Excel.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";

プロパティ値

Excel.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined"

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

siteId

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

秘密度ラベルが属するテナントの一意識別子 (GUID) を取得します。

readonly siteId: string;

プロパティ値

string

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

tooltip

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

秘密度ラベルの説明を取得します。

readonly tooltip: string;

プロパティ値

string

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

メソッドの詳細

load(options)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.SensitivityLabelDetailsLoadOptions): Excel.SensitivityLabelDetails;

パラメーター

options
Excel.Interfaces.SensitivityLabelDetailsLoadOptions

読み込むオブジェクトのプロパティのオプションを指定します。

返品

Excel.SensitivityLabelDetails

load(propertyNames)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Excel.SensitivityLabelDetails;

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。

返品

Excel.SensitivityLabelDetails

load(propertyNamesAndPaths)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.SensitivityLabelDetails;

パラメーター

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。

返品

Excel.SensitivityLabelDetails

toJSON()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.SensitivityLabelDetails オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.SensitivityLabelDetailsData と型指定) を返します。

toJSON(): Excel.Interfaces.SensitivityLabelDetailsData;

返品

Excel.Interfaces.SensitivityLabelDetailsData