Excel.NamedSheetView class

パッケージ:

excel

ワークシートの名前付きシート ビューを表します。 シート ビューには、特定のワークシートの並べ替えルールとフィルター規則が格納されます。 すべてのシート ビュー (一時的なシート ビューも含む) には、ビューへのアクセスに使用されるワークシートを対象とする一意の名前があります。

Extends

OfficeExtension.ClientObject

注釈

API セット: ExcelApiOnline 1.1

使用元

• Excel.NamedSheetViewCollection: add, enterTemporary, getActive, getItem, getItemAt, getItemOrNullObject, items

プロパティ

context	オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
name	シート ビューの名前を指定します。 一時的なシート ビュー名は空の文字列 ("") です。 name プロパティを使用してビューに名前を付けると、シート ビューが保存されます。

メソッド

activate()	このシート ビューをアクティブにします。 これは、Excel UI で "切り替え先" を使用するのと同じです。
delete()	ワークシートからシート ビューを削除します。
duplicate(name)	このシート ビューのコピーを作成します。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
toJSON()	API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.NamedSheetView オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.NamedSheetViewData と型指定) を返します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

name

シート ビューの名前を指定します。 一時的なシート ビュー名は空の文字列 ("") です。 name プロパティを使用してビューに名前を付けると、シート ビューが保存されます。

name: string;

プロパティ値

string

注釈

API セット: ExcelApiOnline 1.1

メソッドの詳細

activate()

このシート ビューをアクティブにします。 これは、Excel UI で "切り替え先" を使用するのと同じです。

activate(): void;

返品

void

注釈

API セット: ExcelApiOnline 1.1

delete()

ワークシートからシート ビューを削除します。

delete(): void;

返品

void

注釈

API セット: ExcelApiOnline 1.1

duplicate(name)

このシート ビューのコピーを作成します。

duplicate(name?: string): Excel.NamedSheetView;

パラメーター

name

string

複製されたシート ビューの名前。 名前を指定しない場合は、名前が生成されます。

返品

Excel.NamedSheetView

複製された新しいシート ビュー。

注釈

API セット: ExcelApiOnline 1.1

load(options)

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

load(options?: Excel.Interfaces.NamedSheetViewLoadOptions): Excel.NamedSheetView;

パラメーター

options

Excel.Interfaces.NamedSheetViewLoadOptions

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

返品

Excel.NamedSheetView

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

返品

Excel.NamedSheetView

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

返品

Excel.NamedSheetView

toJSON()

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

toJSON(): Excel.Interfaces.NamedSheetViewData;

返品

Excel.Interfaces.NamedSheetViewData