Documentation

Class RadDataGrid

Represents a custom Microsoft.Maui.Controls.View implementation that may be used to visualize data in tabular format - that is by rows and columns.

Inheritance
System.Object
RadLayout
RadDataGrid
Inherited Members
Namespace: Telerik.Maui.Controls
Assembly: Telerik.Maui.Controls.dll

Syntax

public class RadDataGrid : RadLayout, IGridView, IRadView, IElementPresenter, IUpdateServiceProvider<UpdateFlags>, ICommandService, ISelectionService, IEditingService

Constructors

RadDataGrid()

Initializes a new instance of the RadDataGrid class.

Declaration
public RadDataGrid()

Fields

AlternateRowBackgroundStyleProperty

Identifies the AlternateRowBackgroundStyle property.

Declaration
public static readonly BindableProperty AlternateRowBackgroundStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ApplyDataOperationsOnPropertyChangeProperty

Identifies the ApplyDataOperationsOnPropertyChange dependency property.

Declaration
public static readonly BindableProperty ApplyDataOperationsOnPropertyChangeProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

AreRowDetailsFrozenProperty

Identifies the AreRowDetailsFrozen property.

Declaration
public static readonly BindableProperty AreRowDetailsFrozenProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

AutoGenerateColumnsProperty

Identifies the AutoGenerateColumns dependency property.

Declaration
public static readonly BindableProperty AutoGenerateColumnsProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

BorderBrushProperty

Identifies the BorderBrush property.

Declaration
public static readonly BindableProperty BorderBrushProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

BorderThicknessProperty

Identifies the BorderThickness property.

Declaration
public static readonly BindableProperty BorderThicknessProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

CanUserExpandMultipleRowDetailsProperty

Identifies the CanUserExpandMultipleRowDetails property.

Declaration
public static readonly BindableProperty CanUserExpandMultipleRowDetailsProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

CanUserReorderColumnsProperty

Identifies the CanUserReorderColumns property.

Declaration
public static readonly BindableProperty CanUserReorderColumnsProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

CanUserResizeColumnsProperty

Identifies the CanUserResizeColumns property.

Declaration
public static readonly BindableProperty CanUserResizeColumnsProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ColumnHeaderDragVisualTemplateProperty

Identifies the ColumnHeaderDragVisualTemplate property.

Declaration
public static readonly BindableProperty ColumnHeaderDragVisualTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ColumnReorderIndicatorTemplateProperty

Identifies the ColumnReorderIndicatorTemplate property.

Declaration
public static readonly BindableProperty ColumnReorderIndicatorTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

CurrentCellProperty

Identifies the CurrentCell property.

Declaration
public static readonly BindableProperty CurrentCellProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

CurrentCellStyleProperty

Identifies the CurrentCellStyle property.

Declaration
public static readonly BindableProperty CurrentCellStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

DataOperationIndicationModeProperty

Identifies the DataOperationIndicationMode property.

Declaration
public static readonly BindableProperty DataOperationIndicationModeProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

DraggedObjectProperty

Identifies the DraggedObject property.

Declaration
public static readonly BindableProperty DraggedObjectProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

EmptyContentDisplayModeProperty

Identifies the EmptyContentDisplayMode property.

Declaration
public static readonly BindableProperty EmptyContentDisplayModeProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

EmptyContentTemplateProperty

Identifies the EmptyContentTemplate property.

Declaration
public static readonly BindableProperty EmptyContentTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ExpandedRowDetailsProperty

Identifies the ExpandedRowDetails property.

Declaration
public static readonly BindableProperty ExpandedRowDetailsProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

FilterDescriptorsProperty

Identifies the FilterDescriptors dependency property.

Declaration
public static readonly BindableProperty FilterDescriptorsProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

FrozenColumnsSplitterStyleProperty

Identifies the FrozenColumnsSplitterStyle property.

Declaration
public static readonly BindableProperty FrozenColumnsSplitterStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

GridLinesColorProperty

Identifies the GridLinesColor property.

Declaration
public static readonly BindableProperty GridLinesColorProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

GridLinesThicknessProperty

Identifies the GridLinesThickness property.

Declaration
public static readonly BindableProperty GridLinesThicknessProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

GridLinesVisibilityProperty

Identifies the GridLinesVisibility property.

Declaration
public static readonly BindableProperty GridLinesVisibilityProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

GroupDescriptorsProperty

Identifies the GroupDescriptors dependency property.

Declaration
public static readonly BindableProperty GroupDescriptorsProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

GroupFooterStyleProperty

Identifies the GroupFooterStyle property.

Declaration
public static readonly BindableProperty GroupFooterStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

GroupFooterStyleSelectorProperty

Identifies the GroupFooterStyleSelector property.

Declaration
public static readonly BindableProperty GroupFooterStyleSelectorProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

GroupFooterTemplateProperty

Identifies the GroupFooterTemplate property.

Declaration
public static readonly BindableProperty GroupFooterTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

GroupHeaderStyleProperty

Identifies the GroupHeaderStyle property.

Declaration
public static readonly BindableProperty GroupHeaderStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

GroupHeaderStyleSelectorProperty

Identifies the GroupHeaderStyleSelector property.

Declaration
public static readonly BindableProperty GroupHeaderStyleSelectorProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

GroupHeaderTemplateProperty

Identifies the GroupHeaderTemplate property.

Declaration
public static readonly BindableProperty GroupHeaderTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

GroupHeaderTemplateSelectorProperty

Identifies the GroupHeaderTemplateSelector property.

Declaration
public static readonly BindableProperty GroupHeaderTemplateSelectorProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

GroupingPanelItemTemplateProperty

Identifies the GroupingPanelItemTemplate property.

Declaration
public static readonly BindableProperty GroupingPanelItemTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

IsBusyProperty

Identifies the IsBusy property.

Declaration
public static readonly BindableProperty IsBusyProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

IsEmptyContentVisibleProperty

Identifies the property.

Declaration
public static readonly BindableProperty IsEmptyContentVisibleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ItemsSourceProperty

Identifies the ItemsSource dependency property.

Declaration
public static readonly BindableProperty ItemsSourceProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ListenForNestedPropertyChangeProperty

Identifies the ListenForNestedPropertyChange property.

Declaration
public static readonly BindableProperty ListenForNestedPropertyChangeProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

LoadOnDemandAutoTemplateProperty

Identifies the LoadOnDemandAutoTemplate property.

Declaration
public static readonly BindableProperty LoadOnDemandAutoTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

LoadOnDemandBufferItemsCountProperty

Identifies the LoadOnDemandBufferItemsCount property.

Declaration
public static readonly BindableProperty LoadOnDemandBufferItemsCountProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

LoadOnDemandModeProperty

Identifies the LoadOnDemandMode property.

Declaration
public static readonly BindableProperty LoadOnDemandModeProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

LoadOnDemandRowStyleProperty

Identifies the LoadOnDemandRowStyle property.

Declaration
public static readonly BindableProperty LoadOnDemandRowStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

LoadOnDemandRowTemplateProperty

Identifies the LoadOnDemandRowTemplate property.

Declaration
public static readonly BindableProperty LoadOnDemandRowTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

MouseHoverStyleProperty

Identifies the MouseHoverStyle property.

Declaration
public static readonly BindableProperty MouseHoverStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

RenderModeProperty

Identifies the RenderMode property.

Declaration
public static readonly BindableProperty RenderModeProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

RowBackgroundStyleProperty

Identifies the RowBackgroundStyle property.

Declaration
public static readonly BindableProperty RowBackgroundStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

RowDetailsTemplateProperty

Identifies the RowDetailsTemplate property.

Declaration
public static readonly BindableProperty RowDetailsTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

RowHeightProperty

Identifies the RowHeight property.

Declaration
public static readonly BindableProperty RowHeightProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SearchPanelProperty

Identifies the SearchPanel property.

Declaration
public static readonly BindableProperty SearchPanelProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SearchSettingsProperty

Identifies the SearchSettings property.

Declaration
public static readonly BindableProperty SearchSettingsProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SelectedItemProperty

Identifies the SelectedItem property.

Declaration
public static readonly BindableProperty SelectedItemProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SelectedItemsProperty

Identifies the SelectedItems property.

Declaration
public static readonly BindableProperty SelectedItemsProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SelectionModeProperty

Identifies the SelectionMode property.

Declaration
public static readonly BindableProperty SelectionModeProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SelectionStyleProperty

Identifies the SelectionStyle property.

Declaration
public static readonly BindableProperty SelectionStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SelectionUnitProperty

Identifies the SelectionUnit property.

Declaration
public static readonly BindableProperty SelectionUnitProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ServicePanelProperty

Identifies the ServicePanel property.

Declaration
public static readonly BindableProperty ServicePanelProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ShowColumnFootersProperty

Identifies the ShowColumnFooters dependency property.

Declaration
public static readonly BindableProperty ShowColumnFootersProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ShowGroupFootersProperty

Identifies the ShowGroupFooters dependency property.

Declaration
public static readonly BindableProperty ShowGroupFootersProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ShowGroupHeaderAggregatesProperty

Identifies the ShowGroupHeaderAggregates dependency property.

Declaration
public static readonly BindableProperty ShowGroupHeaderAggregatesProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SortDescriptorsProperty

Identifies the SortDescriptors dependency property.

Declaration
public static readonly BindableProperty SortDescriptorsProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

UserEditModeProperty

Identifies the UserEditMode property.

Declaration
public static readonly BindableProperty UserEditModeProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

UserFilterModeProperty

Identifies the UserFilterMode property.

Declaration
public static readonly BindableProperty UserFilterModeProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

UserGroupModeProperty

Identifies the UserGroupMode dependency property.

Declaration
public static readonly BindableProperty UserGroupModeProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

UserSortModeProperty

Identifies the UserSortMode dependency property.

Declaration
public static readonly BindableProperty UserSortModeProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ViewportBufferHeightProperty

Identifies the ViewportBufferHeight property.

Declaration
public static readonly BindableProperty ViewportBufferHeightProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

Properties

AlternateRowBackgroundStyle

Gets or sets the Microsoft.Maui.Controls.Style that defines the appearance of an alternate row. The Style should target DataGridAlternateRowBackgroundAppearance.

Declaration
public Style AlternateRowBackgroundStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

ApplyDataOperationsOnPropertyChange

Gets or sets a value indicating whether the operations (sorting, filtering, grouping) should be applied when PropertyChanged event is raised.

Declaration
public bool ApplyDataOperationsOnPropertyChange { get; set; }
Property Value
System.Boolean

AreRowDetailsFrozen

Gets or sets a value indicating whether or not the row details are frozen, i.e. they retain position during horizontal scroll.

Declaration
public bool AreRowDetailsFrozen { get; set; }
Property Value
System.Boolean

AutoGenerateColumns

Gets or sets a value indicating whether grid's columns will be auto-generated from the provided ViewModel's properties.

Declaration
public bool AutoGenerateColumns { get; set; }
Property Value
System.Boolean

BorderBrush

Gets or sets the Brush of the border placed around the RadDataGrid control.

Declaration
public Brush BorderBrush { get; set; }
Property Value
Microsoft.Maui.Controls.Brush

BorderThickness

Gets or sets the thickness of the border placed around the RadDataGrid control.

Declaration
public Thickness BorderThickness { get; set; }
Property Value
Microsoft.Maui.Thickness

CanUserExpandMultipleRowDetails

Gets or sets a value indicating whether multiple row details can be expanded.

Declaration
public bool CanUserExpandMultipleRowDetails { get; set; }
Property Value
System.Boolean

CanUserReorderColumns

Gets or sets a value indicating whether the user can reorder the DataGridColumns in the RadDataGrid.

Declaration
public bool CanUserReorderColumns { get; set; }
Property Value
System.Boolean

CanUserResizeColumns

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

Declaration
public bool CanUserResizeColumns { get; set; }
Property Value
System.Boolean

ColumnHeaderDragVisualTemplate

Gets or sets the template that presents the drag visual of the dragged column header.

Declaration
public DataTemplate ColumnHeaderDragVisualTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

ColumnReorderIndicatorTemplate

Gets or sets the template that presents the indicator that is shown between two columns during reordering.

Declaration
public DataTemplate ColumnReorderIndicatorTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

Columns

Gets the collection of DataGridColumn objects currently displayed within the grid.

Declaration
public DataGridColumnCollection Columns { get; }
Property Value
DataGridColumnCollection

Commands

Gets the collection with all the custom commands registered with the CommandService. Custom commands have higher priority than the built-in (default) ones.

Declaration
public ObservableCollection<ControlCommandBase<RadDataGrid>> Commands { get; }
Property Value
System.Collections.ObjectModel.ObservableCollection<ControlCommandBase<RadDataGrid>>

CommandService

Gets the DataGridCommandService instance that manages the commanding behavior of this instance.

Declaration
public DataGridCommandService CommandService { get; }
Property Value
DataGridCommandService

Implements

CurrentCell

Gets or sets the current cell of the RadDataGrid.

Declaration
public DataGridCellInfo CurrentCell { get; set; }
Property Value
DataGridCellInfo

CurrentCellStyle

Gets or sets the Microsoft.Maui.Controls.Style that defines the appearance settings applied to the RadDataGrid's current cell. The Style should target DataGridCurrentCellAppearance.

Declaration
public Style CurrentCellStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

DataOperationIndicationMode

Gets or sets a value that defines whether a universal indicator is used or individual indicators are used when data operations are applied.

Declaration
public DataOperationIndicationMode DataOperationIndicationMode { get; set; }
Property Value
DataOperationIndicationMode

DraggedObject

Gets the object that is currently being dragged (for example the column when dragging to group).

Declaration
public object DraggedObject { get; }
Property Value
System.Object

EmptyContentDisplayMode

Gets or sets a value that specifies when the EmptyContentTemplate will be displayed.

Declaration
public EmptyContentDisplayMode EmptyContentDisplayMode { get; set; }
Property Value
EmptyContentDisplayMode

EmptyContentTemplate

Gets or sets the Microsoft.Maui.Controls.DataTemplate that defines the content of the view which is shown when there are no items.

Declaration
public DataTemplate EmptyContentTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

ExpandedRowDetails

Gets or sets the collection of items that have expanded row details.

Declaration
public IList ExpandedRowDetails { get; set; }
Property Value
System.Collections.IList

FilterDescriptors

Gets the collection of FilterDescriptorBase objects that defines the current filtering within this instance.

Declaration
public FilterDescriptorCollection FilterDescriptors { get; }
Property Value
FilterDescriptorCollection

FrozenColumns

Gets the collection of DataGridColumn objects currently frozen and displayed within the grid.

Declaration
public DataGridFrozenColumnCollection FrozenColumns { get; }
Property Value
DataGridFrozenColumnCollection

FrozenColumnsSplitterStyle

Gets or sets the Microsoft.Maui.Controls.Style that defines the appearance settings applied to the RadDataGrid's splitter that divides the frozen from the unfrozen area. The Style should target DataGridFrozenColumnsSplitterAppearance.

Declaration
public Style FrozenColumnsSplitterStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

GridLinesColor

Gets or sets the Microsoft.Maui.Graphics.Color value that defines the appearance of grid's horizontal and vertical lines.

Declaration
public Color GridLinesColor { get; set; }
Property Value
Microsoft.Maui.Graphics.Color

GridLinesThickness

Gets or sets the width of the vertical grid lines and the height of the horizontal grid lines.

Declaration
public double GridLinesThickness { get; set; }
Property Value
System.Double

GridLinesVisibility

Gets or sets the GridLinesVisibility value that defines which grid lines are currently visible (displayed).

Declaration
public GridLinesVisibility GridLinesVisibility { get; set; }
Property Value
GridLinesVisibility

GroupDescriptors

Gets the collection of GroupDescriptorBase objects that defines the current grouping within this instance. Multiple group descriptors define multiple group levels.

Declaration
public GroupDescriptorCollection GroupDescriptors { get; }
Property Value
GroupDescriptorCollection

GroupFooterStyle

Gets or sets the Microsoft.Maui.Controls.Style for the appearance of all the group footers within the grid. The Style should target DataGridGroupFooterAppearance.

Declaration
public Style GroupFooterStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

GroupFooterStyleSelector

Gets or sets the IStyleSelector instance that may be used to select different styles on a per group footer basis.

Declaration
public IStyleSelector GroupFooterStyleSelector { get; set; }
Property Value
IStyleSelector

GroupFooterTemplate

Gets or sets the Microsoft.Maui.Controls.DataTemplate instance that defines the appearance of each group footer within the grid. TODO: The data context of each group footer will be a GroupFooterContext instance.

Declaration
public DataTemplate GroupFooterTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

GroupHeaderStyle

Gets or sets the Microsoft.Maui.Controls.Style for the appearance of all the group headers within the grid. The Style should target DataGridGroupHeaderAppearance.

Declaration
public Style GroupHeaderStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

GroupHeaderStyleSelector

Gets or sets the IStyleSelector instance that may be used to select different styles on a per group header basis.

Declaration
public IStyleSelector GroupHeaderStyleSelector { get; set; }
Property Value
IStyleSelector

GroupHeaderTemplate

Gets or sets the Microsoft.Maui.Controls.DataTemplate instance that defines the appearance of each group header within the grid. The data context of each group header will be a GroupHeaderContext instance.

Declaration
public DataTemplate GroupHeaderTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

GroupHeaderTemplateSelector

Gets or sets the Microsoft.Maui.Controls.DataTemplateSelector instance that may be used to select group header template on a per header instance basis. The "Item" parameter of the DataTemplateSelector.SelectTemplate method will be a GroupHeaderContext instance.

Declaration
public DataTemplateSelector GroupHeaderTemplateSelector { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplateSelector

GroupingPanelItemTemplate

Gets or sets the item template of the DataGridGroupingPanel.

Declaration
public DataTemplate GroupingPanelItemTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

HitTestService

Gets the HitTestService instance that provides methods for retrieving rows and cells from a given physical location.

Declaration
public HitTestService HitTestService { get; }
Property Value
HitTestService

IsBusy

Gets or sets a value indicating whether the built-in BusyIndicator control is enabled. If true, the Grid will display an indeterminate progress indicator while it is processing some background requests like filtering, sorting or grouping.

Declaration
public bool IsBusy { get; set; }
Property Value
System.Boolean

ItemsSource

Gets or sets the data provider.

Declaration
public object ItemsSource { get; set; }
Property Value
System.Object

ListenForNestedPropertyChange

Gets or sets a value indicating whether the DataGrid should be updated if INotifyPropertyChanged item from its source is changed.

Declaration
public bool ListenForNestedPropertyChange { get; set; }
Property Value
System.Boolean

LoadOnDemandAutoTemplate

Gets or sets the DataTemplate of the row that get visualized when the LoadOnDemandMode is Auto.

Declaration
public DataTemplate LoadOnDemandAutoTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

LoadOnDemandBufferItemsCount

Gets or sets the incremental loading buffer items count.

Declaration
public int LoadOnDemandBufferItemsCount { get; set; }
Property Value
System.Int32

The incremental loading buffer items count.

LoadOnDemandMode

Gets or sets the load on demand mode.

Declaration
public LoadOnDemandMode LoadOnDemandMode { get; set; }
Property Value
LoadOnDemandMode

LoadOnDemandRowStyle

Gets or sets the Microsoft.Maui.Controls.Style instance that defines the appearance of the load more data row. The Style should target DataGridLoadOnDemandRowAppearance.

Declaration
public Style LoadOnDemandRowStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

LoadOnDemandRowTemplate

Gets or sets the DataTemplate of the row that get visualized when the LoadOnDemandMode is Manual.

Declaration
public DataTemplate LoadOnDemandRowTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

MouseHoverStyle

Gets or sets the Microsoft.Maui.Controls.Style for the appearance applied to the RadDataGrid cells and rows when the mouse is over them. The Style should target DataGridMouseHoverAppearance.

Declaration
public Style MouseHoverStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

RenderMode

Gets or sets the render mode which defines how the content of the DataGrid is rendered - via SkiaSharp or other means (UIView elements in iOS and MacCatalyst).

Declaration
public DataGridRenderMode RenderMode { get; set; }
Property Value
DataGridRenderMode

RowBackgroundStyle

Gets or sets the Microsoft.Maui.Controls.Style for the appearance of each row. The Style should target DataGridRowBackgroundAppearance

Declaration
public Style RowBackgroundStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

RowDetailsTemplate

Gets or sets the Microsoft.Maui.Controls.DataTemplate or Microsoft.Maui.Controls.DataTemplateSelector used for displaying row details.

Declaration
public DataTemplate RowDetailsTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

RowHeight

Gets or sets the height of the row. In order to make the row auto measure its Height set the value to System.Double.NaN.

Declaration
public double RowHeight { get; set; }
Property Value
System.Double

SearchPanel

Gets or sets the panel that contains search related views.

Declaration
public DataGridSearchPanel SearchPanel { get; set; }
Property Value
DataGridSearchPanel

SearchSettings

Gets or sets the corresponding search settings.

Declaration
public DataGridSearchSettings SearchSettings { get; set; }
Property Value
DataGridSearchSettings

SelectedItem

Gets or sets the selected item of the DataGrid.

Declaration
public object SelectedItem { get; set; }
Property Value
System.Object

Remarks

When the value of the SelectionUnit is Cell, the selected item is of type DataGridCellInfo. When the value of the SelectionUnit is Row, the selected item is of the same type as the business object.

SelectedItems

Gets the currently selected items within this instance. The type of items within the collection depends on the current SelectionUnit value:

Declaration
public ObservableCollection<object> SelectedItems { get; }
Property Value
System.Collections.ObjectModel.ObservableCollection<System.Object>

SelectionMode

Gets or sets the selection mode of the DataGrid. The default value is DataGridSelectionMode.Single.

Declaration
public DataGridSelectionMode SelectionMode { get; set; }
Property Value
DataGridSelectionMode

Examples

XAML

 <telerikGrid:RadDataGrid x:Name="dataGrid" SelectionMode="Multiple"/>

C#

this.dataGrid.SelectionMode = DataGridSelectionMode.Multiple;

SelectionStyle

Gets or sets the Microsoft.Maui.Controls.Style for the appearance applied to the RadDataGrid selection. The Style should target DataGridSelectionAppearance.

Declaration
public Style SelectionStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

SelectionUnit

Gets or sets the selection unit of the DataGrid. The default value is DataGridSelectionUnit.Row

Declaration
public DataGridSelectionUnit SelectionUnit { get; set; }
Property Value
DataGridSelectionUnit

Examples

XAML

<telerikGrid:RadDataGrid x:Name="dataGrid" SelectionUnit="Cell"/>

C#

this.dataGrid.SelectionUnit = DataGridSelectionUnit.Cell;

ServicePanel

Gets or sets the panel that contains various service related views such as the DataGridGroupingPanel.

Declaration
public DataGridServicePanel ServicePanel { get; set; }
Property Value
DataGridServicePanel

ShouldDisplayServicePanel

Gets a value indicating whether the default ServicePanel should be displayed or not.

Declaration
public bool ShouldDisplayServicePanel { get; }
Property Value
System.Boolean

ShowColumnFooters

Gets or sets a value indicating whether to show column footers.

Declaration
public bool ShowColumnFooters { get; set; }
Property Value
System.Boolean

ShowGroupFooters

Gets or sets a value indicating whether to show footers for groups.

Declaration
public bool ShowGroupFooters { get; set; }
Property Value
System.Boolean

ShowGroupHeaderAggregates

Gets or sets a value indicating whether to show aggregates in the group headers.

Declaration
public bool ShowGroupHeaderAggregates { get; set; }
Property Value
System.Boolean

SortDescriptors

Gets the collection of SortDescriptorBase objects that defines the current sorting within this instance. Multiple sort descriptors define a sorting operation by multiple keys.

Declaration
public SortDescriptorCollection SortDescriptors { get; }
Property Value
SortDescriptorCollection

UnfrozenColumns

Gets the collection of DataGridColumn objects currently unfrozen and displayed within the grid.

Declaration
public ReadOnlyObservableCollection<DataGridColumn> UnfrozenColumns { get; }
Property Value
System.Collections.ObjectModel.ReadOnlyObservableCollection<DataGridColumn>

UserEditMode

Gets or sets the user edit mode of the DataGrid.

Declaration
public DataGridUserEditMode UserEditMode { get; set; }
Property Value
DataGridUserEditMode

The can user edit.

UserFilterMode

Gets or sets the DataGridUserFilterMode value that defines whether the Filter Glyph is present in the header of the currently available filterable columns. The default value is DataGridUserFilterMode.Auto

Declaration
public DataGridUserFilterMode UserFilterMode { get; set; }
Property Value
DataGridUserFilterMode

Examples

XAML

 <telerikGrid:RadDataGrid x:Name="dataGrid" UserFilterMode="Disabled"/>

C#

this.dataGrid.UserFilterMode = DataGridUserFilterMode.Disabled;

UserGroupMode

Gets or sets the DataGridUserGroupMode value that determines whether the User is allowed to change the current Grouping state through the User Interface. The default value is DataGridUserGroupMode.Auto

Declaration
public DataGridUserGroupMode UserGroupMode { get; set; }
Property Value
DataGridUserGroupMode

Examples

XAML

<telerikGrid:RadDataGrid x:Name="dataGrid" UserGroupMode="Disabled"/>

C#

this.dataGrid.UserGroupMode = DataGridUserGroupMode.Disabled

UserSortMode

Gets or sets the DataGridUserSortMode value that defines how User Input (column header tap) affects the current Sort state of the grid. The default value is DataGridUserSortMode.Auto

Declaration
public DataGridUserSortMode UserSortMode { get; set; }
Property Value
DataGridUserSortMode

Examples

XAML

<telerikGrid:RadDataGrid x:Name="dataGrid" UserSortMode="None"/>

C#

this.dataGrid.UserSortMode = DataGridUserSortMode.None;

ViewportBufferHeight

Gets or sets the size of the buffer of the viewport in UWP. The buffer is intended to virtually expand the size of the viewport the DataGrid's engine works with. The engine then works with a viewport that is actually larger than the visible area of the DataGrid. The engine considers this expanded viewport to be the actual viewport in which the drawing surface is positioned and in which visual elements are realized (virtualized).

Declaration
public double ViewportBufferHeight { get; set; }
Property Value
System.Double

VisualStateService

Gets the service that handles visual-state related logic, such as keeping track of the element that the mouse is currently over.

Declaration
public DataGridVisualStateService VisualStateService { get; }
Property Value
DataGridVisualStateService

Methods

CanRebuildUI(UpdateFlags)

Declaration
protected virtual bool CanRebuildUI(UpdateFlags flags)
Parameters
UpdateFlags flags

Returns
System.Boolean

CreateFilterTapContext(DataGridColumn)

Generates FilterTapContext for the specified column.

Declaration
public FilterTapContext CreateFilterTapContext(DataGridColumn column)
Parameters
DataGridColumn column

Returns
FilterTapContext

DeselectAll()

Clears the current selection state.

Declaration
public void DeselectAll()

DeselectCell(DataGridCellInfo)

Removes the selection for the grid cell defined by the specified cell info.

Declaration
public void DeselectCell(DataGridCellInfo item)
Parameters
DataGridCellInfo item

DeselectItem(Object)

Removes the selection for the specified data item and removes it from the SelectedItems collection.

Declaration
public void DeselectItem(object item)
Parameters
System.Object item

GetDataView()

Gets the IDataViewCollection instance that can be used to traverse and/or manipulate the data after all the Sort, Group and Filter operations are applied.

Declaration
public IDataViewCollection GetDataView()
Returns
IDataViewCollection

GetDistinctValues(DataGridColumn, Boolean)

Gets the distinct values of the column, i.e. all business objects that can be displayed as a value of the cell.

Declaration
public IEnumerable GetDistinctValues(DataGridColumn column, bool filterByOtherDescriptors)
Parameters
DataGridColumn column

System.Boolean filterByOtherDescriptors

Indicates whether all other filters from the FilterDescriptors collection except the filter associated with this column should be used for the query.
Returns
System.Collections.IEnumerable

OnBindingContextChanged()

Invoked whenever the binding context of the element changes. Implement this method to add class handling for this event.

Declaration
protected override void OnBindingContextChanged()

OnHandlerChanged()

Declaration
protected override void OnHandlerChanged()

OnPropertyChanged(String)

Declaration
protected override void OnPropertyChanged(string propertyName = null)
Parameters
System.String propertyName

ScrollItemIntoView(Object)

Scrolls the RadDataGrid so that the business item falls into the visible viewport.

Declaration
public void ScrollItemIntoView(object item)
Parameters
System.Object item

The business item from the ItemsSource.

SelectAll()

Selects all the items as defined by the SelectionMode and SelectionUnit

Declaration
public void SelectAll()

SelectCell(DataGridCellInfo)

Selects the grid cell as defined by the specified cell info.

Declaration
public void SelectCell(DataGridCellInfo item)
Parameters
DataGridCellInfo item

Remarks

In order to select a cell, the SelectionUnit value should be DataGridSelectionUnit.Cell.

SelectItem(Object)

Selects the specified data item and adds it in the SelectedItems collection.

Declaration
public void SelectItem(object item)
Parameters
System.Object item

Remarks

In order to select a Row, the SelectionUnit value should be DataGridSelectionUnit.Row.

Events

ColumnReorderCompleting

Occurs when the user drops the column, doesn't necessarily mean reorder will occur.

Declaration
public event EventHandler<ColumnReorderCompletingEventArgs> ColumnReorderCompleting
Event Type
System.EventHandler<ColumnReorderCompletingEventArgs>

ColumnReordered

Occurs when a column has been successfully reordered.

Declaration
public event EventHandler<ColumnReorderedEventArgs> ColumnReordered
Event Type
System.EventHandler<ColumnReorderedEventArgs>

ColumnReordering

Occurs continuously while the column is being dragged.

Declaration
public event EventHandler<ColumnReorderingEventArgs> ColumnReordering
Event Type
System.EventHandler<ColumnReorderingEventArgs>

ColumnReorderStarting

Occurs when the user starts to drag a column to reorder it.

Declaration
public event EventHandler<ColumnReorderStartingEventArgs> ColumnReorderStarting
Event Type
System.EventHandler<ColumnReorderStartingEventArgs>

ColumnUserResizeCompleted

Occurs when a column has been resized by user interaction.

Declaration
public event EventHandler<ColumnUserResizeCompletedEventArgs> ColumnUserResizeCompleted
Event Type
System.EventHandler<ColumnUserResizeCompletedEventArgs>

CurrentCellChanged

Occurs when the CurrentCell property has changed.

Declaration
public event EventHandler<CurrentCellChangedEventArgs> CurrentCellChanged
Event Type
System.EventHandler<CurrentCellChangedEventArgs>

DataBindingComplete

Occurs when the associated data (ItemsSource) has been successfully bound to the control or any data operation like Group, Sort or Filter is applied. This event is useful if an additional action is required once the data is ready to be visualized.

Declaration
public event EventHandler<DataBindingCompleteEventArgs> DataBindingComplete
Event Type
System.EventHandler<DataBindingCompleteEventArgs>

DistinctValuesLoading

Occurs when loading the distinct values that will be displayed in the DataGridDistinctValuesFilterView. Use this event and its arguments to modify the list of distinct values and bypass the built-in logic of choosing items to display.

Declaration
public event EventHandler<DistinctValuesLoadingEventArgs> DistinctValuesLoading
Event Type
System.EventHandler<DistinctValuesLoadingEventArgs>

LoadOnDemand

Fires when load on demand is requested.

Declaration
public event EventHandler<LoadOnDemandEventArgs> LoadOnDemand
Event Type
System.EventHandler<LoadOnDemandEventArgs>

SelectionChanged

Occurs when the currently selected items change.

Declaration
public event EventHandler<DataGridSelectionChangedEventArgs> SelectionChanged
Event Type
System.EventHandler<DataGridSelectionChangedEventArgs>

Extension Methods