Professional User Interface Suite, Copyright FOSS Software Inc. Help Published with Permission.

Properties

m_dwDefaultScrollTypeH �Specifies the default horizontal scrolling type and is used for resetting the scrolling strategy when switching from the virtual to non-virtual scrolling in the ColumnCountSet() method.
m_dwDefaultScrollTypeV Specifies the default vertical scrolling type and is used for resetting the scrolling strategy when switching from the virtual to non-virtual scrolling in the RowCountSet() method.
m_dwSupportedAccelCommands Specifies standard accelerator commands enabled for the grid (a combination of the __EGSA_*** flags). The default value is zero.
m_hCursorBtnDown Specifies a default mouse pointer over the bottom part of the up-down button built into the cell.
m_hCursorBtnDropdown Specifies a default mouse pointer over the drop-down button built into the cell.
m_hCursorBtnEllipsis Specifies a default mouse pointer over the ellipsis button built into the cell.
m_hCursorBtnUp Specifies a default mouse pointer over the top part of the up-down button built into the cell.
m_hCursorCheckBox Specifies a default mouse pointer over check boxes in the cell.
m_hCursorDefault Specifies a default mouse pointer over the grid window.
m_hCursorFocusArrow Specifies a default mouse pointer over the focus arrow in the outer cell which marks a position of the focused cell.
m_hCursorIcon Specifies a default mouse pointer over the icon area of a cell.
m_hCursorInnerCell �Specifies a default mouse pointer over the inner cells.
m_hCursorOuterSelectionBottom Specifies a default mouse pointer over those outer cells at bottom, which are used for selecting columns.
m_hCursorOuterSelectionLeft Specifies a default mouse pointer over those outer cells on left, which are used for selecting rows.
m_hCursorOuterSelectionRight Specifies a default mouse pointer over those outer cells on right, which are used for selecting rows.
m_hCursorOuterSelectionTop Specifies a default mouse pointer over those outer cells at top, which are used for selecting columns.
m_hCursorResizingH Specifies a default mouse pointer over the vertical border (between cells) used for resizing columns.
m_hCursorResizingV Specifies a default mouse pointer over the horizontal border (between cells) used for resizing rows.
m_hCursorSortArrow Specifies a default mouse pointer over the arrow area of outer cells used for sorting.
m_nMouseActivateCode Specifies a value returned from the WM_MOUSEACTIVATE message handler. By default, it is to MA_ACTIVATE.
m_rcDefaultCellBorderHtSpaces Specifies a rectangle object that defines values in pixels used for calculating the cell border areas and for performing hit-testing.

Classes

~CExtGridBaseWnd Destructor.
AutoFocusBottomRightGet Returns true if the focus should be automatically set on the right bottom cell of the latest selected region in the grid control.
AutoFocusBottomRightSet Sets the boolean flag which specifies whether the focus should be automatically set on the right bottom cell of the latest selected region in the grid control and returns the previous value of the flag.
CExtGridBaseWnd Default constructor.
ColumnAdd Appends a specified number of columns and returns true if the columns have been added successfully.
ColumnCountGet Returns a number of the columns in the grid control. The method returns -1L if the horizontal scrolling strategy is virtual.
ColumnCountSet Sets the number of columns in the grid control and returns the previous number of columns.
ColumnInsert Inserts a specified number of columns into the grid control and returns true if the columns have been inserted successfully.
ColumnRemove Removes a specified number of columns from the grid control and returns the number of removed columns.
ColumnRemoveAll Removes all columns from the grid control and returns the number of removed columns.
ColumnTruncate Truncates columns starting at a specified column.
DefaultColumnWidthGet Returns the default width of columns in pixels. This value makes sense when all columns have an equal width.
DefaultColumnWidthSet Sets the default width of columns in pixels. This value makes sense when all columns have an equal width.
DefaultRowHeightGet Returns the default height of rows in pixels. This value makes sense when all rows have an equal height.
DefaultRowHeightSet Sets the default height of rows in pixels. This value makes sense when all rows have an equal height.
EditCell Activates the in-place editor control for a specified cell and returns true if the editor window has been created and displayed successfully. The default parameters are set in a way to start editing the focused cell.
EnableExpanding Enables/disables the contents pop-up window for grid cells. Such a tooltip-like window shows the cell contents for a partially visible grid cell.
EnableTooltips Enables/disables tooltips that display the grid cell contents.
EnsureVisibleColumn Call this method to ensure that a specified column is visible. The method scrolls the contents of the grid window if needed and returns true if the column has been successfully displayed on the visible page.
EnsureVisibleRow �Call this method to ensure that a specified row is visible. The method scrolls the contents of the grid window if needed and returns true if the row has been successfully displayed on the visible page.
ExpandShadowSizeGet Returns the number of pixels used for drawing the shadow in the contents pop-up window.
ExpandShadowSizeSet Sets the number of pixels used for drawing the shadow in the contents pop-up window and returns the previous value.
FixedSizeColumnsGet Returns true if all columns in the grid control have an equal width.
FixedSizeColumnsSet Sets a boolean flag that specifies whether all columns in the grid control have an equal width and returns the previous value of the flag.
FixedSizeRowsGet Returns true if all rows in the grid control have an equal height.
FixedSizeRowsSet Sets a boolean flag that specifies whether all row in the grid control have an equal height and returns the previous value of the flag.
FocusGet Returns a CPoint object that specifies the location of the focused cell. If CPoint::x and CPoint::y members are less than zero, there is no focused cell at the moment. The CPoint::y value is also used to detect the focused row when the full row selection type is applied. The CPoint::x value is also used to detect the focused column when the full column selection type is applied.
FocusHighlightColumnInnerGet Returns true if all visible inner cells in the column that contains the focused cell are highlighted.
FocusHighlightColumnOuterGet Returns true if all visible outer cells in the column that contains the focused cell are highlighted.
FocusHighlightRowInnerGet Returns true if all visible inner cells in the row that contains the focused cell are highlighted.
FocusHighlightRowOuterGet Returns true if all visible outer cells in the row that contains the focused cell are highlighted.
FocusHighlightSet Enables or disables highlighting for inner/outer cells in the column/row that contains the focused cell.
FocusSet Assigns focus to a specified item in the grid control. The item may be a single cell, row, or column, which depends on the selection type applied. If both ptNewFocus.x and ptNewFocus.y values are less than zero, the item will lose focus. The method returns the CPoint object that specifies the previously focused item.
FocusUnset Removes focus from the grid item. The item may be a single cell, row, or column, which depends on the selection type applied. The method returns the CPoint object that describes previously focused item.
FrozenColumnCountLeftGet Gets the number of frozen columns on the left.
FrozenColumnCountLeftSet Sets the number of frozen columns on the left.
FrozenColumnCountRightGet Gets the number of frozen columns on the right.
FrozenColumnCountRightSet Sets the number of frozen columns on the right.
FrozenRowCountBottomGet Gets the number of frozen rows at the bottom.
FrozenRowCountBottomSet Sets the number of frozen rows at the bottom.
FrozenRowCountTopGet Gets the number of frozen rows at the top.
FrozenRowCountTopSet Sets the number of frozen rows at the top.
GetContentExpandWnd Returns a reference to the contents pop-up window object which is used for displaying the contents of a partially visible cell.
GetSafeInplaceActiveHwnd Returns a handle of the in-place cell editor window. The method returns NULL if no in-place editing is performed.
GetToolTipCtrl Returns a reference to the tooltip control used for displaying cell tips.
GridLinesHorzGet Returns false if the horizontal gridlines are hidden.
GridLinesHorzSet Displays or hides the horizontal gridlines and returns the previous visibility state.
GridLinesVertGet Returns false if the vertical gridlines are hidden.
GridLinesVertSet Displays or hides the horizontal gridlines and returns the previous visibility state.
HitTest Performs hit testing and returns a reference to the object with information about the results of the hit test.
HoverEventsInnerGet Returns true if all visible objects associated with the inner cells are notified about mouse hover events.
HoverEventsOuterGet Returns true if all visible objects associated with the outer cells are notified about mouse hover events.
HoverEventsSet Enables or disables notification about mouse hover events to all visible objects associated with inner and outer cells.
HoverHighlightCellInnerGet Returns true if a visible inner cell in the grid control is highlighted when the mouse pointer hovers over it.
HoverHighlightCellOuterGet Returns true if a visible outer cell in the grid control is highlighted when the mouse pointer hovers over it.
HoverHighlightColumnInnerGet Returns true if all visible inner cells in the column that contains the cell which is hovered over are highlighted.
HoverHighlightColumnOuterGet Returns true if all visible outer cells in the column that contains the cell which is hovered over are highlighted.
HoverHighlightRowInnerGet Returns true if all visible inner cells in the row that contains the cell which is hovered over are highlighted.
HoverHighlightRowOuterGet Returns true if all visible outer cells in the row that contains the cell which is hovered over are highlighted.
HoverHighlightSet Enables and disables cell highlighting with mouse hover events.
HoverInfoGet Returns a reference to the object with information about the results of the hit test. This object describes the current hover state of the mouse pointer.
LbExtSelectionGet Returns true the selection by pressing and holding the mouse and dragging the mouse over cells is enabled.
LbExtSelectionSet Enables/disables the selection by pressing and holding the mouse and dragging the mouse over cells and returns the previous mode of this type of selection.
MultiAreaSelectionGet Returns true if multiple selection is enabled.
MultiAreaSelectionSet Enables or disables multiple selection. Such type of selection allows the user to select more than one rectangular region.
NoHideSelectionGet Returns true if the grid control always shows selection, if any, even if it does not have focus.
NoHideSelectionSet Enables or disables showing selection for the grid control that does not have focus and returns the previous mode of showing selection.
OuterColumnCountLeftGet Returns a number of outer columns on left.
OuterColumnCountLeftSet Sets a number of outer columns on left and returns the previous value.
OuterColumnCountRightGet Returns number of outer header columns on the right.
OuterColumnCountRightSet Sets a number of outer columns on right. The method returns the previous value.
OuterColumnWidthGet Returns a width in pixels of the outer column on the left/right.
OuterColumnWidthSet Sets the width in pixels of the outer column on left/right.
OuterExtentsClearAll Resets all the widths of the outer columns and/or heights of the outer rows.
OuterRowCountBottomGet Returns the number of the outer rows at bottom.
OuterRowCountBottomSet Sets the number of outer the rows at bottom and returns the previous number of rows.
OuterRowCountTopGet Returns the number of the outer rows at top.
OuterRowCountTopSet Sets the number of the outer rows at top. The method returns the previous number of rows at top.
OuterRowHeightGet Returns the height, in pixels, of the outer row at top/bottom.
OuterRowHeightSet Sets the height, in pixels, of the outer row at top/bottom.
RowAdd Appends a specified number of rows to the grid control and returns true if the specified number of rows have been successfully added.
RowCountGet Returns the number of rows in the grid control. The method returns -1L if the vertical scrolling strategy is virtual.
RowCountSet Sets the number of rows in the grid control and returns the previous number of rows.
RowInsert Inserts a specified number of rows into the grid control and returns true if the specified number of rows have been successfully inserted.
RowRemove Removes a specified number of rows from the grid control and returns the number of removed rows.
RowRemoveAll Removes all the rows from the grid control and returns the number of removed rows.
RowTruncate Truncates a specified number of rows in the grid control (i.e. removes all rows up to the end).
SelectionGet Returns a rectangle part of the current selected region or normalized union of all areas.
SelectionGetAreaCount Returns a number of the rectangles in the current selection region.
SelectionGetFirstColumnInRow Returns an index of the first/left selected column in the specified row. The method returns -1 if there are no selected cells in the row.
SelectionGetFirstRowInColumn Returns an index of the first/top selected row in the specified column. The method returns -1 if there are no selected cells in the column.
SelectionGetForCell Returns true if the cell at the specified position is inside the current selection region.
SelectionGetForCellNextPrev Returns an index of the next selected cell in the same column/row or -1 if no selected cell is found.
SelectionGetHitCount Returns a number of the rectangles which cover the specified inner cell.
SelectionGetLastColumnInRow Returns an index of the last/right selected column in the specified row. The method returns -1 if no selected cells in the row are found.
SelectionGetLastRowInColumn Returns an index of the last/bottom selected row in the specified column. The method returns -1 if no selected cells in this column are found.
SelectionGetNextColumnInRow Returns an index of the next selected column, which is greater than nColNo, in the nRowNo row. The method returns -1 if no selected cells are found.
SelectionGetNextRowInColumn Returns an index of the next selected row, which is greater than nRowNo, in the nColNo column. The method returns -1 if no selected cells are found.
SelectionGetPrevColumnInRow Returns an index of the next column (which is less than nColNo) selected to the left in the nRowNo row. The method returns -1 if no selected cells are found.
SelectionGetPrevRowInColumn Returns an index of the next row (which is less than nRowNo) selected to the right in the column with nColNo index. The method returns -1 if no selected cells are found.
SelectionHighlightColumnInnerGet Returns true if all the visible inner cells in a column are highlighted when at least one cell is selected in the same column.
SelectionHighlightColumnOuterGet Returns true if all the visible outer cells are highlighted in a column when at least one cell is selected in the same column.
SelectionHighlightRowInnerGet Returns true if all the visible inner cells are highlighted in a row when at least one cell is selected in the same row.
SelectionHighlightRowOuterGet Returns true if all the visible outer cells are highlighted in a row when at least one cell is selected in the same row.
SelectionHighlightSet Enables or disables the highlighting of the inner/outer cells that have at least one selected cell in the same row or in the same column.
SelectionInsertAt Inserts a new rectangle into the current selection region and returns true if the new rectangle has been successfully inserted. May return false if the OnGbwSelectionCanModify() virtual method disables modification of the current selection region.
SelectionIsEmpty Returns true if the current selection region does not contain rectangles which specify selected areas.
SelectionOptimize Optimizes the selection region by joining neighborhood selection rectangles. Returns true if at least one pair of rectangles was joined.
SelectionRangeGet Get the selected cells.
SelectionRangeSet Makes the specified cells selected and returns true if the selection was set or false otherwise.
SelectionRemoveAt Removes a rectangle from the current selection region. The method returns true if the rectangle has been successfully removed. May return false if the OnGbwSelectionCanModify() virtual method disables modification of the current selection region.
SelectionSet Modifies the current selection region. The method returns true if the current selection region has been successfully changed according to the specified parameters. May return false if the OnGbwSelectionCanModify() virtual method disables modification of the current selection region.
SelectionSetAt Replaces a rectangle in the current selection region. The method returns true if the current selection region has been successfully changed according to the specified parameters. The method returns false if the OnGbwSelectionCanModify() virtual method disables modification of the current selection region or if the nAreaNumber is an invalid index of the rectangle inside the current selection region.
SelectionSplitAllAreas Splits all rectangles in the current selection region into a number of the single row and/or single column rectangles. The updated region covers the same selection but may contain a lager number of rectangles.
SelectionTypeGet Returns the current selection type used in the grid control. The returned value is a subset of basic scrolling window styles returned by the CExtScrollItemWnd::SiwGetStyle() method, which includes only the styles which fit into the __EGBS_SF_MASK mask. The one of the following values describes the basic selection type: __EGBS_SFB_NONE, __EGBS_SFB_CELLS, __EGBS_SFB_FULL_ROWS, and __EGBS_SFB_FULL_COLUMNS. The returned value may also contain any of the __EGBS_SFM_* flags which allow multiply cells, columns or rows be selected.
SelectionTypeSet Sets a new selection type and returns the previous selection type.
SelectionUnset Makes the region which specifies the current selection empty or equal to the focused item which is a cell, row, or column depending on the selection type used.
SubtractSelectionAreasGet Returns true if any grid area that is covered by the even number of rectangles specifying the currently selected region should be interpreted as a non-selected area.
SubtractSelectionAreasSet Enables/disables the rectangle subtraction in the selection region and returns the previous value of the option.

Overridables

OnGbwAccelCommand Called for handing or updating the state of the standard accelerator command. The method returns true if the command handing or updating query was processed or false otherwise.
OnGbwAdjustRects Called to adjust the cell rectangles. By overriding this method you can implement overlapped cells.
OnGbwAnalyzeCellKeyEvent Called when a key is pressed or released while the grid window has focus. The method returns true if the grid control has handled this event.
OnGbwAnalyzeCellMouseClickEvent Called when the left, middle, or right mouse button is pressed, released, or double clicked. The method returns true if the grid control has handled this event.
OnGbwBeginEdit Called to activate an in-place editor for the specified cell. The method returns true if the editor window has been successfully created.
OnGbwCalcVisibleItemRect Called to calculate rectangular areas that describe the location of the visible cell. The method returns true if succeeded.
OnGbwCanResizeColumn Called to detect whether the specified column can be resized and to query the minimum and maximum width of the column in pixels. The method returns true if the column can be resized.
OnGbwCanResizeRow Called to detect whether the specified row can be resized and to query the minimum and maximum height of the row in pixels. The method returns true if the row can be resized.
OnGbwCellJoinAdjustCoordinates Returns true if a cell belongs to a range of merged cells and the cell is not topmost and leftmost in this range. In this case the method also modifies its nColNo and nRow parameters by changing its values to the position of the cell relative to the topmost and leftmost cell in the range. The method returns false otherwise.
OnGbwCellJoinQueryInfo Returns a CSize object that describes how a cell is merged with its neighboring cells.
OnGbwContentTip Called to display content tip over grid cell. Returns true if content tip was displayed. Returns false otherwise.
OnGbwContentTipCancel Called to hide the content tip window.
OnGbwContentTipWndGet Called to reference to the tooltip window which should display content tips.
OnGbwDataDndCanStart Called to detect whether the specified inner data cell be drag-n-dropped and returns true if so or false otherwise.
OnGbwDataDndDo Called to drag-and-drop the inner data cell.
OnGbwDataDndGetStartOffset Called to calculate an offset, in pixels, which is used to detect the event when drag-and-drop of one or more data cells starts.
OnGbwDataDndIsAllowed Called to get the flag indicating whether drag-and-drop of one or more data cells is allowed.
OnGbwEraseArea Called to erase background of the specified area of the grid.
OnGbwExpand Called to display the contents pop-up window for the cell. The method returns true if the window has been displayed successfully.
OnGbwFocusChanged Called when the focused item has been changed. The x members of the POINT objects should not be analyzed if the grid control uses the full-row selection type. The y members of the POINT objects should not be analyzed if the grid control uses the full-column selection type. If both x and y are negative, the POINT structure describes the grid control with no currently focused item.
OnGbwFocusChanging Called to customize the process of changing the focus between cells. The method returns true if the focus change is enabled. The x members of the POINT objects should not be analyzed if the grid control uses the full-row selection type. The y members of the POINT objects should not be analyzed if the grid control uses the full-column selection type. If both x and y are negative, the POINT structure describes the grid control with no currently focused item.
OnGbwHoverCell Called when the mouse pointer hovers over the grid items. The method allows you to detect the mouse enter event and mouse leave event for any grid item.
OnGbwHoverRecalc Called to recalculate the currently hovered grid item. The method returns true if succeeded.
OnGbwHoverRemove Called to remove the hovered state of the grid item that may be currently hovered by the mouse pointer.
OnGbwPaintCell Called to paint any grid cell.
OnGbwPaintExpandedItemContent Called to paint the contents of the client area of the contents pop-up window, which usually displays the cell text. The method returns true if succeeded.
OnGbwPaintExtraSpaceH Called to paint the extra space above and/or below the visible row. The extra space may be used for previewing data like previewing e-mail messages in the Microsoft Outlook grid control. The method is called twice. At first the bPostPaint parameter is set to false and the data cells in the row are not yet painted. The second time the method is called, the bPostPaint parameter is set to true and the data cells in the row are painted. This method may be used to paint the custom background of the visible part of the row. The extra space may be used for painting something (e.g. some data) relating to the entire row.
OnGbwPaintExtraSpaceV Called to paint the extra space on the left and/or on the right of the visible column. The extra space may be used for previewing data like previewing e-mail messages in the Microsoft Outlook grid control. The method is called twice. At first the bPostPaint parameter is set to false and the data cells in the column are not yet painted. The second time the method is called, the bPostPaint parameter is set to true and the data cells in the column are painted. This method may be used to paint the custom background of the visible part of the column. The extra space may be used for painting something (e.g. some data) relating to the entire column.
OnGbwProcessVkBeginEdit Called to activate an in-place editor of the grid item when the nChar key is pressed. The method returns true if succeeded.
OnGbwQueryBackColor Called to query the background color of the cell at the specified location. The method returns a background color of the cell or COLORREF(-1L) value if the grid painting algorithm uses the default background color.
OnGbwQueryCellBorderHtSpaces Called to get the sizes of the cell borders. The returned value contains the sizes of the left, right, top, and bottom borders in pixels.
OnGbwQueryCellGridLines Called to query whether horizontal or vertical grid lines should be painted around the specified cell location. The default implementation calls the CExtGridBaseWnd::GridLinesHorzGet() or CExtGridBaseWnd::GridLinesVertGet() methods that depends on the bHorz argument.
OnGbwQueryPixelColumnOffset Called to get the total width, in pixels, of all the columns with indices less than nColNo. The returned value is a distance between the specified column and the left side of the first left column.
OnGbwQueryPixelRowOffset Called to get the total height, in pixels, of all the rows with indices less than nRowNo. The returned value is a distance between the specified row and the top side of the first top row.
OnGbwQuerySupportedAccelCommands Called to get a set of enabled standard commands (a set of __EGSA_*** flags).
OnGbwQueryTrackingCellMenu Called to get a boolean value that indicates that any cell in the grid control tracks the context menu if it is true.
OnGbwQueryVisibleColumnRange Called to get the indices of the first/last visible columns and an offset, in pixels, between the first visible column on the left and the left border of client area.
OnGbwQueryVisibleRowRange Called to get the indices of the first/last visible row and an offset, in pixels, of the first visible row from the top border of the client area.
OnGbwResizingAdjustHtInfo Called when column resizing is about to start or currently occurring.
OnGbwResizingStateApply Called to apply the new width of the column or height of the row when the user finishes resizing the column or row by drag-and-dropping the border area between two outer cells.
OnGbwResizingStateUpdate Called during resizing the column/row by drag-and-dropping the border area between two outer cells. If the bInitial parameter is set to true, the method initializes the resizing algorithm. If the bFinal parameter is set to true, the method uninitializes the resizing algorithm. If both bInitial and bFinal are set to false, the mouse pointer position has changed and the resizing algorithm should move the tracking line to the new position or change the width of the column or height of the row.
OnGbwSelectionCanModify Called to get a boolean value which indicates that the selection region can be changed if it is true.
OnGbwSelectionChanged Called when the selection region has been changed.
OnGbwSetCursor Called to change the mouse cursor. The method returns true if the new cursor has been successfully set.
OnGbwTooltip Called to initialize the tooltip for the grid item.
OnGbwWalkVisibleAreas Called to perform passing around all the visible items of the grid control. If the dc parameter has an valid HDC handle, the method is called so that all internal objects paint their contents; if the pHT parameter is not NULL, the method is called to allow all internal objects adjust the CExtGridHitTestInfo members.

See Also

CExtGridBaseWnd Overview | Hierarchy Chart