Class GridViewDataControl

true if the row details sections are prevented from scrolling horizontally; otherwise, false. The default is false.

Remarks

Set this property to true to make sure that the contents of the row details sections are never scrolled out of view horizontally.

AutoExpandGroups

Gets or sets a value indicating whether groups should be expanded or not.

Declaration

cs-api-definition

public bool AutoExpandGroups { get; set; }

Property Value

true if groups should be expanded; otherwise, false.

AutoGenerateColumns

Gets or sets a value indicating whether columns are created automatically when the ItemsSource property is set.

Declaration

cs-api-definition

public bool AutoGenerateColumns { get; set; }

Property Value

true if the columns should be created automatically; otherwise, false. The default is true.

Remarks

You can modify the Columns collection at run time regardless of whether it contains generated columns. However, if you specify columns in XAML, you should set AutoGenerateColumns to false. If you want to modify auto-generated columns during generation you can use AutoGeneratingColumn event.

BusyIndicatorContent

Gets or sets the content of GridViewLoadingIndicator.

Declaration

cs-api-definition

public object BusyIndicatorContent { get; set; }

Property Value

BusyIndicatorContentTemplate

Gets or sets the content template of GridViewLoadingIndicator.

Declaration

cs-api-definition

public DataTemplate BusyIndicatorContentTemplate { get; set; }

Property Value

DataTemplate

BusyIndicatorIsIndeterminate

Gets or sets a value that controls the modes of execution of GridViewLoadingIndicator.

Declaration

cs-api-definition

public bool BusyIndicatorIsIndeterminate { get; set; }

Property Value

BusyIndicatorProgressValue

Gets or sets a value that reports any shifts in the GridViewLoadingIndicator's progress value.

Declaration

cs-api-definition

public double BusyIndicatorProgressValue { get; set; }

Property Value

CanUserDeleteRows

Gets or sets a value that indicates whether the user can delete rows.

Declaration

cs-api-definition

public bool CanUserDeleteRows { get; set; }

Property Value

true if the user can add new rows; otherwise, false. The registered default is true.

CanUserFreezeColumns

Gets or sets a value indicating whether the frozen column splitter is visible.

Declaration

cs-api-definition

public bool CanUserFreezeColumns { get; set; }

Property Value

true if user can freeze columns; otherwise, false.

CanUserInsertRows

Gets or sets a value that indicates whether the user can add new rows.

Declaration

cs-api-definition

public bool CanUserInsertRows { get; set; }

Property Value

true if the user can add new rows; otherwise, false. The registered default is true.

Remarks

When this property is set to true a blank row is displayed at the top of GridViewDataControl. A user can enter a new item into the blank row. Adding a new row adds an item to the ItemsSource. You can set default values for the new item by handling the AddingNewDataItem event and setting the values programmatically.

CanUserReorderColumns

Gets or sets a value that indicates whether the user can change the column display order by dragging column headers with the mouse.

Declaration

cs-api-definition

public bool CanUserReorderColumns { get; set; }

Property Value

true if the user can reorder columns; otherwise, false.

Remarks

You can set this behavior for individual columns by setting the GridViewColumn.IsReorderable property. If the GridViewColumn.IsReorderable property and the GridViewDataControl.CanUserReorderColumns property are both set, a value of false will take precedence over a value of true.

CanUserResizeColumns

Gets or sets a value that indicates whether the user can adjust column widths using the mouse.

Declaration

cs-api-definition

public bool CanUserResizeColumns { get; set; }

Property Value

true if the user can resize columns; otherwise, false. The default is true.

Remarks

You can set this behavior for individual columns by setting the GridViewColumn.IsResizable property. If the GridViewColumn.IsResizable property and the GridViewDataControl.CanUserResizeColumns property are both set, a value of false will take precedence over a value of true.

CanUserResizeRows

Gets or sets a value that indicates whether the user can adjust the height of rows by using the mouse.

Declaration

cs-api-definition

public bool CanUserResizeRows { get; set; }

Property Value

true if the user can change the height of the rows; otherwise, false. The registered default is true.

CanUserSortColumns

Gets or sets a value that indicates whether the user can sort columns by clicking the column header.

Declaration

cs-api-definition

public bool CanUserSortColumns { get; set; }

Property Value

true if the user can sort columns; otherwise, false. The default is true.

Remarks

You can set this behavior for individual columns by setting the GridViewColumn.IsSortable property. If the GridViewColumn.IsSortable property and the GridViewDataControl.CanUserSortColumns property are both set, a value of false will take precedence over a value of true.

CanUserSortGroups

Gets or sets a value indicating whether this instance can user sort groups.

Declaration

cs-api-definition

public bool CanUserSortGroups { get; set; }

Property Value

true if this instance can user sort groups; otherwise, false.

CellsPanelHorizontalOffset

Property which caches the cells panel horizontal offset.

Declaration

cs-api-definition

public double CellsPanelHorizontalOffset { get; }

Property Value

TableDefinitionCollection

ChildTableDefinitions

Represents a collection of table definitions.

Declaration

cs-api-definition

public TableDefinitionCollection ChildTableDefinitions { get; }

Property Value

ClipboardCopyMode

Gets or sets a value that indicates how data is copied to the clipboard.

Declaration

cs-api-definition

public GridViewClipboardCopyMode ClipboardCopyMode { get; set; }

Property Value

GridViewClipboardCopyMode

Remarks

Use this property to specify whether a user can copy GridViewDataControl content to the clipboard. If copying is allowed, this property can specify whether the clipboard copy will include column headers and/or footers.

ClipboardPasteMode

The property which determines how content from the Clipboard is pasted into the GridViewDataControl.

Declaration

cs-api-definition

public GridViewClipboardPasteMode ClipboardPasteMode { get; set; }

Property Value

GridViewClipboardPasteMode

ColumnBackground

Gets or sets the Brush that is used to paint the background of cells in grid columns.

Declaration

cs-api-definition

public Brush ColumnBackground { get; set; }

Property Value

Brush

The column background.

ColumnGroups

Gets the collection of column groups.Columns in a group are represented by a common header.

Declaration

cs-api-definition

public RadObservableCollection<GridViewColumnGroup> ColumnGroups { get; }

Property Value

RadObservableCollection<GridViewColumnGroup>

ColumnWidth

Gets or sets the standard width or automatic sizing mode of columns in the control.

Declaration

cs-api-definition

public GridViewLength ColumnWidth { get; set; }

Property Value

GridViewLength

A structure that represents the standard width or automatic sizing mode of columns in the DataGrid. The default is Auto.

Remarks

By default, columns will automatically adjust their width to fit their contents. This property affects the width setting of every column in the control that does not have an explicit Width setting.

Columns

Gets a collection that contains all the columns in the control.

Declaration

cs-api-definition

public GridViewColumnCollection Columns { get; }

Property Value

GridViewColumnCollection

Remarks

Use the Columns collection to add columns, remove columns, or update properties on the columns. Each column in the Columns collection defines a column in the GridViewDataControl. Columns in the collection must derive from GridViewColumn. GridViewDataColumn, which adds support for binding, derives from GridViewColumn and is the base for the defined column types.

ControlPanelItems

Gets or sets the control panel items.

Declaration

cs-api-definition

[SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")]
public ObservableCollection<IControlPanelItem> ControlPanelItems { get; set; }

Property Value

ObservableCollection<IControlPanelItem>

CrossThreadCollectionChangedInterval

Gets or sets the interval at which CollectionChanged events from a background thread are dispatched to the UI thread. The default value is TimeSpan.Zero - each CollectionChanged event is dispatched without any batching. If not TimeSpan.Zero, CollectionChanged events are aggregated and sent to the UI thread for processing them at once.

Declaration

cs-api-definition

public TimeSpan CrossThreadCollectionChangedInterval { get; set; }

Property Value

TimeSpan

CurrentCell

Gets the current cell.

Declaration

cs-api-definition

public GridViewCell CurrentCell { get; }

Property Value

GridViewCell

The current cell.

CurrentCellInfo

Gets or sets the current cell info.

Declaration

cs-api-definition

public GridViewCellInfo CurrentCellInfo { get; set; }

Property Value

GridViewCellInfo

The current cell info.

CurrentColumn

Gets or sets the column that contains the current cell.

Declaration

cs-api-definition

public GridViewColumn CurrentColumn { get; set; }

Property Value

The column that contains the current cell.

CurrentMergedCell

Gets or sets the current merged cell.

Declaration

cs-api-definition

public GridViewMergedCell CurrentMergedCell { get; set; }

Property Value

GridViewMergedCell

The current merged cell.

DataLoadMode

Gets or sets the property determining if the grid data loading should be asynchronous or not.

Declaration

cs-api-definition

public DataLoadMode DataLoadMode { get; set; }

Property Value

DataLoadMode

DataMember

Gets or sets the specific data member in a multimember data source to bind to a data listing control.

Declaration

cs-api-definition

public string DataMember { get; set; }

Property Value

string

DefaultDistinctValuesCount

Gets or sets the default number of distinct values.

Declaration

cs-api-definition

public int DefaultDistinctValuesCount { get; set; }

Property Value

DragElementAction

Set action performed on dragging over elements.

Declaration

cs-api-definition

public DragAction DragElementAction { get; set; }

Property Value

DragAction

EditTriggers

Gets or sets the edit triggers.

Declaration

cs-api-definition

public GridViewEditTriggers EditTriggers { get; set; }

Property Value

GridViewEditTriggers

The edit triggers.

EnableColumnGroupsVirtualization

Property which determines if column groups virtualization is enabled or disabled.

Declaration

cs-api-definition

public bool EnableColumnGroupsVirtualization { get; set; }

Property Value

EnableColumnVirtualization

Property which determines if column virtualization is enabled or disabled.

Declaration

cs-api-definition

public bool EnableColumnVirtualization { get; set; }

Property Value

EnableHeaderContextMenu

Gets or sets a boolean value indicating whether a context menu will be shown when right-clicking the header cells.

Declaration

cs-api-definition

public bool EnableHeaderContextMenu { get; set; }

Property Value

Remarks

Setting this property to true requires a reference to the Telerik.Windows.Controls.Navigation assembly.

EnableLightweightTextRendering

Gets or sets a value that indicates whether the lightweight text rendering mode is enabled.

Declaration

cs-api-definition

public bool EnableLightweightTextRendering { get; set; }

Property Value

Remarks

To enable this, the MergedCellsDirection should be None, CanUserFreezeColumns should be false and GroupRenderMode should be Flat. Additionally, the Content of GridViewCells will be null in this mode.

EnableLostFocusSelectedState

Property which determines if the row or cell "unfocused" selected state is enabled or disabled.

Declaration

cs-api-definition

public bool EnableLostFocusSelectedState { get; set; }

Property Value

EnableMouseWheelScaling

Gets or sets the EnableMouseWheelScaling property.

Declaration

cs-api-definition

public bool EnableMouseWheelScaling { get; set; }

Property Value

EnableRowVirtualization

Property which determines if row virtualization is enabled or disabled.

Declaration

cs-api-definition

public bool EnableRowVirtualization { get; set; }

Property Value

CompositeFilterDescriptorCollection

FilterDescriptors

Gets a collection of FilterDescriptor objects used to filter the items collection of this instance.

Declaration

cs-api-definition

public CompositeFilterDescriptorCollection FilterDescriptors { get; }

Property Value

The filter descriptors.

FilterEditorPosition

Gets or sets the filter editor position.

Declaration

cs-api-definition

public FilterEditorPosition FilterEditorPosition { get; set; }

Property Value

FilterEditorPosition

Remarks

This property takes effect only when the FilteringMode is FilterEditor.

FilteringDropDownStaysOpen

Gets or sets the property which controls whether the filtering dropdowns stay open when a click outside of the popups occurs. true if the popups will stay open, otherwise, false

Declaration

cs-api-definition

public bool FilteringDropDownStaysOpen { get; set; }

Property Value

FilteringMode

Gets or sets the filtering mode.

Declaration

cs-api-definition

public FilteringMode FilteringMode { get; set; }

Property Value

FilteringMode

The filtering mode.

FooterRowStyle

Gets or sets the footer row style.

Declaration

cs-api-definition

public Style FooterRowStyle { get; set; }

Property Value

Style

The header row style.

FrozenColumnCount

Gets or sets the number of columns that the user cannot scroll horizontally.

Declaration

cs-api-definition

public int FrozenColumnCount { get; set; }

Property Value

The number of non-scrolling columns.

Remarks

Frozen columns are columns that are always displayed and cannot be scrolled out of visibility. Frozen columns are always the leftmost columns in display order.

FrozenColumnsSplitterVisibility

Gets or sets the visibility of the left frozen columns splitter.

Declaration

cs-api-definition

public Visibility FrozenColumnsSplitterVisibility { get; set; }

Property Value

Visibility

GridLinesVisibility

Gets or sets a value that indicates which grid lines separating inner cells are shown.

Declaration

cs-api-definition

public GridLinesVisibility GridLinesVisibility { get; set; }

Property Value

GridLinesVisibility

One of the enumeration values indicating which grid lines are shown. The default is Both.

GridViewNewRowContent

Gets or sets a value for the text of the new row.

Declaration

cs-api-definition

public object GridViewNewRowContent { get; set; }

Property Value

GridViewNewRowContentTemplate

Gets or sets a DataTemplate for the text of the new row.

Declaration

cs-api-definition

public DataTemplate GridViewNewRowContentTemplate { get; set; }

Property Value

DataTemplate

GroupCount

Gets the number of groups.

Declaration

cs-api-definition

public int GroupCount { get; }

Property Value

GroupDescriptorCollection

The number of groups.

GroupDescriptors

Gets a collection of GroupDescriptor objects used to group the items collection of this instance.

Declaration

cs-api-definition

public GroupDescriptorCollection GroupDescriptors { get; }

Property Value

The group descriptors.

GroupFooterRowStyle

Gets or sets the group footer row style.

Declaration

cs-api-definition

public Style GroupFooterRowStyle { get; set; }

Property Value

Style

The header row style.

GroupFooterRowStyleSelector

Gets or sets the group footer row style selector.

Declaration

cs-api-definition

public StyleSelector GroupFooterRowStyleSelector { get; set; }

Property Value

StyleSelector

The group footer row style selector.

GroupHeaderTemplate

Gets or sets the template for the group headers.

Declaration

cs-api-definition

public DataTemplate GroupHeaderTemplate { get; set; }

Property Value

DataTemplate

The data template.

GroupPanelBackground

Gets or sets the color behind the content of the GroupPanel.

Declaration

cs-api-definition

public Brush GroupPanelBackground { get; set; }

Property Value

Brush

The group panel background.

GroupPanelForeground

Gets or sets the foreground color of the GroupPanel.

Declaration

cs-api-definition

public Brush GroupPanelForeground { get; set; }

Property Value

Brush

The group panel foreground.

GroupPanelItemStyle

Gets or sets the group panel cell style.

Declaration

cs-api-definition

public Style GroupPanelItemStyle { get; set; }

Property Value

Style

The group panel cell style.

GroupPanelStyle

Gets or sets the group panel style.

Declaration

cs-api-definition

public Style GroupPanelStyle { get; set; }

Property Value

Style

The group panel style.

GroupRowStyle

Gets or sets the group row style.

Declaration

cs-api-definition

public Style GroupRowStyle { get; set; }

Property Value

Style

The group row style.

GroupRowStyleSelector

Gets or sets the group row style selector.

Declaration

cs-api-definition

public StyleSelector GroupRowStyleSelector { get; set; }

Property Value

StyleSelector

The group row style selector.

HandlesScrolling

Declaration

cs-api-definition

protected override bool HandlesScrolling { get; }

Property Value

HasHierarchy

Gets a value indicating whether this row data control has hierarchy or not. This is a dependency property.

Declaration

cs-api-definition

public bool HasHierarchy { get; }

Property Value

HeaderRowStyle

Gets or sets the header row style.

Declaration

cs-api-definition

public Style HeaderRowStyle { get; set; }

Property Value

Style

The header row style.

HierarchyChildTemplate

Gets or sets the content templates for detail tables.

Declaration

cs-api-definition

public DataTemplate HierarchyChildTemplate { get; set; }

Property Value

DataTemplate

Remarks

Please refer to HierarchyChildTemplate for more information on the property.

HierarchyChildTemplateSelector

Gets or sets the data template selector for the grid HierarchyChildTemplate.

Declaration

cs-api-definition

public DataTemplateSelector HierarchyChildTemplateSelector { get; set; }

Property Value

DataTemplateSelector

HierarchyExpandButtonStyle

Gets or sets the hierarchy expand button style.

Declaration

cs-api-definition

public Style HierarchyExpandButtonStyle { get; set; }

Property Value

Style

The hierarchy expand button style.

HierarchyExpandButtonStyleSelector

Gets or sets the hierarchy expand button style selector.

Declaration

cs-api-definition

public StyleSelector HierarchyExpandButtonStyleSelector { get; set; }

Property Value

StyleSelector

The hierarchy expand button style selector.

HorizontalGridLinesBrush

Gets or sets the horizontal grid lines brush.

Declaration

cs-api-definition

public Brush HorizontalGridLinesBrush { get; set; }

Property Value

Brush

The horizontal grid lines brush.

IsBusy

Gets a value indicating whether the grid is currently busy. You can use this property to show/hide the grid loading indicator.

Declaration

cs-api-definition

public bool IsBusy { get; set; }

Property Value

IsExpandableBinding

Property that allows you to set individual rows expandable state using Binding.

Declaration

cs-api-definition

public Binding IsExpandableBinding { get; set; }

Property Value

Binding

IsExpandedBinding

Property that allows you to set individual rows expanded state using Binding.

Declaration

cs-api-definition

public Binding IsExpandedBinding { get; set; }

Property Value

Binding

IsFilteringAllowed

Gets or sets a value indicating whether the control can be filtered through the UI.

Declaration

cs-api-definition

public bool IsFilteringAllowed { get; set; }

Property Value

true if the control can be filtered through the UI; otherwise, false.

IsLocalizationLanguageRespected

Gets or sets a value indicating whether the Language property will be respected for defining CurrentCulture.

Declaration

cs-api-definition

public bool IsLocalizationLanguageRespected { get; set; }

Property Value

true if Language will be respected; otherwise, false.

IsPropertyChangedAggregationEnabled

Gets or sets a value that indicates whether PropertyChanged call should be aggregated, or handled separately.

Declaration

cs-api-definition

public bool IsPropertyChangedAggregationEnabled { get; set; }

Property Value

IsReadOnly

Gets or sets a value that indicates whether the user can edit the values in the control.

Declaration

cs-api-definition

public bool IsReadOnly { get; set; }

Property Value

true if the control is read-only; otherwise, false. The default is false.

Remarks

If the IsReadOnly property is set to true, none of the cells can enter editing mode. You can set this behavior for individual columns by setting the GridViewColumn.IsReadOnly property. If the DataGridColumn.IsReadOnly property and the GridViewColumn.IsReadOnly property are both set, a value of true will take precedence over a value of false.

IsReadOnlyBinding

Property that allows you to set individual rows into a readonly state using Binding.

Declaration

cs-api-definition

public Binding IsReadOnlyBinding { get; set; }

Property Value

Binding

IsScrolling

Gets or sets a value indicating whether the user is currently fast scrolling.

Declaration

cs-api-definition

public bool IsScrolling { get; set; }

Property Value

IsSearchFilteringEnabled

Get or sets a value that indicates whether the filtering is enabled while searching.

Declaration

cs-api-definition

public bool IsSearchFilteringEnabled { get; set; }

Property Value

IsSearchingDeferred

Gets or sets a value indicating whether searching will be executed on each typing or one of the cases - on pressing Enter or losing the focus.

Declaration

cs-api-definition

public bool IsSearchingDeferred { get; set; }

Property Value

KeyboardCommandProvider

Gets the keyboard command provider.

Declaration

cs-api-definition

public IKeyboardCommandProvider KeyboardCommandProvider { get; set; }

Property Value

IKeyboardCommandProvider

The keyboard command provider. This class provides command key mappings.

LeftFrozenColumnCount

Gets or sets the number of columns that are frozen to the left side.

Declaration

cs-api-definition

public int LeftFrozenColumnCount { get; set; }

Property Value

MaxColumnWidth

Gets or sets the maximum width of columns in the GridViewDataControl.

Declaration

cs-api-definition

public double MaxColumnWidth { get; set; }

Property Value

MergedCellsDirection

Gets or sets the merged cells direction.

Declaration

cs-api-definition

public MergedCellsDirection MergedCellsDirection { get; set; }

Property Value

MergedCellsDirection

The merged cells direction.

MergedCellsStyle

Gets or sets Style for MergedCells.

Declaration

cs-api-definition

public Style MergedCellsStyle { get; set; }

Property Value

Style

MergedCellsStyleSelector

Gets or sets the StyleSelector for MergedCells.

Declaration

cs-api-definition

public StyleSelector MergedCellsStyleSelector { get; set; }

Property Value

StyleSelector

MinColumnWidth

Gets or sets the minimum width of columns in the GridViewDataControl.

Declaration

cs-api-definition

public double MinColumnWidth { get; set; }

Property Value

The minimum column width in pixels. The default is 20.

Remarks

PositiveInfinity, NaN, 0 or negative values are not allowed.

MouseWheelScrollDelta

Gets or sets the number of rows to be scrolled up or down when using the mouse wheel. Negative values will effectively reverse the mouse wheel scroll direction.

Declaration

cs-api-definition

public int MouseWheelScrollDelta { get; set; }

Property Value

MultipleColumnSortModifiers

Gets or sets the ModifierKeys that trigger the multiple column sorting when a GridViewHeaderCell is clicked.

Declaration

cs-api-definition

public ModifierKeys MultipleColumnSortModifiers { get; set; }

Property Value

ModifierKeys

NewRowPosition

Gets or sets a value indicating where to show new row.

Declaration

cs-api-definition

public GridViewNewRowPosition NewRowPosition { get; set; }

Property Value

GridViewNewRowPosition

NewRowStyle

Gets or sets the "new" row style.

Declaration

cs-api-definition

public Style NewRowStyle { get; set; }

Property Value

Style

The "new" row style.

NonFrozenColumnsViewportHorizontalOffset

Property which gets/sets the start x coordinate of non frozen columns in view port.

Declaration

cs-api-definition

public double NonFrozenColumnsViewportHorizontalOffset { get; }

Property Value

NonFrozenColumnsViewportHorizontalOffsetRight

Property which gets/sets the start x coordinate of non frozen columns in view port.

Declaration

cs-api-definition

public double NonFrozenColumnsViewportHorizontalOffsetRight { get; }

Property Value

ParentRow

Gets or sets the container for this instance in hierarchy structure.

Declaration

cs-api-definition

public GridViewRow ParentRow { get; set; }

Property Value

GridViewPinnedRowsPosition

The parent row.

PendingCommands

Gets all pending commands.

Declaration

cs-api-definition

public List<ICommand> PendingCommands { get; }

Property Value

List<ICommand>

The pending commands.

PinnedRowsPosition

Gets or sets a value indicating where to show pinned rows.

Declaration

cs-api-definition

public GridViewPinnedRowsPosition PinnedRowsPosition { get; set; }

Property Value

ReorderColumnsMode

Gets or sets the visual mode of reordering columns.

Declaration

cs-api-definition

public ColumnReorderOptions ReorderColumnsMode { get; set; }

Property Value

ColumnReorderOptions

RightFrozenColumnCount

Gets or sets the number of columns that are frozen to the right side.

Declaration

cs-api-definition

public int RightFrozenColumnCount { get; set; }

Property Value

GridViewRowDetailsVisibilityMode

RightFrozenColumnsSplitterVisibility

Gets or sets the visibility of the right frozen columns splitter.

Declaration

cs-api-definition

public Visibility RightFrozenColumnsSplitterVisibility { get; set; }

Property Value

Visibility

RowDetailsProvider

Gets the IDetailsProvider for this GridViewDataControl. If you are using an external DetailsPresenter you should assign its DetailsProvider property to this one. This synchronizes the GridViewDataControl with the external details presenter.

Declaration

cs-api-definition

public IDetailsProvider RowDetailsProvider { get; }

Property Value

IDetailsProvider

RowDetailsStyle

Gets or sets the row details presenter style.

Declaration

cs-api-definition

public Style RowDetailsStyle { get; set; }

Property Value

Style

The row details presenter style.

RowDetailsStyleSelector

Gets or sets the row details style selector.

Declaration

cs-api-definition

public StyleSelector RowDetailsStyleSelector { get; set; }

Property Value

StyleSelector

The grid row details style selector.

RowDetailsTemplate

Gets or sets the template that is used to display the content of the details section of rows.

Declaration

cs-api-definition

public DataTemplate RowDetailsTemplate { get; set; }

Property Value

DataTemplate

The template that is used to display row details. The default is null.

Remarks

In the XAML usage, both attribute and property element syntax for RowDetailsTemplate are shown. Defining the template inline as opposed to referencing an existing one as a resource are both equally valid scenarios.

RowDetailsTemplateSelector

Gets or sets the data template selector for the grid row details row.

Declaration

cs-api-definition

public DataTemplateSelector RowDetailsTemplateSelector { get; set; }

Property Value

DataTemplateSelector

RowDetailsVisibilityMode

Gets or sets the GridViewRowDetailsVisibilityMode that determines the way row details are displayed.

Declaration

cs-api-definition

public GridViewRowDetailsVisibilityMode RowDetailsVisibilityMode { get; set; }

Property Value

RowHeight

Gets or sets the row height for all rows.

Declaration

cs-api-definition

public double RowHeight { get; set; }

Property Value

The height of the rows, in device-independent units. The registered default is 25.

Remarks

By default the grid rows are measured with NaN ("Auto" in XAML) height to make the row automatically adjust its size to fit its content. When you set a value for the RowHeight property, it must be equal to or greater than 0.0. Double.PositiveInfinity is not a valid value for this property. The value restrictions on the Double value are enforced by a ValidateValueCallback mechanism. If you attempt to set a value that is not valid, a run-time exception is thrown.

RowInEditMode

Gets the row in edit mode of the GridViewDataControl.

Declaration

cs-api-definition

public GridViewRow RowInEditMode { get; }

Property Value

The row in edit mode of the GridViewDataControl.

RowIndicatorVisibility

Gets or sets the row indicator visibility.

Declaration

cs-api-definition

public Visibility RowIndicatorVisibility { get; set; }

Property Value

Visibility

The row indicator visibility.

RowStyle

Gets or sets the style that is used when rendering the rows.

Declaration

cs-api-definition

public Style RowStyle { get; set; }

Property Value

Style

The style applied to rows. The default is null.

Remarks

Whether defined as an inline style or as a resource, the Style defines the appearance of a row in the data grid, and should specify a TargetType of GridViewRow. You typically would specify setters for individual properties, and might also use a setter for the Template property if you wanted to change the composition of elements. For information that can help you decide whether to define styles inline or as resources, see Styles and Templates.

RowStyleSelector

Gets or sets the "normal" row style selector.

Declaration

cs-api-definition

public StyleSelector RowStyleSelector { get; set; }

Property Value

StyleSelector

The row style selector.

ScaleFactor

Gets or sets the ScaleFactor property.

Declaration

cs-api-definition

public double ScaleFactor { get; set; }

Property Value

ScrollMode

Gets or sets the scroll mode of the GridViewDataControl.

Declaration

cs-api-definition

public ScrollUpdateMode ScrollMode { get; set; }

Property Value

ScrollUpdateMode

The scroll mode.

ScrollPositionIndicatorTemplate

Gets or sets the data template used by the scroll position indicator in deferred scroll mode . This is a dependency property.

Declaration

cs-api-definition

public DataTemplate ScrollPositionIndicatorTemplate { get; set; }

Property Value

DataTemplate

SearchPanelBackground

Gets or sets the color behind the content of the SearchPanel.

Declaration

cs-api-definition

public Brush SearchPanelBackground { get; set; }

Property Value

Brush

The search panel background.

SearchPanelCloseButtonVisibility

Gets or sets a value corresponding to the GridViewSearchPanel's close button visibility.

Declaration

cs-api-definition

public Visibility SearchPanelCloseButtonVisibility { get; set; }

Property Value

Visibility

SearchPanelForeground

Gets or sets the foreground color of the SearchPanel.

Declaration

cs-api-definition

public Brush SearchPanelForeground { get; set; }

Property Value

Brush

The search panel foreground.

SearchStateManager

Gets or sets the SearchStateManager associated with this control.

Declaration

cs-api-definition

public SearchStateManager SearchStateManager { get; set; }

Property Value

SearchStateManager

SelectedCells

Gets the selected cells.

Declaration

cs-api-definition

public IList<GridViewCellInfo> SelectedCells { get; }

Property Value

IList<GridViewCellInfo>

SelectionMode

Gets or sets the selection behavior for a GridViewDataControl

Declaration

cs-api-definition

public SelectionMode SelectionMode { get; set; }

Property Value

SelectionMode

One of the enumeration values specifying the selection behavior. The default is Single.

Remarks

Set the SelectionMode to specify whether users can select multiple rows or only a single row at a time.

SelectionUnit

Defines what units can be selected.

Declaration

cs-api-definition

public GridViewSelectionUnit SelectionUnit { get; set; }

Property Value

GridViewSelectionUnit

ShouldCloseFilteringPopupOnKeyboardFocusChanged

Gets or sets a value indicating whether column's filtering control should be closed automatically when keyboard focus is changed.

Declaration

cs-api-definition

public bool ShouldCloseFilteringPopupOnKeyboardFocusChanged { get; set; }

Property Value

ShouldReorderColumnsOnUngrouping

Gets or sets a value that indicates whether the user can change the column display order by dragging group panel cells on column headers with the mouse.

Declaration

cs-api-definition

public bool ShouldReorderColumnsOnUngrouping { get; set; }

Property Value

true if the user can reorder columns; otherwise, false.

ShouldRespectIEditableObject

Gets or set a value that indicates whether IEditableObject methods are automatically invoked by GridViewDataControl's data engine.

Declaration

cs-api-definition

public bool ShouldRespectIEditableObject { get; set; }

Property Value

ShowColumnFooters

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

Declaration

cs-api-definition

public bool ShowColumnFooters { get; set; }

Property Value

ShowColumnHeaders

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

Declaration

cs-api-definition

public bool ShowColumnHeaders { get; set; }

Property Value

ShowColumnSortIndexes

Gets or sets a value indicating whether column sort indexes are displayed.

Declaration

cs-api-definition

public bool ShowColumnSortIndexes { get; set; }

Property Value

A value indicating whether column sort indexes are displayed.

ShowGroupFooters

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

Declaration

cs-api-definition

public bool ShowGroupFooters { get; set; }

Property Value

ShowGroupPanel

Gets or sets a value indicating whether to show a group panel.

Declaration

cs-api-definition

public bool ShowGroupPanel { get; set; }

Property Value

ShowScrollPositionIndicator

Gets or sets a value that indicates whether the ScrollPositionIndicator will be shown while deferred scrolling.

Declaration

cs-api-definition

public bool ShowScrollPositionIndicator { get; set; }

Property Value

ShowSearchPanel

Gets or sets a value indicating whether to show the search panel.

Declaration

cs-api-definition

public bool ShowSearchPanel { get; set; }

Property Value

ShowToolTipOnTrimmedText

Gets or sets a value that indicates whether a ToolTip will be visualized if the text in the cells is trimmed.

Declaration

cs-api-definition

public bool? ShowToolTipOnTrimmedText { get; set; }

Property Value

bool?

true if a ToolTip will be visualized; otherwise, false. The registered default is false.

SortDescriptors

Gets a collection of SortDescriptor objects used to sort the items collection of this instance.

Declaration

cs-api-definition

public SortDescriptorCollection SortDescriptors { get; }

Property Value

SortDescriptorCollection

The sort descriptors.

ToolTipOnTrimmedTextShowDuration

Gets or sets the amount of time (in milliseconds) that the trimmed text tooltip remains visible.

Declaration

cs-api-definition

public int ToolTipOnTrimmedTextShowDuration { get; set; }

Property Value

The default value is 5000 milliseconds.

ValidatesOnDataErrors

Denotes in which mode RadGridView will perform data validation.

Declaration

cs-api-definition

public GridViewValidationMode ValidatesOnDataErrors { get; set; }

Property Value

GridViewValidationMode

The default value is a combination between all modes (InViewMode and InEditMode).

Remarks

This property will checks for errors that are raised by the IDataErrorInfo and INotifyDataErrorInfo implementation of the source object.

ValidationType

Gets or sets a value indicating what validation type should be processed by RadGridView.

Declaration

cs-api-definition

public GridViewValidationType ValidationType { get; set; }

Property Value

GridViewValidationType

The default value is a combination between all types (DataAnnotations, IDataErrorInfo and INotifyDataErrorInfo).

VerticalGridLinesBrush

Gets or sets the vertical grid lines brush.

Declaration

cs-api-definition

public Brush VerticalGridLinesBrush { get; set; }

Property Value

Brush

The vertical grid lines brush.

VisibleRowsHeight

Gets or sets the visible rows height.

Declaration

cs-api-definition

public double VisibleRowsHeight { get; set; }

Property Value

The visible rows height.

Remarks

The property value is always greater or equal to the scroll viewport height.

ZoomScaleTransform

Gets the ZoomScaleTransform property.

Declaration

cs-api-definition

[Browsable(false)]
public ScaleTransform ZoomScaleTransform { get; }

Property Value

ScaleTransform

Methods

BeginEdit()

Causes the RadGridView to enter editing mode for the current cell and current row, unless the data grid is already in editing mode.

Declaration

cs-api-definition

public bool BeginEdit()

Returns

true if the RadGridView enters editing mode; otherwise, false.

BeginEdit(RoutedEventArgs)

Causes the RadGridView to enter editing mode for the current cell and current row, unless the data grid is already in editing mode.

Declaration

cs-api-definition

public bool BeginEdit(RoutedEventArgs editEventArgs)

Parameters

editEventArgs

RoutedEventArgs

The RoutedEventArgs instance containing the event data.

Returns

true if the RadGridView enters editing mode; otherwise, false.

BeginInsert()

Causes the RadGridView to show new row and enter into EditMode.

Declaration

cs-api-definition

public bool BeginInsert()

Returns

true if new row enters editing mode; otherwise, false.

BuildHierarchyFromDataSet()

Builds a hierarchy from a data set.

Declaration

cs-api-definition

public void BuildHierarchyFromDataSet()

CalculateAggregates()

Calculate all columns aggregate functions.

Declaration

cs-api-definition

public virtual void CalculateAggregates()

CancelEdit()

Causes the data grid to cancel the current edit, restore the original value, and exit editing mode.

Declaration

cs-api-definition

public void CancelEdit()

ClearContainerForGroupOverride(DependencyObject, object)

When overridden in a derived class, undoes the effects of the PrepareContainerForGroupOverride method.

Declaration

cs-api-definition

protected override void ClearContainerForGroupOverride(DependencyObject element, object item)

Parameters

element

DependencyObject

The container element.

item

The item.

Overrides BaseItemsControl.ClearContainerForGroupOverride(DependencyObject, object)

ClearContainerForItemOverride(DependencyObject, object)

When overridden in a derived class, undoes the effects of the PrepareContainerForItemOverride method.

Declaration

cs-api-definition

protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameters

element

DependencyObject

The container element.

item

The item.

Overrides BaseItemsControl.ClearContainerForItemOverride(DependencyObject, object)

CollapseAllGroups()

Collapses all groups recursively.

Declaration

cs-api-definition

public void CollapseAllGroups()

CollapseAllHierarchyItems()

Collapses all hierarchy items.

Declaration

cs-api-definition

public void CollapseAllHierarchyItems()

CollapseAllHierarchyItems(bool)

Collapses all hierarchy items.

Declaration

cs-api-definition

public void CollapseAllHierarchyItems(bool preserveLocalSettings)

Parameters

preserveLocalSettings

Indicates whether the method overrides the settings set by the RowStyle or RowStyleSelectorProperties.

CollapseGroup(IGroup)

Collapses the visual group for the given IGroup.

Declaration

cs-api-definition

public void CollapseGroup(IGroup group)

Parameters

group

IGroup

The group to collapse.

CollapseHierarchyItem(object)

Collapses the visual GridViewRow for the given item.

Declaration

cs-api-definition

public void CollapseHierarchyItem(object hierarchyItem)

Parameters

hierarchyItem

The hierarchy item to collapse.

CollapseHierarchyItem(object, bool)

Collapses the visual GridViewRow for the given item.

Declaration

cs-api-definition

public void CollapseHierarchyItem(object hierarchyItem, bool preserveLocalSettings)

Parameters

hierarchyItem

The hierarchy item to collapse.

preserveLocalSettings

Indicates whether the method overrides the settings set by the RowStyle or RowStyleSelectorProperties.

ColumnFromDisplayIndex(int)

Returns the GridViewColumn with the given DisplayIndex.

Declaration

cs-api-definition

public GridViewColumn ColumnFromDisplayIndex(int displayIndex)

Parameters

displayIndex

Returns

CommitEdit()

Commits the edit.

Declaration

cs-api-definition

public bool CommitEdit()

Returns

CommitRowEdit(GridViewRow)

Commits the edit of the row.

Declaration

cs-api-definition

public virtual bool CommitRowEdit(GridViewRow gridViewRow)

Parameters

gridViewRow

Returns

InvalidOperationException

CreateItem()

Creates the container for a simple data record.

Declaration

cs-api-definition

protected virtual DependencyObject CreateItem()

Returns

DependencyObject

CreateTableDefinition()

Creates the specific table definition for the DataControl.

Declaration

cs-api-definition

protected override TableDefinition CreateTableDefinition()

Returns

TableDefinition

The newly created TableDefinition.

Overrides DataControl.CreateTableDefinition()

DeferRefresh()

Enters a defer cycle that you can use to merge changes to the view and delay automatic refresh.

Declaration

cs-api-definition

public IDisposable DeferRefresh()

Returns

IDisposable

An IDisposable object that you can use to dispose of the calling object.

EndInit()

Indicates that the initialization process for the element is complete.

Declaration

cs-api-definition

public override void EndInit()

Exceptions

was called without having previously been called on the element.

ExecutePendingCommand()

Executes all pending commands in a sequence.

Declaration

cs-api-definition

public void ExecutePendingCommand()

ExpandAllGroups()

Expands all groups recursively.

Declaration

cs-api-definition

public void ExpandAllGroups()

ExpandAllHierarchyItems()

Expands all hierarchy items.

Declaration

cs-api-definition

public void ExpandAllHierarchyItems()

ExpandAllHierarchyItems(bool)

Expands all hierarchy items.

Declaration

cs-api-definition

public void ExpandAllHierarchyItems(bool preserveLocalSettings)

Parameters

preserveLocalSettings

Indicates whether the method overrides the settings set by the RowStyle or RowStyleSelectorProperties.

ExpandGroup(IGroup)

Set expand state for the given IGroup. If the group is nested all parent groups will be expanded.

Declaration

cs-api-definition

public void ExpandGroup(IGroup group)

Parameters

group

IGroup

The group to expand.

ExpandHierarchyItem(object)

Expands the visual GridViewRow for the given item.

Declaration

cs-api-definition

public void ExpandHierarchyItem(object hierarchyItem)

Parameters

hierarchyItem

The hierarchy item to expand.

ExpandHierarchyItem(object, bool)

Expands the visual GridViewRow for the given item.

Declaration

cs-api-definition

public void ExpandHierarchyItem(object hierarchyItem, bool preserveLocalSettings)

Parameters

hierarchyItem

The hierarchy item to expand.

preserveLocalSettings

Indicates whether the method overrides the settings set by the RowStyle or RowStyleSelectorProperties.

Export(Stream, GridViewExportOptions)

Exports RadGridView to the specified stream.

Declaration

cs-api-definition

public void Export(Stream stream, GridViewExportOptions options)

Parameters

stream

Stream

options

GridViewExportOptions

ExportAsync(Stream, Action, GridViewExportOptions, bool)

Asynchronously exports RadGridView to the specified stream.

Declaration

cs-api-definition

public void ExportAsync(Stream stream, Action exportFinishedCallback, GridViewExportOptions options, bool shouldDisposeStream)

Parameters

stream

Stream

exportFinishedCallback

options

GridViewExportOptions

shouldDisposeStream

ExportAsync(Stream, GridViewExportOptions, bool)

Asynchronously exports RadGridView to the specified stream.

Declaration

cs-api-definition

public void ExportAsync(Stream stream, GridViewExportOptions options, bool shouldDisposeStream)

Parameters

stream

Stream

options

GridViewExportOptions

shouldDisposeStream

GetContainerForItemOverride(object)

Creates or identifies the element that is used to display the given item.

Declaration

cs-api-definition

protected override DependencyObject GetContainerForItemOverride(object item)

Parameters

item

Returns

DependencyObject

The element that is used to display the given item.

Overrides BaseItemsControl.GetContainerForItemOverride(object)

GetDistinctValues(GridViewColumn, bool)

Returns the first 1000 distinct values for the given column.

Declaration

cs-api-definition

public IEnumerable GetDistinctValues(GridViewColumn column, bool filter)

Parameters

column

The column.

filter

A value indicating whether to filter the distinct values based on other columns' existing filters.

Returns

An IEnumerable containing the distinct values.

Remarks

The 'filter' parameter specifies whether distinct values should be filtered according to other columns' active filters. For example, if we have countries and players and we have filtered by CountryX, when we request all distinct players, if 'filter' is true we will get players from CountryX only. If 'filter' is false we will get all distinct players.

GetDistinctValues(GridViewColumn, bool, int?)

Returns distinct values for a given column.

Declaration

cs-api-definition

public IEnumerable GetDistinctValues(GridViewColumn column, bool filter, int? maximumValueCount)

Parameters

column

The column.

filter

A value indicating whether to filter the distinct values base on other columns' existing filters.

maximumValueCount

int?

The maximum amount of distinct values to return. If you specify null for this parameter, then all distinct values will be returned.

Returns

An IEnumerable containing the distinct values.

Remarks

GetRowForItem(object)

Gets the row for an item.

Declaration

cs-api-definition

public GridViewRow GetRowForItem(object item)

Parameters

item

Returns

The row for the corresponding item.

GetSelectionAnchorCell()

Gets the selection anchor cell. This cell is used as a starting point when selecting range using the SHIFT key.

Declaration

cs-api-definition

public GridViewCellInfo GetSelectionAnchorCell()

Returns

GridViewCellInfo

Anchor cell.

GetSelectionAnchorItem()

Gets the selection anchor item. This item is used as a starting point when selecting range using the SHIFT key.

Declaration

cs-api-definition

public object GetSelectionAnchorItem()

Returns

Anchor item.

InitializeSelection()

Initializes the selection.

Declaration

cs-api-definition

protected override void InitializeSelection()

Overrides DataControl.InitializeSelection()

IsExpanded(IGroup)

Gets the expanded state of a group in GridViewDataControl.

Declaration

cs-api-definition

public bool IsExpanded(IGroup group)

Parameters

group

IGroup

The group.

Returns

The state.

IsExpanded(object)

Gets the expanded state of a given item.

Declaration

cs-api-definition

public bool IsExpanded(object item)

Parameters

item

The item.

Returns

GridViewAddingNewEventArgs

The state.

MeasureOverride(Size)

Declaration

cs-api-definition

protected override Size MeasureOverride(Size availableSize)

Parameters

availableSize

Size

Returns

Size

OnAddingNewDataItem(GridViewAddingNewEventArgs)

Raises the AddingNewDataItem event.

Declaration

cs-api-definition

public virtual void OnAddingNewDataItem(GridViewAddingNewEventArgs e)

Parameters

The GridViewAddingNewEventArgs instance containing the event data.

OnAlternationCountChanged(int, int)

Invoked when the AlternationCount property changes.

Declaration

cs-api-definition

protected override void OnAlternationCountChanged(int oldAlternationCount, int newAlternationCount)

Parameters

oldAlternationCount

The old value of AlternationCount.

newAlternationCount

GridViewAutoGeneratingColumnEventArgs

The new value of AlternationCount.

Overrides BaseItemsControl.OnAlternationCountChanged(int, int)

OnApplyTemplate()

Declaration

cs-api-definition

public override void OnApplyTemplate()

OnAutoGeneratingColumn(GridViewAutoGeneratingColumnEventArgs)

Raises the AutoGeneratingColumn event.

Declaration

cs-api-definition

protected virtual void OnAutoGeneratingColumn(GridViewAutoGeneratingColumnEventArgs e)

Parameters

OnCanUserSelectChanged(bool, bool)

Called when property CanUserSelect changes.

Declaration

cs-api-definition

protected override void OnCanUserSelectChanged(bool oldValue, bool newValue)

Parameters

oldValue

Old property value.

newValue

FilterOperatorsLoadingEventArgs

New property value.

Overrides DataControl.OnCanUserSelectChanged(bool, bool)

OnColumnDisplayIndexChanged(GridViewColumnEventArgs)

Called when the DisplayIndex of a column is modified.

Declaration

cs-api-definition

protected virtual void OnColumnDisplayIndexChanged(GridViewColumnEventArgs e)

Parameters

GridViewColumnEventArgs

Remarks

A column's DisplayIndex may be modified as the result of another column's DisplayIndex changing. This is because the GridViewDataControl enforces that the DisplayIndex of all Columns are unique integers from 0 to Columns.Count -1.

OnColumnReordered(GridViewColumnEventArgs)

Called when the column is reordered.

Declaration

cs-api-definition

protected virtual void OnColumnReordered(GridViewColumnEventArgs e)

Parameters

GridViewColumnEventArgs

GridViewColumnEventArgs containing the reordered column.

OnCurrentItemChanged()

Called when the current item of the DataControl is changed.

Declaration

cs-api-definition

protected override void OnCurrentItemChanged()

Overrides DataControl.OnCurrentItemChanged()

OnFilterOperatorsLoading(FilterOperatorsLoadingEventArgs)

Raises the FilterOperatorsLoading event.

Declaration

cs-api-definition

protected virtual void OnFilterOperatorsLoading(FilterOperatorsLoadingEventArgs e)

Parameters

OnGotFocus(RoutedEventArgs)

Declaration

cs-api-definition

protected override void OnGotFocus(RoutedEventArgs e)

Parameters

RoutedEventArgs

OnGroupPanelChanged(GridViewGroupPanel, GridViewGroupPanel)

Called when the GridViewGroupPanel is changed.

Declaration

cs-api-definition

protected virtual void OnGroupPanelChanged(GridViewGroupPanel oldPanel, GridViewGroupPanel newPanel)

Parameters

oldPanel

GridViewGroupPanel

The old panel.

newPanel

GridViewGroupPanel

The new panel.

OnGroupRenderModeChanged()

Called when the virtualization mode changes.

Declaration

cs-api-definition

protected override void OnGroupRenderModeChanged()

Overrides BaseItemsControl.OnGroupRenderModeChanged()

OnInitialized(EventArgs)

Declaration

cs-api-definition

protected override void OnInitialized(EventArgs e)

Parameters

EventArgs

OnItemsChanged(NotifyCollectionChangedEventArgs)

Invoked when the Items property changes.

Declaration

cs-api-definition

protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Parameters

NotifyCollectionChangedEventArgs

Information about the change.

Overrides BaseItemsControl.OnItemsChanged(NotifyCollectionChangedEventArgs)

OnItemsCollectionChanged(object, NotifyCollectionChangedEventArgs)

Called when this.Items collection changes.

Declaration

cs-api-definition

protected override void OnItemsCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)

Parameters

sender

NotifyCollectionChangedEventArgs

The sender.

The NotifyCollectionChangedEventArgs instance containing the event data.

Overrides BaseItemsControl.OnItemsCollectionChanged(object, NotifyCollectionChangedEventArgs)

OnItemsPropertyChanged(object, PropertyChangedEventArgs)

Called when this.Items has a property changed.

Declaration

cs-api-definition

protected override void OnItemsPropertyChanged(object sender, PropertyChangedEventArgs e)

Parameters

sender

The sender.

PropertyChangedEventArgs

The PropertyChangedEventArgs instance containing the event data.

Overrides DataControl.OnItemsPropertyChanged(object, PropertyChangedEventArgs)

OnItemsSourceChanged(object, object)

Called when ItemsSource property has changed.

Declaration

cs-api-definition

protected override void OnItemsSourceChanged(object oldValue, object newValue)

Parameters

oldValue

The old value.

newValue

GridViewRowDetailsEventArgs

The new value.

Overrides BaseItemsControl.OnItemsSourceChanged(object, object)

OnKeyDown(KeyEventArgs)

Declaration

cs-api-definition

protected override void OnKeyDown(KeyEventArgs e)

Parameters

KeyEventArgs

OnLoadingRowDetails(GridViewRowDetailsEventArgs)

Raises the LoadingRowDetails event.

Declaration

cs-api-definition

protected virtual void OnLoadingRowDetails(GridViewRowDetailsEventArgs e)

Parameters

OnLostFocus(RoutedEventArgs)

Declaration

cs-api-definition

protected override void OnLostFocus(RoutedEventArgs e)

Parameters

RoutedEventArgs

OnMouseLeftButtonDown(MouseButtonEventArgs)

Declaration

cs-api-definition

protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)

Parameters

MouseButtonEventArgs

OnMouseMove(MouseEventArgs)

Declaration

cs-api-definition

protected override void OnMouseMove(MouseEventArgs e)

Parameters

MouseEventArgs

OnMouseWheel(MouseWheelEventArgs)

Declaration

cs-api-definition

protected override void OnMouseWheel(MouseWheelEventArgs e)

Parameters

MouseWheelEventArgs

OnNewRowPositionChanged()

Called when property NewRowPosition changes.

Declaration

cs-api-definition

protected virtual void OnNewRowPositionChanged()

OnPinnedRowsPositionChanged()

Called when property PinnedRowsPosition changes.

Declaration

cs-api-definition

protected virtual void OnPinnedRowsPositionChanged()

OnPreviewMouseWheel(MouseWheelEventArgs)

Declaration

cs-api-definition

protected override void OnPreviewMouseWheel(MouseWheelEventArgs e)

Parameters

MouseWheelEventArgs

OnRowDetailsVisibilityChanged(GridViewRowDetailsEventArgs)

Raises the RowDetailsVisibilityChanged event.

Declaration

cs-api-definition

protected virtual void OnRowDetailsVisibilityChanged(GridViewRowDetailsEventArgs e)

Parameters

GridViewRowDetailsEventArgs

OnRowDetailsVisibilityChanging(RowDetailsVisibilityChangingEventArgs)

Raises the RowDetailsVisibilityChanging event.

Declaration

cs-api-definition

protected virtual void OnRowDetailsVisibilityChanging(RowDetailsVisibilityChangingEventArgs e)

Parameters

RowDetailsVisibilityChangingEventArgs

OnSearchPanelVisibilityChanged(VisibilityChangedEventArgs)

Raises the SearchPanelVisibilityChanged event.

Declaration

cs-api-definition

protected virtual void OnSearchPanelVisibilityChanged(VisibilityChangedEventArgs e)

Parameters

VisibilityChangedEventArgs

OnSelectedCellsChanging(GridViewSelectedCellsChangingEventArgs)

Raises the SelectedCellsChangingEvent event.

Declaration

cs-api-definition

protected virtual void OnSelectedCellsChanging(GridViewSelectedCellsChangingEventArgs args)

Parameters

args

GridViewSelectedCellsChangingEventArgs

The GridViewSelectedCellsChangingEventArgs instance containing the event data.

OnSelectedItemChanged(object, object)

Called when the selected item of the DataControl is changed.

Declaration

cs-api-definition

protected override void OnSelectedItemChanged(object oldItem, object newItem)

Parameters

oldItem

newItem

Overrides DataControl.OnSelectedItemChanged(object, object)

OnShowColumnFootersChanged(bool, bool)

Called when property ShowColumnFooters changes.

Declaration

cs-api-definition

protected virtual void OnShowColumnFootersChanged(bool oldValue, bool newValue)

Parameters

oldValue

Old property value.

newValue

New property value.

OnShowColumnHeadersChanged(bool, bool)

Called when property ShowColumnHeaders changes.

Declaration

cs-api-definition

protected virtual void OnShowColumnHeadersChanged(bool oldValue, bool newValue)

Parameters

oldValue

Old property value.

newValue

New property value.

OnShowGroupPanelChanged(bool, bool)

Called when property ShowGroupPanel changes.

Declaration

cs-api-definition

protected virtual void OnShowGroupPanelChanged(bool oldValue, bool newValue)

Parameters

oldValue

Old property value.

newValue

New property value.

OnShowSearchPanelChanged(bool, bool)

Called when property ShowSearchPanel changes.

Declaration

cs-api-definition

protected virtual void OnShowSearchPanelChanged(bool oldValue, bool newValue)

Parameters

oldValue

Old property value.

newValue

GridViewRowDetailsEventArgs

New property value.

OnTextInput(TextCompositionEventArgs)

Declaration

cs-api-definition

protected override void OnTextInput(TextCompositionEventArgs e)

Parameters

TextCompositionEventArgs

OnUnloadingRowDetails(GridViewRowDetailsEventArgs)

Raises the UnloadingRowDetails event.

Declaration

cs-api-definition

protected virtual void OnUnloadingRowDetails(GridViewRowDetailsEventArgs e)

Parameters

PrepareContainerForGroupItemOverride(DependencyObject, object)

Prepares the specified element to display the specified item.

Declaration

cs-api-definition

protected override void PrepareContainerForGroupItemOverride(DependencyObject element, object item)

Parameters

element

DependencyObject

item

Overrides BaseItemsControl.PrepareContainerForGroupItemOverride(DependencyObject, object)

PrepareContainerForItemOverride(DependencyObject, object)

Prepares the specified element to display the specified item.

Declaration

cs-api-definition

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameters

element

DependencyObject

item

Overrides BaseItemsControl.PrepareContainerForItemOverride(DependencyObject, object)

RaiseSelectionChangedEvent(SelectionChangeEventArgs)

Raises the selection changed event.

Declaration

cs-api-definition

protected override void RaiseSelectionChangedEvent(SelectionChangeEventArgs args)

Parameters

args

SelectionChangeEventArgs

The SelectionChangeEventArgs instance containing the event data.

Overrides DataControl.RaiseSelectionChangedEvent(SelectionChangeEventArgs)

RegisterCopyPasteApplicationCommands()

Declaration

cs-api-definition

protected virtual void RegisterCopyPasteApplicationCommands()

ReorderColumns(int, int)

Reorders the columns.

Declaration

cs-api-definition

public void ReorderColumns(int oldIndex, int newIndex)

Parameters

oldIndex

The old index.

newIndex

The new index.

ScrollIndexIntoView(int)

Scrolls the item with the specified index into view.

Declaration

cs-api-definition

public void ScrollIndexIntoView(int index)

Parameters

index

The index of the item.

ScrollIndexIntoView(int, GridViewColumn)

Scrolls the cell with the specified row index and the column into view.

Declaration

cs-api-definition

public void ScrollIndexIntoView(int index, GridViewColumn column)

Parameters

index

The row index to scroll into view.

column

The column to scroll into view.

Remarks

If the column parameter is null then only vertical scroll is performed.

ScrollIndexIntoViewAsync(int, Action<FrameworkElement>)

Scrolls the row with the specified index into view in an asynchronous manner.

Declaration

cs-api-definition

public void ScrollIndexIntoViewAsync(int index, Action<FrameworkElement> scrollFinishedCallback)

Parameters

index

The index to scroll into view.

scrollFinishedCallback

Action<FrameworkElement>

The method to execute when scrolling has finished.

Remarks

Since this method is asynchronous, calling it will return immediately. If you need to perform a certain action once the scrolling is done use the scrollFinishedCallback parameter to pass in a method to execute. The FrameworkElement parameter of this method will be the row that was just scrolled.

ScrollIndexIntoViewAsync(int, Action<FrameworkElement>, Action)

Scrolls the row with the specified index into view in an asynchronous manner.

Declaration

cs-api-definition

public void ScrollIndexIntoViewAsync(int index, Action<FrameworkElement> scrollFinishedCallback, Action scrollFailedCallback)

Parameters

index

The index to scroll into view.

scrollFinishedCallback

Action<FrameworkElement>

The method to execute when scrolling has finished.

scrollFailedCallback

The method to execute when scrolling has failed.

Remarks

ScrollIndexIntoViewAsync(int, GridViewColumn, Action<FrameworkElement>, Action)

Scrolls the row with the specified index and GridViewColumn into view in an asynchronous manner.

Declaration

cs-api-definition

public void ScrollIndexIntoViewAsync(int index, GridViewColumn column, Action<FrameworkElement> scrollFinishedCallback, Action scrollFailedCallback)

Parameters

index

The row index to scroll into view.

column

The column to scroll into view.

scrollFinishedCallback

Action<FrameworkElement>

The method to execute when scrolling has finished.

scrollFailedCallback

The method to execute when scrolling has failed.

Remarks

ScrollIntoView(object)

Scrolls the row containing the data item into view.

Declaration

cs-api-definition

public void ScrollIntoView(object dataItem)

Parameters

dataItem

The data item to scroll into view.

ScrollIntoView(object, GridViewColumn)

Scrolls a cell into view.

Declaration

cs-api-definition

public void ScrollIntoView(object dataItem, GridViewColumn column)

Parameters

dataItem

The data item to scroll into view.

column

The column to scroll into view.

Remarks

If the column parameter is null then only vertical scroll is performed. If the dataItem parameter is null then only horizontal scroll is performed.

ScrollIntoViewAsync(object, Action<FrameworkElement>)

Scrolls the row containing the data item into view in an asynchronous manner.

Declaration

cs-api-definition

public void ScrollIntoViewAsync(object dataItem, Action<FrameworkElement> scrollFinishedCallback)

Parameters

dataItem

The data item to scroll into view.

scrollFinishedCallback

Action<FrameworkElement>

The method to execute when scrolling has finished.

Remarks

ScrollIntoViewAsync(object, Action<FrameworkElement>, Action)

Scrolls the row containing the data item into view in an asynchronous manner.

Declaration

cs-api-definition

public void ScrollIntoViewAsync(object dataItem, Action<FrameworkElement> scrollFinishedCallback, Action scrollFailedCallback)

Parameters

dataItem

The data item to scroll into view.

scrollFinishedCallback

Action<FrameworkElement>

The method to execute when scrolling has finished.

scrollFailedCallback

The method to execute when scrolling has failed.

Remarks

ScrollIntoViewAsync(object, GridViewColumn, Action<FrameworkElement>)

Scrolls the row containing the data item and GridViewColumn into view in an asynchronous manner.

Declaration

cs-api-definition

public void ScrollIntoViewAsync(object dataItem, GridViewColumn column, Action<FrameworkElement> scrollFinishedCallback)

Parameters

dataItem

The data item to scroll into view.

column

The column to scroll into view.

scrollFinishedCallback

Action<FrameworkElement>

The method to execute when scrolling has finished.

Remarks

ScrollIntoViewAsync(object, GridViewColumn, Action<FrameworkElement>, Action)

Scrolls the row containing the data item and GridViewColumn into view in an asynchronous manner.

Declaration

cs-api-definition

public void ScrollIntoViewAsync(object dataItem, GridViewColumn column, Action<FrameworkElement> scrollFinishedCallback, Action scrollFailedCallback)

Parameters

dataItem

The data item to scroll into view.

column

The column to scroll into view.

scrollFinishedCallback

Action<FrameworkElement>

The method to execute when scrolling has finished.

scrollFailedCallback

The method to execute when scrolling has failed.

Remarks

Select(IEnumerable)

Selects specified items.

Declaration

cs-api-definition

public void Select(IEnumerable items)

Parameters

items

SelectAll()

Selects all grid data items.

Declaration

cs-api-definition

public void SelectAll()

SelectItemsRange(int, int, bool)

Selects all the items in the given range.

Declaration

cs-api-definition

[SuppressMessage("Microsoft.Usage", "CA2208:InstantiateArgumentExceptionsCorrectly")]
public void SelectItemsRange(int startIndex, int endIndex, bool shouldClearCurrentSelection)

Parameters

startIndex

endIndex

shouldClearCurrentSelection

SelectItemsRange(object, object, bool)

Selects all the items in the given range.

Declaration

cs-api-definition

public void SelectItemsRange(object startItem, object endItem, bool shouldClearCurrentSelection)

Parameters

startItem

endItem

shouldClearCurrentSelection

SetIsCurrent(object, bool)

Sets the current state for a container that wraps a given data item.

Declaration

cs-api-definition

protected override void SetIsCurrent(object item, bool isCurrent)

Parameters

item

The data item.

isCurrent

If set to true container is current.

Overrides DataControl.SetIsCurrent(object, bool)

SetIsSelected(object, bool)

Sets the selection state for a container that wraps a given data item.

Declaration

cs-api-definition

protected override void SetIsSelected(object item, bool isSelected)

Parameters

item

The data item.

isSelected

If set to true container is selected.

Overrides DataControl.SetIsSelected(object, bool)

SetSelectionAnchor(GridViewCellInfo)

Sets the selection anchor item and cell. This item/cell is used as a starting point when selecting range using the SHIFT key.

Declaration

cs-api-definition

public void SetSelectionAnchor(GridViewCellInfo anchorInfo)

Parameters

anchorInfo

GridViewCellInfo

The item/cell that should be used as selection anchor.

SetSelectionAnchor(object)

Sets the selection anchor item. This item is used as a starting point when selecting range using the SHIFT key.

Declaration

cs-api-definition

public void SetSelectionAnchor(object anchorItem)

Parameters

anchorItem

The item that should be used as selection anchor.

ShouldDestroyContainersOnReset()

Indicates whether recycled containers should be cleared after CollectionChanged.Reset.

Declaration

cs-api-definition

protected virtual bool ShouldDestroyContainersOnReset()

Returns

Unselect(IEnumerable)

Unselects specified items.

Declaration

cs-api-definition

public void Unselect(IEnumerable items)

Parameters

items