DataGrid Class

Displays data in a customizable grid.

Definition

Namespace: Avalonia.Controls
Assembly: Avalonia.Controls.DataGrid (in Avalonia.Controls.DataGrid.dll) Version: 11.3.999
[TemplatePartAttribute("PART_BottomRightCorner", typeof(Visual))]
[TemplatePartAttribute("PART_ColumnHeadersPresenter", typeof(DataGridColumnHeadersPresenter))]
[TemplatePartAttribute("PART_FrozenColumnScrollBarSpacer", typeof(Control))]
[TemplatePartAttribute("PART_HorizontalScrollbar", typeof(ScrollBar))]
[TemplatePartAttribute("PART_RowsPresenter", typeof(DataGridRowsPresenter))]
[TemplatePartAttribute("PART_TopLeftCornerHeader", typeof(ContentControl))]
[TemplatePartAttribute("PART_TopRightCornerHeader", typeof(ContentControl))]
[TemplatePartAttribute("PART_VerticalScrollbar", typeof(ScrollBar))]
[PseudoClassesAttribute(new string[] { ... })]
public class DataGrid : TemplatedControl
Inheritance
Object    AvaloniaObject    Animatable    StyledElement    Visual    Layoutable    Interactive    InputElement    Control    TemplatedControl    DataGrid

Properties

ActualThemeVariant Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty.
(Inherited from StyledElement)
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.
AreRowGroupHeadersFrozen Gets or sets a value that indicates whether the row group header sections remain fixed at the width of the display area or can scroll horizontally.
AutoGenerateColumns Gets or sets a value that indicates whether columns are created automatically when the ItemsSource property is set.
Background Gets or sets the brush used to draw the control's background.
(Inherited from TemplatedControl)
BackgroundSizing Gets or sets how the control's background is drawn relative to the control's border.
(Inherited from TemplatedControl)
BorderBrush Gets or sets the brush used to draw the control's border.
(Inherited from TemplatedControl)
BorderThickness Gets or sets the thickness of the control's border.
(Inherited from TemplatedControl)
Bounds Gets the bounds of the control relative to its parent.
(Inherited from Visual)
BypassFlowDirectionPolicies Gets a value indicating whether control bypass FlowDirecton policies.
(Inherited from Visual)
CanUserReorderColumns Gets or sets a value that indicates whether the user can change the column display order by dragging column headers with the mouse.
CanUserResizeColumns Gets or sets a value that indicates whether the user can adjust column widths using the mouse.
CanUserSortColumns Gets or sets a value that indicates whether the user can sort columns by clicking the column header.
CellTheme Gets or sets the theme applied to all cells.
Classes Gets or sets the styled element's classes.
(Inherited from StyledElement)
Clip Gets or sets the geometry clip for this visual.
(Inherited from Visual)
ClipboardCopyMode The property which determines how DataGrid content is copied to the Clipboard.
ClipToBounds Gets or sets a value indicating whether the control should be clipped to its bounds.
(Inherited from Visual)
CollectionView Gets current IDataGridCollectionView.
ColumnHeaderHeight Gets or sets the height of the column headers row.
ColumnHeaderTheme Gets or sets the theme applied to all column headers.
Columns Gets a collection that contains all the columns in the control.
ColumnWidth Gets or sets the standard width or automatic sizing mode of columns in the control.
ContextFlyout Gets or sets a context flyout to the control
(Inherited from Control)
ContextMenu Gets or sets a context menu to the control.
(Inherited from Control)
CornerRadius Gets or sets the radius of the border rounded corners.
(Inherited from TemplatedControl)
CurrentColumn Gets or sets the column that contains the current cell.
CurrentItem Gets the data item bound to the row that contains the current cell.
Cursor Gets or sets associated mouse cursor.
(Inherited from InputElement)
DataContext Gets or sets the control's data context.
(Inherited from StyledElement)
DataTemplates Gets or sets the data templates for the control.
(Inherited from Control)
DesiredSize Gets the size that this element computed during the measure pass of the layout process.
(Inherited from Layoutable)
DropLocationIndicatorTemplate Gets or sets the template that is used when rendering the column headers.
Effect Gets or sets the effect of the control.
(Inherited from Visual)
FlowDirection Gets or sets the text flow direction.
(Inherited from Visual)
Focusable Gets or sets a value indicating whether the control can receive focus.
(Inherited from InputElement)
FocusAdorner Gets or sets the control's focus adorner.
(Inherited from Control)
FontFamily Gets or sets the font family used to draw the control's text.
(Inherited from TemplatedControl)
FontFeatures Gets or sets the font features turned on/off.
(Inherited from TemplatedControl)
FontSize Gets or sets the size of the control's text in points.
(Inherited from TemplatedControl)
FontStretch Gets or sets the font stretch used to draw the control's text.
(Inherited from TemplatedControl)
FontStyle Gets or sets the font style used to draw the control's text.
(Inherited from TemplatedControl)
FontWeight Gets or sets the font weight used to draw the control's text.
(Inherited from TemplatedControl)
Foreground Gets or sets the brush used to draw the control's text and other foreground elements.
(Inherited from TemplatedControl)
FrozenColumnCount Gets or sets the number of columns that the user cannot scroll horizontally.
GestureRecognizers
(Inherited from InputElement)
GridLinesVisibility Gets or sets a value that indicates which grid lines separating inner cells are shown.
HasMirrorTransform Gets or sets a value indicating whether to apply mirror transform on this control.
(Inherited from Visual)
HeadersVisibility Gets or sets a value that indicates the visibility of row and column headers.
Height Gets or sets the height of the element.
(Inherited from Layoutable)
HorizontalAlignment Gets or sets the element's preferred horizontal alignment in its parent.
(Inherited from Layoutable)
HorizontalGridLinesBrush Gets or sets the Brush that is used to paint grid lines separating rows.
HorizontalScrollBarVisibility Gets or sets a value that indicates how the horizontal scroll bar is displayed.
InheritanceParent Gets or sets the parent object that inherited AvaloniaProperty values are inherited from.
(Inherited from AvaloniaObject)
IsArrangeValid Gets a value indicating whether the control's layouts arrange is valid.
(Inherited from Layoutable)
IsEffectivelyEnabled Gets a value indicating whether this control and all its parents are enabled.
(Inherited from InputElement)
IsEffectivelyVisible Gets a value indicating whether this control and all its parents are visible.
(Inherited from Visual)
IsEnabled Gets or sets a value indicating whether the control is enabled for user interaction.
(Inherited from InputElement)
IsEnabledCore Allows a derived class to override the enabled state of the control.
(Inherited from InputElement)
IsFocused Gets a value indicating whether the control is focused.
(Inherited from InputElement)
IsHitTestVisible Gets or sets a value indicating whether the control is considered for hit testing.
(Inherited from InputElement)
IsInitialized Gets a value that indicates whether the element has finished initialization.
(Inherited from StyledElement)
IsKeyboardFocusWithin Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements.
(Inherited from InputElement)
IsLoaded Gets a value indicating whether the control is fully constructed in the visual tree and both layout and render are complete.
(Inherited from Control)
IsMeasureValid Gets a value indicating whether the control's layout measure is valid.
(Inherited from Layoutable)
IsPointerOver Gets a value indicating whether the pointer is currently over the control.
(Inherited from InputElement)
IsReadOnly Gets or sets a value that indicates whether the user can edit the values in the control.
IsScrollInertiaEnabled Gets or sets whether scroll gestures should include inertia in their behavior and value.
IsTabStop Gets or sets a value that indicates whether the control is included in tab navigation.
(Inherited from InputElement)
IsValid 
IsVisible Gets or sets a value indicating whether this control is visible.
(Inherited from Visual)
ItemAvaloniaProperty Gets or sets the value of a AvaloniaProperty.
(Inherited from AvaloniaObject)
ItemIndexerDescriptor Gets or sets a binding for a AvaloniaProperty.
(Inherited from AvaloniaObject)
ItemsSource Gets or sets a collection that is used to generate the content of the control.
KeyBindings
(Inherited from InputElement)
LogicalChildren Gets the styled element's logical children.
(Inherited from StyledElement)
Margin Gets or sets the margin around the element.
(Inherited from Layoutable)
MaxColumnWidth Gets or sets the maximum width of columns in the DataGrid .
MaxHeight Gets or sets the maximum height of the element.
(Inherited from Layoutable)
MaxWidth Gets or sets the maximum width of the element.
(Inherited from Layoutable)
MinColumnWidth Gets or sets the minimum width of columns in the DataGrid.
MinHeight Gets or sets the minimum height of the element.
(Inherited from Layoutable)
MinWidth Gets or sets the minimum width of the element.
(Inherited from Layoutable)
Name Gets or sets the name of the styled element.
(Inherited from StyledElement)
Opacity Gets or sets the opacity of the control.
(Inherited from Visual)
OpacityMask Gets or sets the opacity mask of the control.
(Inherited from Visual)
Padding Gets or sets the padding placed between the border of the control and its content.
(Inherited from TemplatedControl)
Parent Gets the styled element's logical parent.
(Inherited from StyledElement)
PseudoClasses Gets the Classes collection in a form that allows adding and removing pseudoclasses.
(Inherited from StyledElement)
RenderTransform Gets or sets the render transform of the control.
(Inherited from Visual)
RenderTransformOrigin Gets or sets the transform origin of the control.
(Inherited from Visual)
Resources Gets or sets the styled element's resource dictionary.
(Inherited from StyledElement)
RowBackground Gets or sets the Brush that is used to paint row backgrounds.
RowDetailsTemplate Gets or sets the template that is used to display the content of the details section of rows.
RowDetailsVisibilityMode Gets or sets a value that indicates when the details sections of rows are displayed.
RowGroupTheme Gets or sets the theme applied to all row groups.
RowHeaderWidth Gets or sets the width of the row header column.
RowHeight Gets or sets the standard height of rows in the control.
RowTheme Gets or sets the theme applied to all rows.
SelectedIndex Gets or sets the index of the current selection.
SelectedItem Gets or sets the data item corresponding to the selected row.
SelectedItems Gets a list that contains the data items corresponding to the selected rows.
SelectionMode Gets or sets the selection behavior of the data grid.
StyleKey Gets the type by which the element is styled.
(Inherited from StyledElement)
StyleKeyOverride Gets the type by which the element is styled.
(Inherited from StyledElement)
Styles Gets the styles for the styled element.
(Inherited from StyledElement)
TabIndex Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by pressing the Tab key.
(Inherited from InputElement)
Tag Gets or sets a user-defined object attached to the control.
(Inherited from Control)
Template Gets or sets the template that defines the control's appearance.
(Inherited from TemplatedControl)
TemplatedParent Gets the styled element whose lookless template this styled element is part of.
(Inherited from StyledElement)
Theme Gets or sets the theme to be applied to the element.
(Inherited from StyledElement)
Transitions Gets or sets the property transitions for the control.
(Inherited from Animatable)
UseLayoutRounding Gets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time.
(Inherited from Layoutable)
VerticalAlignment Gets or sets the element's preferred vertical alignment in its parent.
(Inherited from Layoutable)
VerticalGridLinesBrush Gets or sets the Brush that is used to paint grid lines separating columns.
VerticalScrollBarVisibility Gets or sets a value that indicates how the vertical scroll bar is displayed.
VisualChildren Gets the control's child visuals.
(Inherited from Visual)
VisualRoot Gets the root of the visual tree, if the control is attached to a visual tree.
(Inherited from Visual)
Width Gets or sets the width of the element.
(Inherited from Layoutable)
ZIndex Gets or sets the Z index of the control.
(Inherited from Visual)

Methods

AddHandler(RoutedEvent, Delegate, RoutingStrategies, Boolean) Adds a handler for the specified routed event.
(Inherited from Interactive)
AddHandlerTEventArgs(RoutedEventTEventArgs, EventHandlerTEventArgs, RoutingStrategies, Boolean) Adds a handler for the specified routed event.
(Inherited from Interactive)
ApplyStyling Applies styling to the control if the control is initialized and styling is not already applied.
(Inherited from StyledElement)
ApplyTemplate Creates the visual children of the control, if necessary
(Inherited from TemplatedControl)
Arrange(Rect) Arranges the control and its children.
(Inherited from Layoutable)
ArrangeCore(Rect) The default implementation of the control's arrange pass.
(Inherited from Layoutable)
ArrangeOverride(Size) Arranges the content of the DataGridRow.
(Overrides LayoutableArrangeOverride(Size))
BeginEdit Enters editing mode for the current cell and current row (if they're not already in editing mode).
BeginEdit(RoutedEventArgs) Enters editing mode for the current cell and current row (if they're not already in editing mode).
BeginInitSignals the object that initialization is starting.
(Inherited from StyledElement)
Bind(AvaloniaProperty, IBinding) Binds a AvaloniaProperty to an IBinding.
(Inherited from AvaloniaObject)
Bind(AvaloniaProperty, IObservableObject, BindingPriority) Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
BindT(DirectPropertyBaseT, IObservableT) Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
BindT(DirectPropertyBaseT, IObservableBindingValueT) Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
BindT(DirectPropertyBaseT, IObservableObject) Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
BindT(StyledPropertyT, IObservableT, BindingPriority) Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
BindT(StyledPropertyT, IObservableBindingValueT, BindingPriority) Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
BindT(StyledPropertyT, IObservableObject, BindingPriority) Binds a AvaloniaProperty to an observable.
(Inherited from AvaloniaObject)
BuildEventRoute(RoutedEvent) Builds an event route for a routed event.
(Inherited from Interactive)
CancelEdit Cancels editing mode and restores the original value.
CancelEdit(DataGridEditingUnit) Cancels editing mode for the specified DataGridEditingUnit and restores its original value.
CheckAccess Returns a value indicating whether the current thread is the UI thread.
(Inherited from AvaloniaObject)
ClearValue(AvaloniaProperty) Clears a AvaloniaProperty's local value.
(Inherited from AvaloniaObject)
ClearValueT(AvaloniaPropertyT) Clears a AvaloniaProperty's local value.
(Inherited from AvaloniaObject)
ClearValueT(DirectPropertyBaseT) Clears a AvaloniaProperty's local value.
(Inherited from AvaloniaObject)
ClearValueT(StyledPropertyT) Clears a AvaloniaProperty's local value.
(Inherited from AvaloniaObject)
CoerceValue(AvaloniaProperty) Coerces the specified AvaloniaProperty.
(Inherited from AvaloniaObject)
CollapseRowGroup(DataGridCollectionViewGroup, Boolean) Collapses the DataGridRowGroupHeader that represents a given CollectionViewGroup
CommitEdit Commits editing mode and pushes changes to the backend.
CommitEdit(DataGridEditingUnit, Boolean) Commits editing mode for the specified DataGridEditingUnit and pushes changes to the backend.
EndInitSignals the object that initialization is complete.
(Inherited from StyledElement)
Equals(Object) Compares two objects using reference equality.
(Inherited from AvaloniaObject)
ExpandRowGroup(DataGridCollectionViewGroup, Boolean) Expands the DataGridRowGroupHeader that represents a given CollectionViewGroup
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Focus(NavigationMethod, KeyModifiers) Focuses the control.
(Inherited from InputElement)
GetBaseValueT(StyledPropertyT) Gets an AvaloniaProperty base value.
(Inherited from AvaloniaObject)
GetGroupFromItem(Object, Int32) Returns the Group at the indicated level or null if the item is not in the ItemsSource
GetHashCode Gets the hash code for the object.
(Inherited from AvaloniaObject)
GetTemplateFocusTarget Gets the element that receives the focus adorner.
(Inherited from TemplatedControl)
GetTypeGets the Type of the current instance.
(Inherited from Object)
GetValue(AvaloniaProperty) Gets a AvaloniaProperty value.
(Inherited from AvaloniaObject)
GetValueT(DirectPropertyBaseT) Gets a AvaloniaProperty value.
(Inherited from AvaloniaObject)
GetValueT(StyledPropertyT) Gets a AvaloniaProperty value.
(Inherited from AvaloniaObject)
InitializeIfNeeded
(Inherited from StyledElement)
InvalidateArrange Invalidates the arrangement of the control and queues a new layout pass.
(Inherited from Layoutable)
InvalidateMeasure Invalidates the measurement of the control and queues a new layout pass.
(Inherited from Layoutable)
InvalidateMirrorTransform Computes the HasMirrorTransform value according to the FlowDirection and BypassFlowDirectionPolicies
(Inherited from Visual)
InvalidateVisual Invalidates the visual and queues a repaint.
(Inherited from Visual)
IsAnimating(AvaloniaProperty) Checks whether a AvaloniaProperty is animating.
(Inherited from AvaloniaObject)
IsSet(AvaloniaProperty) Checks whether a AvaloniaProperty is set on this object.
(Inherited from AvaloniaObject)
LogicalChildrenCollectionChanged(Object, NotifyCollectionChangedEventArgs)
(Inherited from Visual)
Measure(Size) Carries out a measure of the control.
(Inherited from Layoutable)
MeasureCore(Size) The default implementation of the control's measure pass.
(Inherited from Layoutable)
MeasureOverride(Size) Measures the children of a DataGridRow to prepare for arranging them during the ArrangeOverride(Size) pass.
(Overrides LayoutableMeasureOverride(Size))
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
OnAccessKey(RoutedEventArgs) This method is used to execute the action on an effective IInputElement when a corresponding access key has been invoked. By default, the Focus() method is invoked with the NavigationMethod.Tab to indicate a visual focus adorner. Overwrite this method if other methods or additional functionality is needed when an item should receive the focus.
(Inherited from InputElement)
OnApplyTemplate(TemplateAppliedEventArgs) Builds the visual tree for the column header when a new template is applied.
(Overrides TemplatedControlOnApplyTemplate(TemplateAppliedEventArgs))
OnAttachedToLogicalTree(LogicalTreeAttachmentEventArgs) Called when the styled element is added to a rooted logical tree.
(Inherited from TemplatedControl)
OnAttachedToVisualTree(VisualTreeAttachmentEventArgs)
(Overrides VisualOnAttachedToVisualTree(VisualTreeAttachmentEventArgs))
OnAttachedToVisualTreeCore(VisualTreeAttachmentEventArgs) Calls the OnAttachedToVisualTree(VisualTreeAttachmentEventArgs) method for this control and all of its visual descendants.
(Inherited from Control)
OnAutoGeneratingColumn(DataGridAutoGeneratingColumnEventArgs) Raises the AutoGeneratingColumn event.
OnBeginningEdit(DataGridBeginningEditEventArgs) Raises the BeginningEdit event.
OnCellEditEnded(DataGridCellEditEndedEventArgs) Raises the CellEditEnded event.
OnCellEditEnding(DataGridCellEditEndingEventArgs) Raises the CellEditEnding event.
OnColumnDisplayIndexChanged(DataGridColumnEventArgs) 
OnColumnReordered(DataGridColumnEventArgs) 
OnColumnReordering(DataGridColumnReorderingEventArgs) 
OnColumnSorting(DataGridColumnEventArgs) 
OnCopyingRowClipboardContent(DataGridRowClipboardEventArgs) This method raises the CopyingRowClipboardContent event.
OnCreateAutomationPeer
(Overrides ControlOnCreateAutomationPeer)
OnCurrentCellChanged(EventArgs) Raises the CurrentCellChanged event.
OnDataContextBeginUpdate Called when the DataContext begins updating.
(Overrides StyledElementOnDataContextBeginUpdate)
OnDataContextChanged(EventArgs) Called when the DataContext property changes.
(Inherited from StyledElement)
OnDataContextEndUpdate Called when the DataContext finishes updating.
(Overrides StyledElementOnDataContextEndUpdate)
OnDetachedFromLogicalTree(LogicalTreeAttachmentEventArgs) Called when the styled element is removed from a rooted logical tree.
(Inherited from TemplatedControl)
OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs)
(Overrides VisualOnDetachedFromVisualTree(VisualTreeAttachmentEventArgs))
OnDetachedFromVisualTreeCore(VisualTreeAttachmentEventArgs)
(Inherited from Control)
OnGotFocus(GotFocusEventArgs) Called before the GotFocus event occurs.
(Inherited from Control)
OnInitialized Called when the control finishes initialization.
(Inherited from StyledElement)
OnKeyDown(KeyEventArgs) Called before the KeyDown event occurs.
(Inherited from InputElement)
OnKeyUp(KeyEventArgs) Called before the KeyUp event occurs.
(Inherited from Control)
OnLoaded(RoutedEventArgs) Invoked just before the Loaded event.
(Inherited from Control)
OnLoadingRow(DataGridRowEventArgs) Raises the LoadingRow event for row preparation.
OnLoadingRowDetails(DataGridRowDetailsEventArgs) Raises the LoadingRowDetails for row details preparation
OnLoadingRowGroup(DataGridRowGroupHeaderEventArgs) Raises the LoadingRowGroup event
OnLostFocus(RoutedEventArgs) Called before the LostFocus event occurs.
(Inherited from Control)
OnMeasureInvalidated Called by InvalidateMeasure
(Inherited from Layoutable)
OnPointerCaptureLost(PointerCaptureLostEventArgs) Called before the PointerCaptureLost event occurs.
(Inherited from InputElement)
OnPointerEntered(PointerEventArgs) Called before the PointerEntered event occurs.
(Inherited from InputElement)
OnPointerExited(PointerEventArgs) Called before the PointerExited event occurs.
(Inherited from InputElement)
OnPointerMoved(PointerEventArgs) Called before the PointerMoved event occurs.
(Inherited from InputElement)
OnPointerPressed(PointerPressedEventArgs) Called before the PointerPressed event occurs.
(Inherited from InputElement)
OnPointerReleased(PointerReleasedEventArgs) Called before the PointerReleased event occurs.
(Inherited from Control)
OnPointerWheelChanged(PointerWheelEventArgs) Scrolls the DataGrid according to the direction of the delta.
(Overrides InputElementOnPointerWheelChanged(PointerWheelEventArgs))
OnPreparingCellForEdit(DataGridPreparingCellForEditEventArgs) Raises the PreparingCellForEdit event.
OnPropertyChanged(AvaloniaPropertyChangedEventArgs)
(Inherited from Control)
OnPropertyChangedCore(AvaloniaPropertyChangedEventArgs)
(Inherited from Animatable)
OnRowDetailsVisibilityChanged(DataGridRowDetailsEventArgs) Raises the RowDetailsVisibilityChanged event.
OnRowEditEnded(DataGridRowEditEndedEventArgs) Raises the RowEditEnded event.
OnRowEditEnding(DataGridRowEditEndingEventArgs) Raises the RowEditEnding event.
OnSelectionChanged(SelectionChangedEventArgs) Raises the SelectionChanged event and clears the _selectionChanged. This event won't get raised again until after _selectionChanged is set back to true.
OnSizeChanged(SizeChangedEventArgs) Invoked just before the SizeChanged event.
(Inherited from Control)
OnTemplateChanged(AvaloniaPropertyChangedEventArgs) Called when the Template property changes.
(Inherited from TemplatedControl)
OnTextInput(TextInputEventArgs) Called before the TextInput event occurs.
(Inherited from InputElement)
OnUnloaded(RoutedEventArgs) Invoked just before the Unloaded event.
(Inherited from Control)
OnUnloadingRow(DataGridRowEventArgs) Raises the UnloadingRow event for row recycling.
OnUnloadingRowDetails(DataGridRowDetailsEventArgs) Raises the UnloadingRowDetails event
OnUnloadingRowGroup(DataGridRowGroupHeaderEventArgs) Raises the UnLoadingRowGroup event
OnVisualParentChanged(Visual, Visual) Called when the control's visual parent changes.
(Inherited from Layoutable)
RaiseEvent(RoutedEventArgs) Raises a routed event.
(Inherited from Interactive)
RaisePropertyChangedT(DirectPropertyBaseT, T, T) Raises the PropertyChanged event for a direct property.
(Inherited from AvaloniaObject)
RemoveHandler(RoutedEvent, Delegate) Removes a handler for the specified routed event.
(Inherited from Interactive)
RemoveHandlerTEventArgs(RoutedEventTEventArgs, EventHandlerTEventArgs) Removes a handler for the specified routed event.
(Inherited from Interactive)
Render(DrawingContext) Renders the visual to a DrawingContext.
(Inherited from Visual)
ScrollIntoView(Object, DataGridColumn) Scrolls the specified item or RowGroupHeader and/or column into view. If item is not null: scrolls the row representing the item into view; If column is not null: scrolls the column into view; If both item and column are null, the method returns without scrolling.
SelectAll 
SetAndRaiseT(DirectPropertyBaseT, T, T) Sets the backing field for a direct avalonia property, raising the PropertyChanged event if the value has changed.
(Inherited from AvaloniaObject)
SetCurrentValue(AvaloniaProperty, Object) Sets the value of a dependency property without changing its value source.
(Inherited from AvaloniaObject)
SetCurrentValueT(StyledPropertyT, T) Sets the value of a dependency property without changing its value source.
(Inherited from AvaloniaObject)
SetValue(AvaloniaProperty, Object, BindingPriority) Sets a AvaloniaProperty value.
(Inherited from AvaloniaObject)
SetValueT(DirectPropertyBaseT, T) Sets a AvaloniaProperty value.
(Inherited from AvaloniaObject)
SetValueT(StyledPropertyT, T, BindingPriority) Sets a AvaloniaProperty value.
(Inherited from AvaloniaObject)
ToStringReturns a string that represents the current object.
(Inherited from Object)
TryGetResource(Object, ThemeVariant, Object) Tries to find a resource within the object.
(Inherited from StyledElement)
UpdateDataValidation(AvaloniaProperty, BindingValueType, Exception) Called to update the validation state for properties for which data validation is enabled.
(Inherited from AvaloniaObject)
UpdateIsEffectivelyEnabled Updates the IsEffectivelyEnabled property value according to the parent control's enabled state and IsEnabledCore.
(Inherited from InputElement)
UpdateLayout Executes a layout pass.
(Inherited from Layoutable)
VerifyAccess Checks that the current thread is the UI thread and throws if not.
(Inherited from AvaloniaObject)

Events

ActualThemeVariantChanged Raised when the theme variant is changed on the element or an ancestor of the element.
(Inherited from StyledElement)
AttachedToLogicalTree Raised when the styled element is attached to a rooted logical tree.
(Inherited from StyledElement)
AttachedToVisualTree Raised when the control is attached to a rooted visual tree.
(Inherited from Visual)
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.
BeginningEdit Occurs before a cell or row enters editing mode.
CellEditEnded Occurs after cell editing has ended.
CellEditEnding Occurs immediately before cell editing has ended.
CellPointerPressed Occurs when cell is mouse-pressed.
ColumnDisplayIndexChanged Occurs when the DisplayIndex property of a column changes.
ColumnReordered Raised when column reordering ends, to allow subscribers to clean up.
ColumnReordering Raised when starting a column reordering action. Subscribers to this event can set tooltip and caret UIElements, constrain tooltip position, indicate that a preview should be shown, or cancel reordering.
ContextRequested Occurs when the user has completed a context input gesture, such as a right-click.
(Inherited from Control)
CopyingRowClipboardContent This event is raised by OnCopyingRowClipboardContent method after the default row content is prepared. Event listeners can modify or add to the row clipboard content.
CurrentCellChanged Occurs when a different cell becomes the current cell.
DataContextChanged Occurs when the DataContext property changes.
(Inherited from StyledElement)
DetachedFromLogicalTree Raised when the styled element is detached from a rooted logical tree.
(Inherited from StyledElement)
DetachedFromVisualTree Raised when the control is detached from a rooted visual tree.
(Inherited from Visual)
DoubleTapped Occurs when a double-tap gesture occurs on the control.
(Inherited from InputElement)
EffectiveViewportChanged Occurs when the element's effective viewport changes.
(Inherited from Layoutable)
GotFocus Occurs when the control receives focus.
(Inherited from InputElement)
Holding Occurs when a hold gesture occurs on the control.
(Inherited from InputElement)
HorizontalScroll 
Initialized Occurs when the styled element has finished initialization.
(Inherited from StyledElement)
KeyDown Occurs when a key is pressed while the control has focus.
(Inherited from InputElement)
KeyUp Occurs when a key is released while the control has focus.
(Inherited from InputElement)
LayoutUpdated Occurs when a layout pass completes for the control.
(Inherited from Layoutable)
Loaded Occurs when the control has been fully constructed in the visual tree and both layout and render are complete.
(Inherited from Control)
LoadingRow Occurs after a DataGridRow is instantiated, so that you can customize it before it is used.
LoadingRowDetails Occurs when a new row details template is applied to a row, so that you can customize the details section before it is used.
LoadingRowGroup Occurs before a DataGridRowGroupHeader header is used.
LostFocus Occurs when the control loses focus.
(Inherited from InputElement)
PointerCaptureLost Occurs when the control or its child control loses the pointer capture for any reason, event will not be triggered for a parent control if capture was transferred to another child of that parent control
(Inherited from InputElement)
PointerEntered Occurs when the pointer enters the control.
(Inherited from InputElement)
PointerExited Occurs when the pointer leaves the control.
(Inherited from InputElement)
PointerMoved Occurs when the pointer moves over the control.
(Inherited from InputElement)
PointerPressed Occurs when the pointer is pressed over the control.
(Inherited from InputElement)
PointerReleased Occurs when the pointer is released over the control.
(Inherited from InputElement)
PointerWheelChanged Occurs when the mouse is scrolled over the control.
(Inherited from InputElement)
PreparingCellForEdit Occurs when a cell in a DataGridTemplateColumn enters editing mode.
PropertyChanged Raised when a AvaloniaProperty value changes on this object.
(Inherited from AvaloniaObject)
ResourcesChanged Occurs when a resource in this styled element or a parent styled element has changed.
(Inherited from StyledElement)
RowDetailsVisibilityChanged Occurs when the RowDetailsVisibilityMode property value changes.
RowEditEnded Occurs when the row has been successfully committed or cancelled.
RowEditEnding Occurs immediately before the row has been successfully committed or cancelled.
SelectionChanged Occurs when the SelectedItem or SelectedItems property value changes.
SizeChanged Occurs when the bounds (actual size) of the control have changed.
(Inherited from Control)
Sorting Occurs when the DataGridColumn sorting request is triggered.
Tapped Occurs when a tap gesture occurs on the control.
(Inherited from InputElement)
TemplateApplied Raised when the control's template is applied.
(Inherited from TemplatedControl)
TextInput Occurs when a user typed some text while the control has focus.
(Inherited from InputElement)
TextInputMethodClientRequested Occurs when an input element gains input focus and input method is looking for the corresponding client
(Inherited from InputElement)
Unloaded Occurs when the control is removed from the visual tree.
(Inherited from Control)
UnloadingRow Occurs when a DataGridRow object becomes available for reuse.
UnloadingRowDetails Occurs when a row details element becomes available for reuse.
UnloadingRowGroup Occurs when the DataGridRowGroupHeader is available for reuse.
VerticalScroll 

Fields

AreRowDetailsFrozenProperty 
AreRowGroupHeadersFrozenProperty 
AutoGenerateColumnsProperty 
CanUserReorderColumnsProperty Identifies the CanUserReorderColumns dependency property.
CanUserResizeColumnsProperty Identifies the CanUserResizeColumns dependency property.
CanUserSortColumnsProperty Identifies the CanUserSortColumns dependency property.
CellThemeProperty Identifies the CellTheme dependency property.
ClipboardCopyModeProperty 
CollectionViewProperty 
ColumnHeaderHeightProperty Identifies the ColumnHeaderHeight dependency property.
ColumnHeaderThemeProperty Identifies the ColumnHeaderTheme dependency property.
ColumnWidthProperty Identifies the ColumnWidth dependency property.
DropLocationIndicatorTemplateProperty 
FrozenColumnCountProperty 
GridLinesVisibilityProperty 
HeadersVisibilityProperty 
HorizontalGridLinesBrushProperty 
HorizontalScrollBarVisibilityProperty 
IsReadOnlyProperty 
IsScrollInertiaEnabledProperty Defines the IsScrollInertiaEnabled property.
IsValidProperty 
ItemsSourceProperty Identifies the ItemsSource property.
MaxColumnWidthProperty 
MinColumnWidthProperty 
RowBackgroundProperty 
RowDetailsTemplateProperty 
RowDetailsVisibilityModeProperty 
RowGroupThemeProperty Identifies the RowGroupTheme dependency property.
RowHeaderWidthProperty 
RowHeightProperty 
RowThemeProperty Identifies the RowTheme dependency property.
SelectedIndexProperty 
SelectedItemProperty 
SelectionChangedEvent 
SelectionModeProperty 
VerticalGridLinesBrushProperty 
VerticalScrollBarVisibilityProperty 

Extension Methods

AddDisposableHandlerTEventArgs(RoutedEventTEventArgs, EventHandlerTEventArgs, RoutingStrategies, Boolean) Adds a handler for the specified routed event and returns a disposable that can terminate the event subscription.
(Defined by InteractiveExtensions)
Bind(AvaloniaProperty, IBinding, Object) Binds a property on an AvaloniaObject to an IBinding.
(Defined by AvaloniaObjectExtensions)
BindT(AvaloniaPropertyT, IObservableBindingValueT, BindingPriority) Binds an AvaloniaProperty to an observable.
(Defined by AvaloniaObjectExtensions)
BindT(AvaloniaPropertyT, IObservableT, BindingPriority) Binds an AvaloniaProperty to an observable.
(Defined by AvaloniaObjectExtensions)
BindClass(String, IBinding, Object)
(Defined by StyledElementExtensions)
BringIntoView Tries to bring the control into view.
(Defined by ControlExtensions)
BringIntoView(Rect) Tries to bring the control into view.
(Defined by ControlExtensions)
CalculateDistanceFromAncestor(Visual) Calculates the distance from a visual's ancestor.
(Defined by VisualExtensions)
FindAncestorOfTypeT(Boolean) Finds first ancestor of given type.
(Defined by VisualExtensions)
FindCommonVisualAncestor(Visual) Tries to get the first common ancestor of two visuals.
(Defined by VisualExtensions)
FindControlT(String) Finds the named control in the scope of the specified control.
(Defined by ControlExtensions)
FindDataTemplate(Object, IDataTemplate) Find a data template that matches a piece of data.
(Defined by DataTemplateExtensions)
FindDescendantOfTypeT(Boolean) Finds first descendant of given type.
(Defined by VisualExtensions)
GetBaseValue(AvaloniaProperty) Gets an AvaloniaProperty base value.
(Defined by AvaloniaObjectExtensions)
GetBaseValueT(AvaloniaPropertyT) Gets an AvaloniaProperty base value.
(Defined by AvaloniaObjectExtensions)
GetBindingObservable(AvaloniaProperty) Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetBindingObservableT(AvaloniaPropertyT) Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetBindingObservableTResult(AvaloniaProperty, FuncObject, TResult) Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetBindingObservableTSource, TResult(AvaloniaPropertyTSource, FuncTSource, TResult) Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetBindingSubject(AvaloniaProperty, BindingPriority) Gets a subject for a AvaloniaProperty.
(Defined by AvaloniaObjectReactiveExtensions)
GetBindingSubjectT(AvaloniaPropertyT, BindingPriority) Gets a subject for a AvaloniaProperty.
(Defined by AvaloniaObjectReactiveExtensions)
GetControlT(String) Finds the named control in the scope of the specified control and throws if not found.
(Defined by ControlExtensions)
GetDiagnostic(AvaloniaProperty) Gets a diagnostic for a AvaloniaProperty on a AvaloniaObject.
(Defined by AvaloniaObjectExtensions)
GetInteractiveParent
(Defined by InteractiveExtensions)
GetObservable(AvaloniaProperty) Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetObservableT(AvaloniaPropertyT) Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetObservableTResult(AvaloniaProperty, FuncObject, TResult) Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetObservableTEventArgs(RoutedEventTEventArgs, RoutingStrategies, Boolean) Gets an observable for a RoutedEventTEventArgs.
(Defined by InteractiveExtensions)
GetObservableTSource, TResult(AvaloniaPropertyTSource, FuncTSource, TResult) Gets an observable for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetPropertyChangedObservable(AvaloniaProperty) Gets an observable that listens for property changed events for an AvaloniaProperty.
(Defined by AvaloniaObjectExtensions)
GetSelfAndVisualAncestors Enumerates an Visual and its ancestors in the visual tree.
(Defined by VisualExtensions)
GetSelfAndVisualDescendants Enumerates an Visual and its descendants in the visual tree.
(Defined by VisualExtensions)
GetStyleDiagnostics
(Defined by StyledElementExtensions)
GetSubject(AvaloniaProperty, BindingPriority) Gets a subject for an AvaloniaProperty.
(Defined by AvaloniaObjectReactiveExtensions)
GetSubjectT(AvaloniaPropertyT, BindingPriority) Gets a subject for an AvaloniaProperty.
(Defined by AvaloniaObjectReactiveExtensions)
GetTemplateChildren
(Defined by TemplateExtensions)
GetTransformedBounds
(Defined by VisualExtensions)
GetValueT(AvaloniaPropertyT) Gets a AvaloniaProperty value.
(Defined by AvaloniaObjectExtensions)
GetValueStoreDiagnostic Gets a value store diagnostics for a AvaloniaObject.
(Defined by AvaloniaObjectExtensions)
GetVisualAncestors Enumerates the ancestors of an Visual in the visual tree.
(Defined by VisualExtensions)
GetVisualAt(Point) Gets the first visual in the visual tree whose bounds contain a point.
(Defined by VisualExtensions)
GetVisualAt(Point, FuncVisual, Boolean) Gets the first visual in the visual tree whose bounds contain a point.
(Defined by VisualExtensions)
GetVisualChildren Enumerates the children of an Visual in the visual tree.
(Defined by VisualExtensions)
GetVisualDescendants Enumerates the descendants of an Visual in the visual tree.
(Defined by VisualExtensions)
GetVisualParent Gets the visual parent of an Visual.
(Defined by VisualExtensions)
GetVisualParentT Gets the visual parent of an Visual.
(Defined by VisualExtensions)
GetVisualRoot Gets the root visual for an Visual.
(Defined by VisualExtensions)
GetVisualsAt(Point) Enumerates the visible visuals in the visual tree whose bounds contain a point.
(Defined by VisualExtensions)
GetVisualsAt(Point, FuncVisual, Boolean) Enumerates the visuals in the visual tree whose bounds contain a point.
(Defined by VisualExtensions)
IsAttachedToVisualTree Returns a value indicating whether this control is attached to a visual root.
(Defined by VisualExtensions)
IsVisualAncestorOf(Visual) Tests whether an Visual is an ancestor of another visual.
(Defined by VisualExtensions)
PointToClient(PixelPoint) Converts a point from screen to client coordinates.
(Defined by VisualExtensions)
PointToScreen(Point) Converts a point from client to screen coordinates.
(Defined by VisualExtensions)
TransformToVisual(Visual) Returns a transform that transforms the visual's coordinates into the coordinates of the specified to.
(Defined by VisualExtensions)
TranslatePoint(Point, Visual) Translates a point relative to this visual to coordinates that are relative to the specified visual.
(Defined by VisualExtensions)

See Also