PowerPoint.SensitivityLabelDetailsCollection class

注意

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

PowerPoint.SensitivityLabelDetails オブジェクトのコレクションを表します。

Extends

プロパティ

context

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

items

このコレクション内に読み込まれた子アイテムを取得します。

メソッド

getCount()

このコレクション内の PowerPoint.SensitivityLabelDetails オブジェクトの数を取得します。

getItem(id)

このコレクションで指定された SensitivityLabelDetails オブジェクトを取得します。 指定した ID のアイテムが見つからない場合は、 ItemNotFound エラーをスローします。

getItemAt(index)

このコレクション内の指定されたインデックスにある SensitivityLabelDetails オブジェクトを取得します。 インデックスが範囲外の場合は、 IndexOutOfRange エラーをスローします。

getItemOrNullObject(id)

このコレクションで指定された SensitivityLabelDetails オブジェクトを取得します。 指定した ID のアイテムが見つからない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

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

プロパティの詳細

context

注意

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

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

context: RequestContext;

プロパティ値

items

注意

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

このコレクション内に読み込まれた子アイテムを取得します。

readonly items: PowerPoint.SensitivityLabelDetails[];

プロパティ値

メソッドの詳細

getCount()

注意

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

このコレクション内の PowerPoint.SensitivityLabelDetails オブジェクトの数を取得します。

getCount(): OfficeExtension.ClientResult<number>;

返品

SensitivityLabelDetails オブジェクトの数。

注釈

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

getItem(id)

注意

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

このコレクションで指定された SensitivityLabelDetails オブジェクトを取得します。 指定した ID のアイテムが見つからない場合は、 ItemNotFound エラーをスローします。

getItem(id: string): PowerPoint.SensitivityLabelDetails;

パラメーター

id

string

秘密度ラベルの ID。

返品

指定された SensitivityLabelDetails オブジェクト。

注釈

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

getItemAt(index)

注意

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

このコレクション内の指定されたインデックスにある SensitivityLabelDetails オブジェクトを取得します。 インデックスが範囲外の場合は、 IndexOutOfRange エラーをスローします。

getItemAt(index: number): PowerPoint.SensitivityLabelDetails;

パラメーター

index

number

取得するアイテムのインデックス。 0 を起点とする番号になります。

返品

指定したインデックスにある SensitivityLabelDetails オブジェクト。

注釈

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

getItemOrNullObject(id)

注意

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

このコレクションで指定された SensitivityLabelDetails オブジェクトを取得します。 指定した ID のアイテムが見つからない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

getItemOrNullObject(id: string): PowerPoint.SensitivityLabelDetails;

パラメーター

id

string

秘密度ラベルの ID。

返品

指定された SensitivityLabelDetails オブジェクト。

注釈

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

load(options)

注意

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

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

load(options?: PowerPoint.Interfaces.SensitivityLabelDetailsCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SensitivityLabelDetailsCollection;

パラメーター

options

PowerPoint.Interfaces.SensitivityLabelDetailsCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

返品

load(propertyNames)

注意

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

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

load(propertyNames?: string | string[]): PowerPoint.SensitivityLabelDetailsCollection;

パラメーター

propertyNames

string | string[]

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

返品

load(propertyNamesAndPaths)

注意

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

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SensitivityLabelDetailsCollection;

パラメーター

propertyNamesAndPaths
OfficeExtension.LoadOption

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

返品

toJSON()

注意

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

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

toJSON(): PowerPoint.Interfaces.SensitivityLabelDetailsCollectionData;

返品