<< Return to Main Index

< Return to Class Index

CGXGridCore::HideRows

virtual BOOL HideRows(ROWCOL nFromRow, ROWCOL nToRow, BOOL bHide = TRUE, BOOL* abHideArray = NULL, UINT flags = GX_UPDATENOW, GXCmdType ctCmd = gxDo);

nFromRow

Specifies the first row.

nToRow

Specifies the last row.

bHide

Specifies the visible-flag for all rows.

abHideArray

An optional pointer to an array with the visible-flags for the specified cells. If it is NULL, bHide is used for all cells.

flags

Specifies the update technique. See UpdateChangedRowHeights 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 the user aborted the operation.

Remarks

Overridable command for specifying the visible-flag for specific rows.

Visible-flags are stored with a call to StoreHideRow for each row. The display is updated with UpdateChangedRowHeights.

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

The user can abort the operation.

When the user tracks the size of a row to zero, the row will be hidden. If the user double-clicks on the grid-line of a hidden row or resizes the row using the special cursor, the row will be restored.

To prevent the user from resizing hidden row, override OnTrackRowHeight.  Check for IsRowHidden() and return FALSE when the row is hidden (IsRowHidden returns TRUE).

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 ImplementHideCells 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::StoreHideRow CGXGridCore::IsRowHidden CGXGridCore::UpdateChangedRowHeights CGXGridCore::LockUpdate

CGXGridCore

Class Overview | Class Members