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

Classes

~CExtGridDataProvider Destructor.
CacheColumnCountGet Returns the number of columns which are stored in the data provider.
CacheData Called by the grid control and by a particular data provider implementation to analyze how the scrolling position of the grid control has changed and to load the range of cell objects which get visible on the displayed page. The method returns true if succeeded.
CacheIsVisibleFirstRecord Returns true if the first record in the available data range is visible on the displayed page. This method is only called when the grid control uses the virtual scrolling strategy with an unknown number of records.
CacheIsVisibleLastRecord Returns true if the last record in the available data range is visible on the displayed page. This method is only called when the grid control uses the virtual scrolling strategy with an unknown number of records.
CacheReservedCountsGet Returns the total number of columns/rows in the outer areas of the grid control.
CacheReserveForOuterCells Sets the total number of columns and rows used by the outer areas of the grid control. Depending on the particular implementation, the data provider component may use this method to perform additional initialization of the outer cells. The method returns true if succeeded.
CacheRowCountGet Returns the number of rows which are stored in the data provider.
CellGet Returns a pointer to the cell object at a specified location. The returned value may be a pointer to the valid cell object or NULL. 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.
CellRangeEmpty Destroys the cell objects at a specified location and returns true if succeeded.
CellRangeEmptyAll Destroys all cell objects and returns true if succeeded.
CellRangeSet Initializes or destroys cell objects at the specified location and returns true if succeeded.
CExtGridDataProvider Default constructor.
ColumnCountGet Returns the number of columns in the internal representation of the data table that contains cell objects.
ColumnDefaultValueBind 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. The method returns true if succeeded.
ColumnDefaultValueGet Returns the default value for the specified column or NULL if no default value is bound.
ColumnDefaultValueUnbind Unbinds the default value from a column or from all columns in the grid control and returns true if succeeded.
ColumnDefaultValueUnbindAll Unbinds the default values from all columns and returns true if succeeded.
ColumnInsert Inserts a specified number of new columns to the internal representation of the data table and returns true if succeeded. The inserted range of columns contains only NULL pointers. They may be initialized later with pointers to instances of the CExtGridCell class or a class derived from it.
ColumnRemove Removes a specified number of columns from the internal representation of the data table and returns true if succeeded.
FontGetAt Returns a pointer to the icon object by index or NULL if there is no font with the specified index.
FontGetCount Returns the number of custom fonts stored in the data provider.
FontInsert 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.
FontRemove �Removes the specified font from the internal collection of custom fonts and returns the number of removed handles.
IconGetAt Returns a pointer to the icon object or NULL if the nIdx parameter does not specify a valid icon index. A particular data provider component may implement this method so it will always return NULL if the collection of icons is not supported.
IconGetCount Returns the number of icon objects which are stored in the data provider. A particular data provider component may implement this method so it will always return 0� if the collection of icons is not supported.
IconInsert Inserts a new icon object to the internal collection of icons and returns an index of the new icon or -1 if any of the passed parameters are invalid. A particular data provider component may implement this method so it will always return -1� if the collection of icons is not supported.
IconRemove Removes icons from the internal collection and returns the number of icons removed. The default argument values specify that all icons should be removed.
MinimizeMemoryUsage Minimizes memory usage. This method makes the data provider free the reserved memory, which may previously allocated for further optimization.
RowCountGet Returns the number of rows in the internal representation of the data table that contains cell objects.
RowDefaultValueBind 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. The method returns true if succeeded.
RowDefaultValueGet Returns the default value for the specified row or NULL if no default value is bound.
RowDefaultValueUnbind Unbinds the default value from a row or from all rows in the grid control and returns true if succeeded.
RowDefaultValueUnbindAll Unbinds the default values from all rows and returns true if succeeded.
RowInsert Inserts a specified number of new rows to the internal representation of the data table and returns true if succeeded. The inserted range of rows contains only NULL pointers. They may be initialized later with pointers to instances of the CExtGridCell class or a class derived from it.
RowRemove Removes a specified number of rows from the internal representation of the data table and returns true if succeeded.
SortOrderGet Fills the sorting order object referred to by the _gdso argument with the sorting rules for columns or rows. The method returns true sorting order information has been successfully saved in the _gdso parameter. A particular data provider component may implement this method so it always returns NULL if sorting is not supported.
SortOrderSet Sets the new sorting rules for columns or rows and performs sorting according to these new rules. The method returns true if succeeded. A particular data provider component may implement this method so it always returns NULL if sorting is not supported. NOTE: The method does not affect outer cells.
SortOrderUpdate Performs sorting by columns or by rows according to the current sorting rules. The method returns true if succeeded. A particular data provider component may implement this method so it always returns NULL if sorting is not supported. NOTE: The method does not affect outer cells.
StringAlloc Allocates the string and returns a pointer to the first character of the string or NULL if the allocation failed. The method is used by the cell object which needs to keep text data.
StringFree Frees the string. The method is used by the cell object which needs to keep the text data.
SwapDroppedSeries Moves the column or row to a new position and returns true if succeeded. A particular data provider component may implement this method so it always returns NULL if the row/column swapping is not supported.

See Also

CExtGridDataProvider Overview | Hierarchy Chart