ClassDataGridColumn
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:
public abstract class DataGridColumn : StyleableElement
Inheritance: objectDataGridColumn
Derived Classes:
Constructors
DataGridColumn()
Initializes a new instance of the DataGridColumn class.
Declaration
protected DataGridColumn()
Fields
ActualWidthProperty
Identifies the ActualWidth property.
Declaration
public static readonly BindableProperty ActualWidthProperty
Field Value
BindableProperty
CanUserEditProperty
Identifies the CanUserEdit property.
Declaration
public static readonly BindableProperty CanUserEditProperty
Field Value
BindableProperty
CanUserFilterProperty
Identifies the CanUserFilter property.
Declaration
public static readonly BindableProperty CanUserFilterProperty
Field Value
BindableProperty
CanUserGroupProperty
Identifies the CanUserGroup property.
Declaration
public static readonly BindableProperty CanUserGroupProperty
Field Value
BindableProperty
CanUserReorderProperty
Identifies the CanUserReorder property.
Declaration
public static readonly BindableProperty CanUserReorderProperty
Field Value
BindableProperty
CanUserSortProperty
Identifies the CanUserSort property.
Declaration
public static readonly BindableProperty CanUserSortProperty
Field Value
BindableProperty
CellContentTemplateProperty
Identifies the CellContentTemplate property.
Declaration
public static readonly BindableProperty CellContentTemplateProperty
Field Value
BindableProperty
CellContentTemplateSelectorProperty
Identifies the CellContentTemplateSelector property.
Declaration
public static readonly BindableProperty CellContentTemplateSelectorProperty
Field Value
BindableProperty
CellDecorationStyleProperty
Identifies the CellDecorationStyle property.
Declaration
public static readonly BindableProperty CellDecorationStyleProperty
Field Value
BindableProperty
CellDecorationStyleSelectorProperty
Identifies the CellDecorationStyleSelector property.
Declaration
public static readonly BindableProperty CellDecorationStyleSelectorProperty
Field Value
BindableProperty
CellEditTemplateProperty
Identifies the CellEditTemplate property.
Declaration
public static readonly BindableProperty CellEditTemplateProperty
Field Value
BindableProperty
FilterControlTemplateProperty
Identifies the FilterControlTemplate property.
Declaration
public static readonly BindableProperty FilterControlTemplateProperty
Field Value
BindableProperty
FooterContentTemplateProperty
Identifies the FooterContentTemplate property.
Declaration
public static readonly BindableProperty FooterContentTemplateProperty
Field Value
BindableProperty
FooterStyleProperty
Identifies the FooterStyle property.
Declaration
public static readonly BindableProperty FooterStyleProperty
Field Value
BindableProperty
FooterTextProperty
Identifies the FooterText property.
Declaration
public static readonly BindableProperty FooterTextProperty
Field Value
BindableProperty
HeaderContentTemplateProperty
Identifies the HeaderContentTemplate property.
Declaration
public static readonly BindableProperty HeaderContentTemplateProperty
Field Value
BindableProperty
HeaderStyleProperty
Identifies the HeaderStyle property.
Declaration
public static readonly BindableProperty HeaderStyleProperty
Field Value
BindableProperty
HeaderTextProperty
Identifies the HeaderText property.
Declaration
public static readonly BindableProperty HeaderTextProperty
Field Value
BindableProperty
IsFilteredProperty
Identifies the IsFiltered property.
Declaration
public static readonly BindableProperty IsFilteredProperty
Field Value
BindableProperty
IsFrozenProperty
Identifies the IsFrozen dependency property.
Declaration
public static readonly BindableProperty IsFrozenProperty
Field Value
BindableProperty
IsResizableProperty
Identifies the IsResizable dependency property.
Declaration
public static readonly BindableProperty IsResizableProperty
Field Value
BindableProperty
IsSearchableProperty
Identifies the IsSearchable property.
Declaration
public static readonly BindableProperty IsSearchableProperty
Field Value
BindableProperty
IsVisibleProperty
Identifies the IsVisible property.
Declaration
public static readonly BindableProperty IsVisibleProperty
Field Value
BindableProperty
MinimumWidthProperty
Identifies the MinimumWidth property.
Declaration
public static readonly BindableProperty MinimumWidthProperty
Field Value
BindableProperty
NameProperty
Identifies the Name property.
Declaration
public static readonly BindableProperty NameProperty
Field Value
BindableProperty
ShowDistinctValuesFilterProperty
Identifies the ShowDistinctValuesFilter property.
Declaration
public static readonly BindableProperty ShowDistinctValuesFilterProperty
Field Value
BindableProperty
SizeModeProperty
Identifies the SizeMode property.
Declaration
public static readonly BindableProperty SizeModeProperty
Field Value
BindableProperty
SortDirectionProperty
Identifies the SortDirection property.
Declaration
public static readonly BindableProperty SortDirectionProperty
Field Value
BindableProperty
WidthProperty
Identifies the Width property.
Declaration
public static readonly BindableProperty WidthProperty
Field Value
BindableProperty
Properties
ActualWidth
Gets the actual width of the column.
AggregateDescriptors
Gets the collection of AggregateDescriptorBase objects that defines the current aggregate functions to be applied when the data view is computed.
Declaration
public ObservableItemCollection<AggregateDescriptorBase> AggregateDescriptors { get; }
Property Value
AggregateValues
Gets the aggregate values for the current column.
Declaration
public IEnumerable<string> AggregateValues { get; }
Property Value
CanUserEdit
Gets or sets a value indicating whether the user can edit this column.
Declaration
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.
Declaration
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.
Declaration
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.
Declaration
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.
Declaration
public bool CanUserSort { get; set; }
Property Value
The default value is "true".
Remarks
To enable/disable sorting in RadDataGrid see the .
CellContentTemplate
Gets or sets the DataTemplate instance that defines the appearance of each cell associated with tis column.
Declaration
public DataTemplate CellContentTemplate { get; set; }
Property Value
DataTemplate
CellContentTemplateSelector
Gets or sets the DataTemplateSelector instance that may be used to retrieve dynamic data templates on a per cell basis.
Declaration
public DataTemplateSelector CellContentTemplateSelector { get; set; }
Property Value
DataTemplateSelector
CellDecorationStyle
Gets or sets the Style object that defines the background of each cell associated with this column. The Style should target DataGridCellDecorationAppearance.
Declaration
public Style CellDecorationStyle { get; set; }
Property Value
Style
CellDecorationStyleSelector
Gets or sets the IStyleSelector instance that allows for dynamic decoration on a per cell basis.
Declaration
public IStyleSelector CellDecorationStyleSelector { get; set; }
Property Value
CellEditTemplate
Gets or sets the DataTemplate instance that defines the editor associated with tis column.
Declaration
public DataTemplate CellEditTemplate { get; set; }
Property Value
DataTemplate
DataGrid
Gets the corresponding RadDataGrid.
FilterControlTemplate
Gets or sets the user defined template used for the filtering UI. The template must contain an instance of the DataGridFilterControlBase class.
Declaration
public DataTemplate FilterControlTemplate { get; set; }
Property Value
DataTemplate
FooterContentTemplate
Gets or sets the DataTemplate instance that defines the appearance of the footer.
Declaration
public DataTemplate FooterContentTemplate { get; set; }
Property Value
DataTemplate
FooterStyle
Gets or sets the Style instance that defines the appearance of the DataGridColumn footer. The Style should target DataGridColumnFooterAppearance.
Declaration
public Style FooterStyle { get; set; }
Property Value
Style
FooterText
Gets or sets the content to be displayed in the Footer UI of the Column.
HeaderContentTemplate
Gets or sets the DataTemplate instance that defines the appearance of the header.
Declaration
public DataTemplate HeaderContentTemplate { get; set; }
Property Value
DataTemplate
HeaderStyle
Gets or sets the Style instance that defines the appearance of the header of the column. The Style should target DataGridColumnHeaderAppearance.
Declaration
public Style HeaderStyle { get; set; }
Property Value
Style
HeaderText
Gets or sets the content to be displayed in the Header UI that represents the column.
IsAutoGenerated
Gets a value indicating whether the column is auto-generated internally.
IsFiltered
Gets a value indicating whether the column is currently filtered.
IsFrozen
Gets or sets a value indicating whether the DataGridColumn is frozen.
IsResizable
Gets or sets a value indicating whether the user can resize the DataGridColumn. This is only suppoted in WinUI and MacCatalyst.
IsSearchable
Gets or sets a value indicating whether the cells for this column should be included in searching. See SearchSettings.
IsVisible
Gets or sets a value indicating whether if the current column is visible or not.
MinimumWidth
Gets or sets the minimum width for the column. Applicable when the SizeMode property is set to Fixed.
Name
Gets or sets the unique name of the column. Typically this is used as an identifier for this particular instance.
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.
Declaration
public bool ShowDistinctValuesFilter { get; set; }
Property Value
SizeMode
Gets or sets the DataGridColumnSizeMode value that controls how the column and its associated cells are sized horizontally.
Declaration
public DataGridColumnSizeMode SizeMode { get; set; }
Property Value
SortDirection
Gets the current sort direction of the column.
Declaration
public SortDirection SortDirection { get; }
Property Value
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.
OnPropertyChanged(string)
Declaration
protected override void OnPropertyChanged(string propertyName = null)
Parameters
propertyName