Excel.TableStyleCollection class

注意

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

TableStyles のコレクションを表します。Represents a collection of TableStyles.

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

Extends

プロパティ

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

items

このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.

メソッド

add(name, makeUniqueName)

指定された名前で空の TableStyle を作成します。Creates a blank TableStyle with the specified name.

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

getCount()

コレクションに含まれるテーブル スタイルの数を取得します。Gets the number of table styles in the collection.

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

getDefault()

親オブジェクトのスコープに対する既定の TableStyle を取得します。Gets the default TableStyle for the parent object's scope.

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

getItem(name)

名前で TableStyle を取得します。Gets a TableStyle by name.

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

getItemOrNullObject(name)

名前で TableStyle を取得します。Gets a TableStyle by name. TableStyle が存在しない場合は、null オブジェクトを返します。If the TableStyle does not exist, will return a null object.

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

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(option)
setDefault(newDefaultStyle)

親オブジェクトのスコープで使用する既定の TableStyle を設定します。Sets the default TableStyle for use in the parent object's scope.

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

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元Excel.TableStyleCollectionのオブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.TableStyleCollectionData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.TableStyleCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.TableStyleCollectionData) を使用して、コレクションのアイテムから読み込まれたプロパティの浅いコピーを持つ "items" 配列を含みます。) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

プロパティの詳細

context

注意

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

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

items

注意

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

このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.

readonly items: Excel.TableStyle[];

プロパティ値

Excel.TableStyle[]

メソッドの詳細

add(name, makeUniqueName)

注意

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

指定された名前で空の TableStyle を作成します。Creates a blank TableStyle with the specified name.

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

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

パラメーター

name
string

新しい TableStyle の一意の名前。The unique name for the new TableStyle. 名前が既に使用されている場合は、無効な引数の例外がスローされます。Will throw an invalid argument exception if the name is already in use.

makeUniqueName
boolean

省略可能。既定値は false です。Optional, defaults to false. 場合は true を指定すると、必要に応じて、一意の番号を付けることができます。If true, will append numbers to the name in order to make it unique, if needed.

戻り値

新しく作成された TableStyle。The newly created TableStyle.

getCount()

注意

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

コレクションに含まれるテーブル スタイルの数を取得します。Gets the number of table styles in the collection.

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

getCount(): OfficeExtension.ClientResult<number>;

戻り値

OfficeExtension.ClientResult<number>

getDefault()

注意

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

親オブジェクトのスコープに対する既定の TableStyle を取得します。Gets the default TableStyle for the parent object's scope.

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

getDefault(): Excel.TableStyle;

戻り値

現在の既定の TableStyle である TableStyle オブジェクト。The TableStyle object that is the current default TableStyle.

getItem(name)

注意

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

名前で TableStyle を取得します。Gets a TableStyle by name.

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

getItem(name: string): Excel.TableStyle;

パラメーター

name
string

取得する TableStyle の名前。Name of the TableStyle to be retrieved.

戻り値

入力に一致する名前を持つ TableStyle オブジェクト。The TableStyle object whose name matches the input.

getItemOrNullObject(name)

注意

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

名前で TableStyle を取得します。Gets a TableStyle by name. TableStyle が存在しない場合は、null オブジェクトを返します。If the TableStyle does not exist, will return a null object.

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

getItemOrNullObject(name: string): Excel.TableStyle;

パラメーター

name
string

取得する TableStyle の名前。Name of the TableStyle to be retrieved.

戻り値

入力に一致する名前を持つ TableStyle オブジェクト。The TableStyle object whose name matches the input.

load(option)

注意

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

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

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

パラメーター

option
Excel.Interfaces.TableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.TableStyleCollection-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.TableStyleCollection - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.TableStyleCollection-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.TableStyleCollection - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TableStyleCollection-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.TableStyleCollection - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

注意

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

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

load(option)

注意

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

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

パラメーター

戻り値

setDefault(newDefaultStyle)

注意

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

親オブジェクトのスコープで使用する既定の TableStyle を設定します。Sets the default TableStyle for use in the parent object's scope.

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

setDefault(newDefaultStyle: TableStyle | string): void;

パラメーター

newDefaultStyle
TableStyle | string

新しい既定値にする必要がある、TableStyle オブジェクトの TableStyle オブジェクトまたは名前。The TableStyle object or name of the TableStyle object that should be the new default.

戻り値

void

toJSON()

注意

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

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元Excel.TableStyleCollectionのオブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.TableStyleCollectionData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.TableStyleCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.TableStyleCollectionData) を使用して、コレクションのアイテムから読み込まれたプロパティの浅いコピーを持つ "items" 配列を含みます。) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Excel.Interfaces.TableStyleCollectionData;

戻り値