Excel.NamedSheetView class
ワークシートの名前付きシート ビューを表します。 シート ビューには、特定のワークシートの並べ替えルールとフィルター規則が格納されます。 すべてのシート ビュー (一時シート ビュー) には、ビューへのアクセスに使用される一意のワークシートスコープの名前があります。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| name | シート ビューの名前を指定します。 一時シート ビュー名は空の文字列 ("") です。 name プロパティを使用してビューに名前を付けると、シート ビューが保存されます。 |
メソッド
| activate() | このシート ビューをアクティブにします。 これは、Excel UI で "切り替え" を使用する場合と同じです。 |
| delete() | ワークシートからシート ビューを削除します。 |
| duplicate(name) | このシート ビューのコピーを作成します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
name
シート ビューの名前を指定します。 一時シート ビュー名は空の文字列 ("") です。 name プロパティを使用してビューに名前を付けると、シート ビューが保存されます。
name: string;プロパティ値
string
注釈
メソッドの詳細
activate()
このシート ビューをアクティブにします。 これは、Excel UI で "切り替え" を使用する場合と同じです。
activate(): void;戻り値
void
注釈
delete()
duplicate(name)
このシート ビューのコピーを作成します。
duplicate(name?: string): Excel.NamedSheetView;パラメーター
- name
-
string
複製されたシート ビューの名前。 名前が指定されていない場合は、名前が生成されます。
戻り値
複製された新しいシート ビュー。
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.NamedSheetViewLoadOptions): Excel.NamedSheetView;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.NamedSheetView;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.NamedSheetView;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.NamedSheetView オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.NamedSheetViewData として型指定) を返します。
toJSON(): Excel.Interfaces.NamedSheetViewData;