Excel.NamedSheetViewCollection class

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

context: RequestContext;

プロパティ値

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

readonly items: Excel.NamedSheetView[];

プロパティ値

指定した名前で新しいシート ビューを作成します。

add(name: string): Excel.NamedSheetView;

パラメーター

返品

新しく作成されたシート ビュー オブジェクト。

注釈

API セット: ExcelApiOnline 1.1

新しい一時シート ビューを作成してアクティブ化します。 一時ビューは、アプリケーションを閉じるとき、終了方法で一時ビューを終了するとき、または別のシート ビューに切り替えると削除されます。 一時ビューが存在する場合は、空の文字列 ("") を使用して一時シート ビューにアクセスすることもできます。

enterTemporary(): Excel.NamedSheetView;

返品

新しく作成されたシート ビュー オブジェクト。

注釈

API セット: ExcelApiOnline 1.1

現在アクティブなシート ビューを終了します。

exit(): void;

返品

注釈

API セット: ExcelApiOnline 1.1

ワークシートの現在アクティブなシート ビューを取得します。

getActive(): Excel.NamedSheetView;

返品

このワークシートの現在アクティブなシート ビュー。

注釈

API セット: ExcelApiOnline 1.1

このワークシート内のシート ビュー数を取得します。 一時シート ビューが存在する場合はそれを含めます。

getCount(): OfficeExtension.ClientResult<number>;

返品

注釈

API セット: ExcelApiOnline 1.1

名前を使用してシート ビューを取得します。

getItem(key: string): Excel.NamedSheetView;

パラメーター

返品

指定した名前のシート ビュー、または空の文字列が指定された場合は一時ビュー。 現在の一時ビューがなく、空の文字列が指定された場合は、 ItemNotFound エラーがスローされます。

注釈

API セット: ExcelApiOnline 1.1

コレクション内のインデックスによってシート ビューを取得します。

getItemAt(index: number): Excel.NamedSheetView;

パラメーター

返品

指定されたインデックスのシート ビュー。

注釈

API セット: ExcelApiOnline 1.1

名前を使用してシート ビューを取得します。 シート ビュー オブジェクトが存在しない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

getItemOrNullObject(key: string): Excel.NamedSheetView;

パラメーター

返品

指定した名前のシート ビュー、または空の文字列が指定された場合は一時ビュー。

注釈

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

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

load(options?: Excel.Interfaces.NamedSheetViewCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NamedSheetViewCollection;

パラメーター

返品

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

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

パラメーター

返品

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.NamedSheetViewCollection;

パラメーター

返品

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

toJSON(): Excel.Interfaces.NamedSheetViewCollectionData;

返品