ig.excel.WorksheetRegion
依存関係
-
ig.excel.WorksheetRegion
コンストラクター- new $.ig.excel.WorksheetRegion( worksheet:ig.excel.Worksheet, firstRow:number, firstColumn:number, lastRow:number, lastColumn:number );
WorksheetRegion クラスの新しいインスタンスを初期化します。
- worksheet
- タイプ:ig.excel.Worksheet
- 領域が置かれるワークシート。
- firstRow
- タイプ:number
- 領域の最初の行のインデックス。
- firstColumn
- タイプ:number
- 領域の最初の列のインデックス。
- lastRow
- タイプ:number
- 領域の最後の行のインデックス。
- lastColumn
- タイプ:number
- 領域の最後の列のインデックス。
例外
例外 説明 ig.ArgumentNullException ワークシートは null です。 ig.InvalidOperationException firstRow が lastRow より大きいか、firstColumn が lastColumn より大きいです。 ig.ArgumentOutOfRangeException 指定された行または列インデックスは、有効な行または列領域の外にあります。 -
applyArrayFormula
- .applyArrayFormula( value:string );
配列数式をセルの領域に適用します。
- value
- タイプ:string
- 解析および領域に適用するための配列数式。
例外
例外 説明 ig.ArgumentNullException 値は null または空です。 ig.excel.FormulaParseException 値は有効な数式ではありません。 ig.InvalidOperationException この領域は、配列数式または領域の外に広がるデータ テーブルを含みます。 備考
値は、領域が属する Workbook の CellReferenceMode に基づいて解析されます。領域の WorksheetRegion.worksheet が親コレクションから削除された場合、A1 CellReferenceMode は数式を解析するために使用されます。
-
applyFormula
- .applyFormula( value:string );
数式をセルの領域に適用します。
- value
- タイプ:string
- 解析および領域に適用するための数式。
例外
例外 説明 ig.ArgumentNullException 値は null または空です。 ig.excel.FormulaParseException 値は有効な数式ではありません。 ig.InvalidOperationException この領域は、配列数式または領域の外に広がるデータ テーブルを含みます。 備考
値は、領域が属する Workbook の CellReferenceMode に基づいて解析されます。領域の WorksheetRegion.worksheet が親コレクションから削除された場合、A1 CellReferenceMode は数式を解析するために使用されます。
関連項目
-
equals
- .equals( obj:object );
指定した値がこの WorksheetRegion 値と等しいであるかどうかを決定します。
- obj
- タイプ:object
- 等価をテストするための値。
-
firstColumn
- .firstColumn( );
- 返却型:
- number
- 返却型の説明:
- 領域の最初の列のインデックス。
領域の最初の列のインデックスを取得します。
-
firstRow
- .firstRow( );
- 返却型:
- number
- 返却型の説明:
- 領域の最初の行のインデックス。
領域の最初の行のインデックスを取得します。
-
formatAsTable
- .formatAsTable( tableHasHeaders:boolean );
- 返却型:
- ig.excel.WorksheetTable
- 返却型の説明:
- 作成された WorksheetTable は、この領域の書式設定付きテーブルを表します。
領域をテーブルとして書式設定し、関連付けられた WorksheetTable を Worksheet.tables コレクションに追加します。
- tableHasHeaders
- タイプ:boolean
- この領域の一番上の行にテーブルのヘッダーが含まれているかどうかを示す値です。
例外
例外 説明 ig.InvalidOperationException この領域には、別の WorksheetTable のセルが 1 つ以上含まれています。 ig.InvalidOperationException この領域には、別の WorksheetTable のセルが 1 つ以上含まれています。 ig.InvalidOperationException この領域には、別の WorksheetTable のセルが 1 つ以上含まれています。 備考
このテーブルを作成すると、Workbook.defaultTableStyle は
の値に適用されます。 tableHasHeaders が True である場合、このテーブルを作成すると、列名はヘッダー行のセルから取り込まれます。False の場合、列名が生成されてヘッダー行のセルがワークシートに挿入されます。
列の名前は、親 WorksheetTable 内における一意の名前です。テーブルの作成時に同名の列が 2 つ以上存在する場合、各列を一意に識別できるように 2 番目以降の重複列名の末尾に番号が振られていきます。ヘッダー行のセルのなかに文字列以外の値を持つものがある場合、その値は文字列 (そのセルの現在の表示テキスト) に変換されます。ヘッダー行のセルに値を持たないものがある場合、それらのセルには生成された列名が与えられます。
この領域に収めきれない結合セル領域がある場合、そうしたセル領域はワークシートから除外され、結合領域のセルがすべて収まるようにテーブル領域が拡張されます。
-
formatAsTable
- .formatAsTable( tableHasHeaders:boolean, tableStyle:ig.excel.WorksheetTableStyle );
- 返却型:
- ig.excel.WorksheetTable
- 返却型の説明:
- 作成された WorksheetTable は、この領域の書式設定付きテーブルを表します。
領域をテーブルとして書式設定し、関連付けられた WorksheetTable を Worksheet.tables コレクションに追加します。
- tableHasHeaders
- タイプ:boolean
- この領域の一番上の行にテーブルのヘッダーが含まれているかどうかを示す値です。
- tableStyle
- タイプ:ig.excel.WorksheetTableStyle
- このテーブルに適用する WorksheetTableStyle、または Workbook.defaultTableStyle を使用する場合は null 値になります。
例外
例外 説明 ig.ArgumentException 指定した tableStyle が、Workbook.customTableStyles または Workbook.standardTableStyles コレクションに存在しません。 ig.InvalidOperationException この領域には、別の WorksheetTable のセルが 1 つ以上含まれています。 ig.InvalidOperationException この領域には、別の WorksheetTable のセルが 1 つ以上含まれています。 ig.InvalidOperationException この領域には、別の WorksheetTable のセルが 1 つ以上含まれています。 備考
このテーブルを作成すると、Workbook.defaultTableStyle は
の値に適用されます。 tableHasHeaders が True である場合、このテーブルを作成すると、列名はヘッダー行のセルから取り込まれます。False の場合、列名が生成されてヘッダー行のセルがワークシートに挿入されます。
列の名前は、親 WorksheetTable 内における一意の名前です。テーブルの作成時に同名の列が 2 つ以上存在する場合、各列を一意に識別できるように 2 番目以降の重複列名の末尾に番号が振られていきます。ヘッダー行のセルのなかに文字列以外の値を持つものがある場合、その値は文字列 (そのセルの現在の表示テキスト) に変換されます。ヘッダー行のセルに値を持たないものがある場合、それらのセルには生成された列名が与えられます。
この領域に収めきれない結合セル領域がある場合、そうしたセル領域はワークシートから除外され、結合領域のセルがすべて収まるようにテーブル領域が拡張されます。
-
getBoundsInTwips
- .getBoundsInTwips( );
- 返却型:
- object
- 返却型の説明:
- ワークシートの領域の境界。 数値を持つ 'x'、'y'、'width'、'height'、'left'、'top'、'right'、および 'bottom' プロパティがあるオブジェクトです。
領域の境界をトゥイップで取得します(ポイントの 1/20)。
備考
このメソッドによって返される境界は、ワークシートの現在の構成に限って有効です。 領域の前の行または列のサイズが変更されると、これらの境界は領域の位置を反映しません。
-
getBoundsInTwips
- .getBoundsInTwips( options:ig.excel.PositioningOptions );
- 返却型:
- object
- 返却型の説明:
- ワークシートの領域の境界。 数値を持つ 'x'、'y'、'width'、'height'、'left'、'top'、'right'、および 'bottom' プロパティがあるオブジェクトです。
領域の境界をトゥイップで取得します(ポイントの 1/20)。
- options
- タイプ:ig.excel.PositioningOptions
- 領域の境界線を取得するときに使用するオプション。
備考
このメソッドによって返される境界は、ワークシートの現在の構成に限って有効です。 領域の前の行または列のサイズが変更されると、これらの境界は領域の位置を反映しません。
-
getHashCode
- .getHashCode( );
WorksheetRegion のハッシュ コードを取得します。
-
lastColumn
- .lastColumn( );
- 返却型:
- number
- 返却型の説明:
- 領域の最後の列のインデックス。
領域の最後の列のインデックスを取得します。
-
lastRow
- .lastRow( );
- 返却型:
- number
- 返却型の説明:
- 領域の最後の行のインデックス。
領域の最後の行のインデックスを取得します。
-
toString
- .toString( );
- 返却型:
- string
- 返却型の説明:
- 領域のセルの範囲の文字列表現。
領域のセルの範囲の文字列表現を取得します。
-
toString
- .toString( cellReferenceMode:ig.excel.CellReferenceMode, includeWorksheetName:boolean );
- 返却型:
- string
- 返却型の説明:
- 領域のセルの範囲の文字列表現。
領域のセルの範囲の文字列表現を取得します。
- cellReferenceMode
- タイプ:ig.excel.CellReferenceMode
- セル参照を生成するために使用されるモード。
- includeWorksheetName
- タイプ:boolean
- 領域アドレスにワークシート名を含むかどうかを示す値。
-
toString
- .toString( cellReferenceMode:ig.excel.CellReferenceMode, includeWorksheetName:boolean, useRelativeColumn:boolean, useRelativeRow:boolean );
- 返却型:
- string
- 返却型の説明:
- 領域のセルの範囲の文字列表現。
領域のセルの範囲の文字列表現を取得します。
- cellReferenceMode
- タイプ:ig.excel.CellReferenceMode
- セル参照を生成するために使用されるモード。
- includeWorksheetName
- タイプ:boolean
- 領域アドレスにワークシート名を含むかどうかを示す値。
- useRelativeColumn
- タイプ:boolean
- 領域内のセルの列アドレスを使用するかどうかを示す値。
- useRelativeRow
- タイプ:boolean
- 領域内のセルの行アドレスを使用するかどうかを示す値。
-
worksheet
- .worksheet( );
- 返却型:
- ig.excel.Worksheet
- 返却型の説明:
- 領域が存在するワークシート、または領域がワークシートから外れてしまっている場合は null 値が返されます。
領域が置かれるワークシートを取得します。