ig.excel.Worksheet
備考
Excel ワークシートは、基本的には限られた行と列を持つテーブルです。新しいワークシートを作成するために、Worksheet.workbook インスタンスで Workbook.worksheets コレクションの WorksheetCollection.add メソッドを使用します。
依存関係
-
clearConditionalFormattingData
- .clearConditionalFormattingData( );
保存されないため、Worksheet からすべての条件付き書式ルールをクリアします。
備考
-
columns
- .columns( );
- 返却型:
- ig.excel.WorksheetColumnCollection
- 返却型の説明:
- このワークシート内の列のコレクション。
このワークシート内の列のコレクションを取得します。
備考
列のコレクションは、Workbook.CurrentFormat によって Workbook.maxExcelColumnCount または Workbook.maxExcel2007ColumnCount のコレクションで列の最大数を持つ固定された長さのコレクションです。内部的には、要求があった場合、列が作成されコレクションに追加されます。
注: コレクションの繰り返しは、すべての列を作成しません。これはすでに使用されている列を繰り返すだけです。ワークシートですべての列の作成および反復には、For ループを使用し、0 から最大列カウントより 1 つ少ない回数繰り返し、コレクションのインデクサーに各インデックスを渡します。
-
columns
- .columns( index:number );
- 返却型:
- ig.excel.WorksheetColumn
- 返却型の説明:
- このワークシート内の列のコレクション。
このワークシート内の列のコレクションを取得します。
- index
- タイプ:number
- 取得する列の 0 から始まるインデックス。
例外
例外 説明 ig.ArgumentOutOfRangeException インデックスはゼロ未満です。 ig.InvalidOperationException Workbook.currentFormat によって、index は Workbook.maxExcelColumnCount または Workbook.maxExcel2007ColumnCount 以上にします。 備考
列のコレクションは、Workbook.CurrentFormat によって Workbook.maxExcelColumnCount または Workbook.maxExcel2007ColumnCount のコレクションで列の最大数を持つ固定された長さのコレクションです。内部的には、要求があった場合、列が作成されコレクションに追加されます。
注: コレクションの繰り返しは、すべての列を作成しません。これはすでに使用されている列を繰り返すだけです。ワークシートですべての列の作成および反復には、For ループを使用し、0 から最大列カウントより 1 つ少ない回数繰り返し、コレクションのインデクサーに各インデックスを渡します。
-
conditionalFormats
- .conditionalFormats( );
関連項目
- ig.excel.ConditionalFormatCollection
- ig.excel.ConditionalFormatCollection.addAverageCondition
- ig.excel.ConditionalFormatCollection.addBlanksCondition
- ig.excel.ConditionalFormatCollection.addColorScaleCondition
- ig.excel.ConditionalFormatCollection.addDataBarCondition
- ig.excel.ConditionalFormatCollection.addDateTimeCondition
- ig.excel.ConditionalFormatCollection.addDuplicateCondition
- ig.excel.ConditionalFormatCollection.addErrorsCondition
- ig.excel.ConditionalFormatCollection.addFormulaCondition
- ig.excel.ConditionalFormatCollection.addIconSetCondition
- ig.excel.ConditionalFormatCollection.addNoBlanksCondition
- ig.excel.ConditionalFormatCollection.addNoErrorsCondition
- ig.excel.ConditionalFormatCollection.addOperatorCondition
- ig.excel.ConditionalFormatCollection.addRankCondition
- ig.excel.ConditionalFormatCollection.addTextCondition
- ig.excel.ConditionalFormatCollection.addUniqueCondition
- ig.excel.ConditionBase
-
conditionalFormats
- .conditionalFormats( index:number );
- 返却型:
- ig.excel.ConditionBase
- 返却型の説明:
- index
- タイプ:number
例外
例外 説明 ig.IndexOutOfRangeException -
dataTables
- .dataTables( );
- 返却型:
- ig.excel.WorksheetDataTableCollection
- 返却型の説明:
- このワークシート内のデータ テーブルのコレクション。
このワークシート内のデータ テーブルのコレクションを取得します。
-
dataTables
- .dataTables( index:number );
- 返却型:
- ig.excel.WorksheetDataTable
- 返却型の説明:
- このワークシート内のデータ テーブルのコレクション。
このワークシート内のデータ テーブルのコレクションを取得します。
- index
- タイプ:number
- 取得するデータ テーブルの 0 から始まるインデックス。
-
dataValidationRules
- .dataValidationRules( );
ワークシート内のセルに適用されているデータの入力規則ルールのコレクションを取得します。
-
dataValidationRules
- .dataValidationRules( rule:ig.excel.DataValidationRule );
ワークシート内のセルに適用されているデータの入力規則ルールのコレクションを取得します。
- rule
- タイプ:ig.excel.DataValidationRule
- データの入力規則ルール。
例外
例外 説明 ig.ArgumentNullException ルールが null 値の場合に発生します。 ig.excel.KeyNotFoundException プロパティが取得され、ルールが DataValidationRuleCollection.worksheet に適用されていない場合に発生します。 ig.ArgumentException プロパティが設定され、値がこのコレクション以外のワークシートからのものである場合に発生します。 ig.ArgumentException プロパティが設定され、値がこのコレクション以外のワークシートからのものである場合に発生します。 -
dataValidationRules
- .dataValidationRules( rule:ig.excel.DataValidationRule, value:ig.excel.WorksheetReferenceCollection );
ワークシート内のセルに適用されているデータの入力規則ルールのコレクションを取得します。
- rule
- タイプ:ig.excel.DataValidationRule
- データの入力規則ルール。
- value
- タイプ:ig.excel.WorksheetReferenceCollection
例外
例外 説明 ig.ArgumentNullException ルールが null 値の場合に発生します。 ig.excel.KeyNotFoundException プロパティが取得され、ルールが DataValidationRuleCollection.worksheet に適用されていない場合に発生します。 ig.ArgumentException プロパティが設定され、値がこのコレクション以外のワークシートからのものである場合に発生します。 ig.ArgumentException プロパティが設定され、値がこのコレクション以外のワークシートからのものである場合に発生します。 -
defaultColumnWidth
- .defaultColumnWidth( );
- 返却型:
- number
- 返却型の説明:
- ワークシートのデフォルトのフォントで '0' 数字幅の 1/ 256 で、余白を含む、デフォルトの列幅。
ワークシートのデフォルトのフォントで '0' 数字幅の 1/ 256 で、余白を含む、デフォルトの列幅を取得します。
備考
デフォルトの列幅は、幅が設定されていないすべての列の幅です。
指定される値は、0 から 65535 の間でなければなりません。無効な値は自動的に有効値に調整されます。
このプロパティを設定または取得することは、Worksheet.setDefaultColumnWidth または Worksheet.getDefaultColumnWidth を呼び出し、Character256th の WorksheetColumnWidthUnit 値を使用すること同じ結果が得られます。
-
defaultColumnWidth
- .defaultColumnWidth( value:number );
- 返却型:
- number
- 返却型の説明:
- ワークシートのデフォルトのフォントで '0' 数字幅の 1/ 256 で、余白を含む、デフォルトの列幅。
ワークシートのデフォルトのフォントで '0' 数字幅の 1/ 256 で、余白を含む、デフォルトの列幅を取得します。
- value
- タイプ:number
備考
デフォルトの列幅は、幅が設定されていないすべての列の幅です。
指定される値は、0 から 65535 の間でなければなりません。無効な値は自動的に有効値に調整されます。
このプロパティを設定または取得することは、Worksheet.setDefaultColumnWidth または Worksheet.getDefaultColumnWidth を呼び出し、Character256th の WorksheetColumnWidthUnit 値を使用すること同じ結果が得られます。
-
defaultRowHeight
- .defaultRowHeight( );
- 返却型:
- number
- 返却型の説明:
- デフォルト行のトゥイップでの高さ（1 ポイントの 1/20）。
デフォルト行のトゥイップでの高さ（1 ポイントの 1/20）を取得します。
例外
例外 説明 ig.ArgumentOutOfRangeException 指定される値は、-1 および 8192 の値範囲の外です。 備考
デフォルト行の高さは、正の数に明示的に設定された高さを持たないすべての行の高さです。
指定された値が -1 の場合、デフォルト行の高さはワークブックのデフォルト フォントに基づいて計算され、以降にこのプロパティを取得するとフォント ベースのデフォルト行の高さを返します。
-
defaultRowHeight
- .defaultRowHeight( value:number );
- 返却型:
- number
- 返却型の説明:
- デフォルト行のトゥイップでの高さ（1 ポイントの 1/20）。
デフォルト行のトゥイップでの高さ（1 ポイントの 1/20）を取得します。
- value
- タイプ:number
例外
例外 説明 ig.ArgumentOutOfRangeException 指定される値は、-1 および 8192 の値範囲の外です。 備考
デフォルト行の高さは、正の数に明示的に設定された高さを持たないすべての行の高さです。
指定された値が -1 の場合、デフォルト行の高さはワークブックのデフォルト フォントに基づいて計算され、以降にこのプロパティを取得するとフォント ベースのデフォルト行の高さを返します。
-
deleteCells
- .deleteCells( region:ig.excel.WorksheetRegion, shiftCellsLeft:boolean );
セル領域を削除します。
- region
- タイプ:ig.excel.WorksheetRegion
- 削除する領域
- shiftCellsLeft
- タイプ:boolean
- True の場合、削除した領域の右から左へセルを移動し挿入します。そうでない場合はセルを領域の下から上へ移動します。
例外
例外 説明 ig.InvalidOperationException 操作が許可されていない場合、例えば範囲が保護された領域を交差する場合。 ig.ArgumentNullException 領域が Null の場合。 -
deleteCells
- .deleteCells( address:string, shiftCellsLeft:boolean );
セル領域を削除します。
- address
- タイプ:string
- 削除する領域のアドレス
- shiftCellsLeft
- タイプ:boolean
- True の場合、削除した領域の右から左へセルを移動し挿入します。そうでない場合はセルを領域の下から上へ移動します。
例外
例外 説明 ig.InvalidOperationException 操作が許可されていない場合、例えば範囲が保護された領域を交差する場合。 ig.ArgumentException アドレスが有効でない場合。 -
displayOptions
- .displayOptions( );
- 返却型:
- ig.excel.WorksheetDisplayOptions
- 返却型の説明:
- ワークシートの表示を制御するオブジェクト。
ワークシートの表示を制御するオブジェクトを取得します。
備考
表示オプションには、Microsoft Excel で表示された時にワークシートの表示に影響を及ぼす設定が含まれます。 これらの設定は、ワークシートに保存された印刷されるワークシートまたはデータに影響を及ぼしません。
-
filterSettings
- .filterSettings( );
-
getCell
- .getCell( address:string );
- 返却型:
- ig.excel.WorksheetCell
- 返却型の説明:
- 指定したアドレスまたは名前によって表わされるセル。
指定した住アドレスまたは名前にあるセルを取得します。
- address
- タイプ:string
- セルのアドレスまたは名前。
例外
例外 説明 ig.ArgumentNullException address は null です。 ig.ArgumentException address は、無効な名前であるか、ワークブックのセル参照モードの無効なセルまたは領域アドレスです。 ig.InvalidOperationException address は、相対 R1C1 アドレスです。元のセルを取得するオーバー読み込みは、相対 R1C1 参照を解決するために使用される必要があります。 備考
ワークブックの Workbook.cellReferenceMode は、セル アドレスを解析するために使用されます。
1 つまたは複数の領域参照がセル参照の代わりに指定される場合は、最初の領域の左上のセルが返されます。
名前が指定されている場合、Worksheet にあるセルまたは領域を参照しなければならず、Worksheet.workbook またはワークシートを対象範囲としなければならない、または null 値が返されます。
-
getCell
- .getCell( address:string, cellReferenceMode:ig.excel.CellReferenceMode );
- 返却型:
- ig.excel.WorksheetCell
- 返却型の説明:
- 指定したアドレスまたは名前によって表わされるセル。
指定した住アドレスまたは名前にあるセルを取得します。
- address
- タイプ:string
- セルのアドレスまたは名前。
- cellReferenceMode
- タイプ:ig.excel.CellReferenceMode
- セル アドレスを解析する時に使用されるセル参照モード。
例外
例外 説明 ig.ArgumentNullException address は null です。 ig.excel.InvalidEnumArgumentException cellReferenceMode が Worksheet.cellReferenceMode 列挙体で定義されていません。 ig.ArgumentException address は、無効な名前であるか、ワークブックのセル参照モードの無効なセルまたは領域アドレスです。 ig.InvalidOperationException address は、相対 R1C1 アドレスです。元のセルを取得するオーバー読み込みは、相対 R1C1 参照を解決するために使用される必要があります。 備考
ワークブックの Workbook.cellReferenceMode は、セル アドレスを解析するために使用されます。
1 つまたは複数の領域参照がセル参照の代わりに指定される場合は、最初の領域の左上のセルが返されます。
名前が指定されている場合、Worksheet にあるセルまたは領域を参照しなければならず、Worksheet.workbook またはワークシートを対象範囲としなければならない、または null 値が返されます。
-
getCell
- .getCell( address:string, cellReferenceMode:ig.excel.CellReferenceMode, originCell:ig.excel.WorksheetCell );
- 返却型:
- ig.excel.WorksheetCell
- 返却型の説明:
- 指定したアドレスまたは名前によって表わされるセル。
指定した住アドレスまたは名前にあるセルを取得します。
- address
- タイプ:string
- セルのアドレスまたは名前。
- cellReferenceMode
- タイプ:ig.excel.CellReferenceMode
- セル アドレスを解析する時に使用されるセル参照モード。
- originCell
- タイプ:ig.excel.WorksheetCell
- 相対 R1C1 の参照を解決する基点。
例外
例外 説明 ig.ArgumentNullException address は null です。 ig.excel.InvalidEnumArgumentException cellReferenceMode が Worksheet.cellReferenceMode 列挙体で定義されていません。 ig.ArgumentException address は、無効な名前であるか、ワークブックのセル参照モードの無効なセルまたは領域アドレスです。 ig.InvalidOperationException address は、相対 R1C1 アドレスです。元のセルを取得するオーバー読み込みは、相対 R1C1 参照を解決するために使用される必要があります。 備考
ワークブックの Workbook.cellReferenceMode は、セル アドレスを解析するために使用されます。
1 つまたは複数の領域参照がセル参照の代わりに指定される場合は、最初の領域の左上のセルが返されます。
名前が指定されている場合、Worksheet にあるセルまたは領域を参照しなければならず、Worksheet.workbook またはワークシートを対象範囲としなければならない、または null 値が返されます。
-
getCell
- .getCell( address:string, originCell:ig.excel.WorksheetCell );
- 返却型:
- ig.excel.WorksheetCell
- 返却型の説明:
- 指定したアドレスまたは名前によって表わされるセル。
指定した住アドレスまたは名前にあるセルを取得します。
- address
- タイプ:string
- セルのアドレスまたは名前。
- originCell
- タイプ:ig.excel.WorksheetCell
- 相対 R1C1 の参照を解決する基点。
例外
例外 説明 ig.ArgumentNullException address は null です。 ig.ArgumentException address は、無効な名前であるか、ワークブックのセル参照モードの無効なセルまたは領域アドレスです。 ig.InvalidOperationException address は、相対 R1C1 アドレスです。元のセルを取得するオーバー読み込みは、相対 R1C1 参照を解決するために使用される必要があります。 備考
ワークブックの Workbook.cellReferenceMode は、セル アドレスを解析するために使用されます。
1 つまたは複数の領域参照がセル参照の代わりに指定される場合は、最初の領域の左上のセルが返されます。
名前が指定されている場合、Worksheet にあるセルまたは領域を参照しなければならず、Worksheet.workbook またはワークシートを対象範囲としなければならない、または null 値が返されます。
-
getCellConditionalFormat
- .getCellConditionalFormat( rowIndex:number, columnIndex:number );
- 返却型:
- ig.excel.CellConditionalFormat
- 返却型の説明:
- rowIndex
- タイプ:number
- columnIndex
- タイプ:number
例外
例外 説明 ig.ArgumentOutOfRangeException 備考
-
getDefaultColumnWidth
- .getDefaultColumnWidth( units:ig.excel.WorksheetColumnWidthUnit );
- 返却型:
- number
- 返却型の説明:
- 指定された単位のデフォルトの列幅。
指定された単位でデフォルトの列幅を取得します。
- units
- タイプ:ig.excel.WorksheetColumnWidthUnit
- 幅を返す単位。
例外
例外 説明 ig.excel.InvalidEnumArgumentException units が WorksheetColumnWidthUnit 列挙体で定義されていません。 備考
units が Character256th の場合、返される値は Worksheet.defaultColumnWidth プロパティの値と同じになります。
-
getRegion
- .getRegion( address:string );
- 返却型:
- ig.excel.WorksheetRegion
- 返却型の説明:
- 指定したアドレスまたは名前によって表わされる領域。
指定したアドレスまたは名前にある領域を取得します。
- address
- タイプ:string
- 領域のアドレスまたは名前。
例外
例外 説明 ig.ArgumentNullException address は null です。 ig.ArgumentException address は、無効な名前であるか、ワークブックのセル参照モードの無効なセルまたは領域アドレスです。 ig.InvalidOperationException address は、相対 R1C1 アドレスです。元のセルを取得するオーバー読み込みは、相対 R1C1 参照を解決するために使用される必要があります。 備考
ワークブックの Workbook.cellReferenceMode は、領域アドレスを解析するために使用されます。
セルの参照がセル領域の参照の代わりに指定される場合は、アドレスでセルを含む 1x1 領域が返されます。
参照のリストが指定される場合、最初の参照によって指定された領域が返されます。
名前が指定されている場合、Worksheet にあるセルまたは領域を参照しなければならず、Worksheet.workbook またはワークシートを対象範囲としなければならない、または null 値が返されます。
-
getRegion
- .getRegion( address:string, cellReferenceMode:ig.excel.CellReferenceMode );
- 返却型:
- ig.excel.WorksheetRegion
- 返却型の説明:
- 指定したアドレスまたは名前によって表わされる領域。
指定したアドレスまたは名前にある領域を取得します。
- address
- タイプ:string
- 領域のアドレスまたは名前。
- cellReferenceMode
- タイプ:ig.excel.CellReferenceMode
- セル アドレスを解析する時に使用されるセル参照モード。
例外
例外 説明 ig.ArgumentNullException address は null です。 ig.excel.InvalidEnumArgumentException cellReferenceMode が Worksheet.cellReferenceMode 列挙体で定義されていません。 ig.ArgumentException address は、無効な名前であるか、ワークブックのセル参照モードの無効なセルまたは領域アドレスです。 ig.InvalidOperationException address は、相対 R1C1 アドレスです。元のセルを取得するオーバー読み込みは、相対 R1C1 参照を解決するために使用される必要があります。 備考
ワークブックの Workbook.cellReferenceMode は、領域アドレスを解析するために使用されます。
セルの参照がセル領域の参照の代わりに指定される場合は、アドレスでセルを含む 1x1 領域が返されます。
参照のリストが指定される場合、最初の参照によって指定された領域が返されます。
名前が指定されている場合、Worksheet にあるセルまたは領域を参照しなければならず、Worksheet.workbook またはワークシートを対象範囲としなければならない、または null 値が返されます。
-
getRegion
- .getRegion( address:string, cellReferenceMode:ig.excel.CellReferenceMode, originCell:ig.excel.WorksheetCell );
- 返却型:
- ig.excel.WorksheetRegion
- 返却型の説明:
- 指定したアドレスまたは名前によって表わされる領域。
指定したアドレスまたは名前にある領域を取得します。
- address
- タイプ:string
- 領域のアドレスまたは名前。
- cellReferenceMode
- タイプ:ig.excel.CellReferenceMode
- セル アドレスを解析する時に使用されるセル参照モード。
- originCell
- タイプ:ig.excel.WorksheetCell
- 相対 R1C1 の参照を解決する基点。
例外
例外 説明 ig.ArgumentNullException address は null です。 ig.excel.InvalidEnumArgumentException cellReferenceMode が Worksheet.cellReferenceMode 列挙体で定義されていません。 ig.ArgumentException address は、無効な名前であるか、ワークブックのセル参照モードの無効なセルまたは領域アドレスです。 ig.InvalidOperationException address は、相対 R1C1 アドレスです。元のセルを取得するオーバー読み込みは、相対 R1C1 参照を解決するために使用される必要があります。 備考
ワークブックの Workbook.cellReferenceMode は、領域アドレスを解析するために使用されます。
セルの参照がセル領域の参照の代わりに指定される場合は、アドレスでセルを含む 1x1 領域が返されます。
参照のリストが指定される場合、最初の参照によって指定された領域が返されます。
名前が指定されている場合、Worksheet にあるセルまたは領域を参照しなければならず、Worksheet.workbook またはワークシートを対象範囲としなければならない、または null 値が返されます。
-
getRegion
- .getRegion( address:string, originCell:ig.excel.WorksheetCell );
- 返却型:
- ig.excel.WorksheetRegion
- 返却型の説明:
- 指定したアドレスまたは名前によって表わされる領域。
指定したアドレスまたは名前にある領域を取得します。
- address
- タイプ:string
- 領域のアドレスまたは名前。
- originCell
- タイプ:ig.excel.WorksheetCell
- 相対 R1C1 の参照を解決する基点。
例外
例外 説明 ig.ArgumentNullException address は null です。 ig.ArgumentException address は、無効な名前であるか、ワークブックのセル参照モードの無効なセルまたは領域アドレスです。 ig.InvalidOperationException address は、相対 R1C1 アドレスです。元のセルを取得するオーバー読み込みは、相対 R1C1 参照を解決するために使用される必要があります。 備考
ワークブックの Workbook.cellReferenceMode は、領域アドレスを解析するために使用されます。
セルの参照がセル領域の参照の代わりに指定される場合は、アドレスでセルを含む 1x1 領域が返されます。
参照のリストが指定される場合、最初の参照によって指定された領域が返されます。
名前が指定されている場合、Worksheet にあるセルまたは領域を参照しなければならず、Worksheet.workbook またはワークシートを対象範囲としなければならない、または null 値が返されます。
-
getRegions
- .getRegions( address:string );
- 返却型:
- ig.excel.WorksheetRegion[]
- 返却型の説明:
- 指定したアドレスまたは名前によって表わされる領域の配列。
指定したアドレスまたは名前にある領域を取得します。
- address
- タイプ:string
- 領域のアドレスまたは名前。
例外
例外 説明 ig.ArgumentNullException address は null です。 ig.ArgumentException address は、無効な名前であるか、ワークブックのセル参照モードの無効なセルまたは領域アドレスです。 ig.InvalidOperationException address は、相対 R1C1 アドレスです。元のセルを取得するオーバー読み込みは、相対 R1C1 参照を解決するために使用される必要があります。 備考
ワークブックの Workbook.cellReferenceMode は、領域アドレスを解析するために使用されます。
アドレスは参照のリストにすることができ、それぞれがワークシート上の個別の領域を参照します。
セルまたは単一領域参照が代わりに指定される場合、そのアドレスにある 1 つの領域の配列が返されます。
名前が指定されている場合、Worksheet にあるセルまたは領域を参照しなければならず、Worksheet.workbook またはワークシートを対象範囲としなければならない、または null 値が返されます。
-
getRegions
- .getRegions( address:string, cellReferenceMode:ig.excel.CellReferenceMode );
- 返却型:
- ig.excel.WorksheetRegion[]
- 返却型の説明:
- 指定したアドレスまたは名前によって表わされる領域の配列。
指定したアドレスまたは名前にある領域を取得します。
- address
- タイプ:string
- 領域のアドレスまたは名前。
- cellReferenceMode
- タイプ:ig.excel.CellReferenceMode
- セル アドレスを解析する時に使用されるセル参照モード。
例外
例外 説明 ig.ArgumentNullException address は null です。 ig.excel.InvalidEnumArgumentException cellReferenceMode が Worksheet.cellReferenceMode 列挙体で定義されていません。 ig.ArgumentException address は、無効な名前であるか、ワークブックのセル参照モードの無効なセルまたは領域アドレスです。 ig.InvalidOperationException address は、相対 R1C1 アドレスです。元のセルを取得するオーバー読み込みは、相対 R1C1 参照を解決するために使用される必要があります。 備考
ワークブックの Workbook.cellReferenceMode は、領域アドレスを解析するために使用されます。
アドレスは参照のリストにすることができ、それぞれがワークシート上の個別の領域を参照します。
セルまたは単一領域参照が代わりに指定される場合、そのアドレスにある 1 つの領域の配列が返されます。
名前が指定されている場合、Worksheet にあるセルまたは領域を参照しなければならず、Worksheet.workbook またはワークシートを対象範囲としなければならない、または null 値が返されます。
-
getRegions
- .getRegions( address:string, cellReferenceMode:ig.excel.CellReferenceMode, originCell:ig.excel.WorksheetCell );
- 返却型:
- ig.excel.WorksheetRegion[]
- 返却型の説明:
- 指定したアドレスまたは名前によって表わされる領域の配列。
指定したアドレスまたは名前にある領域を取得します。
- address
- タイプ:string
- 領域のアドレスまたは名前。
- cellReferenceMode
- タイプ:ig.excel.CellReferenceMode
- セル アドレスを解析する時に使用されるセル参照モード。
- originCell
- タイプ:ig.excel.WorksheetCell
- 相対 R1C1 の参照を解決する基点。
例外
例外 説明 ig.ArgumentNullException address は null です。 ig.excel.InvalidEnumArgumentException cellReferenceMode が Worksheet.cellReferenceMode 列挙体で定義されていません。 ig.ArgumentException address は、無効な名前であるか、ワークブックのセル参照モードの無効なセルまたは領域アドレスです。 ig.InvalidOperationException address は、相対 R1C1 アドレスです。元のセルを取得するオーバー読み込みは、相対 R1C1 参照を解決するために使用される必要があります。 備考
ワークブックの Workbook.cellReferenceMode は、領域アドレスを解析するために使用されます。
アドレスは参照のリストにすることができ、それぞれがワークシート上の個別の領域を参照します。
セルまたは単一領域参照が代わりに指定される場合、そのアドレスにある 1 つの領域の配列が返されます。
名前が指定されている場合、Worksheet にあるセルまたは領域を参照しなければならず、Worksheet.workbook またはワークシートを対象範囲としなければならない、または null 値が返されます。
-
getRegions
- .getRegions( address:string, originCell:ig.excel.WorksheetCell );
- 返却型:
- ig.excel.WorksheetRegion[]
- 返却型の説明:
- 指定したアドレスまたは名前によって表わされる領域の配列。
指定したアドレスまたは名前にある領域を取得します。
- address
- タイプ:string
- 領域のアドレスまたは名前。
- originCell
- タイプ:ig.excel.WorksheetCell
- 相対 R1C1 の参照を解決する基点。
例外
例外 説明 ig.ArgumentNullException address は null です。 ig.ArgumentException address は、無効な名前であるか、ワークブックのセル参照モードの無効なセルまたは領域アドレスです。 ig.InvalidOperationException address は、相対 R1C1 アドレスです。元のセルを取得するオーバー読み込みは、相対 R1C1 参照を解決するために使用される必要があります。 備考
ワークブックの Workbook.cellReferenceMode は、領域アドレスを解析するために使用されます。
アドレスは参照のリストにすることができ、それぞれがワークシート上の個別の領域を参照します。
セルまたは単一領域参照が代わりに指定される場合、そのアドレスにある 1 つの領域の配列が返されます。
名前が指定されている場合、Worksheet にあるセルまたは領域を参照しなければならず、Worksheet.workbook またはワークシートを対象範囲としなければならない、または null 値が返されます。
-
hideColumns
- .hideColumns( [startIndex:number], [count:number] );
指定された範囲に列を非表示になります。
- startIndex
- タイプ:number
- オプション
- 非表示にする最初の列のインデックス。null の場合、最初の列から非表示になります。
- count
- タイプ:number
- オプション
- 非表示にする列数。null を指定すると、startIndex を指定した場合、単一の列が非表示になります。それ以外の場合、すべての列が非表示になります。
例外
例外 説明 ig.ArgumentException startIndex が 0 未満の場合に発生します。 ig.ArgumentException startIndex が 0 未満の場合に発生します。 ig.ArgumentException startIndex が 0 未満の場合に発生します。 -
hideRows
- .hideRows( [startIndex:number], [count:number] );
指定した範囲で行が非表示になります。
- startIndex
- タイプ:number
- オプション
- 非表示にする最初の行のインデックス。null の場合、最初の行から非表示になります。
- count
- タイプ:number
- オプション
- 非表示にする行数。null を指定すると、startIndex を指定した場合、単一の行が非表示になります。それ以外の場合、すべての行が非表示になります。
例外
例外 説明 ig.ArgumentException startIndex が 0 未満の場合に発生します。 ig.ArgumentException startIndex が 0 未満の場合に発生します。 ig.ArgumentException startIndex が 0 未満の場合に発生します。 -
hyperlinks
- .hyperlinks( );
Worksheet のセルおよび領域に適用されるハイパーリンクのコレクションを取得します。
-
hyperlinks
- .hyperlinks( index:number );
- 返却型:
- ig.excel.WorksheetHyperlink
- 返却型の説明:
- 指定されたインデックスにあるハイパーリンク。
Worksheet のセルおよび領域に適用されるハイパーリンクのコレクションを取得します。
- index
- タイプ:number
- 取得するハイパーリンクの 0 から始まるインデックス。
例外
例外 説明 ig.ArgumentOutOfRangeException インデックスは 0 未満であるか、または、インデックスが WorksheetHyperlinkCollection.count 以上です。 -
index
- .index( );
- 返却型:
- number
- 返却型の説明:
- 親ワークシートコレクション内での、このワークシートの 0 から始まるインデックス。
親 Workbook.worksheets コレクション内での、このワークシートの 0 から始まるインデックスを取得します。
備考
負の値は、ワークシートが親コレクションから削除されたことを示します。
-
insertCells
- .insertCells( region:ig.excel.WorksheetRegion, shiftCellsRight:boolean );
セル領域を挿入します。
- region
- タイプ:ig.excel.WorksheetRegion
- 挿入する領域
- shiftCellsRight
- タイプ:boolean
- True の場合、新しく挿入するセルの場所を確保するために既存のセルを右へ移動します。そうでない場合は既存のセルを領域の下へ移動します。
例外
例外 説明 ig.InvalidOperationException 操作が許可されていない場合、例えばワークシートからデータが移動される恐れがある場合。 ig.ArgumentNullException 領域が Null の場合。 -
insertCells
- .insertCells( address:string, shiftCellsRight:boolean );
セル領域を挿入します。
- address
- タイプ:string
- 挿入する領域
- shiftCellsRight
- タイプ:boolean
- True の場合、新しく挿入するセルの場所を確保するために既存のセルを右へ移動します。そうでない場合は既存のセルを領域の下へ移動します。
例外
例外 説明 ig.InvalidOperationException 操作が許可されていない場合、例えばワークシートからデータが移動される恐れがある場合。 ig.ArgumentException アドレスが有効でない場合。 -
mergedCellsRegions
- .mergedCellsRegions( );
- 返却型:
- ig.excel.WorksheetMergedCellsRegionCollection
- 返却型の説明:
- このワークシート内の、結合セル範囲のコレクション。
このワークシート内の、結合セル範囲のコレクションを取得します。
備考
ワークシートに新しい結合セル範囲を追加するには、WorksheetMergedCellsRegionCollection.add メソッドを使用します。
-
mergedCellsRegions
- .mergedCellsRegions( index:number );
- 返却型:
- ig.excel.WorksheetMergedCellsRegion
- 返却型の説明:
- このワークシート内の、結合セル範囲のコレクション。
このワークシート内の、結合セル範囲のコレクションを取得します。
- index
- タイプ:number
- 取得する結合されたセル領域の 0 から始まるインデックス。
例外
例外 説明 ig.ArgumentOutOfRangeException インデックスは 0 未満であるか、または、インデックスが WorksheetMergedCellsRegionCollection.count 以上です。 -
moveToIndex
- .moveToIndex( index:number );
ワークシートをワークシートのワークブック コレクションの新しい位置へ移動します。
- index
- タイプ:number
- ワークシートが移動される新しい 0 から始まるインデックスです。
例外
例外 説明 ig.InvalidOperationException ワークシートは、このワークブックからすでに削除されています。 ig.ArgumentOutOfRangeException index が、0 以下であるか、またはワークブックのワークシート数以上です。 -
printOptions
- .printOptions( );
- 返却型:
- ig.excel.PrintOptions
- 返却型の説明:
- ワークシートの印刷方法を制御するオブジェクト。
ワークシートの印刷方法を制御するオブジェクトを取得します。
備考
印刷オプションには、ワークシートの印刷外観に影響を及ぼす設定が含まれます。これらの設定は、ワークシートのデータに影響を及ぼしません。これらは表示設定ではありませんが、一部のワークシート表示スタイルはすべてまたは一部の印刷オプションを表示するので、これらの設定は Microsoft Excel で表示される時にワークシートの表示に影響を及ぼす場合があります。
-
protect
- .protect( [allowDeletingColumns:boolean], [allowDeletingRows:boolean], [allowEditObjects:boolean], [allowEditScenarios:boolean], [allowFiltering:boolean], [allowFormattingCells:boolean], [allowFormattingColumns:boolean], [allowFormattingRows:boolean], [allowInsertingColumns:boolean], [allowInsertingHyperlinks:boolean], [allowInsertingRows:boolean], [allowSorting:boolean], [allowUsingPivotTables:boolean] );
パスワードを使用せずにワークシートを保護します。
- allowDeletingColumns
- タイプ:boolean
- オプション
- WorksheetProtection.allowDeletingColumns の新しい値を示すオプションのブール値。
- allowDeletingRows
- タイプ:boolean
- オプション
- WorksheetProtection.allowDeletingRows の新しい値を示すオプションのブール値。
- allowEditObjects
- タイプ:boolean
- オプション
- WorksheetProtection.allowEditObjects の新しい値を示すオプションのブール値。
- allowEditScenarios
- タイプ:boolean
- オプション
- WorksheetProtection.allowEditScenarios の新しい値を示すオプションのブール値。
- allowFiltering
- タイプ:boolean
- オプション
- WorksheetProtection.allowFiltering の新しい値を示すオプションのブール値。
- allowFormattingCells
- タイプ:boolean
- オプション
- WorksheetProtection.allowFormattingCells の新しい値を示すオプションのブール値。
- allowFormattingColumns
- タイプ:boolean
- オプション
- WorksheetProtection.allowFormattingColumns の新しい値を示すオプションのブール値。
- allowFormattingRows
- タイプ:boolean
- オプション
- WorksheetProtection.allowFormattingRows の新しい値を示すオプションのブール値。
- allowInsertingColumns
- タイプ:boolean
- オプション
- WorksheetProtection.allowInsertingColumns の新しい値を示すオプションのブール値。
- allowInsertingHyperlinks
- タイプ:boolean
- オプション
- WorksheetProtection.allowInsertingHyperlinks の新しい値を示すオプションのブール値。
- allowInsertingRows
- タイプ:boolean
- オプション
- WorksheetProtection.allowInsertingRows の新しい値を示すオプションのブール値。
- allowSorting
- タイプ:boolean
- オプション
- WorksheetProtection.allowSorting の新しい値を示すオプションのブール値。
- allowUsingPivotTables
- タイプ:boolean
- オプション
- WorksheetProtection.allowUsingPivotTables の新しい値を示すオプションのブール値。
備考
Worksheet がパスワードを使用せずに保護される場合、エンド ユーザーが Excel で Worksheet の保護をパスワードを入力せずに解除できます。Worksheet をコードで保護を解除するには、Worksheet.unprotect メソッドを使用できます。
オプション パラメーターは、この Worksheet の Worksheet.protection プロパティの WorksheetProtection インスタンスのプロパティ値を更新するために使用されます。パラメーターが null の場合、関連付けられたプロパティの現在の値は保持されます。それ以外の場合、プロパティは指定した値に更新されます。たとえば、WorksheetProtection.allowDeletingColumns が True で、allowDeletingColumns が null の場合、プロパティは true です。allowDeletingColumns が false の場合、WorksheetProtection.allowDeletingColumns は false に変更されます。
Worksheet を Excel で保護すると、選択可能なセルを指定する UI があります。この状態を設定するには、Worksheet の保護の前または後に WorksheetProtection.selectionMode プロパティを変更できます。
注: Worksheet.isProtected が既に True の場合、メソッドは無視されます。
-
protection
- .protection( );
Worksheet が保護されるときに使用される情報を提供するオブジェクトを返します。
-
rows
- .rows( );
- 返却型:
- ig.excel.WorksheetRowCollection
- 返却型の説明:
- このワークシート内の行のコレクション。
このワークシート内の行のコレクションを取得します。
備考
行のコレクションは、Workbook.CurrentFormat によって Workbook.maxExcelRowCount または Workbook.maxExcel2007RowCount のコレクションで行の最大数を持つ固定された長さのコレクションです。内部で要求があった場合、行が作成されコレクションに追加されます。
注: コレクションの繰り返しは、すべての行を作成しません。これはすでに使用されている行を繰り返すだけです。ワークシートですべての行の作成および反復には、For ループを使用し、0 から最大行数より 1 つ少ない回数反復し、コレクションのインデクサーに各インデックスを渡します。
-
rows
- .rows( index:number );
- 返却型:
- ig.excel.WorksheetRow
- 返却型の説明:
- このワークシート内の行のコレクション。
このワークシート内の行のコレクションを取得します。
- index
- タイプ:number
- 取得する行の 0 から始まるインデックス。
例外
例外 説明 ig.ArgumentOutOfRangeException インデックスはゼロ未満です。 ig.InvalidOperationException Workbook.currentFormat によって、index は Workbook.maxExcelRowCount または Workbook.maxExcel2007RowCount 以上にします。 備考
行のコレクションは、Workbook.CurrentFormat によって Workbook.maxExcelRowCount または Workbook.maxExcel2007RowCount のコレクションで行の最大数を持つ固定された長さのコレクションです。内部で要求があった場合、行が作成されコレクションに追加されます。
注: コレクションの繰り返しは、すべての行を作成しません。これはすでに使用されている行を繰り返すだけです。ワークシートですべての行の作成および反復には、For ループを使用し、0 から最大行数より 1 つ少ない回数反復し、コレクションのインデクサーに各インデックスを渡します。
-
setDefaultColumnWidth
- .setDefaultColumnWidth( value:number, units:ig.excel.WorksheetColumnWidthUnit );
指定された単位でデフォルトの列幅を設定します。
- value
- タイプ:number
- ワークシートに設定されたデフォルトの列幅で、指定した単位で表される。
- units
- タイプ:ig.excel.WorksheetColumnWidthUnit
- value が表される単位。
例外
例外 説明 ig.ArgumentException value は無限または NaN です。 ig.excel.InvalidEnumArgumentException units が WorksheetColumnWidthUnit 列挙体で定義されていません。 -
shapes
- .shapes( );
- 返却型:
- ig.excel.WorksheetShapeCollection
- 返却型の説明:
- このワークシート内の形状のコレクション。
このワークシート内の形状のコレクションを取得します。
-
shapes
- .shapes( index:number );
- 返却型:
- ig.excel.WorksheetShape
- 返却型の説明:
- このワークシート内の形状のコレクション。
このワークシート内の形状のコレクションを取得します。
- index
- タイプ:number
- 取得する形状の 0 から始まるインデックス。
例外
例外 説明 ig.ArgumentOutOfRangeException インデックスは 0 未満であるか、または、インデックスが WorksheetShapeCollection.count 以上です。 -
sortSettings
- .sortSettings( );
-
sparklineGroups
- .sparklineGroups( );
-
sparklineGroups
- .sparklineGroups( index:number );
- 返却型:
- ig.excel.SparklineGroup
- 返却型の説明:
- index
- タイプ:number
例外
例外 説明 ig.IndexOutOfRangeException -
tables
- .tables( );
このワークシートで使用できる WorksheetTable インスタンスのコレクション、つまり、テーブルとしてフォーマットされる領域を取得します。
-
tables
- .tables( index:number );
- 返却型:
- ig.excel.WorksheetTable
- 返却型の説明:
- 指定したインデックスにある WorksheetTable。
このワークシートで使用できる WorksheetTable インスタンスのコレクション、つまり、テーブルとしてフォーマットされる領域を取得します。
- index
- タイプ:number
- 取得したい WorksheetTable のインデックス (ゼロを基準とした数値)。
例外
例外 説明 ig.ArgumentOutOfRangeException インデックスは 0 未満であるか、または、インデックスが WorksheetTableCollection.count 以上です。 -
tables
- .tables( name:string );
- 返却型:
- ig.excel.WorksheetTable
- 返却型の説明:
- 指定したインデックスにある WorksheetTable。
このワークシートで使用できる WorksheetTable インスタンスのコレクション、つまり、テーブルとしてフォーマットされる領域を取得します。
- name
- タイプ:string
- 取得したい WorksheetTable の名前。
例外
例外 説明 ig.InvalidOperationException 指定した名前の WorksheetTable はコレクションに存在しません。 備考
ワークシート名は大文字と小文字を区別せずに比較されます。
-
type
- .type( );
-
unhideColumns
- .unhideColumns( [startIndex:number], [count:number] );
指定された範囲に列を表示します。
- startIndex
- タイプ:number
- オプション
- 表示する最初の列のインデックス。null の場合、最初の列から表示します。
- count
- タイプ:number
- オプション
- 表示する列数。null を指定すると、startIndex を指定した場合、単一の列が表示されます。それ以外の場合、すべての列が表示されます。
例外
例外 説明 ig.ArgumentException startIndex が 0 未満の場合に発生します。 ig.ArgumentException startIndex が 0 未満の場合に発生します。 ig.ArgumentException startIndex が 0 未満の場合に発生します。 -
unhideRows
- .unhideRows( [startIndex:number], [count:number] );
指定された範囲に行を表示します。
- startIndex
- タイプ:number
- オプション
- 表示する最初の行のインデックス。null の場合、最初の行から表示します。
- count
- タイプ:number
- オプション
- 表示する行数。null を指定すると、startIndex が指定した場合、単一の行は表示されます。それ以外の場合、すべての行は表示されます。
例外
例外 説明 ig.ArgumentException startIndex が 0 未満の場合に発生します。 ig.ArgumentException startIndex が 0 未満の場合に発生します。 ig.ArgumentException startIndex が 0 未満の場合に発生します。