<< Return to Main Index

< Return to Class Index

CGXGridCore::SetCoveredCellsRowCol

virtual BOOL SetCoveredCellsRowCol(ROWCOL nRow, ROWCOL nCol, ROWCOL nToRow, ROWCOL nToCol, UINT flags = GX_UPDATENOW, GXCmdType ctCmd = gxDo);

nRow

Specifies the row id for the cell.

nCol

Specifies the column id for the cell.

nToRow

Specifies the last row to cover.

nToCol

Specifies the last column to cover.

flags

Specifies the update technique. See UpdateCoveredCellsRowCol for more information.

ctCmd

Specifies if the executed command is undone (gxUndo), redone (gxRedo), executed the first time (gxDo) or rolled back (gxRollback).

Return Value

TRUE if the command has been successfully executed; it is FALSE if the command failed or if you tried to cover a range of cells which overlaps an already covered range of cells.

Remarks

Overridable command for setting the covered cells-range for a cell. To ‘cover’ cells means that one cell can span severals cells (e.g., to display big headlines).  To remove a covered range, call this method with only the top-left cell of the original covered range.

Covered cells are stored with a call to StoreCoveredCellsRowCol. The display is updated with UpdateCoveredCellsRowCol.

The command generates a CGXSetCoveredCellsCmd-object with undo-information.

Please note that the parameter-object maintains a list of ranges with the covered cells. It makes no sense to override StoreCoveredCellsRowCol and store the covered cells anywhere else.

Control-Factory Specific ->

This method has been implemented using the abstraction mechanism as discussed in the chapter "Reducing the size of your application" in the user's guide. A call to the ImplementCoveredCells method from within the control factory class' InitializeGridComponents method will make the concrete implementation of this method available to your application.

If no concrete implementation is available this method returns FALSE. A warning will be displayed in the debug window.

END Control-Factory Specific

See Also

CGXGridCore::GetCoveredCellsRowCol CGXGridCore::UpdateCoveredCellsRowCol CGXGridParam::GetCoveredCellsList CGXGridCore::LockUpdate

CGXGridCore

Class Overview | Class Members