Excel.TableStyleCollection class

パッケージ:

excel

テーブル スタイルのコレクションを表します。

Extends

OfficeExtension.ClientObject

注釈

[ API セット: ExcelApi 1.10 ]

プロパティ

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

メソッド

add(name, makeUniqueName)	指定した名前の空白の TableStyle を作成します。
getCount()	コレクションに含まれるテーブル スタイルの数を取得します。
getDefault()	親オブジェクトのスコープの既定のテーブル スタイルを取得します。
getItem(name)	名前で TableStyle を取得します。
getItemOrNullObject(name)	名前で TableStyle を取得します。 テーブル スタイルが存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
setDefault(newDefaultStyle)	親オブジェクトのスコープで使用する既定のテーブル スタイルを設定します。
toJSON()	API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.TableStyleCollection オブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.TableStyleCollectionDataとして型指定) を返します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

items

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

readonly items: Excel.TableStyle[];

プロパティ値

Excel.TableStyle[]

メソッドの詳細

add(name, makeUniqueName)

指定した名前の空白の TableStyle を作成します。

add(name: string, makeUniqueName?: boolean): Excel.TableStyle;

パラメーター

name

string

新しいテーブル スタイルの一意の名前。 名前が既に使用されている場合は、 InvalidArgument エラーをスローします。

makeUniqueName

boolean

省略可能。 既定値は false です。 true 場合は、必要に応じて一意にするために、名前に番号を追加します。

戻り値

Excel.TableStyle

新しく作成された TableStyle。

注釈

[ API セット: ExcelApi 1.10 ]

getCount()

コレクションに含まれるテーブル スタイルの数を取得します。

getCount(): OfficeExtension.ClientResult<number>;

戻り値

OfficeExtension.ClientResult<number>

注釈

[ API セット: ExcelApi 1.10 ]

getDefault()

親オブジェクトのスコープの既定のテーブル スタイルを取得します。

getDefault(): Excel.TableStyle;

戻り値

Excel.TableStyle

現在の既定のテーブル スタイルである TableStyle オブジェクト。

注釈

[ API セット: ExcelApi 1.10 ]

getItem(name)

名前で TableStyle を取得します。

getItem(name: string): Excel.TableStyle;

パラメーター

name

string

取得するテーブル スタイルの名前。

戻り値

Excel.TableStyle

名前が入力と一致する TableStyle オブジェクト。

注釈

[ API セット: ExcelApi 1.10 ]

getItemOrNullObject(name)

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

getItemOrNullObject(name: string): Excel.TableStyle;

パラメーター

name

string

取得するテーブル スタイルの名前。

戻り値

Excel.TableStyle

名前が入力と一致する TableStyle オブジェクト。

注釈

[ API セット: ExcelApi 1.10 ]

load(options)

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

load(options?: Excel.Interfaces.TableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableStyleCollection;

パラメーター

options

Excel.Interfaces.TableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

戻り値

Excel.TableStyleCollection

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

Excel.TableStyleCollection

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

OfficeExtension.LoadOption

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

戻り値

Excel.TableStyleCollection

setDefault(newDefaultStyle)

親オブジェクトのスコープで使用する既定のテーブル スタイルを設定します。

setDefault(newDefaultStyle: TableStyle | string): void;

パラメーター

newDefaultStyle

Excel.TableStyle | string

TableStyle オブジェクト(TableStyle オブジェクトの名前)は、新しい既定値にする必要があります。

戻り値

void

注釈

[ API セット: ExcelApi 1.10 ]

toJSON()

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

toJSON(): Excel.Interfaces.TableStyleCollectionData;

戻り値

Excel.Interfaces.TableStyleCollectionData