Excel.PivotTableStyleCollection class
ピボットテーブル スタイルのコレクションを表します。
- Extends
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| add(name, make |
指定した名前で空白の |
| get |
コレクションに含まれる PivotTableStyle の数を取得します。 |
| get |
親オブジェクトのスコープの既定のピボットテーブル スタイルを取得します。 |
| get |
名前で |
| get |
名前で |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set |
親オブジェクトのスコープで使用する既定のピボットテーブル スタイルを設定します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
items
このコレクション内に読み込まれた子アイテムを取得します。
readonly items: Excel.PivotTableStyle[];プロパティ値
メソッドの詳細
add(name, makeUniqueName)
指定した名前で空白の PivotTableStyle を作成します。
add(name: string, makeUniqueName?: boolean): Excel.PivotTableStyle;パラメーター
- name
-
string
新しいピボットテーブル スタイルの一意の名前。 名前が既に使用されている場合は、 InvalidArgument エラーがスローされます。
- makeUniqueName
-
boolean
省略可能。 既定値は false です。
true
の場合、必要に応じて一意にするために名前に番号を追加します。
返品
新しく作成された PivotTableStyle。
注釈
getCount()
コレクションに含まれる PivotTableStyle の数を取得します。
getCount(): OfficeExtension.ClientResult<number>;返品
OfficeExtension.ClientResult<number>
注釈
getDefault()
親オブジェクトのスコープの既定のピボットテーブル スタイルを取得します。
getDefault(): Excel.PivotTableStyle;返品
現在の既定のピボットテーブル スタイルである PivotTableStyle オブジェクト。
注釈
getItem(name)
名前で PivotTableStyle を取得します。
getItem(name: string): Excel.PivotTableStyle;パラメーター
- name
-
string
取得するピボットテーブル スタイルの名前。
返品
名前が入力と一致する PivotTableStyle オブジェクト。
注釈
getItemOrNullObject(name)
名前で PivotTableStyle を取得します。
PivotTableStyleが存在しない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。
getItemOrNullObject(name: string): Excel.PivotTableStyle;パラメーター
- name
-
string
取得するピボットテーブル スタイルの名前。
返品
名前が入力と一致する PivotTableStyle オブジェクト。
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.PivotTableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableStyleCollection;パラメーター
- options
-
Excel.Interfaces.PivotTableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.PivotTableStyleCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotTableStyleCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
setDefault(newDefaultStyle)
親オブジェクトのスコープで使用する既定のピボットテーブル スタイルを設定します。
setDefault(newDefaultStyle: PivotTableStyle | string): void;パラメーター
- newDefaultStyle
-
Excel.PivotTableStyle | string
新しい既定値にする必要がある PivotTableStyle オブジェクト、または PivotTableStyle オブジェクトの名前。
返品
void
注釈
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.PivotTableStyleCollection オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.PivotTableStyleCollectionData として型指定された) を返します。
toJSON(): Excel.Interfaces.PivotTableStyleCollectionData;