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

Properties

m_hCursorOuterDragCancel Specifies the cursor handle that is used when dragging the header cell over to a position beyond the header column/row area.
m_hCursorOuterDragOK Specifies the cursor handle that is used when dragging the header cell over to a position where it can be dropped.
m_hGlobalCachedRange Specifies the HGLOBAL global memory handle which is used by the CExtGridBaseWnd::OnGbwAccelCommand() virtual method invoked with the __EGSA_SELECTED_RANGE_LOAD or __EGSA_SELECTED_RANGE_SAVE value in parameters. The CExtGridBaseWnd::OnGbwAccelCommand() virtual method invoked with these values in parameters performs loading or saving of the selected cell region and all the cell objects in it.

Classes

AdvGetStyle Returns the current style specified by a combination of __EGWS_ADV_* constants.
AdvModifyStyle Modifies the current style specified by a combination of __EGWS_ADV_* constants.
~CExtGridWnd Destructor.
BestFitColumn Makes the column width wide enough to fit the longest cell content and returns true if successful or false otherwise.
BestFitRow Makes the row high enough to fit the cell content with the largest height and returns true if successful or false otherwise.
BseGetStyle Returns the current style specified by a combination of the basic __EGWS_BSE_* constants.
BseGetStyleEx �Returns the current style specified by a combination of the extended __EGWS_BSE_EX_* constants.
BseModifyStyle Modifies the current style specified by a combination of the basic __EGWS_BSE_* constants.
BseModifyStyleEx Modifies the current style specified by a combination of the basic __EGWS_BSE_EX_* constants.
CExtGridWnd Default constructor.
ColumnCountGet Returns the number of columns.
ColumnInsert Inserts a specified number of columns and returns true if succeeded.
ColumnRemove Removes a specified number of columns and returns true if succeeded.
ExternalDataGet Returns true if the grid control requests the size of the displayed data from the data provider. The external data mode is used in cashable data views like the database recordset view. The simple data mode is used in memory grids.
ExternalDataSet Sets or resets the external data mode for the grid control. The external data mode is used in cashable data views like the database recordset view. The simple data mode is used in memory grids.
GridCellGet Returns a pointer to the cell object at a specified location. The returned value may specify an inner cell object or an outer cell object, or be equal to NULL. The first two prototypes use column/row indices and types to specify the location. The latter two use the hit-test object which holds both column/row indices and types. If there is no object associated with the cell, the method allows you to assign a new object for this cell in two ways. The first is to set the pInitRTC pointer to the runtime class object for the required cell type. The alternative way is to set the bAutoFindValue to true (pInitRTC should be NULL). In this case, the new cell object will be copied from the default object associated with the given row or column.
GridCellGetOuterAtBottom Returns a pointer to the cell object at a specified location inside the outer area at bottom. If there is no object associated with the cell, the method allows you to assign a new object for this cell in two ways. The first is to set the pInitRTC pointer to the runtime class object for the required cell type. The alternative way is to set the bAutoFindValue to true (pInitRTC should be NULL). In this case, the new cell object will be copied from the default object associated with the given row or column.
GridCellGetOuterAtLeft Returns a pointer to the cell object at a specified location inside the outer area on left. If there is no object associated with the cell, the method allows you to assign a new object for this cell in two ways. The first is to set the pInitRTC pointer to the runtime class object for the required cell type. The alternative way is to set the bAutoFindValue to true (pInitRTC should be NULL). In this case, the new cell object will be copied from the default object associated with the given row or column.
GridCellGetOuterAtRight Returns a pointer to the cell object at a specified location inside the outer area on right. If there is no object associated with the cell, the method allows you to assign a new object for this cell in two ways. The first is to set the pInitRTC pointer to the runtime class object for the required cell type. The alternative way is to set the bAutoFindValue to true (pInitRTC should be NULL). In this case, the new cell object will be copied from the default object associated with the given row or column.
GridCellGetOuterAtTop Returns a pointer to the cell object at a specified location inside the outer area at top. If there is no object associated with the cell, the method allows you to assign a new object for this cell in two ways. The first is to set the pInitRTC pointer to the runtime class object for the required cell type. The alternative way is to set the bAutoFindValue to true (pInitRTC should be NULL). In this case, the new cell object will be copied from the default object associated with the given row or column.
GridCellJoinGet Returns a CSize object that describes how the cell is merged with its neighboring cells. The possible values and their meanings are given in this table.
GridCellJoinSet Sets how a cell is merged with it neighboring cells and returns true if succeeded or false otherwise.
GridCellJoinTest Checks if a cell can be merged with it neighboring cells and returns true if it can or false otherwise.
GridCellRectsGet Calculates a set of rectangles for a specified visible grid cell and returns true if succeeded.
GridCellSet Initialized or destroys cell objects at a specified location and returns true if succeeded.
GridCellSetOuterAtBottom Initialized or destroys cell objects at a specified location inside the outer area at bottom and returns true if succeeded.
GridCellSetOuterAtLeft Initialized or destroys cell objects at a specified location inside the outer area on left and returns true if succeeded.
GridCellSetOuterAtRight Initialized or destroys cell objects at a specified location inside the outer area on right and returns true if succeeded.
GridCellSetOuterAtTop Initialized or destroys cell objects at a specified location inside the outer area at top and returns true if succeeded.
GridClipboardFormatNameGet Returns the clipboard format name used by the grid control for the clipboard operations and drag-and-dropping of the inner data cells.
GridClipboardFormatNameSet Sets the clipboard format name used by the grid control for the clipboard operations and drag-and-dropping of the inner data cells.
GridColumnDefaultValueBind Binds or unbinds the default cell value to a column or to all columns in the grid control. The default value is the grid cell object used for the automatic initialization of cells.
GridColumnDefaultValueGet Returns the default cell value bound to a specified column or NULL if no default value is bound. The default value is the grid cell object used for the automatic initialization of cells.
GridColumnDefaultValueUnbind Unbinds the default value from a column or from all columns in the grid control. The default value is the grid cell object used for the automatic initialization of cells.
GridColumnDefaultValueUnbindAll Unbinds all the default values bound to the columns in the grid control.
GridEmptyAreaLinesHorzBottomGet Returns true if the horizontal gridlines are drawn in the data area at the bottom when there are no cells or false if the horizontal gridlines are not drawn.
GridEmptyAreaLinesHorzBottomSet Specifies if the horizontal gridlines are drawn in the data area at the bottom when there are no cells. The method returns the previous value of bGridLines.
GridEmptyAreaLinesHorzCornerGet Returns true if the horizontal gridlines are drawn in the data area at the bottom and on the right when there are no cells or false if the horizontal gridlines are not drawn.
GridEmptyAreaLinesHorzCornerSet Specifies if the horizontal gridlines are drawn in the data area at the bottom and on the right when there are no cells. The method returns the previous value of bGridLines.
GridEmptyAreaLinesHorzRightGet Returns true if the horizontal gridlines are drawn in the data area on the right when there are no cells or false if the horizontal gridlines are not drawn.
GridEmptyAreaLinesHorzRightSet Specifies if the horizontal gridlines are drawn in the data area on the right when there are no cells. The method returns the previous value of bGridLines.
GridEmptyAreaLinesVertBottomGet �Returns true if the vertical gridlines are drawn in the data area at the bottom when there are no cells or false if the vertical gridlines are not drawn.
GridEmptyAreaLinesVertBottomSet Specifies if the vertical gridlines are drawn in the data area at the bottom when there are no cells. The method returns the previous value of bGridLines.
GridEmptyAreaLinesVertCornerGet �Returns true if the vertical gridlines are drawn in the data area at the bottom and on the right when there are no cells or false if the vertical gridlines are not drawn.
GridEmptyAreaLinesVertCornerSet Specifies if the vertical gridlines are drawn in the data area at the bottom and on the right when there are no cells. The method returns the previous value of bGridLines.
GridEmptyAreaLinesVertRightGet Returns true if the vertical gridlines are drawn in the data area on the right when there are no cells or false if the vertical gridlines are not drawn.
GridEmptyAreaLinesVertRightSet Specifies if the vertical gridlines are drawn in the data area on the right when there are no cells. The method returns the previous value of bGridLines.
GridFontGetAt Returns the font handle by index or NULL there is no handle with the specified index.
GridFontGetCount Returns the number of additional font handles registered in the grid control with the CExtGridWnd::GridFontInsert() method. The method returns -1 if not additional font handles have been registered.
GridFontInsert Inserts a new font into the internal collection of custom fonts and returns an index of the inserted font or -1 if hFont is invalid or equal to NULL.
GridFontRemove Removes the specified font from the internal collection of custom fonts and returns the number of removed handles.
GridIconGetAt Returns a pointer to the icon object by index or NULL if there is no font with the specified index.
GridIconGetCount Returns the number of CExtCmdIcon objects registered in the grid control.
GridIconInsert Inserts a new icon into the internal collection of the icon objects and returns an index of the inserted object or -1 if pIcon is invalid or equal to NULL.
GridIconRemove Removes icon objects from the internal image collection and returns the number of removed objects.
GridRowDefaultValueBind Binds or unbinds the default cell value to a row or to all rows in the grid control. The default value is the grid cell object used for the automatic initialization of cells.
GridRowDefaultValueGet Returns the default cell value bound to a specified row or NULL if no default value is bound. The default value is the grid cell object used for the automatic initialization of cells.
GridRowDefaultValueUnbind Unbinds the default value from a row or from all rows in the grid control. The default value is the grid cell object used for the automatic initialization of cells.
GridRowDefaultValueUnbindAll Unbinds all the default values bound to the rows in the grid control.
GridSortOrderGet Requests information about the current sort order and returns false if sorting is not available in the data provider object attached to the grid control.
GridSortOrderSetup Modifies the sort order for columns or rows. The method allows you to set a new sort order, add indices to the current sort order, or change ascending/descending order for some indices in the existing sort order. It returns true if succeeded.
OuterColumnCountLeftGet Returns the number of outer columns on left.
OuterColumnCountLeftSet Sets the number of outer columns on left and returns the previous number of columns.
OuterColumnCountRightGet Returns the number of outer columns on right.
OuterColumnCountRightSet Sets the number of outer columns on right and returns the previous number of columns.
OuterRowCountBottomGet Returns the number of outer rows on bottom.
OuterRowCountBottomSet Sets the number of outer rows at bottom and returns the previous number of rows.
OuterRowCountTopGet Returns the number of outer rows on top.
OuterRowCountTopSet Sets the number of outer rows at top and returns the previous number of columns.
RowCountGet Returns the number of inner rows.
RowInsert Inserts one or more inner rows and returns true if succeeded.
RowRemove Removes one or more inner rows and returns true if succeeded.

Overridables

OnGridCalcOuterDropTarget Called to calculate the target location of the outer cell being dragged.
OnGridCellButtonPressing Called when the built-in button is about to be pressed (the user clicked it) but the button is not yet redrawn to correspond to the pressed state nor CExtGridWnd::OnGridCellButtonPressed() is called. You can override this method and return true in it to cancel button pressing.
OnGridCellButtonPressed Called when the built-in button is pressed. The method returns true to indicate that this event has been processed.
OnGridCellGetToolTipText Called provide the hovered by mouse grid cell with the custom tooltip. Returns flag which indicates whether the method handles the custom tooltip text query event.
OnGridCellInplaceControlCreate Called to create the in-place editor window for the specified grid cell. The method returns a handle of the created window handle. The default implementation returns NULL. In this case the CExtGridCell::OnInplaceControlCreate() virtual method of the cell being edited creates a single line edit control.
OnGridCellInplaceControlDateTimeInputComplete Called when the in-place active cell editing of the date time cell is complete. By overriding this method you can save or discard the results of editing.
OnGridCellInplaceControlDateTimeInputVerify Called during date time cell editing. By overriding this method you can filter and modify the text inside the in-place active cell editor window. The method returns true if the string value stored in the dtNew parameter has been modified.
OnGridCellInplaceControlDurationInputComplete Called when the in-place active cell editing of the duration cell is complete. By overriding this method you can save or discard the results of editing.
OnGridCellInplaceControlDurationInputVerify Called during duration cell editing. By overriding this method you can filter and modify the text inside the in-place active cell editor window. The method returns true if the string value stored in the dtSpanNew parameter has been modified.
OnGridCellInplaceControlHotKeyInputComplete Called to notify that the in-place editor for the hot key cell is destroyed. By overriding this method you can save or discard the results of editing.
OnGridCellInplaceControlHotKeyInputVerify Called when the hot key cell is being edited. By overriding this method you can filter and modify the text inside the in-place active cell editor window. The method returns true if the string value stored in the dwHotKeyNew parameter has been modified.
OnGridCellInplaceControlIPAddressInputComplete �Called when the user changes the IP address in the in-place editor. The method returns true if the IP address is valid or false otherwise.
OnGridCellInplaceControlIPAddressInputVerify Called when the user changes the IP address in the in-place editor. The method returns true if the IP address is valid or false otherwise.
OnGridCellInplaceControlPreTranslateMessage Called to intercept calls of MFC's CWnd::PreTranslateMessage() virtual method of the in-place active cell edit window. The method returns a boolean value indicating whether the message should be excluded from the message queue.
OnGridCellInplaceControlQueryStyle Called to get the attributes of the in-place cell editor window.
OnGridCellInplaceControlSliderInputComplete Called when the in-place active cell editing of the slider cell is complete. By overriding this method you can save or discard the results of editing.
OnGridCellInplaceControlSliderInputVerify Called during slider cell editing. By overriding this method you can filter and modify the text inside the in-place active cell editor window. The method returns true if the string value stored in the nPosNew parameter has been modified.
OnGridCellInplaceControlTextInputComplete Called when the in-place active cell editing is complete. By overriding this method you can save or discard the results of editing.
OnGridCellInplaceControlTextInputVerify Called during cell editing. By overriding this method you can filter and modify the text inside the in-place active cell editor window. The method returns true if the string value stored in the sTextNew parameter has been modified.
OnGridCellInplaceControlWindowProc Called to intercept calls of MFC's CWnd::WindowProc() virtual method of the in-place active cell edit window. The method returns true if the message has been handled.
OnGridCellInputComplete Called when in-place editing is complete and the cell value has been changed.
OnGridCellPopupDatePickerSelChange Called to handle the date selection changed event of the date picker control in the popup menu tracked by the built-in button. The method returns true if the cell object has handled the date picker event. The default implementation always return false.
OnGridCellPopupListBoxCalcItemExtraSizes Called to calculate the extra space around the list box item in the popup menu tracked by the built-in button in pixels. If the CSize( -1, -1 ) value is returned, then the grid cell class should compute required size. Otherwise, the grid class is responsible for list box item outer border measurement.
OnGridCellPopupListBoxClose Called to notify that the pop-up list box displayed from the grid cell is closed and returns true. If the false value is returned, then the grid cell class should handle this event. Otherwise, the grid class is responsible for the popup list box behavior.
OnGridCellPopupListBoxInitContent Called to initialize the items of the list box control in the popup menu tracked by the built-in button. If the false value is returned, then the grid cell class should initialize the list box. If the method returns true if the list box control has been successfully initialized by the grid class.
OnGridCellPopupListBoxItemClick Called to notify that an item in the popup list box displayed by the grid cell was clicked. If the false value is returned, then the grid cell class should handle this event. Otherwise, the grid class is responsible for the popup list box behavior.
OnGridCellPopupListBoxItemDraw Called to paint the list box item in the popup menu tracked by the built-in button. The method returns true if the cell object has successfully painted the list box item. If the false value is returned, then the grid cell class should draw the list box item. Otherwise, the grid class is responsible for the list box item painting.
OnGridCellPopupListBoxItemMeasure Called to measure the list box item in the popup menu tracked by the built-in button. The method returns true if the cell object has measured the list box item successfully. If the false value is returned, then the grid cell class should measure the list box item. Otherwise, the grid class is responsible for the list box item sizes.
OnGridCellPopupListBoxMeasureTrackSize Called to calculate the size, in pixels, of the list box control in the popup menu tracked by the built-in button. If the CSize( -1, -1 ) value is returned, then the grid cell should compute required size. Otherwise, the grid class is responsible for the popup list box size.
OnGridCellPopupListBoxQueryMaxSize Called to calculate the maximal allowed size, in pixels, of the list box control in the popup menu tracked by the built-in button. If the CSize( -1, -1 ) value is returned, then the grid cell should compute required size. Otherwise, the grid class is responsible for the popup list box size.
OnGridCellPopupListBoxSelChange Called to handle the selection changed event of the list box control in the popup menu tracked by the built-in button. The method returns true if the cell object has handled the list box event. The default implementation always return false.
OnGridCellPopupListBoxSelEndCancel Called to handle the canceling of the item selection event of the list box control in the popup menu tracked by the built-in button. The method returns true if the cell object has handled the event. The default implementation always returns false.
OnGridCellPopupListBoxSelEndOK Called to handle the final item selection changed event of the list box control in the popup menu tracked by the built-in button. The method returns true if the cell object has handled the event. The default implementation always returns false.
OnGridCellQueryBackColor Called to get the background color of the cell. The default implementation returns COLORREF(-1) which means that the default background color (depending on whether the cell is selected) should be used.
OnGridCellQueryFont Called to get the cell font. The method returns the font handle. The default implementation returns NULL, which means the default GUI font should be used.
OnGridCellQueryTextColor Called to get the text color of the cell. The default implementation returns COLORREF(-1) which means that the default text color (depending on whether the cell is selected) should be used.
OnGridCellSetCheck Called when the check box state has changed in this CExtGridCellCheckBox cell object.
OnGridDataDndComplete Invoked when the data cells drag-and-dropping is finished.
OnGridDoAutoBestFitColumnsForRow Invoked to perform automatic best fitting for specified row.
OnGridDoAutoBestFitOnAccelCmd Called when accelerator command processing complete to perform automatic best fitting of rows and/or columns.
OnGridDoAutoBestFitOnInputComplete Called when in-place editing is complete to perform automatic best fitting of rows and/or columns.
OnGridDoAutoBestFitRowsForColumn Invoked to perform automatic best fitting for specified column.
OnGridDropSourceBeginDrag Called on drag-and-drop start for inner data cells. The method returns a nonzero if dragging is allowed or zero otherwise.
OnGridDropSourceGiveFeedback Invoked during drag-and-dropping inner data cells after the notification of OLE drop target object. The method returns DRAGDROP_S_USEDEFAULTCURSORS if the dragging is in progress, NOERROR otherwise.
OnGridDropSourceQueryContinueDrag Invoked repeatedly until the inner data cells drag-and-dropping is processed. The method returns DRAGDROP_S_CANCEL if the Escape key is pressed, or the left button is raised before the dragging starts. The method returns DRAGDROP_S_DROP if a drop operation should occur; otherwise returns S_OK.
OnGridDropTargetDragEnter Invoked when the cursor enters the grid control for the first time during OLE drag-and-drop. The method returns an OLE drop effect code.
OnGridDropTargetDragLeave Invoked when the cursor leaves the grid control during OLE drag-and-drop.
OnGridDropTargetDragOver Invoked when the cursor is dragged over the grid control during OLE drag-and-drop. The method returns an OLE drop effect code.
OnGridDropTargetDragScroll Invoked during OLE drag-and-drop before invocations of the OnGridDropTargetDragEnter() or OnGridDropTargetDragOver() virtual methods to determine whether the point is in the scrolling region. The method returns an OLE drop effect code which may contain the DROPEFFECT_SCROLL flag to indicate that a drag scroll operation is about to occur or is occurring in the target.
OnGridDropTargetDrop Invoked during OLE drag-and-drop when a drop operation is to occur. The method returns a nonzero if the drop succeeded or zero otherwise. This virtual method is invoked after the OnGridDropTargetDropEx() virtual method.
OnGridDropTargetDropEx Invoked during OLE drag-and-drop when a drop operation is to occur. The method returns a nonzero if the drop succeeded or zero otherwise. This virtual method is invoked before the OnGridDropTargetDrop() virtual method.
OnGridFilterInplaceEditingMessageLoop Invoked for filtering messages in the message loop tracked by the in place activated grid cell editor controls. The method returns true if the message has been handled.
OnGridHookCellQueryButtonInfo Called to query the information about the state and behavior of the built-in button specified by the nButtonType parameter. The method returns false if the button is not used.
OnGridHookCellQueryEnabledDecrement Returns true if a click on the down part of the built-in up/down button of the specified cell should call the cell's CExtGridCell::OnValueDecrement() virtual method. Returns false to make the down part disabled.
OnGridHookCellQueryEnabledIncrement Returns true if a click on the up part of the built-in up/down button of the specified cell should call the cell's CExtGridCell::OnValueIncrement() virtual method. Returns false to make the up part disabled.
OnGridHookCellValueDecrement Called to decrement the cell value and returns true if it has been changed.
OnGridHookCellValueIncrement Called to increment the cell value and returns true if it has been changed.
OnGridOuterDragComplete Called when the outer cell has been completely drag-and-dropped and the corresponding columns/rows have been swapped.
OnGridOuterDragOut Called when columns/rows have been removed as a result of dragging and releasing the outer cell outside of the grid control.
OnGridPaintCellTextHook Called to get the text color of the cell. The default implementation returns the COLORREF(-1) value that causes using of default text color that depends on whether cell is in the selection range.
OnGridPaintDraggedCell Called to paint the client area of the content pop-up window which is used when drag-and-dropping the outer cell.
OnGridQueryAutoBestFitColumns Returns flag that whether the grid control should perform automatic best fitting for columns.
OnGridQueryAutoBestFitColumnsForRow Returns flag that whether the grid control should perform automatic best fitting for specified row.
OnGridQueryAutoBestFitRows Returns flag that whether the grid control should perform automatic best fitting for rows.
OnGridQueryAutoBestFitRowsForColumn Returns flag that whether the grid control should perform automatic best fitting for specified column.
OnGridQueryCenteredDndAlignment Returns flag that indicates the shape of the drag-and-dropped header cell should be centered relatively to the mouse pointer.
OnGridQueryClipboardFormat Returns the clipboard format identifier used by the grid control for the clipboard operations and drag-and-dropping of the inner data cells.
OnGridQueryClipboardFormatName Returns the clipboard format name used by the grid control for the clipboard operations and drag-and-dropping of the inner data cells.
OnGridQueryDataProvider Returns a reference to the CExtGridDataProvider object used by the grid control for holding the cell objects. By default, this method initializes the CExtGridDataProviderMemory object when called for the first time and always returns a reference to this memory cell holder. You can override this method to use cacheable data provider objects which load the visible cell objects from some data source on-the-fly during grid scrolling. The CExtGridDataProviderRecordset class may be used to implement the vertically cacheable recordset scroller for such data sources as ADO recordset objects.
OnGridQueryPressingCellInfo Returns a constant reference to the internal hit-test object that specifies location of the cell which is currently pressed.
OnGridQueryStartDragOffset Returns the CSize object that specifies the minimum offset of the mouse pointer required for starting drag-and-dropping.
OnGridTrackCellButton Called by the cell object to periodically notify the grid control about the button-press event. This method is used by built-in UpDown cell buttons to periodically increment/decrement the numeric values inside cells when the user holds pressed the up/down part of a built-in UpDown button. The method keeps an internal message loop and returns when the user releases the mouse button or any cancel event (e.g. activation of other process) occurs. The method returns true if succeeded.
OnGridTrackCellMousePressing Called when the message loop responsible for tracking the changes caused by when the outer cell has been pressed. When an outer cell is pressed, drag-and-dropping or column/row sorting may start.
OnGridTrackOuterCellDND Called when the message loop responsible for tracking the outer cell being drag-and dropped.
OnQueryBestFitActionEnabled Invoked to query if the column/row can be applied the best fit feature and returns true if it can be applied or false otherwise.

See Also

CExtGridWnd Overview | Hierarchy Chart