Excel.NamedSheetViewCollection class

パッケージ:

excel

ワークシート内のシート ビューのコレクションを表します。

Extends

OfficeExtension.ClientObject

注釈

[ API セット: ExcelApiOnline 1.1 ]

プロパティ

context	オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
items	このコレクション内に読み込まれた子アイテムを取得します。

メソッド

add(name)	指定した名前の新しいシート ビューを作成します。
enterTemporary()	新しい一時シート ビューを作成してアクティブにします。 一時ビューは、アプリケーションを閉じたり、exit メソッドを使用して一時ビューを終了したり、別のシート ビューに切り替えたりするときに削除されます。 一時ビューが存在する場合は、空の文字列 ("") を使用して一時シート ビューにアクセスすることもできます。
exit()	現在アクティブなシート ビューを終了します。
getActive()	ワークシートの現在アクティブなシート ビューを取得します。
getCount()	このワークシートのシート ビューの数を取得します。 一時シート ビューが存在する場合は含まれます。
getItem(key)	名前を使用してシート ビューを取得します。
getItemAt(index)	コレクション内のインデックスによってシート ビューを取得します。
getItemOrNullObject(key)	名前を使用してシート ビューを取得します。 シート ビュー オブジェクトが存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
toJSON()	API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.NamedSheetViewCollection オブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.NamedSheetViewCollectionDataとして型指定) を返します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

items

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

readonly items: Excel.NamedSheetView[];

プロパティ値

Excel.NamedSheetView[]

メソッドの詳細

add(name)

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

add(name: string): Excel.NamedSheetView;

パラメーター

name

string

作成するシート ビューの名前。 指定された名前が既に存在するか、空であるか、ワークシートによって予約されている名前である場合にエラーをスローします。

戻り値

Excel.NamedSheetView

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

注釈

[ API セット: ExcelApiOnline 1.1 ]

enterTemporary()

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

enterTemporary(): Excel.NamedSheetView;

戻り値

Excel.NamedSheetView

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

注釈

[ API セット: ExcelApiOnline 1.1 ]

exit()

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

exit(): void;

戻り値

void

注釈

[ API セット: ExcelApiOnline 1.1 ]

getActive()

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

getActive(): Excel.NamedSheetView;

戻り値

Excel.NamedSheetView

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

注釈

[ API セット: ExcelApiOnline 1.1 ]

getCount()

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

getCount(): OfficeExtension.ClientResult<number>;

戻り値

OfficeExtension.ClientResult<number>

注釈

[ API セット: ExcelApiOnline 1.1 ]

getItem(key)

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

getItem(key: string): Excel.NamedSheetView;

パラメーター

key

string

シート ビューの大文字と小文字を区別する名前。 一時ビューが存在する場合は、空の文字列 ("") を使用して一時シート ビューを取得します。

戻り値

Excel.NamedSheetView

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

注釈

[ API セット: ExcelApiOnline 1.1 ]

getItemAt(index)

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

getItemAt(index: number): Excel.NamedSheetView;

パラメーター

index

number

コレクション内のシート ビュー オブジェクトのインデックス。

戻り値

Excel.NamedSheetView

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

注釈

[ API セット: ExcelApiOnline 1.1 ]

getItemOrNullObject(key)

注意

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

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

getItemOrNullObject(key: string): Excel.NamedSheetView;

パラメーター

key

string

シート ビューの大文字と小文字を区別する名前。 一時ビューが存在する場合は、空の文字列 ("") を使用して一時シート ビューを取得します。

戻り値

Excel.NamedSheetView

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

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

load(options)

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

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

パラメーター

options

Excel.Interfaces.NamedSheetViewCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

戻り値

Excel.NamedSheetViewCollection

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

Excel.NamedSheetViewCollection

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

OfficeExtension.LoadOption

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

戻り値

Excel.NamedSheetViewCollection

toJSON()

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

toJSON(): Excel.Interfaces.NamedSheetViewCollectionData;

戻り値

Excel.Interfaces.NamedSheetViewCollectionData