Back to all docs
API Reference / Telerik.Maui.Controls.DataGrid / DataGridColumn
New to Telerik UI for .NET MAUI? Start a free 30-day trial

DataGridColumn

Class

Defines an abstraction of a table column that is used to visualize data within a RadDataGrid component. A column generally represents a Property within the underlying ViewModel.

Definition

Namespace:Telerik.Maui.Controls.DataGrid

Assembly:Telerik.Maui.Controls.dll

Syntax:
C#
public abstract class DataGridColumn : StyleableElement

Inheritance: objectDataGridColumn

Derived Classes: DataGridTemplateColumnDataGridToggleRowDetailsColumnDataGridTypedColumn

Constructors

DataGridColumn()

Initializes a new instance of the DataGridColumn class.

C#
protected DataGridColumn()

Fields

ActualWidthProperty

BindableProperty

Identifies the ActualWidth property.

C#
public static readonly BindableProperty ActualWidthProperty

CanUserEditProperty

BindableProperty

Identifies the CanUserEdit property.

C#
public static readonly BindableProperty CanUserEditProperty

CanUserFilterProperty

BindableProperty

Identifies the CanUserFilter property.

C#
public static readonly BindableProperty CanUserFilterProperty

CanUserGroupProperty

BindableProperty

Identifies the CanUserGroup property.

C#
public static readonly BindableProperty CanUserGroupProperty

CanUserReorderProperty

BindableProperty

Identifies the CanUserReorder property.

C#
public static readonly BindableProperty CanUserReorderProperty

CanUserSortProperty

BindableProperty

Identifies the CanUserSort property.

C#
public static readonly BindableProperty CanUserSortProperty

CellContentTemplateProperty

BindableProperty

Identifies the CellContentTemplate property.

C#
public static readonly BindableProperty CellContentTemplateProperty

CellContentTemplateSelectorProperty

BindableProperty

Identifies the CellContentTemplateSelector property.

C#
public static readonly BindableProperty CellContentTemplateSelectorProperty

CellDecorationStyleProperty

BindableProperty

Identifies the CellDecorationStyle property.

C#
public static readonly BindableProperty CellDecorationStyleProperty

CellDecorationStyleSelectorProperty

BindableProperty

Identifies the CellDecorationStyleSelector property.

C#
public static readonly BindableProperty CellDecorationStyleSelectorProperty

CellEditTemplateProperty

BindableProperty

Identifies the CellEditTemplate property.

C#
public static readonly BindableProperty CellEditTemplateProperty

FilterControlTemplateProperty

BindableProperty

Identifies the FilterControlTemplate property.

C#
public static readonly BindableProperty FilterControlTemplateProperty

FooterContentTemplateProperty

BindableProperty

Identifies the FooterContentTemplate property.

C#
public static readonly BindableProperty FooterContentTemplateProperty

FooterStyleProperty

BindableProperty

Identifies the FooterStyle property.

C#
public static readonly BindableProperty FooterStyleProperty

FooterTextProperty

BindableProperty

Identifies the FooterText property.

C#
public static readonly BindableProperty FooterTextProperty

HeaderContentTemplateProperty

BindableProperty

Identifies the HeaderContentTemplate property.

C#
public static readonly BindableProperty HeaderContentTemplateProperty

HeaderStyleProperty

BindableProperty

Identifies the HeaderStyle property.

C#
public static readonly BindableProperty HeaderStyleProperty

HeaderTextProperty

BindableProperty

Identifies the HeaderText property.

C#
public static readonly BindableProperty HeaderTextProperty

IsFilteredProperty

BindableProperty

Identifies the IsFiltered property.

C#
public static readonly BindableProperty IsFilteredProperty

IsFrozenProperty

BindableProperty

Identifies the IsFrozen dependency property.

C#
public static readonly BindableProperty IsFrozenProperty

IsResizableProperty

BindableProperty

Identifies the IsResizable dependency property.

C#
public static readonly BindableProperty IsResizableProperty

IsSearchableProperty

BindableProperty

Identifies the IsSearchable property.

C#
public static readonly BindableProperty IsSearchableProperty

IsVisibleProperty

BindableProperty

Identifies the IsVisible property.

C#
public static readonly BindableProperty IsVisibleProperty

MinimumWidthProperty

BindableProperty

Identifies the MinimumWidth property.

C#
public static readonly BindableProperty MinimumWidthProperty

NameProperty

BindableProperty

Identifies the Name property.

C#
public static readonly BindableProperty NameProperty

ShowDistinctValuesFilterProperty

BindableProperty

Identifies the ShowDistinctValuesFilter property.

C#
public static readonly BindableProperty ShowDistinctValuesFilterProperty

SizeModeProperty

BindableProperty

Identifies the SizeMode property.

C#
public static readonly BindableProperty SizeModeProperty

SortDirectionProperty

BindableProperty

Identifies the SortDirection property.

C#
public static readonly BindableProperty SortDirectionProperty

WidthProperty

BindableProperty

Identifies the Width property.

C#
public static readonly BindableProperty WidthProperty

Properties

ActualWidth

Gets the actual width of the column.

C#
public double ActualWidth { get; }

AggregateDescriptors

Gets the collection of AggregateDescriptorBase objects that defines the current aggregate functions to be applied when the data view is computed.

C#
public ObservableItemCollection<AggregateDescriptorBase> AggregateDescriptors { get; }
Remarks:

Available AggregateDescriptorBase types include:

AggregateValues

Gets the aggregate values for the current column.

C#
public IEnumerable<string> AggregateValues { get; }

CanUserEdit

Gets or sets a value indicating whether the user can edit this column.

C#
public bool CanUserEdit { get; set; }
Property Value:

The default value is "true".

Remarks:

To enable/disable editing in RadDataGrid see the

CanUserFilter

Gets or sets a value indicating whether the user can filter this column by using the built-in filtering UI.

C#
public bool CanUserFilter { get; set; }
Property Value:

The default value is "true".

Remarks:

To enable/disable Filtering in RadDataGrid see the

CanUserGroup

Gets or sets a value indicating whether the user can group-by this column by using the built-in Grouping UI.

C#
public bool CanUserGroup { get; set; }
Property Value:

The default value is "true".

Remarks:

To enable/disable grouping in RadDataGrid see the .

CanUserReorder

Gets or sets a value indicating whether the user can use a drag gesture to reorder this column.

C#
public bool CanUserReorder { get; set; }
Property Value:

The default value is "true".

Remarks:

To enable/disable reordering of columns see the CanUserReorderColumns.

CanUserSort

Gets or sets a value indicating whether the user can sort the data by the values in this column.

C#
public bool CanUserSort { get; set; }
Property Value:

The default value is "true".

Remarks:

To enable/disable sorting in RadDataGrid see the .

CellContentTemplate

DataTemplate

Gets or sets the DataTemplate instance that defines the appearance of each cell associated with tis column.

C#
public DataTemplate CellContentTemplate { get; set; }

CellContentTemplateSelector

DataTemplateSelector

Gets or sets the DataTemplateSelector instance that may be used to retrieve dynamic data templates on a per cell basis.

C#
public DataTemplateSelector CellContentTemplateSelector { get; set; }

CellDecorationStyle

Style

Gets or sets the Style object that defines the background of each cell associated with this column. The Style should target DataGridCellDecorationAppearance.

C#
public Style CellDecorationStyle { get; set; }

CellDecorationStyleSelector

Gets or sets the IStyleSelector instance that allows for dynamic decoration on a per cell basis.

C#
public IStyleSelector CellDecorationStyleSelector { get; set; }

CellEditTemplate

DataTemplate

Gets or sets the DataTemplate instance that defines the editor associated with tis column.

C#
public DataTemplate CellEditTemplate { get; set; }

DataGrid

Gets the corresponding RadDataGrid.

C#
public RadDataGrid DataGrid { get; }

FilterControlTemplate

DataTemplate

Gets or sets the user defined template used for the filtering UI. The template must contain an instance of the DataGridFilterControlBase class.

C#
public DataTemplate FilterControlTemplate { get; set; }

FooterContentTemplate

DataTemplate

Gets or sets the DataTemplate instance that defines the appearance of the footer.

C#
public DataTemplate FooterContentTemplate { get; set; }

FooterStyle

Style

Gets or sets the Style instance that defines the appearance of the DataGridColumn footer. The Style should target DataGridColumnFooterAppearance.

C#
public Style FooterStyle { get; set; }

FooterText

Gets or sets the content to be displayed in the Footer UI of the Column.

C#
public string FooterText { get; set; }

HeaderContentTemplate

DataTemplate

Gets or sets the DataTemplate instance that defines the appearance of the header.

C#
public DataTemplate HeaderContentTemplate { get; set; }

HeaderStyle

Style

Gets or sets the Style instance that defines the appearance of the header of the column. The Style should target DataGridColumnHeaderAppearance.

C#
public Style HeaderStyle { get; set; }

HeaderText

Gets or sets the content to be displayed in the Header UI that represents the column.

C#
public string HeaderText { get; set; }

IsAutoGenerated

Gets a value indicating whether the column is auto-generated internally.

C#
public bool IsAutoGenerated { get; }

IsFiltered

Gets a value indicating whether the column is currently filtered.

C#
public bool IsFiltered { get; }

IsFrozen

Gets or sets a value indicating whether the DataGridColumn is frozen.

C#
public bool IsFrozen { get; set; }

IsResizable

Gets or sets a value indicating whether the user can resize the DataGridColumn. This is only suppoted in WinUI and MacCatalyst.

C#
public bool IsResizable { get; set; }

IsSearchable

Gets or sets a value indicating whether the cells for this column should be included in searching. See SearchSettings.

C#
public bool? IsSearchable { get; set; }

IsVisible

Gets or sets a value indicating whether if the current column is visible or not.

C#
public bool IsVisible { get; set; }

MinimumWidth

Gets or sets the minimum width for the column. Applicable when the SizeMode property is set to Fixed.

C#
public double MinimumWidth { get; set; }

Name

Gets or sets the unique name of the column. Typically this is used as an identifier for this particular instance. This value is used by the string indexer in the Columns collection.

C#
public string Name { get; set; }

ShowDistinctValuesFilter

Gets or sets a value that indicates whether the DataGridDistinctValuesFilterView should be shown inside the filtering view to display a list of distinct values to filter by.

C#
public bool ShowDistinctValuesFilter { get; set; }

SizeMode

Gets or sets the DataGridColumnSizeMode value that controls how the column and its associated cells are sized horizontally.

C#
public DataGridColumnSizeMode SizeMode { get; set; }

SortDirection

Gets the current sort direction of the column.

C#
public SortDirection SortDirection { get; }

Width

Gets or sets the fixed width for the column. Applicable when the SizeMode property is set to DataGridColumnSizeMode.Fixed.

C#
public double Width { get; set; }

Methods

GetValueForInstance(object)

Retrieves the column value for the provided object instance. This actually represents the content of a grid cell where a cell is defined by a row (data item) and a column.

C#
public virtual object GetValueForInstance(object instance)
Parameters:instanceobjectReturns:

object

OnPropertyChanged(string)

C#
protected override void OnPropertyChanged(string propertyName = null)
Parameters:propertyNamestring
In this article
DefinitionConstructorsDataGridColumn()FieldsActualWidthPropertyCanUserEditPropertyCanUserFilterPropertyCanUserGroupPropertyCanUserReorderPropertyCanUserSortPropertyCellContentTemplatePropertyCellContentTemplateSelectorPropertyCellDecorationStylePropertyCellDecorationStyleSelectorPropertyCellEditTemplatePropertyFilterControlTemplatePropertyFooterContentTemplatePropertyFooterStylePropertyFooterTextPropertyHeaderContentTemplatePropertyHeaderStylePropertyHeaderTextPropertyIsFilteredPropertyIsFrozenPropertyIsResizablePropertyIsSearchablePropertyIsVisiblePropertyMinimumWidthPropertyNamePropertyShowDistinctValuesFilterPropertySizeModePropertySortDirectionPropertyWidthPropertyPropertiesActualWidthAggregateDescriptorsAggregateValuesCanUserEditCanUserFilterCanUserGroupCanUserReorderCanUserSortCellContentTemplateCellContentTemplateSelectorCellDecorationStyleCellDecorationStyleSelectorCellEditTemplateDataGridFilterControlTemplateFooterContentTemplateFooterStyleFooterTextHeaderContentTemplateHeaderStyleHeaderTextIsAutoGeneratedIsFilteredIsFrozenIsResizableIsSearchableIsVisibleMinimumWidthNameShowDistinctValuesFilterSizeModeSortDirectionWidthMethodsGetValueForInstance(object)OnPropertyChanged(string)
Not finding the help you need?
Contact Support