GridColumnBase Class

Serves as the base for classes that represent grid columns.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v22.1.Core.dll

Declaration

C#
VB.NET

public abstract class GridColumnBase :
    NamedDataItemContainer

Public MustInherit Class GridColumnBase
    Inherits NamedDataItemContainer

Remarks

The GridDashboardItem supports the following column types:

GridDimensionColumn - displays values in the bound data member “as is”.
GridHyperlinkColumn - displays links to external resources related to displayed values.
GridMeasureColumn - displays summaries calculated against data in the bound data member.
GridDeltaColumn - binds to two data members, calculates summaries for both and displays the difference between these summaries.
GridSparklineColumn - displays values in the bound data item using sparklines.

Grid_ColumnTypes

The following code snippets (auto-collected from DevExpress Examples) contain references to the GridColumnBase class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#
VB.NET

winforms-dashboard-custom-properties/CS/WinForms-Dashboard-Custom-Properties/Modules/GridFixedColumnModule.cs#L42

gridItem.GridOptions.ColumnWidthMode = GridColumnWidthMode.AutoFitToContents;
foreach(GridColumnBase itemColumn in gridItem.Columns) {
    string customProperty = itemColumn.CustomProperties.GetValue(PropertyName);

wpf-dashboard-custom-properties/CS/Wpf-Dashboard-Custom-Properties/Modules/GridFixedColumnModule/GridFixedColumnModule.cs#L34

GridDashboardItem grid = dashboard.Items[viewModel.DashboardItemName] as GridDashboardItem;
DevExpress.DashboardCommon.GridColumnBase column = FindColumn(fieldName, grid.Columns);
if(column != null) {

winforms-dashboard-recalculate-totals/CS/WinFormsDashboard_RecalculateTotals/Classes/RecalculateGridTotalsModule.cs#L59

foreach (GridColumn column in underlyingGridView.Columns) {
    var gridDashboardColumn = gridContext.GetDashboardItemColumn(gridItem, column);
    if (gridDashboardColumn != null) {

winforms-dashboard-custom-command-buttons/CS/CommandButtonForTitleAndCaption/Form1.cs#L40

private void SwitchGridMeasureColumnDisplayMode(GridDashboardItem gridItem) {
    foreach (var column in gridItem.Columns) {
        GridMeasureColumn measureColumn = column as GridMeasureColumn;

winforms-dashboard-custom-properties/VB/WinForms-Dashboard-Custom-Properties/Modules/GridFixedColumnModule.vb#L42

gridItem.GridOptions.ColumnWidthMode = GridColumnWidthMode.AutoFitToContents
For Each itemColumn As GridColumnBase In gridItem.Columns
    Dim customProperty As String = itemColumn.CustomProperties.GetValue(PropertyName)

wpf-dashboard-custom-properties/VB/Wpf-Dashboard-Custom-Properties/Modules/GridFixedColumnModule/GridFixedColumnModule.vb#L38

Dim grid As GridDashboardItem = TryCast(dashboard.Items(viewModel.DashboardItemName), GridDashboardItem)
Dim column As DevExpress.DashboardCommon.GridColumnBase = FindColumn(fieldName, grid.Columns)
If column IsNot Nothing Then

winforms-dashboard-recalculate-totals/VB/WinFormsDashboard_RecalculateTotals/Classes/RecalculateGridTotalsModule.vb#L73


Private Sub UpdateColumnSummaryItemText(ByVal gridDashboardColumn As GridColumnBase, ByVal gridcolumn As GridColumn, ByVal dataItemDescriptor As Object)
    gridcolumn.Summary.Clear()