ig.spreadsheet.SpreadsheetSelection
依存関係
-
activeCell
- .activeCell( );
- 返却型:
- ig.spreadsheet.SpreadsheetCell
- 返却型の説明:
- SpreadsheetCell を返します。
アクティブ セルを表すセルを返します。
-
activeCellRangeIndex
- .activeCellRangeIndex( );
アクティブ セルを含む選択グループのインデックスを返します。
-
addActiveCellRange
- .addActiveCellRange( range:ig.spreadsheet.SpreadsheetCellRange, activeCell:ig.spreadsheet.SpreadsheetCell, [extendRangeForMergedCells:boolean] );
指定のセルに新しいセル範囲を追加しセルをアクティブ セルにします。
- range
- タイプ:ig.spreadsheet.SpreadsheetCellRange
- 追加される新規の範囲。
- activeCell
- タイプ:ig.spreadsheet.SpreadsheetCell
- 新しい選択が追加される新しいアクティブ セル。範囲内のセルである必要があります。
- extendRangeForMergedCells
- タイプ:boolean
- オプション
- True に設定し範囲が交差している結合セルを含むように調整します。そうでない場合は False に設定し範囲をそのまま使用します。
例外
例外 説明 ig.ArgumentException activeCell が指定の範囲内にある必要があります。 -
addActiveCellRange
- .addActiveCellRange( rangeAddress:string, activeCellAddress:string, [extendRangeForMergedCells:boolean] );
指定のセルに新しいセル範囲を追加しセルをアクティブ セルにします。
- rangeAddress
- タイプ:string
- 追加する範囲の新しい A1 アドレス。
- activeCellAddress
- タイプ:string
- 新しい選択が追加される新しいアクティブ セルの A1 アドレス。rangeAddress 内のセルである必要があります。
- extendRangeForMergedCells
- タイプ:boolean
- オプション
- True に設定し範囲が交差している結合セルを含むように調整します。そうでない場合は False に設定し範囲をそのまま使用します。
例外
例外 説明 ig.ArgumentException activeCell が指定の範囲内にある必要があります。 -
addCellRange
- .addCellRange( range:ig.spreadsheet.SpreadsheetCellRange, [extendRangeForMergedCells:boolean] );
SpreadsheetSelection.cellRanges の終わりに新しい範囲を追加します。
- range
- タイプ:ig.spreadsheet.SpreadsheetCellRange
- 追加する範囲。
- extendRangeForMergedCells
- タイプ:boolean
- オプション
- True に設定し範囲が交差している結合セルを含むように調整します。そうでない場合は False に設定し範囲をそのまま使用します。
-
addCellRange
- .addCellRange( rangeAddress:string, [extendRangeForMergedCells:boolean] );
SpreadsheetSelection.cellRanges の終わりに新しい範囲を追加します。
- rangeAddress
- タイプ:string
- 追加する範囲の A1 アドレス。
- extendRangeForMergedCells
- タイプ:boolean
- オプション
- True に設定し範囲が交差している結合セルを含むように調整します。そうでない場合は False に設定し範囲をそのまま使用します。
-
cellRanges
- .cellRanges( );
選択されたセルの範囲の読み取り専用のコレクションを返します。
-
cellRangesAddress
- .cellRangesAddress( );
A1 セル参照モードでセル範囲を含む文字列を返します。
備考
複数の範囲がある場合、デフォルトの共用体演算子 (',') で区切られます。
-
cellRangesAddress
- .cellRangesAddress( value:string );
A1 セル参照モードでセル範囲を含む文字列を返します。
- value
- タイプ:string
備考
複数の範囲がある場合、デフォルトの共用体演算子 (',') で区切られます。
-
clearCellRanges
- .clearCellRanges( );
SpreadsheetSelection.cellRanges を SpreadsheetSelection.activeCell のみを含む単一の範囲にリセットします。
-
replaceActiveCellRange
- .replaceActiveCellRange( range:ig.spreadsheet.SpreadsheetCellRange, activeCell:ig.spreadsheet.SpreadsheetCell, [extendRangeForMergedCells:boolean] );
- 返却型:
- boolean
- 返却型の説明:
- アクションが実行されたかどうかを示すブール値。
SpreadsheetSelection.activeCell を含む範囲を指定の範囲で置き換えます。指定のセルを新しい SpreadsheetSelection.activeCell として使用します。
- range
- タイプ:ig.spreadsheet.SpreadsheetCellRange
- SpreadsheetSelection.activeCellRangeIndex インデックスで範囲を置き換える新しい範囲。
- activeCell
- タイプ:ig.spreadsheet.SpreadsheetCell
- この範囲内での新しいアクティブ セル。
- extendRangeForMergedCells
- タイプ:boolean
- オプション
- True に設定し範囲が交差している結合セルを含むように調整します。そうでない場合は False に設定し範囲をそのまま使用します。
例外
例外 説明 ig.ArgumentException activeCell が指定の範囲内にある必要があります。 -
replaceActiveCellRange
- .replaceActiveCellRange( rangeAddress:string, activeCellAddress:string, [extendRangeForMergedCells:boolean] );
- 返却型:
- boolean
- 返却型の説明:
- アクションが実行されたかどうかを示すブール値。
SpreadsheetSelection.activeCell を含む範囲を指定の範囲で置き換えます。指定のセルを新しい SpreadsheetSelection.activeCell として使用します。
- rangeAddress
- タイプ:string
- SpreadsheetSelection.activeCellRangeIndex インデックスで範囲を置き換える新しい範囲の A1 アドレス。
- activeCellAddress
- タイプ:string
- この範囲内での新しいアクティブ セルの A1 アドレス。
- extendRangeForMergedCells
- タイプ:boolean
- オプション
- True に設定し範囲が交差している結合セルを含むように調整します。そうでない場合は False に設定し範囲をそのまま使用します。
例外
例外 説明 ig.ArgumentException activeCell が指定の範囲内にある必要があります。 -
resetSelection
- .resetSelection( ranges:ig.spreadsheet.SpreadsheetCellRange[], activeCell:ig.spreadsheet.SpreadsheetCell, newActiveRangeIndex:number, [extendRangeForMergedCells:boolean] );
現在の選択範囲をクリアし指定の情報を用いて選択を再初期化します。
- ranges
- タイプ:ig.spreadsheet.SpreadsheetCellRange[]
- 新しい選択範囲。範囲は少なくても 1 つがある必要があります。
- activeCell
- タイプ:ig.spreadsheet.SpreadsheetCell
- SpreadsheetSelection.activeCell で使用するセル。指定の範囲内にある必要があります。
- newActiveRangeIndex
- タイプ:number
- アクティブ セルを含む範囲のインデックス。
- extendRangeForMergedCells
- タイプ:boolean
- オプション
- True に設定し範囲が交差している結合セルを含むように調整します。そうでない場合は False に設定し範囲をそのまま使用します。
例外
例外 説明 ig.ArgumentNullException 範囲は Null に設定できません。 ig.ArgumentException 範囲は 0 の長さ配列に設定できません。 ig.ArgumentException 範囲は 0 の長さ配列に設定できません。 ig.ArgumentOutOfRangeException newActiveRangeIndex が指定の範囲内にあるインデックスである必要があります。 -
resetSelection
- .resetSelection( range:ig.spreadsheet.SpreadsheetCellRange, activeCell:ig.spreadsheet.SpreadsheetCell, [extendRangeForMergedCells:boolean] );
現在の選択範囲をクリアし指定の情報を用いて選択を再初期化します。
- range
- タイプ:ig.spreadsheet.SpreadsheetCellRange
- 新しい選択範囲。
- activeCell
- タイプ:ig.spreadsheet.SpreadsheetCell
- SpreadsheetSelection.activeCell で使用するセル。指定の範囲内にある必要があります。
- extendRangeForMergedCells
- タイプ:boolean
- オプション
- True に設定し範囲が交差している結合セルを含むように調整します。そうでない場合は False に設定し範囲をそのまま使用します。
例外
例外 説明 ig.ArgumentException 範囲は 0 の長さ配列に設定できません。 -
resetSelection
- .resetSelection( rangesAddress:string, activeCellAddress:string, newActiveRangeIndex:number, [extendRangeForMergedCells:boolean] );
現在の選択範囲をクリアし指定の情報を用いて選択を再初期化します。
- rangesAddress
- タイプ:string
- 新しい選択範囲。範囲は少なくても 1 つがある必要があります。
- activeCellAddress
- タイプ:string
- SpreadsheetSelection.activeCell で使用するセル。指定の rangesAddress 内にある必要があります。
- newActiveRangeIndex
- タイプ:number
- アクティブ セルを含む範囲のインデックス。
- extendRangeForMergedCells
- タイプ:boolean
- オプション
- True に設定し範囲が交差している結合セルを含むように調整します。そうでない場合は False に設定し範囲をそのまま使用します。
例外
例外 説明 ig.ArgumentException 範囲は 0 の長さ配列に設定できません。 ig.ArgumentException 範囲は 0 の長さ配列に設定できません。 ig.ArgumentOutOfRangeException newActiveRangeIndex が指定の範囲内にあるインデックスである必要があります。 -
setActiveCell
- .setActiveCell( cell:ig.spreadsheet.SpreadsheetCell, [rangeIndex:number] );
SpreadsheetSelection.activeCell と SpreadsheetSelection.activeCellRangeIndex を指定した値に更新します。
- cell
- タイプ:ig.spreadsheet.SpreadsheetCell
- アクティブ セルに変更する選択セル。
- rangeIndex
- タイプ:number
- オプション
- 指定のセルを含む SpreadsheetSelection.cellRanges の範囲インデックス (オプション)。
-
setActiveCell
- .setActiveCell( cellAddress:string, [rangeIndex:number] );
SpreadsheetSelection.activeCell と SpreadsheetSelection.activeCellRangeIndex を指定した値に更新します。
- cellAddress
- タイプ:string
- アクティブ セルに変更する選択セルの A1 アドレス。
- rangeIndex
- タイプ:number
- オプション
- 指定のセルを含む SpreadsheetSelection.cellRanges の範囲インデックス (オプション)。
-
unselectRange
- .unselectRange( range:ig.spreadsheet.SpreadsheetCellRange );
指定した範囲にあるセルを選択解除します。
- range
- タイプ:ig.spreadsheet.SpreadsheetCellRange
- セルが選択から解除する範囲。
備考
注: 指定した範囲が選択のすべてのセルを含む場合、選択は現在の SpreadsheetSelection.activeCell のみを含むために変更されます。