Class GridViewDataControl

public class GridViewDataControl : BaseItemsControl, INotifyPropertyChanged, ISelectorInternal, IGeneratorHost, IGroupsProvider, IScrollingServiceCore, IScrollingInfo, IDataControl, IWeakEventListener<DataErrorsChangedEventArgs>, IWeakEventListener<PropertyChangedEventArgs>

Constructors

GridViewDataControl()

Initializes a new instance of the GridViewDataControl class.

Declaration

public GridViewDataControl()

Fields

AlternateRowBackgroundProperty

Identifies the AlternateRowBackground dependency property.

Declaration

public static readonly DependencyProperty AlternateRowBackgroundProperty

Field Value

System.Windows.DependencyProperty

AlternateRowStyleSelectorProperty

Identifies the AlternateRowStyleSelector dependency property.

Declaration

public static readonly DependencyProperty AlternateRowStyleSelectorProperty

Field Value

System.Windows.DependencyProperty

BusyIndicatorContentTemplateProperty

Identifies the BusyIndicatorContentTemplate property.

Declaration

public static readonly DependencyProperty BusyIndicatorContentTemplateProperty

Field Value

System.Windows.DependencyProperty

BusyIndicatorIsIndeterminateProperty

Identifies the BusyIndicatorIsIndeterminate property.

Declaration

public static readonly DependencyProperty BusyIndicatorIsIndeterminateProperty

Field Value

System.Windows.DependencyProperty

BusyIndicatorProgressValueProperty

Identifies the BusyIndicatorProgressValue property.

Declaration

public static readonly DependencyProperty BusyIndicatorProgressValueProperty

Field Value

System.Windows.DependencyProperty

CellsPanelHorizontalOffsetProperty

Dependency Property for CellsPanelHorizontalOffset.

Declaration

public static readonly DependencyProperty CellsPanelHorizontalOffsetProperty

Field Value

System.Windows.DependencyProperty

CopyingCellClipboardContentEvent

Occurs on copying a cell to the Clipboard.

Declaration

public static readonly RoutedEvent CopyingCellClipboardContentEvent

Field Value

System.Windows.RoutedEvent

CrossThreadCollectionChangedIntervalProperty

Identifies the CrossThreadCollectionChangedInterval dependency property.

Declaration

public static readonly DependencyProperty CrossThreadCollectionChangedIntervalProperty

Field Value

System.Windows.DependencyProperty

DefaultDistinctValuesCountProperty

Identifies the DefaultDistinctValuesCount dependency property.

Declaration

public static readonly DependencyProperty DefaultDistinctValuesCountProperty

Field Value

System.Windows.DependencyProperty

EnableColumnGroupsVirtualizationProperty

Dependency property for EnableColumnGroupsVirtualization.

Declaration

public static readonly DependencyProperty EnableColumnGroupsVirtualizationProperty

Field Value

System.Windows.DependencyProperty

EnableColumnVirtualizationProperty

Dependency property for EnableColumnVirtualization.

Declaration

public static readonly DependencyProperty EnableColumnVirtualizationProperty

Field Value

System.Windows.DependencyProperty

EnableHeaderContextMenuProperty

Identifies the EnableHeaderContextMenu dependency property.

Declaration

public static readonly DependencyProperty EnableHeaderContextMenuProperty

Field Value

System.Windows.DependencyProperty

EnableLostFocusSelectedStateProperty

Dependency property for EnableLostFocusSelectedState.

Declaration

public static readonly DependencyProperty EnableLostFocusSelectedStateProperty

Field Value

System.Windows.DependencyProperty

EnableMouseWheelScalingProperty

Identifies the EnableMouseWheelScaling dependency property.

Declaration

public static readonly DependencyProperty EnableMouseWheelScalingProperty

Field Value

System.Windows.DependencyProperty

EnableRowVirtualizationProperty

Dependency property for EnableRowVirtualization.

Declaration

public static readonly DependencyProperty EnableRowVirtualizationProperty

Field Value

System.Windows.DependencyProperty

FilteringDropDownStaysOpenProperty

Identifies the FilteringDropDownStaysOpen dependency property.

Declaration

public static readonly DependencyProperty FilteringDropDownStaysOpenProperty

Field Value

System.Windows.DependencyProperty

FrozenColumnsSplitterVisibilityProperty

Identifies the FrozenColumnsSplitterVisibility dependency property.

Declaration

public static readonly DependencyProperty FrozenColumnsSplitterVisibilityProperty

Field Value

System.Windows.DependencyProperty

GroupFooterRowStyleSelectorProperty

Identifies the GroupFooterRowStyleSelector dependency property.

Declaration

public static readonly DependencyProperty GroupFooterRowStyleSelectorProperty

Field Value

System.Windows.DependencyProperty

GroupRowIsExpandedChangedEvent

Occurs when a group row's expanded state is changed.

Declaration

public static readonly RoutedEvent GroupRowIsExpandedChangedEvent

Field Value

System.Windows.RoutedEvent

GroupRowIsExpandedChangingEvent

Occurs when a group row's expanded state is about to be changed.

Declaration

public static readonly RoutedEvent GroupRowIsExpandedChangingEvent

Field Value

System.Windows.RoutedEvent

HierarchyChildTemplateProperty

Identifies the HierarchyChildTemplateProperty property.

Declaration

public static readonly DependencyProperty HierarchyChildTemplateProperty

Field Value

System.Windows.DependencyProperty

HierarchyChildTemplateSelectorProperty

Identifies the HierarchyChildTemplateSelector dependency property.

Declaration

public static readonly DependencyProperty HierarchyChildTemplateSelectorProperty

Field Value

System.Windows.DependencyProperty

HierarchyExpandButtonStyleProperty

Identifies the HierarchyExpandButtonStyle dependency property.

Declaration

public static readonly DependencyProperty HierarchyExpandButtonStyleProperty

Field Value

System.Windows.DependencyProperty

HierarchyExpandButtonStyleSelectorProperty

Identifies the HierarchyExpandButtonStyleSelector dependency property.

Declaration

public static readonly DependencyProperty HierarchyExpandButtonStyleSelectorProperty

Field Value

System.Windows.DependencyProperty

HorizontalGridLinesBrushProperty

Represents the HorizontalGridLinesBrush dependency property.

Declaration

public static readonly DependencyProperty HorizontalGridLinesBrushProperty

Field Value

System.Windows.DependencyProperty

IsLocalizationLanguageRespectedProperty

Identifies the IsLocalizationLanguageRespected property.

Declaration

public static readonly DependencyProperty IsLocalizationLanguageRespectedProperty

Field Value

System.Windows.DependencyProperty

IsPropertyChangedAggregationEnabledProperty

Represents the IsPropertyChangedAggregationEnabled DependencyProperty.

Declaration

public static readonly DependencyProperty IsPropertyChangedAggregationEnabledProperty

Field Value

System.Windows.DependencyProperty

IsSearchFilteringEnabledProperty

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

Declaration

public static readonly DependencyProperty IsSearchFilteringEnabledProperty

Field Value

System.Windows.DependencyProperty

MaxColumnWidthProperty

The DependencyProperty that represents the MaxColumnWidth property.

Declaration

public static readonly DependencyProperty MaxColumnWidthProperty

Field Value

System.Windows.DependencyProperty

The maximum column width in pixels. The default is Double.PositiveInfinity.

MergedCellsStyleSelectorProperty

Identifies the MergedCellsStyleSelector dependency property.

Declaration

public static readonly DependencyProperty MergedCellsStyleSelectorProperty

Field Value

System.Windows.DependencyProperty

MultipleColumnSortModifiersProperty

Identifies the MultipleColumnSortModifiers dependency property.

Declaration

public static readonly DependencyProperty MultipleColumnSortModifiersProperty

Field Value

System.Windows.DependencyProperty

NonFrozenColumnsViewportHorizontalOffsetProperty

Dependency property for NonFrozenColumnsViewportHorizontalOffset Property.

Declaration

public static readonly DependencyProperty NonFrozenColumnsViewportHorizontalOffsetProperty

Field Value

System.Windows.DependencyProperty

NonFrozenColumnsViewportHorizontalOffsetRightProperty

Dependency property for NonFrozenColumnsViewportHorizontalOffset Property.

Declaration

public static readonly DependencyProperty NonFrozenColumnsViewportHorizontalOffsetRightProperty

Field Value

System.Windows.DependencyProperty

PastingCellClipboardContentEvent

Occurs on pasting a cell from the Clipboard.

Declaration

public static readonly RoutedEvent PastingCellClipboardContentEvent

Field Value

System.Windows.RoutedEvent

RightFrozenColumnCountProperty

Represents the RightFrozenColumnCount dependency property.

Declaration

public static readonly DependencyProperty RightFrozenColumnCountProperty

Field Value

System.Windows.DependencyProperty

RightFrozenColumnsSplitterVisibilityProperty

Identifies the RightFrozenColumnsSplitterVisibility dependency property.

Declaration

public static readonly DependencyProperty RightFrozenColumnsSplitterVisibilityProperty

Field Value

System.Windows.DependencyProperty

RowDetailsStyleSelectorProperty

Identifies the RowDetailsStyleSelector dependency property.

Declaration

public static readonly DependencyProperty RowDetailsStyleSelectorProperty

Field Value

System.Windows.DependencyProperty

RowDetailsTemplateSelectorProperty

Identifies the RowDetailsTemplateSelector dependency property.

Declaration

public static readonly DependencyProperty RowDetailsTemplateSelectorProperty

Field Value

System.Windows.DependencyProperty

RowDetailsVisibilityModeProperty

Identifies the RowDetailsVisibilityMode dependency property.

Declaration

public static readonly DependencyProperty RowDetailsVisibilityModeProperty

Field Value

System.Windows.DependencyProperty

RowIndicatorVisibilityProperty

Identifies the RowIndicatorVisibility dependency property.

Declaration

public static readonly DependencyProperty RowIndicatorVisibilityProperty

Field Value

System.Windows.DependencyProperty

ScrollPositionIndicatorTemplateProperty

Identifies the ScrollPositionIndicatorTemplate property.

Declaration

public static readonly DependencyProperty ScrollPositionIndicatorTemplateProperty

Field Value

System.Windows.DependencyProperty

The identifier for the ScrollPositionIndicatorTemplate property

SearchPanelCloseButtonVisibilityProperty

Identifies the SearchPanelCloseButtonVisibility dependency property.

Declaration

public static readonly DependencyProperty SearchPanelCloseButtonVisibilityProperty

Field Value

System.Windows.DependencyProperty

ShouldCloseFilteringPopupOnKeyboardFocusChangedProperty

Identifies the ShouldCloseFilteringPopupOnKeyboardFocusChanged dependency property.

Declaration

public static readonly DependencyProperty ShouldCloseFilteringPopupOnKeyboardFocusChangedProperty

Field Value

System.Windows.DependencyProperty

ShouldReorderColumnsOnUngroupingProperty

Identifies the ShouldReorderColumnsOnUngroupingProperty dependency property.

Declaration

public static readonly DependencyProperty ShouldReorderColumnsOnUngroupingProperty

Field Value

System.Windows.DependencyProperty

ShouldRespectIEditableObjectProperty

Represents the ShouldRespectIEditableObject DependencyProperty.

Declaration

public static readonly DependencyProperty ShouldRespectIEditableObjectProperty

Field Value

System.Windows.DependencyProperty

ShowScrollPositionIndicatorProperty

Identifies the ShowScrollPositionIndicator dependency property.

Declaration

public static readonly DependencyProperty ShowScrollPositionIndicatorProperty

Field Value

System.Windows.DependencyProperty

ShowToolTipOnTrimmedTextProperty

Identifies the ShowToolTipOnTrimmedText dependency property.

Declaration

public static readonly DependencyProperty ShowToolTipOnTrimmedTextProperty

Field Value

System.Windows.DependencyProperty

ToolTipOnTrimmedTextShowDurationProperty

Identifies the ToolTipOnTrimmedTextShowDurationProperty dependency property.

Declaration

public static readonly DependencyProperty ToolTipOnTrimmedTextShowDurationProperty

Field Value

System.Windows.DependencyProperty

VerticalGridLinesBrushProperty

Represents the VerticalGridLinesBrush dependency property.

Declaration

public static readonly DependencyProperty VerticalGridLinesBrushProperty

Field Value

System.Windows.DependencyProperty

Properties

ActionOnLostFocus

Gets or sets the action to take when an element of the GridViewDataControl loses focus.

Declaration

public ActionOnLostFocus ActionOnLostFocus { get; set; }

Property Value

ActionOnLostFocus

The action to take when an element of the GridViewDataControl loses focus.

AlternateRowBackground

Gets or sets the Brush that is used to paint the background of odd-numbered rows.

Declaration

public Brush AlternateRowBackground { get; set; }

Property Value

System.Windows.Media.Brush

The brush that is used to paint the background of odd-numbered rows.

AlternateRowStyle

Gets or sets the alternate row style.

Declaration

public Style AlternateRowStyle { get; set; }

Property Value

System.Windows.Style

The alternate row style.

AlternateRowStyleSelector

Gets or sets the alternate row style selector.

Declaration

public StyleSelector AlternateRowStyleSelector { get; set; }

Property Value

System.Windows.Controls.StyleSelector

The alternate row style selector.

AreRowDetailsFrozen

Gets or sets a value that indicates whether the row details sections remain fixed at the width of the display area or can scroll horizontally.

Declaration

public bool AreRowDetailsFrozen { get; set; }

Property Value

System.Boolean

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

public bool AutoExpandGroups { get; set; }

Property Value

System.Boolean

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

public bool AutoGenerateColumns { get; set; }

Property Value

System.Boolean

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

public object BusyIndicatorContent { get; set; }

Property Value

System.Object

BusyIndicatorContentTemplate

Gets or sets the content template of GridViewLoadingIndicator.

Declaration

public DataTemplate BusyIndicatorContentTemplate { get; set; }

Property Value

System.Windows.DataTemplate

BusyIndicatorIsIndeterminate

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

Declaration

public bool BusyIndicatorIsIndeterminate { get; set; }

Property Value

System.Boolean

BusyIndicatorProgressValue

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

Declaration

public double BusyIndicatorProgressValue { get; set; }

Property Value

System.Double

CanUserDeleteRows

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

Declaration

public bool CanUserDeleteRows { get; set; }

Property Value

System.Boolean

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

public bool CanUserFreezeColumns { get; set; }

Property Value

System.Boolean

true if user can freeze columns; otherwise, false.

CanUserInsertRows

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

Declaration

public bool CanUserInsertRows { get; set; }

Property Value

System.Boolean

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

public bool CanUserReorderColumns { get; set; }

Property Value

System.Boolean

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

public bool CanUserResizeColumns { get; set; }

Property Value

System.Boolean

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

public bool CanUserResizeRows { get; set; }

Property Value

System.Boolean

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

public bool CanUserSortColumns { get; set; }

Property Value

System.Boolean

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

public bool CanUserSortGroups { get; set; }

Property Value

System.Boolean

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

CellsPanelHorizontalOffset

Property which caches the cells panel horizontal offset.

Declaration

public double CellsPanelHorizontalOffset { get; }

Property Value

System.Double

ChildTableDefinitions

Represents a collection of table definitions.

Declaration

public TableDefinitionCollection ChildTableDefinitions { get; }

Property Value

TableDefinitionCollection

ClipboardCopyMode

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

Declaration

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

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

public Brush ColumnBackground { get; set; }

Property Value

System.Windows.Media.Brush

The column background.

ColumnGroups

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

Declaration

public RadObservableCollection<GridViewColumnGroup> ColumnGroups { get; }

Property Value

RadObservableCollection<GridViewColumnGroup>

Columns

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

Declaration

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.

ColumnWidth

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

Declaration

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.

ControlPanelItems

Gets or sets the control panel items.

Declaration

public ObservableCollection<IControlPanelItem> ControlPanelItems { get; set; }

Property Value

System.Collections.ObjectModel.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

public TimeSpan CrossThreadCollectionChangedInterval { get; set; }

Property Value

System.TimeSpan

CurrentCell

Gets the current cell.

Declaration

public GridViewCell CurrentCell { get; }

Property Value

GridViewCell

The current cell.

CurrentCellInfo

Gets or sets the current cell info.

Declaration

public GridViewCellInfo CurrentCellInfo { get; set; }

Property Value

GridViewCellInfo

The current cell info.

CurrentColumn

Gets or sets the column that contains the current cell.

Declaration

public GridViewColumn CurrentColumn { get; set; }

Property Value

GridViewColumn

The column that contains the current cell.

CurrentMergedCell

Gets or sets the current merged cell.

Declaration

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

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

public string DataMember { get; set; }

Property Value

System.String

DefaultDistinctValuesCount

Gets or sets the default number of distinct values.

Declaration

public int DefaultDistinctValuesCount { get; set; }

Property Value

System.Int32

DragElementAction

Set action performed on dragging over elements.

Declaration

public DragAction DragElementAction { get; set; }

Property Value

DragAction

EditTriggers

Gets or sets the edit triggers.

Declaration

public GridViewEditTriggers EditTriggers { get; set; }

Property Value

GridViewEditTriggers

The edit triggers.

EnableColumnGroupsVirtualization

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

Declaration

public bool EnableColumnGroupsVirtualization { get; set; }

Property Value

System.Boolean

EnableColumnVirtualization

Property which determines if column virtualization is enabled or disabled.

Declaration

public bool EnableColumnVirtualization { get; set; }

Property Value

System.Boolean

EnableHeaderContextMenu

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

Declaration

public bool EnableHeaderContextMenu { get; set; }

Property Value

System.Boolean

Remarks

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

EnableLostFocusSelectedState

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

Declaration

public bool EnableLostFocusSelectedState { get; set; }

Property Value

System.Boolean

EnableMouseWheelScaling

Gets or sets the EnableMouseWheelScaling property.

Declaration

public bool EnableMouseWheelScaling { get; set; }

Property Value

System.Boolean

EnableRowVirtualization

Property which determines if row virtualization is enabled or disabled.

Declaration

public bool EnableRowVirtualization { get; set; }

Property Value

System.Boolean

FilterDescriptors

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

Declaration

public CompositeFilterDescriptorCollection FilterDescriptors { get; }

Property Value

CompositeFilterDescriptorCollection

The filter descriptors.

FilterEditorPosition

Gets or sets the filter editor position.

Declaration

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

public bool FilteringDropDownStaysOpen { get; set; }

Property Value

System.Boolean

FilteringMode

Gets or sets the filtering mode.

Declaration

public FilteringMode FilteringMode { get; set; }

Property Value

FilteringMode

The filtering mode.

FooterRowStyle

Gets or sets the footer row style.

Declaration

public Style FooterRowStyle { get; set; }

Property Value

System.Windows.Style

The header row style.

FrozenColumnCount

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

Declaration

public int FrozenColumnCount { get; set; }

Property Value

System.Int32

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

public Visibility FrozenColumnsSplitterVisibility { get; set; }

Property Value

System.Windows.Visibility

GridLinesVisibility

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

Declaration

public GridLinesVisibility GridLinesVisibility { get; set; }

Property Value

GridLinesVisibility

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

GroupCount

Gets the number of groups.

Declaration

public int GroupCount { get; }

Property Value

System.Int32

The number of groups.

GroupDescriptors

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

Declaration

public GroupDescriptorCollection GroupDescriptors { get; }

Property Value

GroupDescriptorCollection

The group descriptors.

GroupFooterRowStyle

Gets or sets the group footer row style.

Declaration

public Style GroupFooterRowStyle { get; set; }

Property Value

System.Windows.Style

The header row style.

GroupFooterRowStyleSelector

Gets or sets the group footer row style selector.

Declaration

public StyleSelector GroupFooterRowStyleSelector { get; set; }

Property Value

System.Windows.Controls.StyleSelector

The group footer row style selector.

GroupHeaderTemplate

Gets or sets the template for the group headers.

Declaration

public DataTemplate GroupHeaderTemplate { get; set; }

Property Value

System.Windows.DataTemplate

The data template.

GroupPanelBackground

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

Declaration

public Brush GroupPanelBackground { get; set; }

Property Value

System.Windows.Media.Brush

The group panel background.

GroupPanelForeground

Gets or sets the foreground color of the GroupPanel.

Declaration

public Brush GroupPanelForeground { get; set; }

Property Value

System.Windows.Media.Brush

The group panel foreground.

GroupPanelItemStyle

Gets or sets the group panel cell style.

Declaration

public Style GroupPanelItemStyle { get; set; }

Property Value

System.Windows.Style

The group panel cell style.

GroupPanelStyle

Gets or sets the group panel style.

Declaration

public Style GroupPanelStyle { get; set; }

Property Value

System.Windows.Style

The group panel style.

GroupRowStyle

Gets or sets the group row style.

Declaration

public Style GroupRowStyle { get; set; }

Property Value

System.Windows.Style

The group row style.

GroupRowStyleSelector

Gets or sets the group row style selector.

Declaration

public StyleSelector GroupRowStyleSelector { get; set; }

Property Value

System.Windows.Controls.StyleSelector

The group row style selector.

HandlesScrolling

Declaration

protected override bool HandlesScrolling { get; }

Property Value

System.Boolean

HasHierarchy

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

Declaration

public bool HasHierarchy { get; }

Property Value

System.Boolean

HeaderRowStyle

Gets or sets the header row style.

Declaration

public Style HeaderRowStyle { get; set; }

Property Value

System.Windows.Style

The header row style.

HierarchyChildTemplate

Gets or sets the content templates for detail tables.

Declaration

public DataTemplate HierarchyChildTemplate { get; set; }

Property Value

System.Windows.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

public DataTemplateSelector HierarchyChildTemplateSelector { get; set; }

Property Value

System.Windows.Controls.DataTemplateSelector

HierarchyExpandButtonStyle

Gets or sets the hierarchy expand button style.

Declaration

public Style HierarchyExpandButtonStyle { get; set; }

Property Value

System.Windows.Style

The hierarchy expand button style.

HierarchyExpandButtonStyleSelector

Gets or sets the hierarchy expand button style selector.

Declaration

public StyleSelector HierarchyExpandButtonStyleSelector { get; set; }

Property Value

System.Windows.Controls.StyleSelector

The hierarchy expand button style selector.

HorizontalGridLinesBrush

Gets or sets the horizontal grid lines brush.

Declaration

public Brush HorizontalGridLinesBrush { get; set; }

Property Value

System.Windows.Media.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

public bool IsBusy { get; set; }

Property Value

System.Boolean

IsExpandableBinding

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

Declaration

public Binding IsExpandableBinding { get; set; }

Property Value

System.Windows.Data.Binding

IsExpandedBinding

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

Declaration

public Binding IsExpandedBinding { get; set; }

Property Value

System.Windows.Data.Binding

IsFilteringAllowed

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

Declaration

public bool IsFilteringAllowed { get; set; }

Property Value

System.Boolean

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

public bool IsLocalizationLanguageRespected { get; set; }

Property Value

System.Boolean

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

public bool IsPropertyChangedAggregationEnabled { get; set; }

Property Value

System.Boolean

IsReadOnly

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

Declaration

public bool IsReadOnly { get; set; }

Property Value

System.Boolean

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

public Binding IsReadOnlyBinding { get; set; }

Property Value

System.Windows.Data.Binding

IsScrolling

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

Declaration

public bool IsScrolling { get; set; }

Property Value

System.Boolean

IsSearchFilteringEnabled

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

Declaration

public bool IsSearchFilteringEnabled { get; set; }

Property Value

System.Boolean

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

public bool IsSearchingDeferred { get; set; }

Property Value

System.Boolean

KeyboardCommandProvider

Gets the keyboard command provider.

Declaration

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

public int LeftFrozenColumnCount { get; set; }

Property Value

System.Int32

MaxColumnWidth

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

Declaration

public double MaxColumnWidth { get; set; }

Property Value

System.Double

MergedCellsDirection

Gets or sets the merged cells direction.

Declaration

public MergedCellsDirection MergedCellsDirection { get; set; }

Property Value

MergedCellsDirection

The merged cells direction.

MergedCellsStyle

Gets or sets Style for MergedCells.

Declaration

public Style MergedCellsStyle { get; set; }

Property Value

System.Windows.Style

MergedCellsStyleSelector

Gets or sets the StyleSelector for MergedCells.

Declaration

public StyleSelector MergedCellsStyleSelector { get; set; }

Property Value

System.Windows.Controls.StyleSelector

MinColumnWidth

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

Declaration

public double MinColumnWidth { get; set; }

Property Value

System.Double

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

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

public int MouseWheelScrollDelta { get; set; }

Property Value

System.Int32

MultipleColumnSortModifiers

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

Declaration

public ModifierKeys MultipleColumnSortModifiers { get; set; }

Property Value

System.Windows.Input.ModifierKeys

NewRowPosition

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

Declaration

public GridViewNewRowPosition NewRowPosition { get; set; }

Property Value

GridViewNewRowPosition

NewRowStyle

Gets or sets the "new" row style.

Declaration

public Style NewRowStyle { get; set; }

Property Value

System.Windows.Style

The "new" row style.

NonFrozenColumnsViewportHorizontalOffset

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

Declaration

public double NonFrozenColumnsViewportHorizontalOffset { get; }

Property Value

System.Double

NonFrozenColumnsViewportHorizontalOffsetRight

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

Declaration

public double NonFrozenColumnsViewportHorizontalOffsetRight { get; }

Property Value

System.Double

ParentRow

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

Declaration

public GridViewRow ParentRow { get; set; }

Property Value

GridViewRow

The parent row.

PendingCommands

Gets all pending commands.

Declaration

public List<ICommand> PendingCommands { get; }

Property Value

System.Collections.Generic.List<System.Windows.Input.ICommand>

The pending commands.

PinnedRowsPosition

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

Declaration

public GridViewPinnedRowsPosition PinnedRowsPosition { get; set; }

Property Value

GridViewPinnedRowsPosition

ReorderColumnsMode

Gets or sets the visual mode of reordering columns.

Declaration

public ColumnReorderOptions ReorderColumnsMode { get; set; }

Property Value

ColumnReorderOptions

RightFrozenColumnCount

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

Declaration

public int RightFrozenColumnCount { get; set; }

Property Value

System.Int32

RightFrozenColumnsSplitterVisibility

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

Declaration

public Visibility RightFrozenColumnsSplitterVisibility { get; set; }

Property Value

System.Windows.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

public IDetailsProvider RowDetailsProvider { get; }

Property Value

IDetailsProvider

RowDetailsStyle

Gets or sets the row details presenter style.

Declaration

public Style RowDetailsStyle { get; set; }

Property Value

System.Windows.Style

The row details presenter style.

RowDetailsStyleSelector

Gets or sets the row details style selector.

Declaration

public StyleSelector RowDetailsStyleSelector { get; set; }

Property Value

System.Windows.Controls.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

public DataTemplate RowDetailsTemplate { get; set; }

Property Value

System.Windows.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

public DataTemplateSelector RowDetailsTemplateSelector { get; set; }

Property Value

System.Windows.Controls.DataTemplateSelector

RowDetailsVisibilityMode

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

Declaration

public GridViewRowDetailsVisibilityMode RowDetailsVisibilityMode { get; set; }

Property Value

GridViewRowDetailsVisibilityMode

RowHeight

Gets or sets the row height for all rows.

Declaration

public double RowHeight { get; set; }

Property Value

System.Double

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.

RowIndicatorVisibility

Gets or sets the row indicator visibility.

Declaration

public Visibility RowIndicatorVisibility { get; set; }

Property Value

System.Windows.Visibility

The row indicator visibility.

RowInEditMode

Gets the row in edit mode of the GridViewDataControl.

Declaration

public GridViewRow RowInEditMode { get; }

Property Value

GridViewRow

The row in edit mode of the GridViewDataControl.

RowStyle

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

Declaration

public Style RowStyle { get; set; }

Property Value

System.Windows.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

public StyleSelector RowStyleSelector { get; set; }

Property Value

System.Windows.Controls.StyleSelector

The row style selector.

ScaleFactor

Gets or sets the ScaleFactor property.

Declaration

public double ScaleFactor { get; set; }

Property Value

System.Double

ScrollMode

Gets or sets the scroll mode of the GridViewDataControl.

Declaration

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

public DataTemplate ScrollPositionIndicatorTemplate { get; set; }

Property Value

System.Windows.DataTemplate

SearchPanelBackground

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

Declaration

public Brush SearchPanelBackground { get; set; }

Property Value

System.Windows.Media.Brush

The search panel background.

SearchPanelCloseButtonVisibility

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

Declaration

public Visibility SearchPanelCloseButtonVisibility { get; set; }

Property Value

System.Windows.Visibility

SearchPanelForeground

Gets or sets the foreground color of the SearchPanel.

Declaration

public Brush SearchPanelForeground { get; set; }

Property Value

System.Windows.Media.Brush

The search panel foreground.

SearchStateManager

Gets or sets the SearchStateManager associated with this control.

Declaration

public SearchStateManager SearchStateManager { get; set; }

Property Value

SearchStateManager

SelectedCells

Gets the selected cells.

Declaration

public IList<GridViewCellInfo> SelectedCells { get; }

Property Value

System.Collections.Generic.IList<GridViewCellInfo>

SelectionMode

Gets or sets the selection behavior for a GridViewDataControl

Declaration

public SelectionMode SelectionMode { get; set; }

Property Value

System.Windows.Controls.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

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

public bool ShouldCloseFilteringPopupOnKeyboardFocusChanged { get; set; }

Property Value

System.Boolean

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

public bool ShouldReorderColumnsOnUngrouping { get; set; }

Property Value

System.Boolean

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

public bool ShouldRespectIEditableObject { get; set; }

Property Value

System.Boolean

ShowColumnFooters

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

Declaration

public bool ShowColumnFooters { get; set; }

Property Value

System.Boolean

ShowColumnHeaders

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

Declaration

public bool ShowColumnHeaders { get; set; }

Property Value

System.Boolean

ShowColumnSortIndexes

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

Declaration

public bool ShowColumnSortIndexes { get; set; }

Property Value

System.Boolean

A value indicating whether column sort indexes are displayed.

ShowGroupFooters

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

Declaration

public bool ShowGroupFooters { get; set; }

Property Value

System.Boolean

ShowGroupPanel

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

Declaration

public bool ShowGroupPanel { get; set; }

Property Value

System.Boolean

ShowScrollPositionIndicator

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

Declaration

public bool ShowScrollPositionIndicator { get; set; }

Property Value

System.Boolean

ShowSearchPanel

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

Declaration

public bool ShowSearchPanel { get; set; }

Property Value

System.Boolean

ShowToolTipOnTrimmedText

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

Declaration

public Nullable<bool> ShowToolTipOnTrimmedText { get; set; }

Property Value

System.Nullable<System.Boolean>

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

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

public int ToolTipOnTrimmedTextShowDuration { get; set; }

Property Value

System.Int32

The default value is 5000 milliseconds.

ValidatesOnDataErrors

Denotes in which mode RadGridView will perform data validation.

Declaration

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

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

public Brush VerticalGridLinesBrush { get; set; }

Property Value

System.Windows.Media.Brush

The vertical grid lines brush.

VisibleRowsHeight

Gets or sets the visible rows height.

Declaration

public double VisibleRowsHeight { get; set; }

Property Value

System.Double

The visible rows height.

Remarks

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

ZoomScaleTransform

Gets the ZoomScaleTransform property.

Declaration

public ScaleTransform ZoomScaleTransform { get; }

Property Value

System.Windows.Media.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

public bool BeginEdit()

Returns

System.Boolean

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

public bool BeginEdit(RoutedEventArgs editEventArgs)

Parameters

System.Windows.RoutedEventArgs editEventArgs

The System.Windows.RoutedEventArgs instance containing the event data.

Returns

System.Boolean

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

BeginInsert()

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

Declaration

public bool BeginInsert()

Returns

System.Boolean

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

BuildHierarchyFromDataSet()

Builds a hierarchy from a data set.

Declaration

public void BuildHierarchyFromDataSet()

CalculateAggregates()

Calculate all columns aggregate functions.

Declaration

public virtual void CalculateAggregates()

CancelEdit()

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

Declaration

public void CancelEdit()

ClearContainerForGroupOverride(DependencyObject, Object)

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

Declaration

protected override void ClearContainerForGroupOverride(DependencyObject element, object item)

Parameters

System.Windows.DependencyObject element

The container element.

System.Object 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

protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameters

System.Windows.DependencyObject element

The container element.

System.Object item

The item.

Overrides

BaseItemsControl.ClearContainerForItemOverride(DependencyObject, Object)

CollapseAllGroups()

Collapses all groups recursively.

Declaration

public void CollapseAllGroups()

CollapseAllHierarchyItems()

Collapses all hierarchy items.

Declaration

public void CollapseAllHierarchyItems()

CollapseAllHierarchyItems(Boolean)

Collapses all hierarchy items.

Declaration

public void CollapseAllHierarchyItems(bool preserveLocalSettings)

Parameters

System.Boolean 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

public void CollapseGroup(IGroup group)

Parameters

IGroup group

The group to collapse.

CollapseHierarchyItem(Object)

Collapses the visual GridViewRow for the given item.

Declaration

public void CollapseHierarchyItem(object hierarchyItem)

Parameters

System.Object hierarchyItem

The hierarchy item to collapse.

CollapseHierarchyItem(Object, Boolean)

Collapses the visual GridViewRow for the given item.

Declaration

public void CollapseHierarchyItem(object hierarchyItem, bool preserveLocalSettings)

Parameters

System.Object hierarchyItem

The hierarchy item to collapse.

System.Boolean preserveLocalSettings

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

ColumnFromDisplayIndex(Int32)

Returns the GridViewColumn with the given DisplayIndex.

Declaration

public GridViewColumn ColumnFromDisplayIndex(int displayIndex)

Parameters

System.Int32 displayIndex

Returns

GridViewColumn

CommitEdit()

Commits the edit.

Declaration

public bool CommitEdit()

Returns

System.Boolean

CommitRowEdit(GridViewRow)

Commits the edit of the row.

Declaration

public virtual bool CommitRowEdit(GridViewRow gridViewRow)

Parameters

GridViewRow gridViewRow

Returns

System.Boolean

CreateItem()

Creates the container for a simple data record.

Declaration

protected virtual DependencyObject CreateItem()

Returns

System.Windows.DependencyObject

CreateTableDefinition()

Creates the specific table definition for the DataControl.

Declaration

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

public IDisposable DeferRefresh()

Returns

System.IDisposable

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

EndInit()

Indicates that the initialization process for the element is complete.

Declaration

public override void EndInit()

Exceptions

System.InvalidOperationException

System.Windows.FrameworkElement.EndInit was called without System.Windows.FrameworkElement.BeginInit having previously been called on the element.

ExecutePendingCommand()

Executes all pending commands in a sequence.

Declaration

public void ExecutePendingCommand()

ExpandAllGroups()

Expands all groups recursively.

Declaration

public void ExpandAllGroups()

ExpandAllHierarchyItems()

Expands all hierarchy items.

Declaration

public void ExpandAllHierarchyItems()

ExpandAllHierarchyItems(Boolean)

Expands all hierarchy items.

Declaration

public void ExpandAllHierarchyItems(bool preserveLocalSettings)

Parameters

System.Boolean 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

public void ExpandGroup(IGroup group)

Parameters

IGroup group

The group to expand.

ExpandHierarchyItem(Object)

Expands the visual GridViewRow for the given item.

Declaration

public void ExpandHierarchyItem(object hierarchyItem)

Parameters

System.Object hierarchyItem

The hierarchy item to expand.

ExpandHierarchyItem(Object, Boolean)

Expands the visual GridViewRow for the given item.

Declaration

public void ExpandHierarchyItem(object hierarchyItem, bool preserveLocalSettings)

Parameters

System.Object hierarchyItem

The hierarchy item to expand.

System.Boolean preserveLocalSettings

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

Export(Stream, GridViewExportOptions)

Exports RadGridView to the specified stream.

Declaration

public void Export(Stream stream, GridViewExportOptions options)

Parameters

System.IO.Stream stream

GridViewExportOptions options

ExportAsync(Stream, Action, GridViewExportOptions, Boolean)

Asynchronously exports RadGridView to the specified stream.

Declaration

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

Parameters

System.IO.Stream stream

System.Action exportFinishedCallback

GridViewExportOptions options

System.Boolean shouldDisposeStream

ExportAsync(Stream, GridViewExportOptions, Boolean)

Asynchronously exports RadGridView to the specified stream.

Declaration

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

Parameters

System.IO.Stream stream

GridViewExportOptions options

System.Boolean shouldDisposeStream

GetContainerForItemOverride(Object)

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

Declaration

protected override DependencyObject GetContainerForItemOverride(object item)

Parameters

System.Object item

Returns

System.Windows.DependencyObject

The element that is used to display the given item.

Overrides

BaseItemsControl.GetContainerForItemOverride(Object)

GetDistinctValues(GridViewColumn, Boolean)

Returns the first 1000 distinct values for the given column.

Declaration

public IEnumerable GetDistinctValues(GridViewColumn column, bool filter)

Parameters

GridViewColumn column

The column.

System.Boolean filter

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

Returns

System.Collections.IEnumerable

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, Boolean, Nullable<Int32>)

Returns distinct values for a given column.

Declaration

public IEnumerable GetDistinctValues(GridViewColumn column, bool filter, Nullable<int> maximumValueCount)

Parameters

GridViewColumn column

The column.

System.Boolean filter

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

System.Nullable<System.Int32> maximumValueCount

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

Returns

System.Collections.IEnumerable

An IEnumerable containing the distinct values.

Remarks

GetRowForItem(Object)

Gets the row for an item.

Declaration

public GridViewRow GetRowForItem(object item)

Parameters

System.Object item

Returns

GridViewRow

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

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

public object GetSelectionAnchorItem()

Returns

System.Object

Anchor item.

InitializeSelection()

Initializes the selection.

Declaration

protected override void InitializeSelection()

Overrides

DataControl.InitializeSelection()

IsExpanded(Object)

Gets the expanded state of a given item.

Declaration

public bool IsExpanded(object item)

Parameters

System.Object item

The item.

Returns

System.Boolean

The state.

IsExpanded(IGroup)

Gets the expanded state of a group in GridViewDataControl.

Declaration

public bool IsExpanded(IGroup group)

Parameters

IGroup group

The group.

Returns

System.Boolean

The state.

MeasureOverride(Size)

Declaration

protected override Size MeasureOverride(Size availableSize)

Parameters

System.Windows.Size availableSize

Returns

System.Windows.Size

OnAddingNewDataItem(GridViewAddingNewEventArgs)

Raises the AddingNewDataItem event.

Declaration

public virtual void OnAddingNewDataItem(GridViewAddingNewEventArgs e)

Parameters

GridViewAddingNewEventArgs e

The GridViewAddingNewEventArgs instance containing the event data.

OnAlternationCountChanged(Int32, Int32)

Invoked when the AlternationCount property changes.

Declaration

protected override void OnAlternationCountChanged(int oldAlternationCount, int newAlternationCount)

Parameters

System.Int32 oldAlternationCount

The old value of AlternationCount.

System.Int32 newAlternationCount

The new value of AlternationCount.

Overrides

BaseItemsControl.OnAlternationCountChanged(Int32, Int32)

OnApplyTemplate()

Declaration

public override void OnApplyTemplate()

OnAutoGeneratingColumn(GridViewAutoGeneratingColumnEventArgs)

Raises the AutoGeneratingColumn event.

Declaration

protected virtual void OnAutoGeneratingColumn(GridViewAutoGeneratingColumnEventArgs e)

Parameters

GridViewAutoGeneratingColumnEventArgs e

OnCanUserSelectChanged(Boolean, Boolean)

Called when property CanUserSelect changes.

Declaration

protected override void OnCanUserSelectChanged(bool oldValue, bool newValue)

Parameters

System.Boolean oldValue

Old property value.

System.Boolean newValue

New property value.

Overrides

DataControl.OnCanUserSelectChanged(Boolean, Boolean)

OnColumnDisplayIndexChanged(GridViewColumnEventArgs)

Called when the DisplayIndex of a column is modified.

Declaration

protected virtual void OnColumnDisplayIndexChanged(GridViewColumnEventArgs e)

Parameters

GridViewColumnEventArgs e

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

protected virtual void OnColumnReordered(GridViewColumnEventArgs e)

Parameters

GridViewColumnEventArgs e

GridViewColumnEventArgs containing the reordered column.

OnCurrentItemChanged()

Called when the current item of the DataControl is changed.

Declaration

protected override void OnCurrentItemChanged()

Overrides

DataControl.OnCurrentItemChanged()

OnFilterOperatorsLoading(FilterOperatorsLoadingEventArgs)

Raises the FilterOperatorsLoading event.

Declaration

protected virtual void OnFilterOperatorsLoading(FilterOperatorsLoadingEventArgs e)

Parameters

FilterOperatorsLoadingEventArgs e

OnGotFocus(RoutedEventArgs)

Declaration

protected override void OnGotFocus(RoutedEventArgs e)

Parameters

System.Windows.RoutedEventArgs e

OnGroupPanelChanged(GridViewGroupPanel, GridViewGroupPanel)

Called when the GridViewGroupPanel is changed.

Declaration

protected virtual void OnGroupPanelChanged(GridViewGroupPanel oldPanel, GridViewGroupPanel newPanel)

Parameters

GridViewGroupPanel oldPanel

The old panel.

GridViewGroupPanel newPanel

The new panel.

OnGroupRenderModeChanged()

Called when the virtualization mode changes.

Declaration

protected override void OnGroupRenderModeChanged()

Overrides

BaseItemsControl.OnGroupRenderModeChanged()

OnInitialized(EventArgs)

Declaration

protected override void OnInitialized(EventArgs e)

Parameters

System.EventArgs e

OnItemsChanged(NotifyCollectionChangedEventArgs)

Invoked when the Items property changes.

Declaration

protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Parameters

System.Collections.Specialized.NotifyCollectionChangedEventArgs e

Information about the change.

Overrides

BaseItemsControl.OnItemsChanged(NotifyCollectionChangedEventArgs)

OnItemsCollectionChanged(Object, NotifyCollectionChangedEventArgs)

Called when this.Items collection changes.

Declaration

protected override void OnItemsCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)

Parameters

System.Object sender

The sender.

System.Collections.Specialized.NotifyCollectionChangedEventArgs e

The System.Collections.Specialized.NotifyCollectionChangedEventArgs instance containing the event data.

Overrides

BaseItemsControl.OnItemsCollectionChanged(Object, NotifyCollectionChangedEventArgs)

OnItemsPropertyChanged(Object, PropertyChangedEventArgs)

Called when this.Items has a property changed.

Declaration

protected override void OnItemsPropertyChanged(object sender, PropertyChangedEventArgs e)

Parameters

System.Object sender

The sender.

System.ComponentModel.PropertyChangedEventArgs e

The System.ComponentModel.PropertyChangedEventArgs instance containing the event data.

Overrides

DataControl.OnItemsPropertyChanged(Object, PropertyChangedEventArgs)

OnItemsSourceChanged(Object, Object)

Called when ItemsSource property has changed.

Declaration

protected override void OnItemsSourceChanged(object oldValue, object newValue)

Parameters

System.Object oldValue

The old value.

System.Object newValue

The new value.

Overrides

BaseItemsControl.OnItemsSourceChanged(Object, Object)

OnKeyDown(KeyEventArgs)

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

System.Windows.Input.KeyEventArgs e

OnLoadingRowDetails(GridViewRowDetailsEventArgs)

Raises the LoadingRowDetails event.

Declaration

protected virtual void OnLoadingRowDetails(GridViewRowDetailsEventArgs e)

Parameters

GridViewRowDetailsEventArgs e

OnLostFocus(RoutedEventArgs)

Declaration

protected override void OnLostFocus(RoutedEventArgs e)

Parameters

System.Windows.RoutedEventArgs e

OnMouseLeftButtonDown(MouseButtonEventArgs)

Declaration

protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)

Parameters

System.Windows.Input.MouseButtonEventArgs e

OnMouseMove(MouseEventArgs)

Declaration

protected override void OnMouseMove(MouseEventArgs e)

Parameters

System.Windows.Input.MouseEventArgs e

OnMouseWheel(MouseWheelEventArgs)

Declaration

protected override void OnMouseWheel(MouseWheelEventArgs e)

Parameters

System.Windows.Input.MouseWheelEventArgs e

OnNewRowPositionChanged()

Called when property NewRowPosition changes.

Declaration

protected virtual void OnNewRowPositionChanged()

OnPinnedRowsPositionChanged()

Called when property PinnedRowsPosition changes.

Declaration

protected virtual void OnPinnedRowsPositionChanged()

OnPreviewMouseWheel(MouseWheelEventArgs)

Declaration

protected override void OnPreviewMouseWheel(MouseWheelEventArgs e)

Parameters

System.Windows.Input.MouseWheelEventArgs e

OnRowDetailsVisibilityChanged(GridViewRowDetailsEventArgs)

Raises the RowDetailsVisibilityChanged event.

Declaration

protected virtual void OnRowDetailsVisibilityChanged(GridViewRowDetailsEventArgs e)

Parameters

GridViewRowDetailsEventArgs e

OnRowDetailsVisibilityChanging(RowDetailsVisibilityChangingEventArgs)

Raises the RowDetailsVisibilityChanging event.

Declaration

protected virtual void OnRowDetailsVisibilityChanging(RowDetailsVisibilityChangingEventArgs e)

Parameters

RowDetailsVisibilityChangingEventArgs e

OnSearchPanelVisibilityChanged(VisibilityChangedEventArgs)

Raises the SearchPanelVisibilityChanged event.

Declaration

protected virtual void OnSearchPanelVisibilityChanged(VisibilityChangedEventArgs e)

Parameters

VisibilityChangedEventArgs e

OnSelectedCellsChanging(GridViewSelectedCellsChangingEventArgs)

Raises the SelectedCellsChangingEvent event.

Declaration

protected virtual void OnSelectedCellsChanging(GridViewSelectedCellsChangingEventArgs args)

Parameters

GridViewSelectedCellsChangingEventArgs args

The GridViewSelectedCellsChangingEventArgs instance containing the event data.

OnSelectedItemChanged(Object, Object)

Called when the selected item of the DataControl is changed.

Declaration

protected override void OnSelectedItemChanged(object oldItem, object newItem)

Parameters

System.Object oldItem

System.Object newItem

Overrides

DataControl.OnSelectedItemChanged(Object, Object)

OnShowColumnFootersChanged(Boolean, Boolean)

Called when property ShowColumnFooters changes.

Declaration

protected virtual void OnShowColumnFootersChanged(bool oldValue, bool newValue)

Parameters

System.Boolean oldValue

Old property value.

System.Boolean newValue

New property value.

OnShowColumnHeadersChanged(Boolean, Boolean)

Called when property ShowColumnHeaders changes.

Declaration

protected virtual void OnShowColumnHeadersChanged(bool oldValue, bool newValue)

Parameters

System.Boolean oldValue

Old property value.

System.Boolean newValue

New property value.

OnShowGroupPanelChanged(Boolean, Boolean)

Called when property ShowGroupPanel changes.

Declaration

protected virtual void OnShowGroupPanelChanged(bool oldValue, bool newValue)

Parameters

System.Boolean oldValue

Old property value.

System.Boolean newValue

New property value.

OnShowSearchPanelChanged(Boolean, Boolean)

Called when property ShowSearchPanel changes.

Declaration

protected virtual void OnShowSearchPanelChanged(bool oldValue, bool newValue)

Parameters

System.Boolean oldValue

Old property value.

System.Boolean newValue

New property value.

OnTextInput(TextCompositionEventArgs)

Declaration

protected override void OnTextInput(TextCompositionEventArgs e)

Parameters

System.Windows.Input.TextCompositionEventArgs e

OnUnloadingRowDetails(GridViewRowDetailsEventArgs)

Raises the UnloadingRowDetails event.

Declaration

protected virtual void OnUnloadingRowDetails(GridViewRowDetailsEventArgs e)

Parameters

GridViewRowDetailsEventArgs e

PrepareContainerForGroupItemOverride(DependencyObject, Object)

Prepares the specified element to display the specified item.

Declaration

protected override void PrepareContainerForGroupItemOverride(DependencyObject element, object item)

Parameters

System.Windows.DependencyObject element

System.Object item

Overrides

BaseItemsControl.PrepareContainerForGroupItemOverride(DependencyObject, Object)

PrepareContainerForItemOverride(DependencyObject, Object)

Prepares the specified element to display the specified item.

Declaration

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameters

System.Windows.DependencyObject element

System.Object item

Overrides

BaseItemsControl.PrepareContainerForItemOverride(DependencyObject, Object)

RaiseSelectionChangedEvent(SelectionChangeEventArgs)

Raises the selection changed event.

Declaration

protected override void RaiseSelectionChangedEvent(SelectionChangeEventArgs args)

Parameters

SelectionChangeEventArgs args

The SelectionChangeEventArgs instance containing the event data.

Overrides

DataControl.RaiseSelectionChangedEvent(SelectionChangeEventArgs)

RegisterCopyPasteApplicationCommands()

Declaration

protected virtual void RegisterCopyPasteApplicationCommands()

ReorderColumns(Int32, Int32)

Reorders the columns.

Declaration

public void ReorderColumns(int oldIndex, int newIndex)

Parameters

System.Int32 oldIndex

The old index.

System.Int32 newIndex

The new index.

ScrollIndexIntoView(Int32)

Scrolls the item with the specified index into view.

Declaration

public void ScrollIndexIntoView(int index)

Parameters

System.Int32 index

The index of the item.

ScrollIndexIntoView(Int32, GridViewColumn)

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

Declaration

public void ScrollIndexIntoView(int index, GridViewColumn column)

Parameters

System.Int32 index

The row index to scroll into view.

GridViewColumn column

The column to scroll into view.

Remarks

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

ScrollIndexIntoViewAsync(Int32, Action<FrameworkElement>)

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

Declaration

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

Parameters

System.Int32 index

The index to scroll into view.

System.Action<System.Windows.FrameworkElement> scrollFinishedCallback

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(Int32, Action<FrameworkElement>, Action)

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

Declaration

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

Parameters

System.Int32 index

The index to scroll into view.

System.Action<System.Windows.FrameworkElement> scrollFinishedCallback

The method to execute when scrolling has finished.

System.Action scrollFailedCallback

The method to execute when scrolling has failed.

Remarks

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

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

Declaration

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

Parameters

System.Int32 index

The row index to scroll into view.

GridViewColumn column

The column to scroll into view.

System.Action<System.Windows.FrameworkElement> scrollFinishedCallback

The method to execute when scrolling has finished.

System.Action scrollFailedCallback

The method to execute when scrolling has failed.

Remarks

ScrollIntoView(Object)

Scrolls the row containing the data item into view.

Declaration

public void ScrollIntoView(object dataItem)

Parameters

System.Object dataItem

The data item to scroll into view.

ScrollIntoView(Object, GridViewColumn)

Scrolls a cell into view.

Declaration

public void ScrollIntoView(object dataItem, GridViewColumn column)

Parameters

System.Object dataItem

The data item to scroll into view.

GridViewColumn 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

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

Parameters

System.Object dataItem

The data item to scroll into view.

System.Action<System.Windows.FrameworkElement> scrollFinishedCallback

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

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

Parameters

System.Object dataItem

The data item to scroll into view.

System.Action<System.Windows.FrameworkElement> scrollFinishedCallback

The method to execute when scrolling has finished.

System.Action 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

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

Parameters

System.Object dataItem

The data item to scroll into view.

GridViewColumn column

The column to scroll into view.

System.Action<System.Windows.FrameworkElement> scrollFinishedCallback

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

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

Parameters

System.Object dataItem

The data item to scroll into view.

GridViewColumn column

The column to scroll into view.

System.Action<System.Windows.FrameworkElement> scrollFinishedCallback

The method to execute when scrolling has finished.

System.Action scrollFailedCallback

The method to execute when scrolling has failed.

Remarks

Select(IEnumerable)

Selects specified items.

Declaration

public void Select(IEnumerable items)

Parameters

System.Collections.IEnumerable items

SelectAll()

Selects all grid data items.

Declaration

public void SelectAll()

SelectItemsRange(Int32, Int32, Boolean)

Selects all the items in the given range.

Declaration

public void SelectItemsRange(int startIndex, int endIndex, bool shouldClearCurrentSelection)

Parameters

System.Int32 startIndex

System.Int32 endIndex

System.Boolean shouldClearCurrentSelection

SelectItemsRange(Object, Object, Boolean)

Selects all the items in the given range.

Declaration

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

Parameters

System.Object startItem

System.Object endItem

System.Boolean shouldClearCurrentSelection

SetIsCurrent(Object, Boolean)

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

Declaration

protected override void SetIsCurrent(object item, bool isCurrent)

Parameters

System.Object item

The data item.

System.Boolean isCurrent

If set to true container is current.

Overrides

DataControl.SetIsCurrent(Object, Boolean)

SetIsSelected(Object, Boolean)

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

Declaration

protected override void SetIsSelected(object item, bool isSelected)

Parameters

System.Object item

The data item.

System.Boolean isSelected

If set to true container is selected.

Overrides

DataControl.SetIsSelected(Object, Boolean)

SetSelectionAnchor(Object)

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

Declaration

public void SetSelectionAnchor(object anchorItem)

Parameters

System.Object anchorItem

The item that should be used as selection anchor.

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

public void SetSelectionAnchor(GridViewCellInfo anchorInfo)

Parameters

GridViewCellInfo anchorInfo

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

ShouldDestroyContainersOnReset()

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

Declaration

protected virtual bool ShouldDestroyContainersOnReset()

Returns

System.Boolean

Unselect(IEnumerable)

Unselects specified items.

Declaration

public void Unselect(IEnumerable items)

Parameters

System.Collections.IEnumerable items

UnselectAll()

Unselects all grid data items.

Declaration

public void UnselectAll()

Events

AddingNewDataItem

Occurs before a new data item is added. This event enables providing custom logic when inserting a new item in a data source.

Declaration

public event EventHandler<GridViewAddingNewEventArgs> AddingNewDataItem

Event Type

System.EventHandler<GridViewAddingNewEventArgs>

AutoGeneratingColumn

Occurs one time for each public, non-static property in the bound data type when the ItemsSource property is changed and the AutoGenerateColumns property is true.

Declaration

public event EventHandler<GridViewAutoGeneratingColumnEventArgs> AutoGeneratingColumn

Event Type

System.EventHandler<GridViewAutoGeneratingColumnEventArgs>

BeginningEdit

Occurs before a cell or row enters editing mode.

Declaration

public event EventHandler<GridViewBeginningEditRoutedEventArgs> BeginningEdit

Event Type

System.EventHandler<GridViewBeginningEditRoutedEventArgs>

CellEditEnded

Occurs when a cell edit ended.

Declaration

public event EventHandler<GridViewCellEditEndedEventArgs> CellEditEnded

Event Type

System.EventHandler<GridViewCellEditEndedEventArgs>

CellLoaded

Occurs when a cell is loaded.

Declaration

public event EventHandler<CellEventArgs> CellLoaded

Event Type

System.EventHandler<CellEventArgs>

CellUnloaded

Occurs when a cell is loaded.

Declaration

public event EventHandler<CellEventArgs> CellUnloaded

Event Type

System.EventHandler<CellEventArgs>

CellValidated

Occurs when a cell is validated.

Declaration

public event EventHandler<GridViewCellValidatedEventArgs> CellValidated

Event Type

System.EventHandler<GridViewCellValidatedEventArgs>

CellValidating

Occurs when a cell is validating.

Declaration

public event EventHandler<GridViewCellValidatingEventArgs> CellValidating

Event Type

System.EventHandler<GridViewCellValidatingEventArgs>

ColumnDisplayIndexChanged

Event that is fired when the DisplayIndex on one of the GridViewDataControl's Columns changes.

Declaration

public event EventHandler<GridViewColumnEventArgs> ColumnDisplayIndexChanged

Event Type

System.EventHandler<GridViewColumnEventArgs>

ColumnReordered

Occurs when a column is reordered.

Declaration

public event EventHandler<GridViewColumnEventArgs> ColumnReordered

Event Type

System.EventHandler<GridViewColumnEventArgs>

ColumnReordering

Occurs before the column is reordered.

Declaration

public event EventHandler<ColumnReorderingEventArgs> ColumnReordering

Event Type

System.EventHandler<ColumnReorderingEventArgs>

ColumnWidthChanged

Occurs when column width changed.

Declaration

public event EventHandler<ColumnWidthChangedEventArgs> ColumnWidthChanged

Event Type

System.EventHandler<ColumnWidthChangedEventArgs>

ColumnWidthChanging

Occurs when column width changed.

Declaration

public event EventHandler<ColumnWidthChangingEventArgs> ColumnWidthChanging

Event Type

System.EventHandler<ColumnWidthChangingEventArgs>

Copied

Occurs after the selected cells of the GridViewDataControl were copied to the Clipboard.

Declaration

public event EventHandler<RadRoutedEventArgs> Copied

Event Type

System.EventHandler<RadRoutedEventArgs>

Copying

Occurs before the selected cells of the GridViewDataControl are copied to the Clipboard.

Declaration

public event EventHandler<GridViewClipboardEventArgs> Copying

Event Type

System.EventHandler<GridViewClipboardEventArgs>

CopyingCellClipboardContent

Occurs before a cell is copied to the Clipboard.

Declaration

public event EventHandler<GridViewCellClipboardEventArgs> CopyingCellClipboardContent

Event Type

System.EventHandler<GridViewCellClipboardEventArgs>

CurrentCellInfoChanged

Occurs when the current cell info was changed.

Declaration

public event EventHandler<GridViewCurrentCellInfoChangedEventArgs> CurrentCellInfoChanged

Event Type

System.EventHandler<GridViewCurrentCellInfoChangedEventArgs>

DataError

Occurs when a data error occurs while committing changed data.

Declaration

public event EventHandler<DataErrorEventArgs> DataError

Event Type

System.EventHandler<DataErrorEventArgs>

DataLoaded

Occurs when the grid data are loaded.

Declaration

public event EventHandler<EventArgs> DataLoaded

Event Type

System.EventHandler<System.EventArgs>

DataLoading

Occurs when the grid data is about to load data.

Declaration

public event EventHandler<GridViewDataLoadingEventArgs> DataLoading

Event Type

System.EventHandler<GridViewDataLoadingEventArgs>

Deleted

Occurs after deletion was performed.

Declaration

public event EventHandler<GridViewDeletedEventArgs> Deleted

Event Type

System.EventHandler<GridViewDeletedEventArgs>

Deleting

Occurs before deletion is performed.

Declaration

public event EventHandler<GridViewDeletingEventArgs> Deleting

Event Type

System.EventHandler<GridViewDeletingEventArgs>

DistinctValuesLoading

Occurs when the grid column distinct values is about to be loaded.

Declaration

public event EventHandler<GridViewDistinctValuesLoadingEventArgs> DistinctValuesLoading

Event Type

System.EventHandler<GridViewDistinctValuesLoadingEventArgs>

ElementExported

Occurs after element export.

Declaration

public event EventHandler<GridViewElementExportedEventArgs> ElementExported

Event Type

System.EventHandler<GridViewElementExportedEventArgs>

ElementExportedToDocument

Occurs after element export to XLSX or PDF.

Declaration

public event EventHandler<GridViewElementExportedToDocumentEventArgs> ElementExportedToDocument

Event Type

System.EventHandler<GridViewElementExportedToDocumentEventArgs>

ElementExporting

Occurs before element export.

Declaration

public event EventHandler<GridViewElementExportingEventArgs> ElementExporting

Event Type

System.EventHandler<GridViewElementExportingEventArgs>

ElementExportingToDocument

Occurs before element export to XLSX or PDF.

Declaration

public event EventHandler<GridViewElementExportingToDocumentEventArgs> ElementExportingToDocument

Event Type

System.EventHandler<GridViewElementExportingToDocumentEventArgs>

FieldFilterEditorCreated

Occurs when a field filter editor has been created. This event allows you to modify certain properties of the editor.

Declaration

public event EventHandler<EditorCreatedEventArgs> FieldFilterEditorCreated

Event Type

System.EventHandler<EditorCreatedEventArgs>

Filtered

Occurs after filter operation.

Declaration

public event EventHandler<GridViewFilteredEventArgs> Filtered

Event Type

System.EventHandler<GridViewFilteredEventArgs>

Filtering

Occurs before filter operation.

Declaration

public event EventHandler<GridViewFilteringEventArgs> Filtering

Event Type

System.EventHandler<GridViewFilteringEventArgs>

FilterOperatorsLoading

Occurs before the filter operators of the filtering control are loaded. Use this event if you want to remove one or more of the filter operators or if you want to change the one selected by default.

Declaration

public event EventHandler<FilterOperatorsLoadingEventArgs> FilterOperatorsLoading

Event Type

System.EventHandler<FilterOperatorsLoadingEventArgs>

FrozenColumnsChanged

Occurs when a FrozenColumnsCount's property changed.

Declaration

public event EventHandler<FrozenColumnsChangedEventArgs> FrozenColumnsChanged

Event Type

System.EventHandler<FrozenColumnsChangedEventArgs>

Grouped

Occurs after grouping was performed.

Declaration

public event EventHandler<GridViewGroupedEventArgs> Grouped

Event Type

System.EventHandler<GridViewGroupedEventArgs>

Grouping

Occurs while grouping is performed. (Cancelable).

Declaration

public event EventHandler<GridViewGroupingEventArgs> Grouping

Event Type

System.EventHandler<GridViewGroupingEventArgs>

GroupRowIsExpandedChanged

Occurs when a group row's expanded state is changed.

Declaration

public event EventHandler<GroupRowEventArgs> GroupRowIsExpandedChanged

Event Type

System.EventHandler<GroupRowEventArgs>

GroupRowIsExpandedChanging

Occurs when a group row's expanded state is about to be changed.

Declaration

public event EventHandler<GroupRowCancelEventArgs> GroupRowIsExpandedChanging

Event Type

System.EventHandler<GroupRowCancelEventArgs>

InitializingExcelMLStyles

Occurs when ExcelML worksheet styles are initialized.

Declaration

public event EventHandler<ExcelMLStylesEventArgs> InitializingExcelMLStyles

Event Type

System.EventHandler<ExcelMLStylesEventArgs>

LoadingRowDetails

Occurs when the details for a row are loaded from the details template.

Declaration

public event EventHandler<GridViewRowDetailsEventArgs> LoadingRowDetails

Event Type

System.EventHandler<GridViewRowDetailsEventArgs>

Pasted

Occurs after content from the Clipboard was pasted into the GridViewDataControl.

Declaration

public event EventHandler<RadRoutedEventArgs> Pasted

Event Type

System.EventHandler<RadRoutedEventArgs>

Pasting

Occurs before content from the Clipboard is pasted into the GridViewDataControl.

Declaration

public event EventHandler<GridViewClipboardEventArgs> Pasting

Event Type

System.EventHandler<GridViewClipboardEventArgs>

PastingCellClipboardContent

Occurs before a cell is pasted from the Clipboard.

Declaration

public event EventHandler<GridViewCellClipboardEventArgs> PastingCellClipboardContent

Event Type

System.EventHandler<GridViewCellClipboardEventArgs>

PreparedCellForEdit

Occurs when a cell is prepared for editing.

Declaration

public event EventHandler<GridViewPreparingCellForEditEventArgs> PreparedCellForEdit

Event Type

System.EventHandler<GridViewPreparingCellForEditEventArgs>

PreparingCellForEdit

Occurs when a cell is entering edit mode.

Declaration

public event EventHandler<GridViewPreparingCellForEditEventArgs> PreparingCellForEdit

Event Type

System.EventHandler<GridViewPreparingCellForEditEventArgs>

RowActivated

Occurs when a row is activated - when user double click on it or press enter on selected row.

Declaration

public event EventHandler<RowEventArgs> RowActivated

Event Type

System.EventHandler<RowEventArgs>

RowDetailsVisibilityChanged

Occurs when the details for a row change their Visibility.

Declaration

public event EventHandler<GridViewRowDetailsEventArgs> RowDetailsVisibilityChanged

Event Type

System.EventHandler<GridViewRowDetailsEventArgs>

RowDetailsVisibilityChanging

Occurs when the details for a row are about to change their visibility.

Declaration

public event EventHandler<RowDetailsVisibilityChangingEventArgs> RowDetailsVisibilityChanging

Event Type

System.EventHandler<RowDetailsVisibilityChangingEventArgs>

RowEditEnded

Occurs when a row edit ended.

Declaration

public event EventHandler<GridViewRowEditEndedEventArgs> RowEditEnded

Event Type

System.EventHandler<GridViewRowEditEndedEventArgs>

RowIsExpandedChanged

Occurs when a row's expanded state is changed - when its hierarchy child is expanded or collapsed.

Declaration

public event EventHandler<RowEventArgs> RowIsExpandedChanged

Event Type

System.EventHandler<RowEventArgs>

RowIsExpandedChanging

Occurs when a row's expanded state is about to be changed - when its hierarchy child is expanded or collapsed.

Declaration

public event EventHandler<RowCancelEventArgs> RowIsExpandedChanging

Event Type

System.EventHandler<RowCancelEventArgs>

RowLoaded

Occurs when a row is loaded.

Declaration

public event EventHandler<RowLoadedEventArgs> RowLoaded

Event Type

System.EventHandler<RowLoadedEventArgs>

RowResized

Occurs when the grid data are loaded.

Declaration

public event EventHandler<RowResizedEventArgs> RowResized

Event Type

System.EventHandler<RowResizedEventArgs>

RowResizing

Occurs when the grid data is about to load data.

Declaration

public event EventHandler<RowResizingEventArgs> RowResizing

Event Type

System.EventHandler<RowResizingEventArgs>

RowUnloaded

Occurs when a row is unloaded.

Declaration

public event EventHandler<RowUnloadedEventArgs> RowUnloaded

Event Type

System.EventHandler<RowUnloadedEventArgs>

RowValidated

Occurs when a row is validated.

Declaration

public event EventHandler<GridViewRowValidatedEventArgs> RowValidated

Event Type

System.EventHandler<GridViewRowValidatedEventArgs>

RowValidating

Occurs when a row is validating.

Declaration

public event EventHandler<GridViewRowValidatingEventArgs> RowValidating

Event Type

System.EventHandler<GridViewRowValidatingEventArgs>

Searched

Occurs after searching in the search panel.

Declaration

public event EventHandler<GridViewSearchedEventArgs> Searched

Event Type

System.EventHandler<GridViewSearchedEventArgs>

Searching

Occurs before searching in the search panel.

Declaration

public event EventHandler<GridViewSearchingEventArgs> Searching

Event Type

System.EventHandler<GridViewSearchingEventArgs>

SearchPanelVisibilityChanged

Occurs when the search panel changes its Visibility.

Declaration

public event EventHandler<VisibilityChangedEventArgs> SearchPanelVisibilityChanged

Event Type

System.EventHandler<VisibilityChangedEventArgs>

SelectedCellsChanged

Event that fires when the SelectedCells collection is changed.

Declaration

public event EventHandler<GridViewSelectedCellsChangedEventArgs> SelectedCellsChanged

Event Type

System.EventHandler<GridViewSelectedCellsChangedEventArgs>

SelectedCellsChanging

Event that fires when the SelectedCells collection is about to change.

Declaration

public event EventHandler<GridViewSelectedCellsChangingEventArgs> SelectedCellsChanging

Event Type

System.EventHandler<GridViewSelectedCellsChangingEventArgs>

Sorted

Occurs after sorted was performed.

Declaration

public event EventHandler<GridViewSortedEventArgs> Sorted

Event Type

System.EventHandler<GridViewSortedEventArgs>

Sorting

Occurs before RadGridView or a nested hierarchy child performs sorting.

Declaration

public event EventHandler<GridViewSortingEventArgs> Sorting

Event Type

System.EventHandler<GridViewSortingEventArgs>

UnloadingRowDetails

Occurs when the details for a row are loaded from the details template.

Declaration

public event EventHandler<GridViewRowDetailsEventArgs> UnloadingRowDetails

Event Type

System.EventHandler<GridViewRowDetailsEventArgs>

Explicit Interface Implementations

IScrollingInfo.ExtentHeight

Declaration

double IScrollingInfo.ExtentHeight { get; }

Returns

System.Double

Implements

IScrollingInfo.ExtentHeight

IScrollingInfo.ExtentWidth

Declaration

double IScrollingInfo.ExtentWidth { get; }

Returns

System.Double

Implements

IScrollingInfo.ExtentWidth

IScrollingInfo.HorizontalOffset

Declaration

double IScrollingInfo.HorizontalOffset { get; }

Returns

System.Double

Implements

IScrollingInfo.HorizontalOffset

IScrollingInfo.TransformFromDropTargetToViewPort(Point)

Declaration

Point IScrollingInfo.TransformFromDropTargetToViewPort(Point positionInDropTarget)

Parameters

System.Windows.Point positionInDropTarget

Returns

System.Windows.Point

Implements

IScrollingInfo.TransformFromDropTargetToViewPort(Point)

IScrollingInfo.VerticalOffset

Declaration

double IScrollingInfo.VerticalOffset { get; }

Returns

System.Double

Implements

IScrollingInfo.VerticalOffset

IScrollingInfo.ViewportHeight

Declaration

double IScrollingInfo.ViewportHeight { get; }

Returns

System.Double

Implements

IScrollingInfo.ViewportHeight

IScrollingInfo.ViewportWidth

Declaration

double IScrollingInfo.ViewportWidth { get; }

Returns

System.Double

Implements

IScrollingInfo.ViewportWidth

IScrollingServiceCore.ScrollHorizontal(Double)

Declaration

void IScrollingServiceCore.ScrollHorizontal(double offsetX)

Parameters

System.Double offsetX

Implements

IScrollingServiceCore.ScrollHorizontal(Double)

IScrollingServiceCore.ScrollVertical(Double)

Declaration

void IScrollingServiceCore.ScrollVertical(double offsetY)

Parameters

System.Double offsetY

Implements

IScrollingServiceCore.ScrollVertical(Double)

Extension Methods

ExportExtensions.ToExcelML(GridViewDataControl)

ExportExtensions.ToExcelML(GridViewDataControl, Boolean)

ExportExtensions.ToExcelML(GridViewDataControl, Boolean, Boolean)

ExportExtensions.ToExcelML(GridViewDataControl, IEnumerable, Boolean)

ExportExtensions.ToExcelML(GridViewDataControl, IEnumerable, Boolean, Boolean)

ExportExtensions.ToHtml(GridViewDataControl)

ExportExtensions.ToHtml(GridViewDataControl, Boolean)

ExportExtensions.ToHtml(GridViewDataControl, Boolean, Boolean)

ExportExtensions.ToHtml(GridViewDataControl, IEnumerable, Boolean)

ExportExtensions.ToHtml(GridViewDataControl, IEnumerable, Boolean, Boolean)

ExportExtensions.ToText(GridViewDataControl)

ExportExtensions.ToText(GridViewDataControl, Boolean)

ExportExtensions.ToText(GridViewDataControl, Boolean, Boolean)

ExportExtensions.ToText(GridViewDataControl, IEnumerable, Boolean)

ExportExtensions.ToText(GridViewDataControl, IEnumerable, Boolean, Boolean)

ExportExtensions.ToCsv(GridViewDataControl)

ExportExtensions.ToCsv(GridViewDataControl, Boolean)

ExportExtensions.ToCsv(GridViewDataControl, Boolean, Boolean)

ExportExtensions.ToCsv(GridViewDataControl, IEnumerable, Boolean)

ExportExtensions.ToCsv(GridViewDataControl, IEnumerable, Boolean, Boolean)

GridViewDataControlExtensions.FindGroupByItem(BaseItemsControl, Object)

GridViewDataControlExportExtensions.ExportToXlsx(GridViewDataControl, Stream)

GridViewDataControlExportExtensions.ExportToXlsx(GridViewDataControl, Stream, GridViewDocumentExportOptions)

GridViewDataControlExportExtensions.ExportToWorkbook(GridViewDataControl)

GridViewDataControlExportExtensions.ExportToWorkbook(GridViewDataControl, GridViewDocumentExportOptions)

GridViewDataControlExportExtensions.ExportToPdf(GridViewDataControl, Stream)

GridViewDataControlExportExtensions.ExportToPdf(GridViewDataControl, Stream, GridViewDocumentExportOptions)

GridViewDataControlExportExtensions.ExportToRadFixedDocument(GridViewDataControl)

GridViewDataControlExportExtensions.ExportToRadFixedDocument(GridViewDataControl, GridViewDocumentExportOptions)

CollectionExtensions.ToEnumerable<T>(T)

EnumerableExtensions.ToEnumerable<T>(T)