Excel.Interfaces.TableScopedCollectionLoadOptions interface

スコープ付きのテーブルのコレクションを表します。 各テーブルでは、テーブルの左上隅がアンカーの位置とみなされ、テーブルは上から下、次に左から右に並べ替えられます。

プロパティ

$all

読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.address など) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。

altTextDescription

For each ITEM in the collection: アクセシビリティのための代替テキストを指定します。

altTextTitle

For each ITEM in the collection: スクリーン リーダーで使用されるものなど、テーブルの概要を指定します。

autoFilter

For each ITEM in the collection: テーブルの AutoFilter オブジェクトを表します。

columns

For each ITEM in the collection: テーブルのすべての列のコレクションを表します。

comment

For each ITEM in the collection: テーブルに関連付けられているコメントを指定します。

highlightFirstColumn

For each ITEM in the collection: 最初の列に特別な書式が含まれるかどうかを指定します。

highlightLastColumn

For each ITEM in the collection: 最後の列に特別な書式が設定されているかどうかを指定します。

id

For each ITEM in the collection: 指定したブック内のテーブルを一意に識別する型の値を返します。 識別子の値は、テーブルの名前が変更された場合も変わりません。

isActive

For each ITEM in the collection: テーブルが現在アクティブかどうかを取得します。

legacyId

For each ITEM in the collection: 数値 ID を返します。

name

コレクション内の各アイテムの場合: テーブルの名前。

テーブルのセット名は、「 Excel テーブルの名前を変更する」 の記事で指定されているガイドラインに従う必要があります。

rows

For each ITEM in the collection: テーブル内のすべての行のコレクションを表します。

showBandedColumns

コレクション内の各アイテムの場合: テーブルを読みやすくするために、奇数列と偶数列が異なる方法で強調表示される縞模様の書式設定を列に表示するかどうかを指定します。

showBandedRows

For each ITEM in the collection: 表を読みやすくするために、行に奇数行と偶数行を異なる方法で強調表示する縞模様の書式を表示するかどうかを指定します。

showFilterButton

For each ITEM in the collection: 各列ヘッダーの上部にフィルター ボタンを表示するかどうかを指定します。 これは、テーブルにヘッダー行が含まれている場合のみ設定できます。

showHeaders

For each ITEM in the collection: ヘッダー行を表示するかどうかを指定します。 この値によって、ヘッダー行の表示または削除を設定できます。

showTotals

For each ITEM in the collection: 行の合計を表示するかどうかを指定します。 この値によって、集計行の表示または削除を設定できます。

sort

For each ITEM in the collection: テーブルの並べ替えを表します。

source

For each ITEM in the collection: テーブルの元となるデータ ソースの型を取得します。

style

For each ITEM in the collection: テーブル スタイルを表す定数値。 指定可能な値は、"TableStyleLight1" から "TableStyleLight21"、"TableStyleMedium1" から "TableStyleMedium28"、"TableStyleDark1" から "TableStyleDark11" です。 ブックに存在するカスタムのユーザー定義スタイルも指定できます。

tableStyle

For each ITEM in the collection: テーブルに適用されているスタイル。

worksheet

コレクション内の各アイテムの場合: 現在のテーブルを含むワークシート。

プロパティの詳細

$all

読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.address など) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。

$all?: boolean;

プロパティ値

boolean

altTextDescription

注意

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

For each ITEM in the collection: アクセシビリティのための代替テキストを指定します。

altTextDescription?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

altTextTitle

注意

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

For each ITEM in the collection: スクリーン リーダーで使用されるものなど、テーブルの概要を指定します。

altTextTitle?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

autoFilter

For each ITEM in the collection: テーブルの AutoFilter オブジェクトを表します。

autoFilter?: Excel.Interfaces.AutoFilterLoadOptions;

プロパティ値

注釈

API セット: ExcelApi 1.9

columns

For each ITEM in the collection: テーブルのすべての列のコレクションを表します。

columns?: Excel.Interfaces.TableColumnCollectionLoadOptions;

プロパティ値

注釈

API セット: ExcelApi 1.9

comment

注意

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

For each ITEM in the collection: テーブルに関連付けられているコメントを指定します。

comment?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

highlightFirstColumn

For each ITEM in the collection: 最初の列に特別な書式が含まれるかどうかを指定します。

highlightFirstColumn?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.3

highlightLastColumn

For each ITEM in the collection: 最後の列に特別な書式が設定されているかどうかを指定します。

highlightLastColumn?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.3

id

For each ITEM in the collection: 指定したブック内のテーブルを一意に識別する型の値を返します。 識別子の値は、テーブルの名前が変更された場合も変わりません。

id?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1

isActive

注意

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

For each ITEM in the collection: テーブルが現在アクティブかどうかを取得します。

isActive?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

legacyId

For each ITEM in the collection: 数値 ID を返します。

legacyId?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.8

name

コレクション内の各アイテムの場合: テーブルの名前。

テーブルのセット名は、「 Excel テーブルの名前を変更する」 の記事で指定されているガイドラインに従う必要があります。

name?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1

rows

For each ITEM in the collection: テーブル内のすべての行のコレクションを表します。

rows?: Excel.Interfaces.TableRowCollectionLoadOptions;

プロパティ値

注釈

API セット: ExcelApi 1.9

showBandedColumns

コレクション内の各アイテムの場合: テーブルを読みやすくするために、奇数列と偶数列が異なる方法で強調表示される縞模様の書式設定を列に表示するかどうかを指定します。

showBandedColumns?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.3

showBandedRows

For each ITEM in the collection: 表を読みやすくするために、行に奇数行と偶数行を異なる方法で強調表示する縞模様の書式を表示するかどうかを指定します。

showBandedRows?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.3

showFilterButton

For each ITEM in the collection: 各列ヘッダーの上部にフィルター ボタンを表示するかどうかを指定します。 これは、テーブルにヘッダー行が含まれている場合のみ設定できます。

showFilterButton?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.3

showHeaders

For each ITEM in the collection: ヘッダー行を表示するかどうかを指定します。 この値によって、ヘッダー行の表示または削除を設定できます。

showHeaders?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1

showTotals

For each ITEM in the collection: 行の合計を表示するかどうかを指定します。 この値によって、集計行の表示または削除を設定できます。

showTotals?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1

sort

For each ITEM in the collection: テーブルの並べ替えを表します。

sort?: Excel.Interfaces.TableSortLoadOptions;

プロパティ値

注釈

API セット: ExcelApi 1.9

source

注意

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

For each ITEM in the collection: テーブルの元となるデータ ソースの型を取得します。

source?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

style

For each ITEM in the collection: テーブル スタイルを表す定数値。 指定可能な値は、"TableStyleLight1" から "TableStyleLight21"、"TableStyleMedium1" から "TableStyleMedium28"、"TableStyleDark1" から "TableStyleDark11" です。 ブックに存在するカスタムのユーザー定義スタイルも指定できます。

style?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.1

tableStyle

注意

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

For each ITEM in the collection: テーブルに適用されているスタイル。

tableStyle?: Excel.Interfaces.TableStyleLoadOptions;

プロパティ値

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

worksheet

コレクション内の各アイテムの場合: 現在のテーブルを含むワークシート。

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

プロパティ値

注釈

API セット: ExcelApi 1.9