Class RadDataGrid

AreGroupHeadersClippedWhenFrozen

Gets or sets a value indicating whether the group header should be clipped to the bounds of the frozen area when there are frozen columns.

Declaration

cs-api-definition

public bool AreGroupHeadersClippedWhenFrozen { get; set; }

Property Value

AreRowDetailsFrozen

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

Declaration

cs-api-definition

public bool AreRowDetailsFrozen { get; set; }

Property Value

AutoExpandGroups

Gets or sets a value indicating whether newly added groups should be automatically expanded.

Declaration

cs-api-definition

public bool AutoExpandGroups { get; set; }

Property Value

AutoGenerateColumns

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

Declaration

cs-api-definition

public bool AutoGenerateColumns { get; set; }

Property Value

BorderBrush

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

Declaration

cs-api-definition

public Brush BorderBrush { get; set; }

Property Value

Brush

BorderThickness

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

Declaration

cs-api-definition

public Thickness BorderThickness { get; set; }

Property Value

Thickness

CanUserExpandMultipleRowDetails

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

Declaration

cs-api-definition

public bool CanUserExpandMultipleRowDetails { get; set; }

Property Value

CanUserReorderColumns

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

Declaration

cs-api-definition

public bool CanUserReorderColumns { get; set; }

Property Value

CanUserResizeColumns

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

Declaration

cs-api-definition

public bool CanUserResizeColumns { get; set; }

Property Value

ObservableCollection<ControlCommandBase<RadDataGrid>>

ColumnHeaderDragVisualTemplate

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

Declaration

cs-api-definition

public DataTemplate ColumnHeaderDragVisualTemplate { get; set; }

Property Value

DataTemplate

ColumnReorderIndicatorTemplate

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

Declaration

cs-api-definition

public DataTemplate ColumnReorderIndicatorTemplate { get; set; }

Property Value

DataTemplate

Columns

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

Declaration

cs-api-definition

public DataGridColumnCollection Columns { get; }

Property Value

DataGridColumnCollection

CommandService

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

Declaration

cs-api-definition

public DataGridCommandService CommandService { get; }

Property Value

DataGridCommandService

Implements ICommandService.CommandService

Remarks

The CommandService provides programmatic access to execute both built-in and custom commands within the DataGrid.

Core Methods:

ExecuteCommand: Executes custom commands first, then falls back to built-in commands
ExecuteDefaultCommand: Directly executes the built-in command, bypassing any custom overrides

Integration with User Interaction:

The CommandService automatically handles user interactions and translates them into command executions, allowing developers to intercept and customize any grid behavior through custom commands.

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

cs-api-definition

public ObservableCollection<ControlCommandBase<RadDataGrid>> Commands { get; }

Property Value

Remarks

Custom Command Implementation:

To create a custom command, inherit from DataGridCommand and override the necessary methods:

Id: Set the DataGridCommandId to specify which built-in command to override
CanExecute: Define when the command can be executed
Execute: Implement the custom command logic

Command Execution Flow:

Custom commands are checked first based on their DataGridCommandId
If no custom command matches or can execute, the default built-in command is used
Use ExecuteDefaultCommand(DataGridCommandId, object) to invoke the original behavior

Available Command IDs:

Common command IDs include CellTap, CellDoubleTap, ColumnHeaderTap, BeginEdit, CommitEdit, CancelEdit, LoadMoreData, and others defined in DataGridCommandId.

CurrentCell

Gets or sets the current cell of the RadDataGrid.

Declaration

cs-api-definition

public DataGridCellInfo CurrentCell { get; set; }

Property Value

DataGridCellInfo

CurrentCellStyle

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

Declaration

cs-api-definition

public Style CurrentCellStyle { get; set; }

Property Value

Style

DataOperationIndicationMode

Gets or sets a value that defines how data operation indicators are displayed when data operations like sorting, filtering, or grouping are applied.

Declaration

cs-api-definition

public DataOperationIndicationMode DataOperationIndicationMode { get; set; }

Property Value

DataOperationIndicationMode

A DataOperationIndicationMode value that determines the indication behavior. The default value is Individual.

Remarks

When set to Individual, separate indicators are shown for each operation (sort, filter, group) in the appropriate column headers.

When set to Universal, a single indicator shows the overall data operation state.

This property affects the visual feedback provided to users about active data operations on the grid.

EmptyContentDisplayMode

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

Declaration

cs-api-definition

public EmptyContentDisplayMode EmptyContentDisplayMode { get; set; }

Property Value

EmptyContentDisplayMode

EmptyContentTemplate

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

Declaration

cs-api-definition

public DataTemplate EmptyContentTemplate { get; set; }

Property Value

DataTemplate

ExpandedRowDetails

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

Declaration

cs-api-definition

public IList ExpandedRowDetails { get; set; }

Property Value

IList

FilterDescriptors

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

Declaration

cs-api-definition

public FilterDescriptorCollection FilterDescriptors { get; }

Property Value

FilterDescriptorCollection

FrozenColumns

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

Declaration

cs-api-definition

public DataGridFrozenColumnCollection FrozenColumns { get; }

Property Value

DataGridFrozenColumnCollection

FrozenColumnsSplitterStyle

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

cs-api-definition

public Style FrozenColumnsSplitterStyle { get; set; }

Property Value

Style

GridLinesColor

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

Declaration

cs-api-definition

public Color GridLinesColor { get; set; }

Property Value

Color

GridLinesThickness

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

Declaration

cs-api-definition

public double GridLinesThickness { get; set; }

Property Value

double

GridLinesVisibility

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

Declaration

cs-api-definition

public GridLinesVisibility GridLinesVisibility { get; set; }

Property Value

GridLinesVisibility

GroupAggregateCellStyle

Gets or sets the Style for the appearance of each aggregate within the group header of the grid. The cells are visible when GroupAggregatesAlignment is set to NextToHeader. The Style should target DataGridGroupAggregateCellAppearance.

Declaration

cs-api-definition

public Style GroupAggregateCellStyle { get; set; }

Property Value

Style

GroupAggregateCellStyleSelector

Gets or sets the IStyleSelector instance that may be used to select different styles of each aggregate within the group header of the grid. The cells are visible when GroupAggregatesAlignment is set to NextToHeader.

Declaration

cs-api-definition

public IStyleSelector GroupAggregateCellStyleSelector { get; set; }

Property Value

DataGridGroupAggregatesAlignment

GroupAggregateCellTemplate

Gets or sets the DataTemplate instance that defines the appearance of each aggregate within the group header of the grid. The cells are visible when GroupAggregatesAlignment is set to NextToHeader.

Declaration

cs-api-definition

public DataTemplate GroupAggregateCellTemplate { get; set; }

Property Value

DataTemplate

GroupAggregatesAlignment

Gets or sets a value that indicates the alignment of the aggregates in the group according its header.

Declaration

cs-api-definition

public DataGridGroupAggregatesAlignment GroupAggregatesAlignment { get; set; }

Property Value

GroupDescriptors

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

Declaration

cs-api-definition

public GroupDescriptorCollection GroupDescriptors { get; }

Property Value

GroupDescriptorCollection

GroupFooterStyle

Gets or sets the Style that defines the visual appearance of group footers within the grid. The Style should target DataGridGroupFooterAppearance to customize properties like background color, text formatting, and borders.

Declaration

cs-api-definition

public Style GroupFooterStyle { get; set; }

Property Value

Style

A Style object that applies to all group footers, or null to use the default appearance.

Remarks

Group footers are displayed at the bottom of each group when ShowGroupFooters is set to true. This style provides a way to consistently format all group footers across the entire grid.

GroupFooterStyleSelector

Gets or sets the IStyleSelector instance that enables dynamic style selection for group footers based on the data context. This allows for conditional styling where different group footers can have different appearances based on their underlying data.

Declaration

cs-api-definition

public IStyleSelector GroupFooterStyleSelector { get; set; }

Property Value

An IStyleSelector implementation that receives a GroupFooterContext and returns the appropriate Style, or null to use the default style selection.

Remarks

The style selector takes precedence over the GroupFooterStyle property when both are set. This is useful for scenarios where you need different styles for different group types or levels.

GroupFooterTemplate

Gets or sets the DataTemplate that defines the visual structure and layout of each group footer within the grid. This template allows for complete customization of the group footer appearance, including custom controls, layouts, and data binding.

Declaration

cs-api-definition

public DataTemplate GroupFooterTemplate { get; set; }

Property Value

DataTemplate

A DataTemplate where the data context is a GroupFooterContext instance containing group information, or null to use the default group footer template.

Remarks

The GroupFooterContext provides access to the group key, item count, aggregate values, and other grouping-related properties. Group footers are only displayed when ShowGroupFooters is set to true. Use this property when you need more control over the group footer layout than what styling alone can provide.

GroupHeaderStyle

Gets or sets the Style that defines the visual appearance of group headers within the grid. The Style should target DataGridGroupHeaderAppearance to customize properties like background color, text formatting, borders, and expand/collapse button appearance.

Declaration

cs-api-definition

public Style GroupHeaderStyle { get; set; }

Property Value

Style

A Style object that applies to all group headers, or null to use the default appearance.

GroupHeaderStyleSelector

Gets or sets the IStyleSelector instance that enables dynamic style selection for group headers based on the data context. This allows for conditional styling where different group headers can have different appearances based on their underlying data.

Declaration

cs-api-definition

public IStyleSelector GroupHeaderStyleSelector { get; set; }

Property Value

An IStyleSelector implementation that receives a GroupHeaderContext and returns the appropriate Style, or null to use the default style selection.

GroupHeaderTemplate

Gets or sets the DataTemplate that defines the visual structure and layout of each group header within the grid. This template allows for complete customization of the group header appearance, including custom controls, layouts, and data binding.

Declaration

cs-api-definition

public DataTemplate GroupHeaderTemplate { get; set; }

Property Value

DataTemplate

A DataTemplate where the data context is a GroupHeaderContext instance containing group information, or null to use the default group header template.

Remarks

The GroupHeaderContext provides access to the group key, item count, and other grouping-related properties. Use this property when you need more control over the group header layout than what styling alone can provide.

GroupHeaderTemplateSelector

Gets or sets a DataTemplateSelector that enables dynamic template selection for group headers based on the data context. This allows different group headers to use different templates depending on their data, group level, or other contextual information.

Declaration

cs-api-definition

public DataTemplateSelector GroupHeaderTemplateSelector { get; set; }

Property Value

DataTemplateSelector

A DataTemplateSelector implementation where the SelectTemplate method receives a GroupHeaderContext as the item parameter, or null to use the default template selection.

Remarks

The selector's SelectTemplate method will be called with a GroupHeaderContext instance that provides access to group-specific information. This is useful for scenarios where you need different templates for different group levels or group types.

GroupingPanelItemTemplate

Gets or sets the item template of the DataGridGroupingPanel.

Declaration

cs-api-definition

public DataTemplate GroupingPanelItemTemplate { get; set; }

Property Value

DataTemplate

HitTestService

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

Declaration

cs-api-definition

public HitTestService HitTestService { get; }

Property Value

HitTestService

IsBusy

Gets or sets a value indicating whether the built-in busy indicator is displayed during data processing operations. When set to true, the grid displays an indeterminate progress indicator while performing background operations such as sorting, filtering, grouping, or data loading.

Declaration

cs-api-definition

public bool IsBusy { get; set; }

Property Value

true to show the busy indicator during data operations; false to hide it. The default is false.

Remarks

The busy indicator provides visual feedback to users that the grid is processing data and helps improve the user experience during potentially long-running operations. You can also manually control this property to show a busy state for custom operations. The indicator appears as an overlay on the entire grid control.

ItemsSource

Gets or sets the data provider.

Declaration

cs-api-definition

public object ItemsSource { get; set; }

Property Value

ListenForNestedPropertyChange

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

Declaration

cs-api-definition

public bool ListenForNestedPropertyChange { get; set; }

Property Value

LoadOnDemandAutoTemplate

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

Declaration

cs-api-definition

public DataTemplate LoadOnDemandAutoTemplate { get; set; }

Property Value

DataTemplate

LoadOnDemandBufferItemsCount

Gets or sets the incremental loading buffer items count.

Declaration

cs-api-definition

public int LoadOnDemandBufferItemsCount { get; set; }

Property Value

int

The incremental loading buffer items count.

LoadOnDemandMode

Gets or sets the load on demand mode.

Declaration

cs-api-definition

public LoadOnDemandMode LoadOnDemandMode { get; set; }

Property Value

LoadOnDemandMode

LoadOnDemandRowStyle

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

Declaration

cs-api-definition

public Style LoadOnDemandRowStyle { get; set; }

Property Value

Style

LoadOnDemandRowTemplate

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

Declaration

cs-api-definition

public DataTemplate LoadOnDemandRowTemplate { get; set; }

Property Value

DataTemplate

MouseHoverStyle

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

Declaration

cs-api-definition

public Style MouseHoverStyle { get; set; }

Property Value

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

cs-api-definition

public DataGridRenderMode RenderMode { get; set; }

Property Value

DataGridRenderMode

RowBackgroundStyle

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

Declaration

cs-api-definition

public Style RowBackgroundStyle { get; set; }

Property Value

Style

RowBackgroundStyleSelector

Gets or sets custom style-selection logic for a style that defines the appearance of each row.

Declaration

cs-api-definition

public IStyleSelector RowBackgroundStyleSelector { get; set; }

Property Value

RowDetailsTemplate

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

Declaration

cs-api-definition

public DataTemplate RowDetailsTemplate { get; set; }

Property Value

DataTemplate

RowHeight

Gets or sets the height of data rows in the grid.

Declaration

cs-api-definition

public double RowHeight { get; set; }

Property Value

double

The row height in device-independent units, or NaN to enable automatic row height calculation based on content. The default value is NaN.

Remarks

When set to a specific value, all data rows will have a uniform height, which can improve scrolling performance. When set to NaN, each row will measure its content and size itself accordingly, which allows for variable row heights but may impact performance. This property does not affect the height of column headers, group headers, or other non-data row elements.

SearchPanel

Gets or sets the panel that contains search related views.

Declaration

cs-api-definition

public DataGridSearchPanel SearchPanel { get; set; }

Property Value

DataGridSearchPanel

SearchSettings

Gets or sets the corresponding search settings.

Declaration

cs-api-definition

public DataGridSearchSettings SearchSettings { get; set; }

Property Value

DataGridSearchSettings

SelectedItem

Gets or sets the selected item of the DataGrid.

Declaration

cs-api-definition

public object SelectedItem { get; set; }

Property Value

ObservableCollection<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: - The data item (row) when the selection unit is Row. - A DataGridCellInfo object when the selection unit is Cell.

Declaration

cs-api-definition

public ObservableCollection<object> SelectedItems { get; }

Property Value

SelectionMode

Gets or sets the selection mode that determines how many items can be selected simultaneously.

Declaration

cs-api-definition

public DataGridSelectionMode SelectionMode { get; set; }

Property Value

DataGridSelectionMode

A DataGridSelectionMode value. The default is Single.

Remarks

Single allows only one item to be selected at a time. Multiple allows multiple items to be selected using touch/mouse gestures and keyboard modifiers. None disables selection entirely.

SelectionStyle

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

Declaration

cs-api-definition

public Style SelectionStyle { get; set; }

Property Value

Style

SelectionUnit

Gets or sets the selection unit that determines whether entire rows or individual cells can be selected.

Declaration

cs-api-definition

public DataGridSelectionUnit SelectionUnit { get; set; }

Property Value

DataGridSelectionUnit

A DataGridSelectionUnit value. The default is Row.

Remarks

When set to Row, users can select entire rows and the SelectedItems collection contains business objects. When set to Cell, users can select individual cells and the SelectedItems collection contains DataGridCellInfo objects.

ServicePanel

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

Declaration

cs-api-definition

public DataGridServicePanel ServicePanel { get; set; }

Property Value

DataGridServicePanel

ShowColumnFooters

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

Declaration

cs-api-definition

public bool ShowColumnFooters { get; set; }

Property Value

ShowGroupFooters

Gets or sets a value indicating whether group footers are displayed at the bottom of each group in the grid.

Declaration

cs-api-definition

public bool ShowGroupFooters { get; set; }

Property Value

true to display group footers; false to hide them. The default is false.

Remarks

Group footers provide a summary area at the end of each group where you can display aggregate information such as counts, sums, averages, etc.

Use the GroupFooterTemplate property to customize the appearance and content of group footers.

Group footers are only visible when the data is grouped (i.e., when there are items in the GroupDescriptors collection).

ShowGroupHeaderAggregates

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

Declaration

cs-api-definition

public bool ShowGroupHeaderAggregates { get; set; }

Property Value

ReadOnlyObservableCollection<DataGridColumn>

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

cs-api-definition

public SortDescriptorCollection SortDescriptors { get; }

Property Value

SortDescriptorCollection

UnfrozenColumns

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

Declaration

cs-api-definition

public ReadOnlyObservableCollection<DataGridColumn> UnfrozenColumns { get; }

Property Value

UserEditMode

Gets or sets the user edit mode of the DataGrid.

Declaration

cs-api-definition

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

cs-api-definition

public DataGridUserFilterMode UserFilterMode { get; set; }

Property Value

DataGridUserFilterMode

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

cs-api-definition

public DataGridUserGroupMode UserGroupMode { get; set; }

Property Value

DataGridUserGroupMode

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

cs-api-definition

public DataGridUserSortMode UserSortMode { get; set; }

Property Value

DataGridUserSortMode

ViewportBufferHeight

Gets or sets the height of the viewport buffer used for virtualization optimization. The buffer extends the viewport beyond the visible area to improve scrolling performance by pre-rendering additional rows.

Declaration

cs-api-definition

public double ViewportBufferHeight { get; set; }

Property Value

double

The buffer height in device-independent units. The default value is 200.0.

Remarks

A larger buffer improves perceived performance during scrolling by reducing the likelihood of blank areas appearing, but uses more memory. A smaller buffer uses less memory but may show blank areas during fast scrolling. This property is particularly important for large datasets where UI virtualization is critical for performance.

VisualStateService

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

Declaration

cs-api-definition

public DataGridVisualStateService VisualStateService { get; }

Property Value

DataGridVisualStateService

Methods

CanRebuildUI(UpdateFlags)

Declaration

cs-api-definition

protected virtual bool CanRebuildUI(UpdateFlags flags)

Parameters

flags

UpdateFlags

Returns

CreateFilterTapContext(DataGridColumn)

Generates FilterTapContext for the specified column.

Declaration

cs-api-definition

public FilterTapContext CreateFilterTapContext(DataGridColumn column)

Parameters

column

DataGridColumn

Returns

FilterTapContext

DeselectAll()

Clears the current selection state.

Declaration

cs-api-definition

public void DeselectAll()

DeselectCell(DataGridCellInfo)

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

Declaration

cs-api-definition

public void DeselectCell(DataGridCellInfo item)

Parameters

item

DataGridCellInfo

DeselectItem(object)

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

Declaration

cs-api-definition

public void DeselectItem(object item)

Parameters

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

cs-api-definition

public IDataViewCollection GetDataView()

Returns

IDataViewCollection

GetDistinctValues(DataGridColumn, bool)

Retrieves the distinct values for a specified column that can be used for filtering operations.

Declaration

cs-api-definition

public IEnumerable GetDistinctValues(DataGridColumn column, bool filterByOtherDescriptors)

Parameters

column

DataGridColumn

The DataGridColumn for which to retrieve distinct values.

filterByOtherDescriptors

true to apply all other active filters from the FilterDescriptors collection when determining distinct values (excluding the filter for the specified column); false to retrieve distinct values from the entire unfiltered dataset.

Returns

IEnumerable

An IEnumerable containing the distinct values for the specified column. These values represent the unique data that can appear in cells for this column.

Remarks

This method is commonly used to populate filter UI controls with available values for a column. When filterByOtherDescriptors is true, the returned distinct values will reflect only the values that exist in the currently filtered dataset, providing a more relevant set of filter options.

OnBindingContextChanged()

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

Declaration

cs-api-definition

protected override void OnBindingContextChanged()

OnHandlerChanged()

Declaration

cs-api-definition

protected override void OnHandlerChanged()

OnPropertyChanged(string)

Declaration

cs-api-definition

protected override void OnPropertyChanged(string propertyName = null)

Parameters

propertyName

string

ScrollColumnIntoView(DataGridColumn)

Scrolls the grid horizontally to bring the specified column into the visible viewport.

Declaration

cs-api-definition

public void ScrollColumnIntoView(DataGridColumn column)

Parameters

column

DataGridColumn

The DataGridColumn to scroll into view.

Remarks

This method will scroll the grid horizontally to ensure the specified column is visible. If the column is frozen or not part of the grid, no scrolling will occur. The scrolling operation adjusts the horizontal scroll position to make the column visible while maintaining the current vertical scroll position.

ScrollItemIntoView(object)

Scrolls the grid to bring the specified data item into the visible viewport.

Declaration

cs-api-definition

public void ScrollItemIntoView(object item)

Parameters

item

The business object from the ItemsSource to scroll into view.

Exceptions

ArgumentNullException

Thrown when item is null.

Remarks

This method will scroll the grid vertically to ensure the row containing the specified item is visible. If the item is not found in the current data source, no scrolling will occur. The scrolling operation respects the current grouping, sorting, and filtering state of the grid.

SelectAll()

Selects all the items as defined by the SelectionMode and SelectionUnit

Declaration

cs-api-definition

public void SelectAll()

SelectCell(DataGridCellInfo)

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

Declaration

cs-api-definition

public void SelectCell(DataGridCellInfo item)

Parameters

item

DataGridCellInfo

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

cs-api-definition

public void SelectItem(object item)

Parameters

item