Grid3 and Grid4 Equivalents
- 34 minutes to read
This topic provides a conversion guide for ExpressQuantumGrid4 equivalents to the following ExpressQuantumGrid3 elements:
Grid control | Summary items |
---|---|
TdxDBGrid Properties Methods Events | TdxDBGridSummaryGroups Properties Methods |
TdxDBGridSummaryGroup Properties Methods Events | |
Bands | |
TdxTreeListBand Properties Methods | TdxDBGridSummaryItems Properties Methods |
TdxTreeListBands Properties Methods | TdxDBGridSummaryItem Properties Methods Events |
Columns | Filter |
TdxDBGridColumn Properties Methods Events | TdxDBGridFilter Properties Methods |
Nodes/Records | |
TdxDBGridNode Properties Methods |
Grid control
The main difference between versions 3 and 4 of the ExpressQuantumGrid is that the latter is capable of displaying data within multiple Views. ExpressQuantumGrid4 provides different Views (Table, Banded Table and Card Views) for displaying data while ExpressQuantumGrid3 provides just one basic Table View (which can be displayed with or without bands). Most of the TdxDBGrid functionality is now implemented by View objects. Views present data from data fields by means of “items”. An Item represents a column in Table Views and a row in Card Views. Refer to the Views and Items sections for more details.
A data controller represented by the View’s DataController property implements data-aware operations such as loading data, filtering, grouping and calculating summaries. Customizing colors and fonts has been delegated to Style objects and so is implemented now by assigning styles to grid elements.
These changes mean that the multitude of top level properties in the grid have been replaced by a small collection of objects. While these changes provide for a more efficient and extensible product, we recognize that users of ExpressQuantumGrid3 will have initial difficulty in finding the properties required while converting event handlers for ExpressQuantumGrid4 and hence the reason for this topic.
Note
the two technologies are very different so there isn’t always a simple replacement available. While we have tried to cover as many options as possible, the following lists can never be totally complete (you may be using our product in ways we haven’t considered!). If you still have difficulty in replacing your ExpressQuantumGrid3 code because your needs are not covered here, please write to support@devexpress.com and we will help you.
ExpressQuantumGrid3 members | ExpressQuantumGrid4 equivalents |
---|---|
TdxDBGrid Object
Properties | |
---|---|
In TCustomdxDBGrid | |
DataSetChangedBusy | The View’s DataController.Provider.IsDataSetBusy property. |
DefaultFields | Fields in ExpressQuantumGrid4 are not automatically retrieved from a data source. You can use the Retrieve Fields button in the Columns panel of the Component Editor or call the View’s DataController.CreateAllItems method. |
Filter | The View’s DataController.Filter and Filtering properties. |
GroupColumnCount | The View’s GroupedItemCount property |
GroupColumns | The View’s GroupedItems property. |
GroupPanelColor | The View’s Styles.GroupByBox property. |
GroupPanelFontColor | The View’s Styles.GroupByBox property. |
GroupPanelHeight | –; |
LockRefresh | The View’s DataController.BeginLocate and EndLocate methods allow you to prevent a grid control from excessive reloading of data when navigating through dataset records. If you need to call the TDataSet.Locate method, enclose this part of the code with BeginLocate and EndLocate. Calling the BeginLocate and EndLocate methods is equivalent to setting the LockRefresh property to True and False respectively. |
OptionsBehavior TdxDBGridOptionBehavior = (edgoAnsiSort, edgoAutoCopySelectedToClipboard, edgoAutoSearch, edgoAutoSort, edgoBandButtonClicking, edgoCaseInsensitive, edgoCellMultiSelect, edgoCollapsedReload, edgoDblClick, edgoDragCollapse, edgoDragExpand, edgoDragScroll, edgoEditing, edgoEnterShowEditor, edgoEnterThrough, edgoExtMultiSelect, edgoHeaderButtonClicking, edgoHorzThrough, edgoImmediateEditor, edgoMouseScroll, edgoMultiSelect, edgoMultiSort, edgoSeekDetail, edgoShowHourGlass, edgoStoreToIniFile, edgoStoreToRegistry, edgoTabs, edgoTabThrough, edgoVertThrough); | Equivalents for the various options are described below. |
edgoAnsiSort | The dcoAnsiSort option of the View’s DataController.Options property |
edgoAutoCopySelectedToClipboard | –; |
edgoAutoSearch | The View’s OptionsBehavior.IncSearch and item’s Options.IncSearch properties |
edgoAutoSort | The View’s OptionsCustomize.ItemSorting (ColumnSorting in a grid Table View) and item’s Options.Sorting property. |
edgoBandButtonClicking | –; |
edgoCaseInsensitive | The dcoCaseInsensitive option of the View’s DataController.Options property |
edgoCellMultiSelect | –; |
edgoCollapsedReload | –; |
edgoDblClick | –; |
edgoDragCollapse | –; |
edgoDragExpand | The View’s OptionsBehavior.DragOpening property. |
edgoDragScroll | See the View’s OptionsBehavior.DragFocusing and OptionsBehavior.DragScrolling properties. |
edgoEditing | The View’s OptionsData.Editing and item’s Options.Editing properties |
edgoEnterShowEditor | –; If end-users are allowed to edit cell values, they can initiate editing of the focused cell by pressing the Enter or Space key, or by typing a new cell value directly. |
edgoEnterThrough | The View’s OptionsBehavior.GoToNextCellOnEnter property |
edgoExtMultiSelect | End-users are allowed to select multiple records from different groups provided that the OptionsSelection.MultiSelect property is set to True. Setting this property to True is equivalent to enabling both the edgoMultiSelect and edgoExtMultiSelect options in Grid 3. |
edgoHeaderButtonClicking | –; |
edgoHorzThrough | The View’s OptionsBehavior.FocusCellOnCycle property |
edgoImmediateEditor | The View’s OptionsBehavior.ImmediateEditor property. |
edgoMouseScroll | –; |
edgoMultiSelect | The View’s OptionsSelection.MultiSelect property. Setting this property to True is equivalent to enabling both the edgoMultiSelect and edgoExtMultiSelect options in Grid 3. |
edgoMultiSort | –; End-users are allowed to sort the View data by values of multiple columns if the View’s OptionsCustomize.ColumnSorting property is set to True. Setting this property to True is equivalent to enabling both the edgoMultiSort And edgoAutoSort options in Grid 3). |
edgoSeekDetail | –; |
edgoShowHourGlass | –; |
edgoStoreToIniFile | –; See the View’s StoreToIniFile method. |
edgoStoreToRegistry | –; See the View’s StoreToRegistry method. |
edgoTabs | The View’s OptionsBehavior.FocusCellOnTab property |
edgoTabThrough | The View’s OptionsBehavior.FocusCellOnCycle and OptionsBehavior.FocusCellOnTab properties |
edgoVertThrough | –; |
OptionsCustomize TdxDBGridOptionCustomize = (edgoBandMoving, edgoBandPanelSizing, edgoBandSizing, edgoColumnMoving, edgoColumnSizing, edgoExtCustomizing, edgoFullSizing, edgoHeaderPanelSizing, edgoKeepColumnWidth, edgoNotHideColumn, edgoRowSizing); | Equivalents for the various options are described below. |
edgoBandMoving | The Banded Table View’s OptionsCustomize.BandMoving and band’s Options.Moving properties. |
edgoBandPanelSizing | –; |
edgoBandSizing | The Banded Table View’s OptionsCustomize.BandSizing and the band’s Options.Sizing properties. |
edgoColumnMoving | The View’s OptionsCustomize.ItemMoving (OptionsCustomize.ColumnMoving in a grid Table View) and item’s Options.Moving properties. |
edgoColumnSizing | The View’s OptionsCustomize.ColumnHorzSizing and column’s Options.HorzSizing properties. See also the OptionsCustomize.ColumnVertSizing and Options.VertSizing properties which are available in Banded Table Views. |
edgoExtCustomizing | The (Banded) Table View’s OptionsCustomize.ColumnHiding property. |
edgoFullSizing | –; |
edgoHeaderPanelSizing | –; |
edgoKeepColumnWidth | –; |
edgoNotHideColumn | See the View’s OptionsCustomize.ColumnHidingOnGrouping property. |
edgoRowSizing | In a Banded Table View, the row height can be adjusted by changing the height of column headers displayed within the bands. To enable this, set the OptionsCustomize.ColumnVertSizing property of a Banded Table View to True. |
OptionsDB TdxDBGridOptionDB = (edgoCanAppend, edgoCancelOnExit, edgoCanDelete, edgoCanInsert, edgoCanNavigation, edgoConfirmDelete, edgoLoadAllRecords, edgoPartialLoad, edgoResetColumnFocus, edgoSmartRefresh, edgoSmartReload, edgoSyncSelection, edgoUseBookmarks, edgoUseLocate); | Equivalents for the various options are described below. |
edgoCanAppend | The View’s OptionsData.Appending property |
edgoCancelOnExit | The View’s OptionsData.CancelOnExit property |
edgoCanDelete | The View’s OptionsData.Deleting property |
edgoCanInsert | The View’s OptionsData.Inserting property |
edgoCanNavigation | The View’s DataController.DataModeController.SyncMode property. |
edgoConfirmDelete | The View’s OptionsData.DeletingConfirmation property |
edgoLoadAllRecords | By default, ExpressQuantumGrid4 loads all records into memory. To limit the number of records loaded at a time, see the View’s DataController.DataModeController.GridMode property |
edgoPartialLoad | You can use the grid mode to limit the number of records loaded into memory at a time. See the View’s DataController.DataModeController.GridMode property |
edgoResetColumnFocus | The View’s OptionsBehavior.FocusFirstCellOnNewRecord property |
edgoSmartRefresh | The View’s DataController.DataModeController.SmartRefresh property |
edgoSmartReload | –; |
edgoSyncSelection | The View’s DataController.DataModeController.SyncMode property |
edgoUseBookmarks | –; |
edgoUseLocate | –; The Locate method is always used if key field names are specified via the View’s DataController.KeyFieldNames property. |
OptionsView TdxDBGridOptionView = (edgoAutoCalcPreviewLines, edgoAutoHeaderPanelHeight, edgoAutoWidth, edgoBandHeaderWidth, edgoDrawEndEllipsis, edgoHideFocusRect, edgoHotTrack, edgoIndicator, edgoInvertSelect, edgoPreview, edgoRowAutoHeight, edgoRowSelect, edgoShowButtonAlways, edgoUseBitmap); | Equivalents for the various options are described below. |
edgoAutoCalcPreviewLines | The (Banded) Table View’s Preview.AutoHeight property. |
edgoAutoHeaderPanelHeight | –; |
edgoAutoWidth | The (Banded) Table View’s OptionsView.ColumnAutoWidth property. |
edgoBandHeaderWidth | –; |
edgoDrawEndEllipsis | The following properties affect ellipsis displaying when clipping occurs: OptionsView.BandHeaderEndEllipsis |
edgoHideFocusRect | –; |
edgoHotTrack | –; |
edgoIndicator | The View’s OptionsView.Indicator property |
edgoInvertSelect | The View’s OptionsSelection.InvertSelect property |
edgoPreview | The View’s Preview.Visible property |
edgoRowAutoHeight | The View’s OptionsView.CellAutoHeight property |
edgoRowSelect | The View’s OptionsSelection.CellSelect property |
edgoShowButtonAlways | The View’s OptionsView.ShowEditButtons property |
edgoUseBitmap | –; |
PartialLoad | ExpressQuantumGrid4 does not provide PartialLoad mode. You can use the grid mode to limit the number of records loaded into memory at a time. See the View’s DataController.DataModeController.GridMode property. |
PartialLoadBufferCount | ExpressQuantumGrid4 does not provide PartialLoad mode. ExpressQuantumGrid4 provides the grid mode for limiting the number of records loaded into memory at a time. Use the DataController.DataModeController.GridModeBufferCount to specify the buffer size. |
ShowGroupPanel | The View’s OptionsView.GroupByBox property |
ShowSummaryFooter | The View’s OptionsView.Footer property. |
SummaryGroups | All summaries are set via the View’s DataController.Summary property. Summary groups are provided by the Summary.SummaryGroups collection. To create default summary groups, use the Summary.DefaultGroupSummaryItems property. |
SummarySeparator | The TcxDataGroupSummaryItems.Separator property. |
UseBookmarks | When in grid mode, bookmarks are stored automatically for the selected records and can be accessed via the View’s DataController.GetSelectedBookmark function. When not in grid mode, bookmarks are not stored. |
Derived from TCustomdxDBTreeListControl | |
Columns | The Items property declared in a base View class. Specific View classes provide the Columns (in a Table and Banded Table Views) and Rows properties (in a Card View) as equivalents (the Items collection). |
DataLink | –; |
DataSource | The View’s DataController.DataSource property in data-aware Views and DataController.CustomDataSource in non data-aware Views. |
FocusedField | You can access a focused item (column in a grid Table View or row in a Card View) using the View’s Controller.FocusedItem property. To access the field linked to the item, see the item’s DataBinding.Field property. |
GrIndicatorWidth | The View’s OptionsView.IndicatorWidth property. |
KeyField | The View’s DataController.KeyFieldNames property. |
PreviewFieldName | The View’s Preview.Column property. |
PreviewMaxLength | –; |
SelectedRows | The View’s DataController.GetSelectedBookmark function (in grid mode only). |
SortedColumn | The first element of the SortedItems collection. |
SortedColumns | The (Banded) Table View’s SortedItems property. |
VisibleColumns | The View’s VisibleItems property. Views publish the VisibleColumns (in Table and Banded Table Views) and VisibleRows (in a Card View) properties and these provide access to the same items as VisibleItems. |
Derived from TCustomdxTreeListControl | |
BandMaxRowCount | –; |
BandRowCount | The BandHeaderLineCount property (Banded Table Views only). |
Bands | The Bands property (Banded Table Views only). |
ColumnCount | The View’s ItemCount property. |
DefaultLayout | –; |
HeaderMinRowCount | –; See the View’s HeaderHeight property. |
HeaderPanelMaxRowCount | –; |
HeaderPanelRowCount | To determine the View’s band nesting level, use the View’s Bands.VisibleRowCount property (Banded Table Views only). To create a nested band layout, use a band’s Position.BandIndex property in code or nest bands as necessary, using drag and drop at design or runtime. To collapse nested bands to a single row and prohibit end-users from nesting bands, set the Position.BandIndex property to -1 for all bands, and disable the View’s OptionsCustomize.NestedBands property. |
IniFileName | –; |
IniSectionName | –; |
RegistryPath | –; |
SortedColumnCount | The View’s SortedItemCount property. |
VisibleColumnCount | The VisibleItemCount property in a base View class. In a grid (Banded) Table View and Card View, you can use the VisibleColumnCount and VisibleRowCount properties respectively. |
Derived from TCustomdxTreeList | Note Grid3 provided a treelist control also and the grid itself was based on nodes. Grid4 does not use nodes and the ExpressQuantumTreeList is now a separate product (under development –; Sept 2002). |
ArrowsColor | –; |
AutoExpandOnSearch | Group rows are always expanded on finding a record during an incremental search. |
AutoSearchColor | The View’s Styles.IncSearch property. |
BandButtonPushed | –; |
BandColor | The Styles.BandHeader property (Banded Table Views only) and the band’s Styles.Header property. |
BandFont | The Styles.BandHeader property (Banded Table Views only) and the band’s Styles.Header property. |
BandPanelHeight | –; |
BorderStyle | –; |
Count | –; See the View’s ViewData.Records property to get the collection of all records currently displayed. To know whether a particular record is at the root nesting level, see its Level property. |
CustomizingBandListBox | –; |
CustomizingForm | The View’s Controller.CustomizationForm property. |
CustomizingHeaderListBox | –; |
CustomizingPos | The View’s Controller.CustomizationFormBounds property. You can also use the Left, Top, Width and Height properties of the object obtained via the Controller.CustomizationForm property. |
CustomizingRowCount | –; |
DblClkExpanding | Double-clicking group rows always expands/collapse the corresponding group. The View’s TcxGridTableOptionsBehavior.ExpandMasterRowOnDblClick property allows you to prevent expanding/collapsing of master rows on a double-click event. |
DefaultRowHeight | The View’s OptionsView.DataRowHeight property. |
DescTextHeight | –; |
DownBandIndex | –; |
DownBandPushed | –; |
DownColumnIndex | –; |
DownColumnPushed | –; |
DragAbsoluteBandIndex | –; |
DragAbsoluteHeaderIndex | –; |
DragNode | –; |
EditingText | Use the View’s Controller.EditingItem property to access the item (column in a Table View or card in a Card View) being edited. The EditValue property of the item specifies its value. Alternatively you can use the View’s Controller.FocusedRecord.DisplayTexts property to get the text representation of an individual item’s value within the currently focused record. |
FixedBandLineColor | The View’s OptionsView.FixedBandSeparatorColor property. |
FixedBandLineWidth | The View’s OptionsView.FixedBandSeparatorWidth property. |
FocusedAbsoluteIndex | The View’s Controller.FocusedItemIndex property. |
FocusedColumn | The View’s Controller.FocusedItem property. |
FocusedNode | The View’s Controller.FocusedRecord property. |
FocusedNumber | The View’s Controller.FocusedRecord.Index property. |
FooterPanelHeight | –; |
FooterRowHeight | –; |
FooterRowNodeHeight | –; |
GridLineColor | The View’s OptionsView.GridLineColor property. |
GroupNodeColor | The View’s Styles.Group property. |
GroupNodeTextColor | The View’s Styles.Group property. |
HeaderButtonPushed | –; |
HeaderColor | The View’s Styles.Header and the column’s Styles.Header properties |
HeaderFont | The View’s Styles.Header and the column’s Styles.Header properties |
HeaderHeight | The View’s HeaderHeight property. |
HeaderPanelHeight | The View’s HeaderHeight property. |
HeaderRowHeight | –; |
HideFocusRect | The View’s OptionsSelection.HideFocusRect property. |
HideSelection | The View’s OptionsSelection.HideSelection property. |
HideSelectionColor | The View’s Styles.Inactive property. |
HideSelectionTextColor | The View’s Styles.Inactive property. |
HighlightColor | The View’s Styles.Selection property. |
HighlightTextColor | The View’s Styles.Selection property. |
IndentDesc | The Preview.LeftIndent and Preview.RightIndent properties provide the two indents. |
InplaceColumnIndex | The View’s Controller.EditingItem.Index property. Check the Controller.IsEditing property to see whether a cell is currently being edited. |
InplaceEditor | The View’s Controller.EditingController.Edit property. The View’s Controller.EditingItem.GetProperties method provides access to the properties of the editor (and these vary depending on the editor’s type). |
IsCustomizing | The View’s Controller.Customization property. |
Items | The View’s ViewData.Records property. |
LastNode | Use the View’s ViewData.Records property to access any record within a View. |
LeftCoord | The View’s Controller.LeftPos property. |
LookAndFeel | The LookAndFeel property. |
MaxRowLineCount | The View’s OptionsView.CellTextMaxLineCount property. |
NewItemRowHeight | –; |
PreviewFont | The View’s Styles.Preview property. |
PreviewLines | The (Banded) Table View’s Preview.MaxLineCount property. |
RowFooterColor | The Styles.Footer property specifies the style for both the footer and group footer panels. You can specify different styles for these panels by handling the Styles.OnGetFooterStyle event. |
RowFooterTextColor | The Styles.Footer property specifies the style for both footer and group footer panels. You can specify different styles for these panels by handling the Styles.OnGetFooterStyle event. |
RowHeight | Use the View’s ViewInfo.RecordsViewInfo[ARowIndex].Height property. ARowIndex specifies the position of the required record among all visible records within a View |
RowSeparatorLineWidth | The View’s OptionsView.RowSeparatorWidth property. |
ScrollBars | The View’s OptionsView.ScrollBars property. |
SelectedCount | The View’s Controller.SelectedRecordCount property. |
SelectedNodes | The View’s Controller.SelectedRecords property. |
ShowBands | The OptionsView.BandHeaders property of a Banded Table View. |
ShowGrid | The View’s OptionsView.GridLines property allows you to specify which grid lines to display. |
ShowHeader | The View’s OptionsView.Header property. |
ShowHiddenInCustomizeBox | –; |
ShowNewItemRow | The View’s OptionsView.NewItemRow property. |
ShowPreviewGrid | The View’s OptionsView.GridLines property allows you to specify which grid lines to display. |
ShowRowFooter | The View’s OptionsView.GroupFooters property. |
SimpleCustomizeBox | –; |
State | –; |
TopIndex | The View’s Controller.TopRecordIndex property. |
TopNode | The View’s ViewData.Records[0] value. |
TopVisibleNode | The View’s ViewData.Records[GridView1.Controller.TopRecordIndex] value. |
WaitForExpandNodeTime | The grid’s DragOpeningWaitTime property. |
Methods | |
---|---|
In TdxDBGrid | |
SaveToHTML | The global ExportGridToHTML procedure. |
SaveToText | The global ExportGridToText procedure. |
SaveToXLS | The global ExportGridToExcel procedure. |
SaveToXML | The global ExportGridToXML procedure. |
Derived from TCustomdxDBGrid | |
AddGroupColumn | Set the GroupIndex property of the desired column to a value greater than or equal to the GroupedColumnCount property value. |
BeginGrouping | The View’s BeginUpdate method. |
CanAddGroupColumn | –; |
DeleteGroupColumn | –; Set the column’s GroupIndex property to –;1 for that purpose. |
EndGrouping | The View’s EndUpdate method. |
FindNodeByKeyValue | The View’s DataController.FindRecordIndexByKey function. |
GetGroupColumnAt | Use the ViewInfo.GetHitTest method. This returns an object with information on the grid element containing the specified coordinates. The following code shows how you can determine whether a given point belongs to the header of a column. If so, AColumn is assigned to this column. var AHitTest: TcxCustomGridHitTest; AColumn: TcxGridColumn;//…AHitTest := cxGrid1.ViewInfo.GetHitTest(X, Y);if AHitTest is TcxGridColumnHeaderHitTest then AColumn := TcxGridColumnHeaderHitTest(AHitTest).Column; See the column’s GroupIndex property value to see whether data is grouped by this column. |
GetNodeFooterColumnAt | Use the ViewInfo.GetHitTest method. This returns an object with information on the grid element containing the specified coordinates. The following code determines the column referenced within the group footer. var AHitTest: TcxCustomGridHitTest; AColumn: TcxGridColumn;//…AHitTest := cxGrid1.ViewInfo.GetHitTest(X, Y);if AHitTest is TcxGridGroupFooterCellHitTest then AColumn := TcxGridGroupFooterCellHitTest(AHitTest).Column; |
GetSummaryGroupByName | –; |
GetSummaryItemAt | –; |
InsertGroupColumn | Set the column’s GroupIndex property to a value between 0 and GroupedColumnCount ** –; 1**. |
IsGridMode | The View’s DataController.IsGridMode function. |
IsPartialLoad | ExpressQuantumGrid4 does not provide the PartialLoad mode. Use grid mode to limit the number of records loaded into memory at once. |
PointInFooterPanel | See the View’s ViewInfo.GetHitTest.HitTestCode function. If the specified point belongs to the footer panel, it returns htFooter. |
PointInGroupPanel | See the View’s ViewInfo.GetHitTest.HitTestCode function. If the specified point belongs to the group panel, it returns htGroupByBox. |
RebuildGroupIndexes | –; |
RefreshGroupColumns | The View’s DataController.Summary.Calculate method. |
Derived from TCustomdxDBTreeListControl | |
ClearGroupColumns | The View’s DataController.Groups.ClearGrouping method. |
ColumnByFieldName | In (Banded) Table Views, see the GetColumnByFieldName method. In Card Views, the equivalent is GetRowByFieldName. Note that these methods do not throw an exception if no items found linked to the specified field. |
ColumnByName | The View’s FindItemByName method. |
CreateColumnEx | –; Use the View’s CreateItem (CreateColumn in a grid (Banded) Table View, CreateRow in a Card View) method to add a new column. To specify an editor for the item, see the PropertiesClass and RepositoryItem properties. |
CreateColumn | –; See the View’s CreateItem method to add a new item. In Table and Card Views, you use the CreateColumn and CreateRow methods respectively. These implement the same functionality, but differ from CreateItem by the class of the returned object. |
FindColumnByFieldName | In (Banded) Table Views, see the GetColumnByFieldName method. In Card Views, the equivalent is GetRowByFieldName. |
FullRefresh | Call the View’s DataController.UpdateItems method with False as a parameter. |
GetColumnAt | Use the ViewInfo.GetHitTest method. This returns an object with information on the grid element with the coordinates specified. For instance, the following code determines the item (column) at point (X,Y) if the point relates to a record or to the column header panel. var AHitTest: TcxCustomGridHitTest; AItem: TcxCustomGridTableItem;//…AHitTest := cxGrid1.ViewInfo.GetHitTest(X, Y);if AHitTest is TcxGridRecordCellHitTest then AItem := TcxGridRecordCellHitTest(AHitTest).Itemelse if AHitTest is TcxGridColumnHeaderHitTest then AItem := TcxGridColumnHeaderHitTest(AHitTest).Column; |
GetDefaultColumnClass | When the item’s ValueTypeClass property is set, this value determines the default editor assigned to the item. An example of registering a default editor follows: GetDefaultEditDataRepositoryItems.RegisterItem(TcxBooleanValueType, cxEditRegisteredItemsStandardVersion, GetDefaultEditRepository.CreateItem(TcxEditRepositoryCheckBoxItem)); Here, a check box is registered as the editor for items with the value type of TcxBooleanValueType. To redefine the default editor for this value type, call the RegisterItem procedure passing it the required repository item instead of TcxEditRepositoryCheckBoxItem. The second parameter of the procedure specifies the priority of the registered editor. To redefine the existing editor, you must set the parameter to a value greater than the cxEditRegisteredItemsStandardVersion. If an item is assigned to a value type not registered by RegisterItem, its editor is determined by the RegisterDefaultItem method: GetDefaultEditDataRepositoryItems.RegisterDefaultItem(cxEditRegisteredItemsStandardVersion, GetDefaultEditRepository.CreateItem(TcxEditRepositoryTextItem)); If you need to use a different editor, call RegisterDefaultItem passing it another repository item instead of TcxEditRepositoryTextItem. Like the RegisterItem method, set the first parameter to a value greater than the cxEditRegisteredItemsStandardVersion constant. |
GetDefaultFieldColumnClass | In data-aware Views, items (columns in a (Banded) Table View and cards in a Card View) are assigned default editors based on the field type. An example of registering a default editor follows: GetDefaultEditDBRepositoryItems.RegisterItem(ftCurrency, cxEditRegisteredItemsStandardVersion, GetDefaultEditRepository.CreateItem(TcxEditRepositoryCurrencyItem)); Here, a currency editor represented by the TcxEditRepositoryCurrencyItem class is registered as an editor for currency fields. The first parameter specifies a value of the TFieldType enumerator. The second parameter specifies the priority of the registered editor. To redefine the existing editor, you must set the parameter to a value greater than the cxEditRegisteredItemsStandardVersion. If an item is assigned to a field not registered by the RegisterItem method, its editor is determined by the RegisterDefaultItem method: GetDefaultEditDBRepositoryItems.RegisterDefaultItem(cxEditRegisteredItemsStandardVersion, GetDefaultEditRepository.CreateItem(TcxEditRepositoryMaskItem)); If you need to use a different editor, call RegisterDefaultItem passing it another repository item instead of TcxEditRepositoryMaskItem. Like the RegisterItem method, set the first parameter to a value greater than the cxEditRegisteredItemsStandardVersion constant. |
GetFooterColumnAt | Use the ViewInfo.GetHitTest method. This returns an object with information on the grid element containing the specified coordinates. The following code determines a particular column within the footer panel. var AHitTest: TcxCustomGridHitTest; AColumn: TcxGridColumn;//…AHitTest := cxGrid1.ViewInfo.GetHitTest(X, Y);if AHitTest is TcxGridFooterCellHitTest then AColumn := TcxGridFooterCellHitTest(AHitTest).Column; |
GetHeaderColumnAt | Use the ViewInfo.GetHitTest method. This returns an object with information on the grid element containing the specified coordinates. The following code shows how you can determine whether a given point is within a column header. If so, AColumn is assigned to this column: var AHitTest: TcxCustomGridHitTest; AColumn: TcxGridColumn;//…AHitTest := cxGrid1.ViewInfo.GetHitTest(X, Y);if AHitTest is TcxGridColumnHeaderHitTest then AColumn := TcxGridColumnHeaderHitTest(AHitTest).Column; |
RefreshBookmarks | –; |
Derived from TCustomdxTreeListControl | |
ApplyBestFit | The item’s ApplyBestFit method. To adjust the width of all View columns, call the View’s ApplyBestFit method. |
AssignColumns | The View’s Assign method. |
BeginSorting | The View’s BeginUpdate method. |
DestroyColumns | The View’s ClearItems method. |
EndSorting | The View’s EndUpdate method. |
GetAbsoluteColumnIndex | The Index property of the desired item. To access an item by its position among the visible items, use the View’s VisibleItems property. |
GetBandAt | Use the ViewInfo.GetHitTest method. This returns an object with information on the grid element containing the specified coordinates. The following code gets the band at a specific point provided that it is within the band header panel: var AHitTest: TcxCustomGridHitTest; ABand: TcxGridBand;//…AHitTest := cxGrid1.ViewInfo.GetHitTest(X, Y);if AHitTest is TcxGridBandHeaderHitTest then ABand := TcxGridBandHeaderHitTest(AHitTest).Band; |
GetColumnAt | Use the ViewInfo.GetHitTest method. This returns an object with information on the grid element containing the specified coordinates. For instance, the following code determines the item (column) at point (X,Y) if the point is within a record or the column header panel. var AHitTest: TcxCustomGridHitTest; AItem: TcxCustomGridTableItem;//…AHitTest := cxGrid1.ViewInfo.GetHitTest(X, Y);if AHitTest is TcxGridRecordCellHitTest then AItem := TcxGridRecordCellHitTest(AHitTest).Itemelse if AHitTest is TcxGridColumnHeaderHitTest then AItem := TcxGridColumnHeaderHitTest(AHitTest).Column; |
GetDisplayValue | The TcxCustomGridRecord.DisplayTexts property provides the text representation of a value stored in a particular record field. |
GetVisibleColumnIndex | The VisibleIndex property of the desired item. To access an individual item by its absolute index, see the View’s Items property (Columns in a (Banded) Table View or Rows in a Card View). |
LoadFromIniFile | The View’s RestoreFromIniFile method. |
LoadFromRegistry | The View’s RestoreFromRegistry method. |
RefreshDefaultColumnsWidths | –; The RestoreDefaults method, declared in View and item classes, allows you to restore the default column widths. |
RefreshSorting | –; |
RestoreColumnsDefaults | –; The RestoreDefaults method declared in the View and item classes allows you to restore the default column widths and captions. |
SaveToIniFile | The View’s StoreToIniFile method. |
SaveToRegistry | The View’s StoreToRegistry method. |
Derived from TCustomdxTreeList | |
Add | The View’s DataController.AppendRecord method. |
AddFirst | –; |
AdjustColumnsWidth | –; The View’s OptionsView.ColumnAutoWidth property |
BeginSelection | –; |
BeginUpdate | The BeginUpdate method declared in the TcxCustomGrid, TcxCustomGridView, TcxCustomDataController, TcxDataSummary and TcxFilterCriteria classes. |
CalcDrawInfo | –; |
CancelEditor | Call the View’s Controller.EditingController.HideEdit method passing False as the Accept parameter. |
CellRect | Use code like this to access a particular cell region within a record: (cxGrid1TableView1.ViewInfo.RecordsViewInfo[AIndex] as TcxGridDataRowViewInfo).GetBoundsForItem(AItem); AIndex specifies the TcxCustomGridRecord.Index property value. AItem is an item (column in a (Banded) Table View and row in a Card View) to which the required cell belongs. |
ClearColumnsSorted | The View’s DataController.ClearSorting method. |
ClearNodes | In unbound mode, set the View’s DataController.RecordCount property to 0. |
CloseEditor | Call the View’s Controller.EditingController.HideEdit method passing True as the Accept parameter. |
ColumnCalcLineCount | –; |
ColumnsCustomizing | The View’s Controller.Customization property. |
CopyAllToClipboard | Call the View’s CopyToClipboard method passing True as the ACopyAll parameter. |
CopySelectedToClipboard | Call the View’s CopyToClipboard method passing False as the ACopyAll parameter. |
EndColumnsCustomizing | The View’s Controller.Customization property. |
EndSearch | The View’s Controller.CancelIncSearching method. |
EndSelection | –; |
EndUpdate | The EndUpdate method declared in the TcxCustomGrid, TcxCustomGridView, TcxCustomDataController, TcxDataSummary and TcxFilterCriteria classes. |
FreeDrawInfo | –; |
FullCollapse | The View’s ViewData.Collapse method lets you collapse group and master rows within a View. The View’s DataController.Groups.FullCollapse method collapses group rows. |
FullExpand | The View’s ViewData.Expand method lets you expand group and master rows within a View. The View’s DataController.Groups.FullExpand method expands group rows. |
GetEditRect | Use the code as follows (cxGrid1TableView1.ViewInfo.RecordsViewInfo[AIndex] as TcxGridDataRowViewInfo).GetCellViewInfoByItem(AItem).ContentBounds; AIndex specifies the record index defined by the TcxCustomGridRecord.Index property. AItem refers to the item (column in a (Banded) Table View and row in a Card View). |
GetFocusedAbsoluteIndex | Use the View’s Controller.FocusedItem.Index property. |
GetFocusedVisibleIndex | Use the View’s Controller.FocusedItemIndex or Controller.FocusedItem.VisibleIndex property. |
GetHitInfo | See the View’s ViewInfo.GetHitTest method. This returns an object with information on a grid element (a TcxCustomGridHitTest class descendant) at specific coordinates. You can determine the type of the element via the HitTestCode function of the object obtained. |
GetHitTestInfoAt | See the View’s ViewInfo.GetHitTest method. This returns an object with information on a grid element (a TcxCustomGridHitTest class descendant) at specific coordinates. You can determine the type of the element via the HitTestCode function of the object returned. |
GetNextVisible | –; The View’s ViewData.Records property provides access to all records currently displayed within a View. A record can be obtained from this collection by its Index property as it identifies the visual position of the record within a View. For instance, you can use the code below to access the record following the ACurrentRecord: ANextRecord := view1.ViewData.Records[ACurrentRecord.Index + 1]; |
GetNodeAt | Use the ViewInfo.GetHitTest method. This returns an object with information on the grid element containing the specified coordinates. The following code determines the record at the (X,Y) point if it falls within the content area: var AHitTest: TcxCustomGridHitTest; ARecord: TcxCustomGridRecord;//…AHitTest := cxGrid1.ViewInfo.GetHitTest(X, Y);if AHitTest is TcxGridRecordHitTest then ARecord := TcxGridRecordHitTest(AHitTest).GridRecord; |
GotoFirst | The View’s Controller.GoToFirst method. |
GotoLast | The View’s Controller.GoToLast method. |
GotoNext | The View’s Controller.GoToNext method. |
GotoPrev | The View’s Controller.GoToPrev method. |
HeaderPanelBestFit | –; |
HideEditor | –; Call the View’s Controller.EditingController.HideEdit method passing True as the Accept parameter. |
IndexOf | –; Use the Index property of a TcxCustomGridRecord object to get the position of the record. |
Insert | In unbound mode, use the View’s DataController.InsertRecord method to insert a new record above the record specified as the method’s parameter. In bound mode, you should use the methods of the dataset object to which the View is connected by means of a TDataSource object (for instance, the Insert method of a TDataSet descendant). |
IsInvertSelect | The View’s OptionsSelection.InvertSelect property. |
IsNodeVisible | The Visible property of a TcxCustomGridRecord object. |
MakeBandVisible | –; |
MakeColumnVisible | The View’s Controller.MakeItemVisible method. |
MakeNodeVisible |
You can also make a master row owning a specific detail View visible via the MakeMasterGridRecordVisible method. |
PointInCustomizingForm | See the View’s ViewInfo.GetHitTest.HitTestCode function. If the specified point belongs to the customization form, it returns the htCustomizationForm constant value. |
SaveAllToStrings | –; |
SaveAllToTextFile | –; |
SaveSelectedToStrings | –; |
SaveSelectedToTextFile | See the ExportGridToText procedure. |
ShowButtonEditorMouse | See the View’s Controller.EditingController.ShowEdit method. |
ShowEditorChar | See the View’s Controller.EditingController.ShowEdit method. |
ShowEditor | See the View’s Controller.EditingController.ShowEdit method. Alternatively, you can set the View’s Controller.EditingItem property to open the editor for a specific item within the currently focused record. |
ShowEditorMouse | See the View’s Controller.EditingController.ShowEdit method. |
StartSearch | To start an incremental search, assign a string to the View’s Controller.IncSearchingText property. |
Derived from TCustomdxContainer | |
HideDrawFocusRect | The View’s OptionsSelection.HideFocusRect property. |
IsShowButtonAlways | The View’s OptionsView.ShowEditButtons property. |
Events | |
---|---|
Derived from TCustomdxDBGrid | |
OnAddGroupColumn | ExpressQuantumGrid4 does not provide an event to allow you to control column grouping. You can prevent grouping by a particular column though by using the column’s Options.Grouping property. |
OnBackgroundDrawEvent | See the View’s OnCustomDrawPartBackground event. |
OnClearNodeData | –; |
OnColumnClick | The column’s OnHeaderClick event. |
OnColumnSorting | ExpressQuantumGrid4 does not provide an event to allow you to control column sorting. The column’s Options.Sorting property can be used to prevent a user from sorting by the column. |
OnCustomDraw | The OnCustomDrawCell event provided by View and item objects. |
OnEndDragGroupColumn | ExpressQuantumGrid4 does not provide an event to allow you to control column grouping. Use the column’s Options.Grouping property to prevent the grouping by that column. |
OnFilterChanged | The View’s DataController.Filter.OnBeforeChange event. |
OnEnumFilterValues | The column’s OnGetFilterValues or View’s DataController.Filter.OnGetValueList event. |
OnGetCustomSummaryText | –; |
OnHideColumn | The View’s OnColumnPosChanged event. |
OnReloadGroupList | The View’s DataController.OnGroupingChanged event. |
OnShowColumn | The View’s OnColumnPosChanged event. |
OnSummaryNode | The TcxDataSummaryItems.OnSummary event provided by the FooterSummaryItems, DefaultGroupSummaryItems properties and by every summary group in the SummaryGroups collection. |
Derived from TCustomdxDBTreeListControl | |
OnBeforeCalcSummary | –; |
OnCalcSummary | The View’s DataController.Summary.OnAfterSummary event. |
OnChangeNodeEx | –; The View’s OnFocusedRecordChanged event. |
OnGetEditColor | See the Styles.OnGetContentStyle event provided by View and item objects. |
OnGetPreviewText | The OnGetDisplayText event of the column assigned to the (Banded) Table View’s Preview.Column property. |
OnRefreshNodeData | –; |
Derived from TCustomdxTreeListControl | |
OnBandButtonClick | –; |
OnBandClick | The TcxGridBand.OnHeaderClick event. |
OnCalcRowLineHeight | –; |
OnCanBandDragging | ExpressQuantumGrid4 does not provide an event allowing you to control band dragging. You can prevent a user from a dragging a band by setting the View’s OptionsCustomize.BandMoving or the band’s Options.Moving property to False. |
OnCanHeaderDragging | ExpressQuantumGrid4 does not provide an event allowing you to control column dragging. The View’s OptionsCustomize.ColumnMoving and the item’s Options.Moving properties can be set to False to prevent the dragging of column(s). |
OnChangedColumnsWidth | The View’s OnColumnSizeChanged event. |
OnColumnClick | The column’s OnHeaderClick event. |
OnColumnMoved | The column’s OnColumnPosChanged event. |
OnCustomDraw | The OnCustomDrawCell event provided by View and item objects. |
OnCustomDrawBand | The View’s OnCustomDrawBandHeader event. |
OnCustomDrawCell | The OnCustomDrawCell event provided by View and item objects. |
OnCustomDrawColumnHeader | The View’s OnCustomDrawColumnHeader event. |
OnCustomDrawFooter | The View’s OnCustomDrawFooterCell event. |
OnCustomDrawFooterNode | The View’s OnCustomDrawFooterCell event. |
OnCustomDrawPreview | The OnCustomDrawCell event provided by View and item objects. |
OnCustomDrawPreviewCell | The OnCustomDrawCell event provided by View and item objects. |
OnDragEndBand | –; Handle the View’s OnBandPosChanged event for writing code after a band’s position has changed. |
OnDragEndHeader | –; Handle the View’s OnColumnPosChanged event for writing code after a column’s position has changed |
OnDragOverBand | –; |
OnDragOverHeader | –; |
OnEndDragColumn | –; |
OnGetLevelColor | The View’s Styles.OnGetGroupStyle event. |
OnGetNodeDragText | –; In v5 or later, the View’s OnGetDragDropText event. |
OnHeaderButtonClick | –; |
OnHeaderMoved | The View’s OnColumnPosChanged event. |
OnHideBand | –; The OnBandPosChanged event declared in a Banded Table View. |
OnHideHeader | –; The View’s OnColumnPosChanged event. |
OnIsExistFooterCell | –; |
OnShowBand | –; The OnBandPosChanged event declared in a Banded Table View. |
OnShowHeader | –; The View’s OnColumnPosChanged event. |
OnStartBandDragging | –; |
OnStartHeaderDragging | –; |
Derived from TCustomdxTreeList | |
OnBeginDragNode | –; |
OnCanNodeSelected | The View’s OnCanSelectRecord event. |
OnChangeColumn | The View’s OnFocusedItemChanged event. |
OnChangeLeftCoord | The View’s OnLeftPosChanged event. |
OnChangeNode | The View’s OnFocusedRecordChanged event. |
OnChangeTopVisibleNode | The View’s OnTopRecordIndexChanged event. |
OnCollapsed | –; |
OnCollapsing | –; |
OnCompare | The View’s DataController.OnCompare event. |
OnDeletion | –; |
OnEditChange | The View’s OnEditChanged event. |
OnEdited | –; |
OnEditing | The View’s OnEditing event. |
OnEditValidate | Handle the OnValidate event of the editor assigned to an item. |
OnEndColumnsCustomizing | –; |
OnExpanded | –; |
OnExpanding | –; |
OnHotTrackNode | –; |
OnSelectedCountChange | The View’s OnSelectionChanged event. |
Bands
Unlike the previous version of the grid control, ExpressQuantumGrid4 does not contain bands by default. Instead, it provides Banded Table Views (TcxGridBandedTableView and TcxGridDBBandedTableView). A Banded Table View contains the Bands property providing a collection of TcxGridBand objects.
ExpressQuantumGrid3 members | ExpressQuantumGrid4 equivalents |
---|---|
TdxTreeListBand Object
Properties | |
---|---|
In TdxTreeListBand | |
Alignment | The TcxGridBand.Alignment property. |
Caption | The TcxGridBand.Caption property. |
DisableCustomizing | The TcxGridBand.VisibleForCustomization property. |
DisableDragging | The band’s Options.Moving property. |
Fixed | The TcxGridBand.FixedKind property. |
HeaderColCount | The Count property of a band row within a Banded Table View. To access a particular band’s row, use code as follows |
HeaderColumn | The Items property of a band row within a Banded Table View. To access a particular band’s row, use code as follows: |
HeaderRowCount | The band’s Rows.Count property. |
MinWidth | To specify the minimum width of a band, set the minimum width (the MinWidth property) of the columns displayed within the band. |
OnlyOwnColumns | –; |
Sizing | The band’s Options.Sizing property. |
Visible | The Visible property of a band within a Banded Table View. Individual bands can be accessed via the Banded Table View’s Bands property. |
VisibleIndex | The VisibleIndex property of a band within a Banded Table View. Individual bands can be accessed via the Banded Table View’s Bands property. |
Width | The Width property of a band within a Banded Table View. Individual bands can be accessed via the Banded Table View’s Bands property. |
Methods | |
In TdxTreeListBand | |
RestoreDefaults | –; |
TdxTreeListBands Object
Properties | |
---|---|
In TdxTreeListBands | |
Items | The TcxGridBands.Items property. |
TreeList | Bands belong to a View specified by the TcxGridBands.GridView property. |
VisibleCount | The TcxGridBands.VisibleCount property. |
VisibleItems | The TcxGridBands.VisibleItems property. |
Methods | |
In TdxTreeListBands | |
Add | The TcxGridBands.Add method. |
GetAbsoluteIndex | –; |
GetVisibleIndex | –; |
RestoreDefaults | –; |
Columns
Every View provided by ExpressQuantumGrid4 contains a collection of View-specific items (columns in a (Banded) Table View and rows in a Card View) displaying data from particular fields. Unlike the previous version of the grid control, ExpressQuantumGrid4 does not provide different column types. Instead, you should use the item’s properties (RepositoryItem or PropertiesClass) to specify the editor type used to edit the item’s data. You can refer to the Data Editing Using Inplace Editors section for more information.
ExpressQuantumGrid4 provides different repository items corresponding to the ExpressQuantumGrid3 columns. These repository items can be used to specify the in-place editor type:
ExpressQuantumGrid3 members | ExpressQuantumGrid4 equivalents |
---|---|
ExpressQuantumGrid3 columns | Repository items |
---|---|
TdxDBGridColumn | |
TdxDBGridBlobColumn | |
TdxDBGridButtonColumn | |
TdxDBGridCalcColumn | |
TdxDBGridCheckColumn | |
TdxDBGridCurrencyColumn | |
TdxDBGridDateColumn | |
TdxDBGridDropDownColumn | –; |
TdxDBGridExtLookupColumn | |
TdxDBGridGraphicColumn | |
TdxDBGridHyperLinkColumn | |
TdxDBGridImageColumn | |
TdxDBGridLookupColumn | |
TdxDBGridMaskColumn | |
TdxDBGridMemoColumn | |
TdxDBGridMRUColumn | |
TdxDBGridPickColumn | |
TdxDBGridPopupColumn | |
TdxDBGridSpinColumn | |
TdxDBGridTimeColumn | |
TdxDBGridWrapperColumn | –; Use any repository item listed above and handle the OnGetProperties event to specify the type of editor used to edit values of individual item cells. |
Footer summary properties were removed from the columns and moved into the TcxDataSummary class. This class maintains the calculation of all summaries (footer, group summaries and summary groups).
The next table lists members of the TdxDBGridColumn class and the ExpressQuantumGrid4 equivalents:
TdxDBGridColumn Object
Properties | |
---|---|
Derived from TdxDBTreeListColumn | |
ATreeList | Items belong to a View specified by the GridView property. |
DisableGrouping | The column’s Options.Grouping property. |
Field | The item’s DataBinding.Field property. |
FieldName | The item’s DataBinding.FieldName property. |
GroupIndex | The column’s GroupIndex property. |
SortBySummary | –; |
SummaryField | –; The ItemLink (Column in Table Views) and/or FieldName properties of a summary item. To calculate summaries when data is grouped by the current column,
|
SummaryFooterField | –; The ItemLink and/or FieldName properties of a summary item within the View’s DataController.Summary.FooterSummaryItems collection. |
SummaryFooterFormat | –; The Format property of a summary item within the View’s DataController.Summary.FooterSummaryItems collection. |
SummaryFooterText | –; Use the FooterSummaryTexts property of the View’s DataController.Summary object. |
SummaryFooterType | –; The Kind property of a summary item within the View’s DataController.Summary.FooterSummaryItems collection. |
SummaryFooterValue | –; To get the footer summary results, use the FooterSummaryValues property of the View’s DataController.Summary object. |
SummaryFormat | –; The Format property of a summary item. |
SummaryGroup | –; |
SummaryGroupName | –; To calculate a set of summaries when data is grouped by the current column:
|
SummaryType | –; The Kind property of a summary item. See the SummaryField entry for details. |
VariantType | The item’s DataBinding.ValueTypeClass.GetVarType method. |
Derived from TdxTreeListColumn | |
Alignment | The Alignment attribute of the in-place editor properties. To access the column editor properties, use the RepositoryItem.Properties, Properties objects or the GetProperties method. |
AssignedValues | –; |
BandIndex | The banded column’s Position.BandIndex property. |
Caption | The item’s Caption property. |
CharCase | The CharCase attribute of the in-place editor properties. To access the column editor properties, use the RepositoryItem.Properties, Properties objects or the GetProperties method. |
ColIndex | The banded column’s Position.ColIndex property. |
Color | The item’s Styles.Content property. |
DisableCaption | –; |
DisableCustomizing | The column’s VisibleForCustomization property. |
DisableDragging | The column’s Options.Moving property. |
DisableEditor | The item’s Options.Editing property. |
DisableFilter | The item’s Options.Filtering property. |
Font | The item’s Styles.Content property. |
HeaderAlignment | The HeaderAlignmentHorz and HeaderAlignmentVert properties of columns; the CaptionAlignmentHorz and CaptionAlignmentVert properties of Card View rows. |
HeaderGlyph | –; The View’s BackgroundBitmaps.Header property allows you to specify the bitmap used to render all column headers. |
HeaderMaxLineCount | The banded column’s Position.LineCount property. |
Index | The item’s Index property. |
MaxLength | The MaxLength attribute of the in-place editor properties. To access the column editor properties, use the RepositoryItem.Properties, Properties objects or the GetProperties method. |
MinWidth | The column’s MinWidth property. |
PasswordChar | –; You can use the EchoMode attribute of the in-place editor properties to specify how characters are displayed. To access the column editor properties, use the RepositoryItem.Properties, Properties objects or the GetProperties method. |
ReadOnly | The ReadOnly attribute of the in-place editor properties. To access the column editor properties, use the RepositoryItem.Properties, Properties objects or the GetProperties method. |
RowIndex | The banded column’s Position.RowIndex property. |
Sizing | The column’s Options.HorzSizing property. |
Sorted | The column’s SortOrder property. |
TabStop | –; |
VertAlignment | The Alignment attribute of the in-place editor properties. To access the column editor properties, use the RepositoryItem.Properties, Properties objects or the GetProperties method. |
Visible | The item’s Visible property. |
Width | The item’s Width property. |
Methods | |
Derived from TdxTreeListColumn | |
Assign | The item’s Assign method. |
DefaultAlignment | The item’s DefaultValuesProvider.DefaultAlignment method. |
DefaultCaption | The item’s DataBinding.DefaultCaption method. |
DefaultColor | –; |
DefaultFont | –; |
DefaultReadOnly | The item’s DefaultValuesProvider.DefaultReadOnly method. |
DefaultWidth | The item’s DataBinding.DefaultWidth method. |
GetBestFit | –; |
RestoreDefaults | The item’s RestoreDefaults method. |
RestoreDefaultWidth | –; |
Events | |
Derived from TdxDBTreeListColumn | |
OnCustomDraw | The item’s OnCustomDrawCell event. |
OnCustomDrawHeader | The item’s OnCustomDrawHeader event. |
OnDrawSummaryFooter | The column’s OnCustomDrawFooterCell event. |
OnGetText | The item’s OnGetDisplayText event. |
OnSummary | The OnSummary event of the View’s DataController.Summary.DefaultGroupSummaryItems and DataController.DataSummary.SummaryGroups[ASummaryGroupIndex].SummaryItems objects. |
OnSummaryFooter | The OnSummary event of the View’s DataController.Summary.FooterSummaryItems object. |
Derived from TdxTreeListColumn | |
OnChange | –; See the View’s OnEditChanged event. |
OnCustomDrawCell | The item’s OnCustomDrawCell event. |
OnCustomDrawColumnHeader | The item’s OnCustomDrawHeader event. |
OnValidate | –; Specify an editor for an item via the PropertiesClass or RepositoryItem property and handle the Properties.OnValidate or RepositoryItem.Properties.OnValidate event respectively. |
Nodes/Records
Records provided by an ExpressQuantumGrid4 View can be accessed via the ViewData property (e.g. TcxGridTableView.ViewData). TcxCustomGridRecord is the base class for items available via the ViewData object and these items consist of group rows, master and data rows, the new item row and cards. ViewData contains only those records which are currently visible or potentially visible by scrolling. It does not contain records hidden under collapsed group rows.
TdxDBGridNode Object
ExpressQuantumGrid3 members | ExpressQuantumGrid4 equivalents |
---|---|
Properties | |
---|---|
In TdxDBGridNode | |
GroupId | The TcxGridGroupRow.Value property. |
RecNo | The TcxCustomGridRecord.RecordIndex property. |
SummaryValue | –; SummaryValue represents a value of a group summary set via the column’s SummaryType and SummaryField properties. There are no equivalents to these three properties. In ExpressQuantumGrid4, you use summary groups to calculate summaries when grouping by particular column(s). Summary groups are supported by the View’s DataController.Summary.SummaryGroups property. To get a group summary value for a particular data group, use the DataController.Summary.GroupSummaryValues property. |
SummaryValues | –; Use the View’s DataController.Summary.GroupSummaryValues property to get a summary value for a particular data group. |
Derived from TdxDBTreeListControlNode | |
Description | –; |
Id | –; See TcxCustomGridRecord.RecordIndex property. |
VariantData | –; |
VariantValues | The View’s DataController.Values property and the TcxCustomGridRecord.Values property. |
Derived from TdxTreeListNode | |
AbsoluteIndex | The TcxCustomGridRecord.Index property. |
Count | –; |
CountValues | The TcxCustomGridRecord.ValueCount property. |
Data | –; |
Deleting | –; |
Expanded | The TcxCustomGridRecord.Expanded property. |
Focused | The TcxCustomGridRecord.Focused property. |
HasChildren | –; You can determine whether the current row is a group row by analyzing the row class. A group row contains an object of the TcxGridGroupRow class. |
ImageIndex | –; |
Index | –; |
IsLast | –; |
IsVisible | The TcxCustomGridRecord.Visible property. |
Items | –; TcxGridGroupRow does not maintain a collection of child rows. Instead, you can use the View’s ViewData property to access the list of all records currently displayed within the View. |
Level | The TcxCustomGridRecord.Level property. |
Owner | Use the TcxCustomGridRecord.ViewData property to access the object owning the current record. |
Parent | –; |
Selected | The TcxCustomGridRecord.Selected property. |
SelectedIndex | –; |
StateIndex | –; |
Strings | The TcxCustomGridRecord.DisplayTexts property. For group rows, use the TcxGridGroupRow.DisplayText property. |
Values | The TcxCustomGridRecord.Values property. |
Methods | |
Derived from TdxDBTreeListControlNode | |
Delete | –; In unbound mode, use the View’s DataController.DeleteRecord method passing it the record’s RecordIndex property value as a parameter. To delete records from Views connected to datasets, use the View’s DataController.DeleteFocused or DeleteSelection methods. |
Derived from TdxTreeListNode | |
AddChild | –; |
AddChildFirst | –; |
AddNodesToList | –; |
Collapse | The TcxCustomGridRecord.Collapse method. |
DeleteChildren | –; |
Expand | The TcxCustomGridRecord.Expand method. |
GetNext | –; |
GetNextNode | –; |
GetNextSibling | –; |
GetPrev | –; |
GetPrevSibling | –; |
GetPriorNode | –; |
GetPriorParentNode | –; |
HasAsParent | –; |
IndexOf | –; |
InsertChild | –; |
MakeVisible | The TcxCustomGridRecord.MakeVisible method. |
MoveTo | –; |
Summary items
ExpressQuantumGrid provides summary groups (as in the previous version), thus enabling you to calculate summaries when grouping by particular columns. Default summary groups are now available via the View’s DataController.Summary.DefaultGroupSummaryItems property.
ExpressQuantumGrid3 members | ExpressQuantumGrid4 equivalents |
---|---|
TdxDBGridSummaryGroups Object
Properties | |
---|---|
In TdxDBGridSummaryGroups | |
DBGrid | The collection of summary groups belongs to a TcxDataSummary object that can be obtained via the TcxDataSummaryGroups.Summary property. |
Items | The TcxDataSummaryGroups.Items property. |
Methods | |
In TdxDBGridSummaryGroups | |
Add | The TcxDataSummaryGroups.Add method. |
GetDefaultGroup | –; Default groups are provided by the View’s DataController.Summary.DefaultGroupSummaryItems property. |
TdxDBGridSummaryGroup Object
Properties | |
---|---|
In TdxDBGridSummaryGroup | |
BeginSummaryText | The TcxDataGroupSummaryItems.BeginText property. |
DefaultGroup | ExpressQuantumGrid4 provides a collection of default summary items supported by the View’s DataController.Summary.DefaultGroupSummaryItems property. Default summary items specify summaries to calculate when data is grouped by any grid column except for those columns associated with summary groups in the DataController.Summary.SummaryGroups property. |
EndSummaryText | The TcxDataGroupSummaryItems.EndText property. |
Name | –; |
SummaryItems | The TcxDataSummaryGroup.SummaryItems property. |
Methods | |
In TdxDBGridSummaryGroup | |
GetSummaryGroups | See the TcxDataSummaryGroup.SummaryGroups property. |
Events | |
In TdxDBGridSummaryGroup | |
OnChangeName | –; |
TdxDBGridSummaryItems Object
Properties | |
---|---|
In TdxDBGridSummaryItems | |
Items | The Items property of the TcxDataSummaryGroup.SummaryItems object. You can access a particular summary group via the View’s DataController.Summary.SummaryGroups property. |
SummaryGroup | –; |
Methods | |
In TdxDBGridSummaryItems | |
Add | The TcxDataSummaryItems.Add method. |
TdxDBGridSummaryItem Object
Properties | |
---|---|
In TdxDBGridSummaryItem | |
ColumnName | The ItemLink property of a summary item contained in the TcxDataSummaryGroup.SummaryItems collection. Table Views and Banded Table Views provide summary items. These declare the Column property (TcxGridTableSummaryItem.Column, for instance) which can be used instead of ItemLink. |
SummaryField | The FieldName property of a summary item contained in the TcxDataSummaryGroup.SummaryItems collection. |
SummaryFormat | The Format property of a summary item contained in the TcxDataSummaryGroup.SummaryItems collection. |
SummaryType | The Kind property of a summary item contained in the TcxDataSummaryGroup.SummaryItems collection. |
Methods | |
In TdxDBGridSummaryItem | |
GetSummaryItems | –; See the TcxDataSummaryItem.SummaryItems property. |
Events | |
In TdxDBGridSummaryItem | |
OnSummary | See the TcxDataSummaryItems.OnSummary event. |
Filter
Filtering data in ExpressQuantumGrid4 is implemented by the TcxDataFilterCriteria class. It allows you to create complex filter conditions, enable/disable filter criteria and customize the filter drop-down list.
ExpressQuantumGrid3 members | ExpressQuantumGrid4 equivalents |
---|---|
TdxDBGridFilter Object
Properties | |
---|---|
In TdxDBGridFilter | |
Active | The View’s OptionsCustomize.ColumnFiltering property. |
AutoDataSetFilter | The View’s DataController.Filter.AutoDataSetFilter property. |
CaseInsensitive | The fcoCaseInsensitive option in the View’s DataController.Filter.AutoDataSetFilter property. |
DropDownCount | The View’s Filtering.MaxDropDownCount property. |
FilterCaption | The View’s DataController.Filter.FilterCaption property. |
FilterStatus | The View’s Filtering.Visible property. |
FilterText | The View’s DataController.Filter.FilterText property. |
MaxDropDownCount | The View’s DataController.Filter.MaxValueListCount property. |
Methods | |
In TdxDBGridFilter | |
Add |
|
AddNull | When creating a filter condition using the TcxFilterCriteriaItemList.AddItem method, you can specify NULL as a value for the AValue parameter. |
Clear | The View’s DataController.Filter.Clear method. You can temporarily disable filtering via the DataController.Filter.Active property. |
Remove | The View’s DataController.Filter.RemoveItemByItemLink method. Pass the column object as the AItemLink parameter. |
ShowCustomDialog | The View’s Filtering.RunCustomizeDialog method. |