ig.excel.WorksheetTableCollection

Worksheet の WorksheetTable インスタンスのコレクション。

依存関係

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
このコントロールにオプションはありません。
このコントロールにイベントはありません。

  • add

    .add( region:string, tableHasHeaders:boolean, [tableStyle:ig.excel.WorksheetTableStyle] );
    返却型:
    ig.excel.WorksheetTable
    返却型の説明:
    作成された WorksheetTable は、この領域の書式設定付きテーブルを表します。

    特定の領域をテーブルとして書式設定し、関連する WorksheetTable をこのコレクションに追加します。

    • region
    • タイプ:string
    • テーブルとして書式設定する領域。
    • tableHasHeaders
    • タイプ:boolean
    • この領域の一番上の行にテーブルのヘッダーが含まれているかどうかを示す値です。
    • tableStyle
    • タイプ:ig.excel.WorksheetTableStyle
    • オプション
    • このテーブルに適用する WorksheetTableStyle、または Workbook.defaultTableStyle を使用する場合は null 値になります。

    例外

    例外 説明
    ig.InvalidOperationException 親ワークシートは子ワークブックから削除されています。
    ig.InvalidOperationException 親ワークシートは子ワークブックから削除されています。
    ig.InvalidOperationException 親ワークシートは子ワークブックから削除されています。
    ig.InvalidOperationException 親ワークシートは子ワークブックから削除されています。
    ig.ArgumentNullException 領域は null または空です。
    ig.ArgumentException region はワークブックのセル参照モードで無効な領域アドレスです。
    ig.ArgumentException region はワークブックのセル参照モードで無効な領域アドレスです。

    備考

    このテーブルを作成すると、指定した tableStyle は の値に適用されます。

    tableHasHeaders が True である場合、このテーブルを作成すると、列名はヘッダー行のセルから取り込まれます。False の場合、列名が生成されてヘッダー行のセルがワークシートに挿入されます。

    列の名前は、親 WorksheetTable 内における一意の名前です。テーブルの作成時に同名の列が 2 つ以上存在する場合、各列を一意に識別できるように 2 番目以降の重複列名の末尾に番号が振られていきます。ヘッダー行のセルのなかに文字列以外の値を持つものがある場合、その値は文字列 (そのセルの現在の表示テキスト) に変換されます。ヘッダー行のセルに値を持たないものがある場合、それらのセルには生成された列名が与えられます。

    この領域に収めきれない結合セル領域がある場合、そうしたセル領域はワークシートから除外され、結合領域のセルがすべて収まるようにテーブル領域が拡張されます。

    関連項目

  • clear

    .clear( );

    このコレクションを消去し、ワークシートからテーブルをすべて削除します。

  • contains

    .contains( table:ig.excel.WorksheetTable );
    返却型:
    boolean
    返却型の説明:
    この WorksheetTable がコレクションに含まれている場合は True、そうでない場合は False。

    指定した WorksheetTable がこのコレクションに含まれているかどうかを調べます。

    • table
    • タイプ:ig.excel.WorksheetTable
    • コレクションに含まれているかどうかを調べたい WorksheetTable。

  • count

    .count( );
    返却型:
    number
    返却型の説明:
    このコレクションにあるテーブルの数。

    このコレクションにあるテーブルの数を取得します。

  • exists

    .exists( name:string );
    返却型:
    boolean
    返却型の説明:
    指定した名前の WorksheetTable があった場合は True、なかった場合は False。

    指定した名前の WorksheetTable がコレクションに含まれているかどうかを調べます。

    • name
    • タイプ:string
    • 調べたい WorksheetTable の名前。

    備考

    テーブル名は大文字と小文字を区別せずに比較されます。

  • indexOf

    .indexOf( table:ig.excel.WorksheetTable );
    返却型:
    number
    返却型の説明:
    コレクション内における指定した WorksheetTable のインデックス (ゼロを基準とした数値) が返されます。指定した WorksheetTable がこのコレクションに含まれていない場合は -1 が返されます。

    コレクション内の指定した WorksheetTable のインデックスを取得します。

    • table
    • タイプ:ig.excel.WorksheetTable
    • コレクションに含まれているかどうかを調べたい WorksheetTable。

  • item

    .item( index:number );
    返却型:
    ig.excel.WorksheetTable
    返却型の説明:
    指定したインデックスにある WorksheetTable。

    指定したインデックスにある WorksheetTable を取得します。

    • index
    • タイプ:number
    • 取得したい WorksheetTable のインデックス (ゼロを基準とした数値)。

    例外

    例外 説明
    ig.ArgumentOutOfRangeException インデックスは 0 未満であるか、または、インデックスが WorksheetTableCollection.count 以上です。

  • item

    .item( name:string );
    返却型:
    ig.excel.WorksheetTable
    返却型の説明:
    指定したインデックスにある WorksheetTable。

    指定したインデックスにある WorksheetTable を取得します。

    • name
    • タイプ:string
    • 取得したい WorksheetTable の名前。

    例外

    例外 説明
    ig.InvalidOperationException 指定した名前の WorksheetTable はコレクションに存在しません。

    備考

    ワークシート名は大文字と小文字を区別せずに比較されます。

    関連項目

  • remove

    .remove( table:ig.excel.WorksheetTable, [convertToRange:boolean] );
    返却型:
    boolean
    返却型の説明:
    指定した WorksheetTable が見つかって削除された場合は True、そうでない場合は False。

    WorksheetTable をコレクションから削除します。

    • table
    • タイプ:ig.excel.WorksheetTable
    • コレクションから削除したい WorksheetTable。
    • convertToRange
    • タイプ:boolean
    • オプション
    • テーブル スタイルの書式設定をセルに適用するには True。

  • removeAt

    .removeAt( index:number, [convertToRange:boolean] );

    指定したインデックスにある WorksheetTable を削除します。

    • index
    • タイプ:number
    • 削除したい WorksheetTable のインデックス (ゼロを基準とした数値)。
    • convertToRange
    • タイプ:boolean
    • オプション
    • テーブル スタイルの書式設定をセルに適用するには True。

    例外

    例外 説明
    ig.ArgumentOutOfRangeException インデックスが 0 未満、または WorksheetTableCollection.count 以上の値です。

Copyright © 1996 - 2024 Infragistics, Inc. All rights reserved.