Class

RadDataGrid

Initializes a new instance of the RadDataGrid class.

Declaration

public RadDataGrid()

Identifies the AggregateRowBackground dependency property.

Declaration

public static readonly DependencyProperty AggregateRowBackgroundProperty

Field Value

Identifies the AlternateRowBackground dependency property.

Declaration

public static readonly DependencyProperty AlternateRowBackgroundProperty

Field Value

Identifies the AlternationStartIndex dependency property.

Declaration

public static readonly DependencyProperty AlternationStartIndexProperty

Field Value

Identifies the AlternationStep dependency property.

Declaration

public static readonly DependencyProperty AlternationStepProperty

Field Value

Identifies the AutoGenerateColumns dependency property.

Declaration

public static readonly DependencyProperty AutoGenerateColumnsProperty

Field Value

Identifies the CanUserChooseColumns dependency property.

Declaration

public static readonly DependencyProperty CanUserChooseColumnsProperty

Field Value

Identifies the ColumnDataOperationsMode dependency property.

Declaration

public static readonly DependencyProperty ColumnDataOperationsModeProperty

Field Value

Identifies the ColumnResizeHandleDisplayMode dependency property.

Declaration

public static readonly DependencyProperty ColumnResizeHandleDisplayModeProperty

Field Value

Identifies the CurrentItem dependency property.

Declaration

public static readonly DependencyProperty CurrentItemProperty

Field Value

Identifies the DragBehavior dependency property.

Declaration

public static readonly DependencyProperty DragBehaviorProperty

Field Value

Identifies the EnsureCurrentItemIntoView dependency property.

Declaration

public static readonly DependencyProperty EnsureCurrentItemIntoViewProperty

Field Value

Identifies the ExternalEditor dependency property.

Declaration

public static readonly DependencyProperty ExternalEditorProperty

Field Value

Identifies the FrozenColumnCount dependency property.

Declaration

public static readonly DependencyProperty FrozenColumnCountProperty

Field Value

Identifies the GridLinesBrush dependency property.

Declaration

public static readonly DependencyProperty GridLinesBrushProperty

Field Value

Identifies the GridLinesThickness dependency property.

Declaration

public static readonly DependencyProperty GridLinesThicknessProperty

Field Value

Identifies the GridLinesVisibility dependency property.

Declaration

public static readonly DependencyProperty GridLinesVisibilityProperty

Field Value

Identifies the GroupHeaderDisplayMode dependency property.

Declaration

public static readonly DependencyProperty GroupHeaderDisplayModeProperty

Field Value

Identifies the GroupHeaderStyle dependency property.

Declaration

public static readonly DependencyProperty GroupHeaderStyleProperty

Field Value

Identifies the GroupHeaderStyleSelector dependency property.

Declaration

public static readonly DependencyProperty GroupHeaderStyleSelectorProperty

Field Value

Identifies the GroupHeaderTemplate dependency property.

Declaration

public static readonly DependencyProperty GroupHeaderTemplateProperty

Field Value

Identifies the GroupHeaderTemplateSelector dependency property.

Declaration

public static readonly DependencyProperty GroupHeaderTemplateSelectorProperty

Field Value

Identifies the GroupPanelPosition dependency property.

Declaration

public static readonly DependencyProperty GroupPanelPositionProperty

Field Value

Identifies the HideFlyoutOnBackButtonPressed dependency property.

Declaration

public static readonly DependencyProperty HideFlyoutOnBackButtonPressedProperty

Field Value

Identifies the IncrementalLoadingMode dependency property.

Declaration

public static readonly DependencyProperty IncrementalLoadingModeProperty

Field Value

Identifies the IndentWidth dependency property.

Declaration

public static readonly DependencyProperty IndentWidthProperty

Field Value

Identifies the IsBusyIndicatorEnabled dependency property.

Declaration

public static readonly DependencyProperty IsBusyIndicatorEnabledProperty

Field Value

Identifies the IsSynchronizedWithCurrentItem dependency property.

Declaration

public static readonly DependencyProperty IsSynchronizedWithCurrentItemProperty

Field Value

Identifies the ItemsSource dependency property.

Declaration

public static readonly DependencyProperty ItemsSourceProperty

Field Value

Identifies the ListenForNestedPropertyChange dependency property.

Declaration

public static readonly DependencyProperty ListenForNestedPropertyChangeProperty

Field Value

Identifies the RealizedItemsVerticalBufferScale dependency property.

Declaration

public static readonly DependencyProperty RealizedItemsBufferScaleProperty

Field Value

Identifies the AlternateRowBackground dependency property.

Declaration

public static readonly DependencyProperty RowBackgroundProperty

Field Value

Identifies the RowBackgroundSelector dependency property.

Declaration

public static readonly DependencyProperty RowBackgroundSelectorProperty

Field Value

Identifies the RowDetailsDisplayMode dependency property.

Declaration

public static readonly DependencyProperty RowDetailsDisplayModeProperty

Field Value

Identifies the RowDetailsTemplate dependency property.

Declaration

public static readonly DependencyProperty RowDetailsTemplateProperty

Field Value

Identifies the RowHeight dependency property.

Declaration

public static readonly DependencyProperty RowHeightProperty

Field Value

Identifies the SelectedItem dependency property.

Declaration

public static readonly DependencyProperty SelectedItemProperty

Field Value

Identifies the SelectionMode dependency property.

Declaration

public static readonly DependencyProperty SelectionModeProperty

Field Value

Identifies the SelectionUnit dependency property.

Declaration

public static readonly DependencyProperty SelectionUnitProperty

Field Value

Identifies the UserColumnReorderMode dependency property.

Declaration

public static readonly DependencyProperty UserColumnReorderModeProperty

Field Value

Identifies the UserEditMode dependency property.

Declaration

public static readonly DependencyProperty UserEditModeProperty

Field Value

Identifies the UserGroupMode dependency property.

Declaration

public static readonly DependencyProperty UserFilterModeProperty

Field Value

Identifies the UserGroupMode dependency property.

Declaration

public static readonly DependencyProperty UserGroupModeProperty

Field Value

Identifies the UserSortMode dependency property.

Declaration

public static readonly DependencyProperty UserSortModeProperty

Field Value

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

Declaration

public AggregateDescriptorCollection AggregateDescriptors { get; }

Property Value

Gets or sets the Brush that defines the fill of each aggregate row.

Declaration

public Brush AggregateRowBackground { get; set; }

Property Value

Gets or sets the Brush that defines the fill of the alternate rows, as defined by the AlternationStep property.

Declaration

public Brush AlternateRowBackground { get; set; }

Property Value

Gets or sets the zero-based index of the row which is considered as alternation start.

Declaration

public int AlternationStartIndex { get; set; }

Property Value

Gets or sets the step between each two alternate rows. The Modulus (%) operand is applied over this value.

Declaration

public int AlternationStep { get; set; }

Property Value

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

Gets or sets a value indicating whether the user is allowed to choose which columns are visible.

Declaration

public bool CanUserChooseColumns { get; set; }

Property Value

Gets or sets the Data Operations Mode of the ColumnHeader.

Declaration

public ColumnDataOperationsMode ColumnDataOperationsMode { get; set; }

Property Value

Gets or sets the DataGridColumnResizeHandleDisplayMode value that defines how User Input (dragging column resize thumb) affects the current column size in the grid. The default value is DataGridColumnResizeHandleDisplayMode.OnHold

Declaration

public DataGridColumnResizeHandleDisplayMode ColumnResizeHandleDisplayMode { get; set; }

Property Value

Example

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

this.dataGrid.ColumnResizeHandleDisplayMode = DataGridColumnResizeHandleDisplayMode.None;

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

Declaration

public DataGridColumnCollection Columns { get; }

Property Value

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

Declaration

public CommandService CommandService { get; }

Property Value

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 CommandCollection<RadDataGrid> Commands { get; }

Property Value

Gets the object instance from the ItemsSource that is currently considered as Current.

Declaration

public object CurrentItem { get; }

Property Value

Gets or sets the behavior controlling drag operations inside the DataGrid.

Declaration

public DataGridDragBehavior DragBehavior { get; set; }

Property Value

Gets or sets a value indicating whether the CurrentItem should always be automatically scrolled into view.

Declaration

public bool EnsureCurrentItemIntoView { get; set; }

Property Value

Gets or sets external editor of the DataGrid.

Declaration

public IGridExternalEditor ExternalEditor { get; set; }

Property Value

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

Declaration

public FilterDescriptorCollection FilterDescriptors { get; }

Property Value

Gets or sets the count of the frozen columns.

Declaration

public int FrozenColumnCount { get; set; }

Property Value

Gets or sets the Brush value that defines the appearance of grid's horizontal lines.

Declaration

public Brush GridLinesBrush { get; set; }

Property Value

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

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

Declaration

public GridLinesVisibility GridLinesVisibility { get; set; }

Property Value

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

Gets or sets the DataGridGroupHeaderDisplayMode value that determines how group headers are displayed. The default value is DataGridGroupHeaderDisplayMode.Frozen

Declaration

public DataGridGroupHeaderDisplayMode GroupHeaderDisplayMode { get; set; }

Property Value

Example

<telerikGrid:RadDataGrid x:Name="dataGrid" GroupHeaderDisplayMode="Scrollable"/>

this.dataGrid.GroupHeaderDisplayMode = DataGridGroupHeaderDisplayMode.Scrollable;

Gets or sets the Style instance that defines the appearance of all the group headers within the grid. The style instance should target the DataGridGroupHeader type.

Declaration

public Style GroupHeaderStyle { get; set; }

Property Value

Example

<Style TargetType="GridPrimitives:DataGridGroupHeader">
      <Setter Property="Foreground" Value="Red"/>
 </Style>

Gets or sets the StyleSelector instance that may be used to select different styles on a per group header basis. The style instance returned should target the DataGridGroupHeader type.

Declaration

public StyleSelector GroupHeaderStyleSelector { get; set; }

Property Value

Example

    public class CustomStyleSelector : StyleSelector
{
public Style ExpandedStyle {get;set;}
public Style CollapsedStyle {get;set;}
protected override Style SelectStyleCore(object item, DependencyObject container)
{
   if ((item as GroupHeaderContext).IsExpanded == true) { return this.ExpandedStyle;} else{ return this.CollapsedStyle;}
}
}

Gets or sets the 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

Example

<telerikGrid:RadDataGrid.GroupHeaderTemplate>
     <DataTemplate>
         <TextBlock Text="{Binding Level}" FontSize="26"/>
     </DataTemplate>
  </telerikGrid:RadDataGrid.GroupHeaderTemplate>

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

Declaration

public DataTemplateSelector GroupHeaderTemplateSelector { get; set; }

Property Value

Example

public class CustomDataTemplateSelector : DataTemplateSelector
{
   public DataTemplate ExpandedTemplate { get; set; }
   public DataTemplate CollapsedTemplate { get; set; }
   protected override DataTemplate SelectTemplateCore(object item, Microsoft.UI.Xaml.DependencyObject container)
   {
       if ((item as GroupHeaderContext).IsExpanded == true) { return this.ExpandedTemplate; } else { return this.CollapsedTemplate; }
   }
}

Gets or sets the position of the Group Panel related to the DataGrid.

Declaration

public GroupPanelPosition GroupPanelPosition { get; set; }

Property Value

Gets or sets a value indicating whether information if the flyout should be hidden when the back Button gets pressed.

Declaration

public bool HideFlyoutOnBackButtonPressed { get; set; }

Property Value

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

Declaration

public HitTestService HitTestService { get; }

Property Value

Gets or sets the incremental loading mode.

Declaration

public BatchLoadingMode IncrementalLoadingMode { get; set; }

Property Value

Gets or sets a value that is used to offset different levels of nested groups. The default value is 24.

Declaration

public double IndentWidth { get; set; }

Property Value

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 IsBusyIndicatorEnabled { get; set; }

Property Value

Gets or sets a value indicating whether the SelectedItem and CurrentItem are synchronized.

Declaration

public bool IsSynchronizedWithCurrentItem { get; set; }

Property Value

Gets or sets the data provider.

Declaration

public object ItemsSource { get; set; }

Property Value

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

Gets or sets the relative to viewport size buffer scale that will be used to realize items outside viewport. Default value is 1.

Declaration

public double RealizedItemsVerticalBufferScale { get; set; }

Property Value

Gets or sets the Brush that defines the fill of each row.

Declaration

public Brush RowBackground { get; set; }

Property Value

Gets or sets the ObjectSelector<T> that may be used to provide conditional fill for grid rows.

Declaration

public ObjectSelector<Brush> RowBackgroundSelector { get; set; }

Property Value

Gets or sets the display mode for the row details - whether they should be visualized or not.

Declaration

public DataGridRowDetailsMode RowDetailsDisplayMode { get; set; }

Property Value

Gets or sets the Template of the row details.

Declaration

public DataTemplate RowDetailsTemplate { get; set; }

Property Value

Gets or sets the standard height of rows in the control. The default value is NaN (auto).

Declaration

public double RowHeight { get; set; }

Property Value

Gets or sets the selected item of the DataGrid.

Declaration

public object SelectedItem { get; set; }

Property Value

Remarks

Gets the currently selected items within this instance. The type of items within the collection depends on the current SelectionUnit value: - The data item (row) when the selection unit is Row. - A DataGridCellInfo object when the selection unit is Cell.

Declaration

public BindableCollection<object> SelectedItems { get; }

Property Value

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

Declaration

public DataGridSelectionMode SelectionMode { get; set; }

Property Value

Example

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

this.dataGrid.SelectionMode = DataGridSelectionMode.Multiple;

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

Declaration

public DataGridSelectionUnit SelectionUnit { get; set; }

Property Value

Example

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

this.dataGrid.SelectionUnit = DataGridSelectionUnit.Cell;

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

Gets or sets the DataGridUserColumnReorderMode value that defines how User Input (dragging column header over another headers) affects the current column position in the grid. The default value is DataGridUserColumnReorderMode.Interactive

Declaration

public DataGridUserColumnReorderMode UserColumnReorderMode { get; set; }

Property Value

Example

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

this.dataGrid.UserColumnReorderMode = DataGridUserColumnReorderMode.None;

Gets or sets the user edit mode of the DataGrid.

Declaration

public DataGridUserEditMode UserEditMode { get; set; }

Property Value

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

Example

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

this.dataGrid.UserFilterMode = DataGridUserFilterMode.Disabled;

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

Example

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

this.dataGrid.UserGroupMode = DataGridUserGroupMode.Disabled

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

Example

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

this.dataGrid.UserSortMode = DataGridUserSortMode.None;

Called when the Framework is called. Inheritors should override this method should they have some custom template-related logic. This is done to ensure that the property is properly initialized.

Declaration

protected override bool ApplyTemplateCore()

Returns

Overrides RadControl.ApplyTemplateCore()

Begins the edit operation for the specified data item.

Declaration

public bool BeginEdit(object item)

Parameters

Returns

Cancels the current edit operation.

Declaration

public bool CancelEdit()

Returns

Commits the current edit operation.

Declaration

public bool CommitEdit()

Returns

Clears the current selection state.

Declaration

public void DeselectAll()

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

Declaration

public void DeselectCell(DataGridCellInfo item)

Parameters

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

Declaration

public void DeselectItem(object item)

Parameters

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

Declaration

public IDataView GetDataView()

Returns

Hide the row details.

Declaration

public void HideRowDetailsForItem(object item)

Parameters

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

Overrides RadControl.OnCreateAutomationPeer()

Called before the KeyDown event occurs.

Declaration

protected override void OnKeyDown(KeyRoutedEventArgs e)

Parameters

Occurs when the method has been called and the template is already successfully applied.

Declaration

protected override void OnTemplateApplied()

Overrides RadControl.OnTemplateApplied()

Attempts to bring the specified DataGridColumn into view asynchronously.

Declaration

public void ScrollColumnIntoView(DataGridColumn column)

Parameters

Attempts to bring the specified DataGridColumn into view asynchronously.

Declaration

public void ScrollColumnIntoView(DataGridColumn column, Action scrollCompletedAction)

Parameters

Attempts to bring the data item at the specified zero-based index into view asynchronously.

Declaration

public void ScrollIndexIntoView(int index)

Parameters

Attempts to bring the data item at the specified zero-based index into view asynchronously.

Declaration

public void ScrollIndexIntoView(int index, Action scrollCompletedAction)

Parameters

Attempts to bring the specified data item into view asynchronously.

Declaration

public void ScrollItemIntoView(object item)

Parameters

Attempts to bring the specified data item into view asynchronously.

Declaration

public void ScrollItemIntoView(object item, Action scrollCompletedAction)

Parameters

Selects all the items as defined by the SelectionMode and SelectionUnit

Declaration

public void SelectAll()

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

Declaration

public void SelectCell(DataGridCellInfo item)

Parameters

Remarks

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

Declaration

public void SelectItem(object item)

Parameters

Remarks

Show the row details.

Declaration

public void ShowRowDetailsForItem(object item)

Parameters

Removes the current control template. Occurs when a template has already been applied and a new one is applied.

Declaration

protected override void UnapplyTemplateCore()

Overrides RadControl.UnapplyTemplateCore()

Occurs when an async export operation is completed.

Declaration

public event AsyncCompletedEventHandler AsyncExportCompleted

Event Value

Occurs when the progress of an async export operation changes.

Declaration

public event ProgressChangedEventHandler AsyncExportProgressChanged

Event Value

Occurs when the CurrentItem property has changed.

Declaration

public event EventHandler CurrentItemChanged

Event Value

Occurs when the CurrentItem property is about to change. The event may be canceled to prevent the actual change.

Declaration

public event CurrentChangingEventHandler CurrentItemChanging

Event Value

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 Value

Occurs after an element is exported.

Declaration

public event EventHandler<DataGridElementExportedEventArgs> ElementExported

Event Value

Occurs before an element is exported.

Declaration

public event EventHandler<DataGridElementExportingEventArgs> ElementExporting

Event Value

Occurs when the currently selected items change.

Declaration

public event EventHandler<DataGridSelectionChangedEventArgs> SelectionChanged

Event Value