Summary
Displays data in a customizable grid.
- Namespace
- Avalonia
.Controls - Interfaces
-
- IAvaloniaObjectDebug
- I
Notify Property Changed - IValueSink
- ISetLogicalParent
- I
Set Inheritance Parent - IControl
- IDataTemplateHost
- ILayoutable
- IInputElement
- IInteractive
- IVisual
- IStyledElement
- IStyleable
- IStyleHost
- ILogical
- IResourceHost
- IResourceNode
- IDataContextProvider
- ISupportInitialize
- INamed
- I
Visual Brush Initialize - ISetterValue
- ITemplatedControl
- IAvaloniaObject
- Base Types
graph BT
Type-->Base0["TemplatedControl"]
click Base0 "/api/Avalonia.Controls.Primitives/TemplatedControl"
Base0-->Base1["Control"]
click Base1 "/api/Avalonia.Controls/Control"
Base1-->Base2["InputElement"]
click Base2 "/api/Avalonia.Input/InputElement"
Base2-->Base3["Interactive"]
click Base3 "/api/Avalonia.Interactivity/Interactive"
Base3-->Base4["Layoutable"]
click Base4 "/api/Avalonia.Layout/Layoutable"
Base4-->Base5["Visual"]
click Base5 "/api/Avalonia/Visual"
Base5-->Base6["StyledElement"]
click Base6 "/api/Avalonia/StyledElement"
Base6-->Base7["Animatable"]
click Base7 "/api/Avalonia.Animation/Animatable"
Base7-->Base8["AvaloniaObject"]
click Base8 "/api/Avalonia/AvaloniaObject"
Base8-->Base9["object"]
Type-.->Interface0["IAvaloniaObjectDebug"]
click Interface0 "/api/Avalonia.Diagnostics/IAvaloniaObjectDebug"
Type-.->Interface1["INotifyPropertyChanged"]
Type-.->Interface2["IValueSink"]
Type-.->Interface3["ISetLogicalParent"]
click Interface3 "/api/Avalonia.Controls/ISetLogicalParent"
Type-.->Interface4["ISetInheritanceParent"]
click Interface4 "/api/Avalonia.Controls/ISetInheritanceParent"
Type-.->Interface5["IControl"]
click Interface5 "/api/Avalonia.Controls/IControl"
Type-.->Interface6["IDataTemplateHost"]
click Interface6 "/api/Avalonia.Controls.Templates/IDataTemplateHost"
Type-.->Interface7["ILayoutable"]
click Interface7 "/api/Avalonia.Layout/ILayoutable"
Type-.->Interface8["IInputElement"]
click Interface8 "/api/Avalonia.Input/IInputElement"
Type-.->Interface9["IInteractive"]
click Interface9 "/api/Avalonia.Interactivity/IInteractive"
Type-.->Interface10["IVisual"]
click Interface10 "/api/Avalonia.VisualTree/IVisual"
Type-.->Interface11["IStyledElement"]
click Interface11 "/api/Avalonia/IStyledElement"
Type-.->Interface12["IStyleable"]
click Interface12 "/api/Avalonia.Styling/IStyleable"
Type-.->Interface13["IStyleHost"]
click Interface13 "/api/Avalonia.Styling/IStyleHost"
Type-.->Interface14["ILogical"]
click Interface14 "/api/Avalonia.LogicalTree/ILogical"
Type-.->Interface15["IResourceHost"]
click Interface15 "/api/Avalonia.Controls/IResourceHost"
Type-.->Interface16["IResourceNode"]
click Interface16 "/api/Avalonia.Controls/IResourceNode"
Type-.->Interface17["IDataContextProvider"]
click Interface17 "/api/Avalonia/IDataContextProvider"
Type-.->Interface18["ISupportInitialize"]
Type-.->Interface19["INamed"]
click Interface19 "/api/Avalonia/INamed"
Type-.->Interface20["IVisualBrushInitialize"]
click Interface20 "/api/Avalonia.Rendering/IVisualBrushInitialize"
Type-.->Interface21["ISetterValue"]
click Interface21 "/api/Avalonia.Styling/ISetterValue"
Type-.->Interface22["ITemplatedControl"]
click Interface22 "/api/Avalonia.Styling/ITemplatedControl"
Type-.->Interface23["IAvaloniaObject"]
click Interface23 "/api/Avalonia/IAvaloniaObject"
Type["DataGrid"]
class Type type-node
Syntax
[PseudoClasses(":invalid", ":empty-rows", ":empty-columns")]
public class DataGrid : TemplatedControl, IAvaloniaObjectDebug, INotifyPropertyChanged, IValueSink,
ISetLogicalParent, ISetInheritanceParent, IControl, IDataTemplateHost, ILayoutable,
IInputElement, IInteractive, IVisual, IStyledElement, IStyleable, IStyleHost, ILogical,
IResourceHost, IResourceNode, IDataContextProvider, ISupportInitialize, INamed,
IVisualBrushInitialize, ISetterValue, ITemplatedControl, IAvaloniaObjectAttributes
| Type | Description |
|---|---|
| Pseudo |
Constructors
| Name | Summary |
|---|---|
| DataGrid |
Initializes a new instance of the DataGrid class.
|
Events
| Name | Type | Summary |
|---|---|---|
| Attached |
EventHandler |
Raised when the styled element is attached to a rooted logical tree.
Inherited from StyledElement
|
| AttachedToVisualTree | EventHandler |
Raised when the control is attached to a rooted visual tree.
Inherited from Visual
|
| AutoGeneratingColumn | EventHandler |
Occurs one time for each public, non-static property in the bound data type when the
Avalonia.Controls.DataGrid.ItemsSource property is changed and the
AutoGenerateColumns property is true.
|
| BeginningEdit | EventHandler |
Occurs before a cell or row enters editing mode.
|
| CellEditEnded | EventHandler |
Occurs after cell editing has ended.
|
| CellEditEnding | EventHandler |
Occurs immediately before cell editing has ended.
|
| CellPointerPressed | EventHandler |
Occurs when cell is mouse-pressed.
|
| Column |
EventHandler |
Occurs when the
DisplayIndex
property of a column changes.
|
| ColumnReordered | EventHandler |
Raised when column reordering ends, to allow subscribers to clean up.
|
| ColumnReordering | EventHandler |
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.
|
| Copying |
EventHandler |
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 | EventHandler |
Occurs when a different cell becomes the current cell.
|
| DataContextChanged | EventHandler? |
Occurs when the
DataContext property changes.
Inherited from StyledElement
|
| Detached |
EventHandler |
Raised when the styled element is detached from a rooted logical tree.
Inherited from StyledElement
|
| Detached |
EventHandler |
Raised when the control is detached from a rooted visual tree.
Inherited from Visual
|
| DoubleTapped | EventHandler |
Occurs when a double-tap gesture occurs on the control.
Inherited from InputElement
|
| Effective |
EventHandler |
Occurs when the element's effective viewport changes.
Inherited from Layoutable
|
| GotFocus | EventHandler |
Occurs when the control receives focus.
Inherited from InputElement
|
| HorizontalScroll | EventHandler |
|
| Initialized | EventHandler? |
Occurs when the styled element has finished initialization.
Inherited from StyledElement
|
| KeyDown | EventHandler |
Occurs when a key is pressed while the control has focus.
Inherited from InputElement
|
| KeyUp | EventHandler |
Occurs when a key is released while the control has focus.
Inherited from InputElement
|
| LayoutUpdated | EventHandler? |
Occurs when a layout pass completes for the control.
Inherited from Layoutable
|
| LoadingRow | EventHandler |
Occurs after a
DataGridRow
is instantiated, so that you can customize it before it is used.
|
| LoadingRowDetails | EventHandler |
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 | EventHandler |
Occurs before a DataGridRowGroupHeader header is used.
|
| LostFocus | EventHandler |
Occurs when the control loses focus.
Inherited from InputElement
|
| PointerCaptureLost | EventHandler |
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
|
| PointerEnter | EventHandler |
Occurs when the pointer enters the control.
Inherited from InputElement
|
| PointerLeave | EventHandler |
Occurs when the pointer leaves the control.
Inherited from InputElement
|
| PointerMoved | EventHandler |
Occurs when the pointer moves over the control.
Inherited from InputElement
|
| PointerPressed | EventHandler |
Occurs when the pointer is pressed over the control.
Inherited from InputElement
|
| PointerReleased | EventHandler |
Occurs when the pointer is released over the control.
Inherited from InputElement
|
| PointerWheelChanged | EventHandler |
Occurs when the mouse wheen is scrolled over the control.
Inherited from InputElement
|
| PreparingCellForEdit | EventHandler |
Occurs when a cell in a
DataGridTemplateColumn enters editing mode.
|
| PropertyChanged | EventHandler |
Raised when a
AvaloniaProperty value changes on this object.
Inherited from AvaloniaObject
|
| ResourcesChanged | EventHandler |
Occurs when a resource in this styled element or a parent styled element has changed.
Inherited from StyledElement
|
| Row |
EventHandler |
Occurs when the
RowDetailsVisibilityMode
property value changes.
|
| RowEditEnded | EventHandler |
Occurs when the row has been successfully committed or cancelled.
|
| RowEditEnding | EventHandler |
Occurs immediately before the row has been successfully committed or cancelled.
|
| SelectionChanged | EventHandler |
Occurs when the
SelectedItem or
SelectedItems property value changes.
|
| Sorting | EventHandler |
Occurs when the
DataGridColumn sorting request is triggered.
|
| Tapped | EventHandler |
Occurs when a tap gesture occurs on the control.
Inherited from InputElement
|
| TemplateApplied | EventHandler |
Raised when the control's template is applied.
Inherited from TemplatedControl
|
| TextInput | EventHandler |
Occurs when a user typed some text while the control has focus.
Inherited from InputElement
|
| Text |
EventHandler |
Occurs when an input element gains input focus and input method is looking for the corresponding client
Inherited from InputElement
|
| Text |
EventHandler |
Occurs when an input element gains input focus and input method is asking for required content options
Inherited from InputElement
|
| UnloadingRow | EventHandler |
Occurs when a
DataGridRow
object becomes available for reuse.
|
| UnloadingRowDetails | EventHandler |
Occurs when a row details element becomes available for reuse.
|
| UnloadingRowGroup | EventHandler |
Occurs when the DataGridRowGroupHeader is available for reuse.
|
| VerticalScroll | EventHandler |
Fields
| Name | Constant Value | Summary |
|---|---|---|
| Alternating |
static
|
|
| Are |
static
|
|
| Are |
static
|
|
| Auto |
static
|
|
| BackgroundProperty |
Defines the
Background property.
Inherited from TemplatedControl
static
|
|
| BorderBrushProperty |
Defines the
BorderBrush property.
Inherited from TemplatedControl
static
|
|
| Border |
Defines the
BorderThickness property.
Inherited from TemplatedControl
static
|
|
| BoundsProperty |
Defines the
Bounds property.
Inherited from Visual
static
|
|
| Can |
Identifies the CanUserReorderColumns dependency property.
static
|
|
| Can |
Identifies the CanUserResizeColumns dependency property.
static
|
|
| Can |
Identifies the CanUserSortColumns dependency property.
static
|
|
| Clipboard |
static
|
|
| ClipProperty |
Defines the
Clip property.
Inherited from Visual
static
|
|
| ClipToBoundsProperty |
Defines the
ClipToBounds property.
Inherited from Visual
static
|
|
| ClockProperty |
Defines the
Clock property.
Inherited from Animatable
static
|
|
| Column |
Identifies the ColumnHeaderHeight dependency property.
static
|
|
| ColumnWidthProperty |
Identifies the ColumnWidth dependency property.
static
|
|
| Context |
Defines the
ContextFlyout property
Inherited from Control
static
|
|
| ContextMenuProperty |
Defines the
ContextMenu property.
Inherited from Control
static
|
|
| CursorProperty |
Gets or sets associated mouse cursor.
Inherited from InputElement
static
|
|
| DataContextProperty |
Defines the
DataContext property.
Inherited from StyledElement
static
|
|
| DesiredSizeProperty |
Defines the
DesiredSize property.
Inherited from Layoutable
static
|
|
| DoubleTappedEvent |
Defines the
DoubleTapped event.
Inherited from InputElement
static
|
|
| Drop |
static
|
|
| FocusableProperty |
Defines the
Focusable property.
Inherited from InputElement
static
|
|
| FocusAdornerProperty |
Defines the
FocusAdorner property.
Inherited from Control
static
|
|
| FontFamilyProperty |
Defines the
FontFamily property.
Inherited from TemplatedControl
static
|
|
| FontSizeProperty |
Defines the
FontSize property.
Inherited from TemplatedControl
static
|
|
| FontStyleProperty |
Defines the
FontStyle property.
Inherited from TemplatedControl
static
|
|
| FontWeightProperty |
Defines the
FontWeight property.
Inherited from TemplatedControl
static
|
|
| ForegroundProperty |
Defines the
Foreground property.
Inherited from TemplatedControl
static
|
|
| Frozen |
static
|
|
| GotFocusEvent |
Defines the
GotFocus event.
Inherited from InputElement
static
|
|
| Grid |
static
|
|
| Headers |
static
|
|
| HeightProperty |
Defines the
Height property.
Inherited from Layoutable
static
|
|
| Horizontal |
Defines the
HorizontalAlignment property.
Inherited from Layoutable
static
|
|
| Horizontal |
static
|
|
| Horizontal |
static
|
|
| Is |
Defines the
IsEffectivelyEnabled property.
Inherited from InputElement
static
|
|
| IsEnabledProperty |
Defines the
IsEnabled property.
Inherited from InputElement
static
|
|
| IsFocusedProperty |
Defines the
IsFocused property.
Inherited from InputElement
static
|
|
| Is |
Defines the
IsHitTestVisible property.
Inherited from InputElement
static
|
|
| Is |
Defines the
IsKeyboardFocusWithin property.
Inherited from InputElement
static
|
|
| Is |
Defines the
IsPointerOver property.
Inherited from InputElement
static
|
|
| IsReadOnlyProperty |
static
|
|
| Is |
Defines the IsTemplateFocusTarget attached property.
Inherited from TemplatedControl
static
|
|
| IsValidProperty |
static
|
|
| IsVisibleProperty |
Defines the
IsVisibleProperty property.
Inherited from Visual
static
|
|
| ItemsProperty |
Identifies the ItemsSource dependency property.
static
|
|
| KeyDownEvent |
Defines the
KeyDown event.
Inherited from InputElement
static
|
|
| KeyUpEvent |
Defines the
KeyUp event.
Inherited from InputElement
static
|
|
| LostFocusEvent |
Defines the
LostFocus event.
Inherited from InputElement
static
|
|
| MarginProperty |
Defines the
Margin property.
Inherited from Layoutable
static
|
|
| Max |
static
|
|
| MaxHeightProperty |
Defines the
MaxHeight property.
Inherited from Layoutable
static
|
|
| MaxWidthProperty |
Defines the
MaxWidth property.
Inherited from Layoutable
static
|
|
| Min |
static
|
|
| MinHeightProperty |
Defines the
MinHeight property.
Inherited from Layoutable
static
|
|
| MinWidthProperty |
Defines the
MinWidth property.
Inherited from Layoutable
static
|
|
| NameProperty |
Defines the
Name property.
Inherited from StyledElement
static
|
|
| OpacityMaskProperty |
Defines the
OpacityMask property.
Inherited from Visual
static
|
|
| OpacityProperty |
Defines the
Opacity property.
Inherited from Visual
static
|
|
| PaddingProperty |
Defines the
Padding property.
Inherited from TemplatedControl
static
|
|
| ParentProperty |
Defines the
Parent property.
Inherited from StyledElement
static
|
|
| Pointer |
Defines the
PointerCaptureLost routed event.
Inherited from InputElement
static
|
|
| PointerEnterEvent |
Defines the
PointerEnter event.
Inherited from InputElement
static
|
|
| PointerLeaveEvent |
Defines the
PointerLeave event.
Inherited from InputElement
static
|
|
| PointerMovedEvent |
Defines the
PointerMoved event.
Inherited from InputElement
static
|
|
| PointerPressedEvent |
Defines the
PointerPressed event.
Inherited from InputElement
static
|
|
| PointerReleasedEvent |
Defines the
PointerReleased event.
Inherited from InputElement
static
|
|
| Pointer |
Defines the
PointerWheelChanged event.
Inherited from InputElement
static
|
|
| Render |
Defines the
RenderTransformOrigin property.
Inherited from Visual
static
|
|
| Render |
Defines the
RenderTransform property.
Inherited from Visual
static
|
|
| Request |
Event raised when an element wishes to be scrolled into view.
Inherited from Control
static
|
|
| Row |
static
|
|
| Row |
static
|
|
| Row |
static
|
|
| Row |
static
|
|
| RowHeightProperty |
static
|
|
| Selected |
static
|
|
| SelectedItemProperty |
static
|
|
| Selection |
static
|
|
| Selection |
static
|
|
| TagProperty |
Defines the
Tag property.
Inherited from Control
static
|
|
| TappedEvent |
Defines the
Tapped event.
Inherited from InputElement
static
|
|
| TemplateAppliedEvent |
Defines the
TemplateApplied routed event.
Inherited from TemplatedControl
static
|
|
| Templated |
Defines the
TemplatedParent property.
Inherited from StyledElement
static
|
|
| TemplateProperty |
Defines the
Template property.
Inherited from TemplatedControl
static
|
|
| TextInputEvent |
Defines the
TextInput event.
Inherited from InputElement
static
|
|
| Text |
Defines the
TextInputMethodClientRequested event.
Inherited from InputElement
static
|
|
| Text |
Defines the
TextInputOptionsQuery event.
Inherited from InputElement
static
|
|
| Transformed |
Inherited from Visual
static
|
|
| TransitionsProperty |
Defines the
Transitions property.
Inherited from Animatable
static
|
|
| Use |
Defines the
UseLayoutRoundingProperty property.
Inherited from Layoutable
static
|
|
| Vertical |
Defines the
VerticalAlignment property.
Inherited from Layoutable
static
|
|
| Vertical |
static
|
|
| Vertical |
static
|
|
| VisualParentProperty |
Defines the
VisualParent property.
Inherited from Visual
static
|
|
| WidthProperty |
Defines the
Width property.
Inherited from Layoutable
static
|
|
| ZIndexProperty |
Defines the
ZIndex property.
Inherited from Visual
static
|
Properties
| Name | Value | Summary |
|---|---|---|
| Alternating |
IBrush |
Gets or sets the
System.Windows.Media.Brush that is used to paint the background of odd-numbered rows.
|
| AreRowDetailsFrozen | bool |
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.
|
| Are |
bool |
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 | bool |
Gets or sets a value that indicates whether columns are created
automatically when the
Avalonia.Controls.DataGrid.ItemsSource property is set.
|
| Background | IBrush |
Gets or sets the brush used to draw the control's background.
Inherited from TemplatedControl
|
| BorderBrush | IBrush |
Gets or sets the brush used to draw the control's border.
Inherited from TemplatedControl
|
| BorderThickness | Thickness |
Gets or sets the thickness of the control's border.
Inherited from TemplatedControl
|
| Bounds | Rect |
Gets the bounds of the control relative to its parent.
Inherited from Visual
|
| Can |
bool |
Gets or sets a value that indicates whether the user can change
the column display order by dragging column headers with the mouse.
|
| CanUserResizeColumns | bool |
Gets or sets a value that indicates whether the user can adjust column widths using the mouse.
|
| CanUserSortColumns | bool |
Gets or sets a value that indicates whether the user can sort columns by clicking the column header.
|
| Classes | Classes |
Gets or sets the styled element's classes.
Inherited from StyledElement
|
| Clip | Geometry |
Gets or sets the geometry clip for this visual.
Inherited from Visual
|
| ClipboardCopyMode | Data |
The property which determines how DataGrid content is copied to the Clipboard.
|
| ClipToBounds | bool |
Gets or sets a value indicating whether the control should be clipped to its bounds.
Inherited from Visual
|
| Clock | IClock |
Gets or sets the clock which controls the animations on the control.
Inherited from Animatable
|
| ColumnHeaderHeight | double |
Gets or sets the height of the column headers row.
|
| Columns | ObservableCollection |
Gets a collection that contains all the columns in the control.
|
| ColumnWidth | DataGridLength |
Gets or sets the standard width or automatic sizing mode of columns in the control.
|
| ContextFlyout | FlyoutBase? |
Gets or sets a context flyout to the control
Inherited from Control
|
| ContextMenu | ContextMenu? |
Gets or sets a context menu to the control.
Inherited from Control
|
| CurrentColumn | DataGridColumn |
Gets or sets the column that contains the current cell.
|
| CurrentItem | object |
Gets the data item bound to the row that contains the current cell.
|
| Cursor | Cursor? |
Gets or sets associated mouse cursor.
Inherited from InputElement
|
| DataContext | object? |
Gets or sets the control's data context.
Inherited from StyledElement
|
| DataTemplates | DataTemplates |
Gets or sets the data templates for the control.
Inherited from Control
|
| DesiredSize | Size |
Gets the size that this element computed during the measure pass of the layout process.
Inherited from Layoutable
|
| Drop |
ITemplate |
Gets or sets the template that is used when rendering the column headers.
|
| Focusable | bool |
Gets or sets a value indicating whether the control can receive focus.
Inherited from InputElement
|
| FocusAdorner | ITemplate |
Gets or sets the control's focus adorner.
Inherited from Control
|
| FontFamily | FontFamily |
Gets or sets the font family used to draw the control's text.
Inherited from TemplatedControl
|
| FontSize | double |
Gets or sets the size of the control's text in points.
Inherited from TemplatedControl
|
| FontStyle | FontStyle |
Gets or sets the font style used to draw the control's text.
Inherited from TemplatedControl
|
| FontWeight | FontWeight |
Gets or sets the font weight used to draw the control's text.
Inherited from TemplatedControl
|
| Foreground | IBrush |
Gets or sets the brush used to draw the control's text and other foreground elements.
Inherited from TemplatedControl
|
| FrozenColumnCount | int |
Gets or sets the number of columns that the user cannot scroll horizontally.
|
| GestureRecognizers | Gesture |
Inherited from InputElement
|
| GridLinesVisibility | Data |
Gets or sets a value that indicates which grid lines separating inner cells are shown.
|
| HeadersVisibility | Data |
Gets or sets a value that indicates the visibility of row and column headers.
|
| Height | double |
Gets or sets the height of the element.
Inherited from Layoutable
|
| HorizontalAlignment | HorizontalAlignment |
Gets or sets the element's preferred horizontal alignment in its parent.
Inherited from Layoutable
|
| Horizontal |
IBrush |
Gets or sets the
System.Windows.Media.Brush that is used to paint grid lines separating rows.
|
| Horizontal |
ScrollBarVisibility |
Gets or sets a value that indicates how the horizontal scroll bar is displayed.
|
| InheritanceParent | IAvaloniaObject |
Gets or sets the parent object that inherited
AvaloniaProperty values
are inherited from.
Inherited from AvaloniaObject
|
| IsArrangeValid | bool |
Gets a value indicating whether the control's layouts arrange is valid.
Inherited from Layoutable
|
| IsEffectivelyEnabled | bool |
Gets a value indicating whether this control and all its parents are enabled.
Inherited from InputElement
|
| IsEffectivelyVisible | bool |
Gets a value indicating whether this control and all its parents are visible.
Inherited from Visual
|
| IsEnabled | bool |
Gets or sets a value indicating whether the control is enabled for user interaction.
Inherited from InputElement
|
| IsEnabledCore | bool |
Allows a derived class to override the enabled state of the control.
Inherited from InputElement
|
| IsFocused | bool |
Gets a value indicating whether the control is focused.
Inherited from InputElement
|
| IsHitTestVisible | bool |
Gets or sets a value indicating whether the control is considered for hit testing.
Inherited from InputElement
|
| IsInitialized | bool |
Gets a value that indicates whether the element has finished initialization.
Inherited from StyledElement
|
| Is |
bool |
Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements.
Inherited from InputElement
|
| IsMeasureValid | bool |
Gets a value indicating whether the control's layout measure is valid.
Inherited from Layoutable
|
| IsPointerOver | bool |
Gets a value indicating whether the pointer is currently over the control.
Inherited from InputElement
|
| IsReadOnly | bool |
Gets or sets a value that indicates whether the user can edit the values in the control.
|
| IsValid | bool | |
| IsVisible | bool |
Gets or sets a value indicating whether this control is visible.
Inherited from Visual
|
| Items | IEnumerable |
Gets or sets a collection that is used to generate the content of the control.
|
| KeyBindings | List |
Inherited from InputElement
|
| LogicalChildren | IAvaloniaList |
Gets the styled element's logical children.
Inherited from StyledElement
|
| Margin | Thickness |
Gets or sets the margin around the element.
Inherited from Layoutable
|
| MaxColumnWidth | double |
Gets or sets the maximum width of columns in the
DataGrid .
|
| MaxHeight | double |
Gets or sets the maximum height of the element.
Inherited from Layoutable
|
| MaxWidth | double |
Gets or sets the maximum width of the element.
Inherited from Layoutable
|
| MinColumnWidth | double |
Gets or sets the minimum width of columns in the
DataGrid.
|
| MinHeight | double |
Gets or sets the minimum height of the element.
Inherited from Layoutable
|
| MinWidth | double |
Gets or sets the minimum width of the element.
Inherited from Layoutable
|
| Name | string? |
Gets or sets the name of the styled element.
Inherited from StyledElement
|
| Opacity | double |
Gets or sets the opacity of the control.
Inherited from Visual
|
| OpacityMask | IBrush |
Gets or sets the opacity mask of the control.
Inherited from Visual
|
| Padding | Thickness |
Gets or sets the padding placed between the border of the control and its content.
Inherited from TemplatedControl
|
| Parent | IControl? |
Inherited from Control
|
| Parent | IStyledElement? |
Gets the styled element's logical parent.
Inherited from StyledElement
|
| PseudoClasses | IPseudoClasses |
Gets the
Classes collection in a form that allows adding and removing
pseudoclasses.
Inherited from StyledElement
|
| RenderTransform | ITransform |
Gets or sets the render transform of the control.
Inherited from Visual
|
| Render |
RelativePoint |
Gets or sets the transform origin of the control.
Inherited from Visual
|
| Resources | IResourceDictionary |
Gets or sets the styled element's resource dictionary.
Inherited from StyledElement
|
| RowBackground | IBrush |
Gets or sets the
System.Windows.Media.Brush that is used to paint row backgrounds.
|
| RowDetailsTemplate | IDataTemplate |
Gets or sets the template that is used to display the content of the details section of rows.
|
| Row |
Data |
Gets or sets a value that indicates when the details sections of rows are displayed.
|
| RowHeaderWidth | double |
Gets or sets the width of the row header column.
|
| RowHeight | double |
Gets or sets the standard height of rows in the control.
|
| SelectedIndex | int |
Gets or sets the index of the current selection.
|
| SelectedItem | object |
Gets or sets the data item corresponding to the selected row.
|
| SelectedItems | IList |
Gets a list that contains the data items corresponding to the selected rows.
|
| SelectionMode | Data |
Gets or sets the selection behavior of the data grid.
|
| Styles | Styles |
Gets the styles for the styled element.
Inherited from StyledElement
|
| Tag | object? |
Gets or sets a user-defined object attached to the control.
Inherited from Control
|
| Template | IControlTemplate |
Gets or sets the template that defines the control's appearance.
Inherited from TemplatedControl
|
| TemplatedParent | ITemplatedControl? |
Gets the styled element whose lookless template this styled element is part of.
Inherited from StyledElement
|
| this[ |
object |
Gets or sets the value of a
AvaloniaProperty.
Inherited from AvaloniaObject
|
| this[ |
IBinding |
Gets or sets a binding for a
AvaloniaProperty.
Inherited from AvaloniaObject
|
| TransformedBounds | TransformedBounds? |
Gets the bounds of the control relative to the window, accounting for rendering transforms.
Inherited from Visual
|
| Transitions | Transitions? |
Gets or sets the property transitions for the control.
Inherited from Animatable
|
| UseLayoutRounding | bool |
Gets or sets a value that determines whether the element should be snapped to pixel
boundaries at layout time.
Inherited from Layoutable
|
| VerticalAlignment | VerticalAlignment |
Gets or sets the element's preferred vertical alignment in its parent.
Inherited from Layoutable
|
| Vertical |
IBrush |
Gets or sets the
System.Windows.Media.Brush that is used to paint grid lines separating columns.
|
| Vertical |
ScrollBarVisibility |
Gets or sets a value that indicates how the vertical scroll bar is displayed.
|
| VisualChildren | IAvaloniaList |
Gets the control's child visuals.
Inherited from Visual
|
| VisualRoot | IRenderRoot |
Gets the root of the visual tree, if the control is attached to a visual tree.
Inherited from Visual
|
| Width | double |
Gets or sets the width of the element.
Inherited from Layoutable
|
| ZIndex | int |
Gets or sets the Z index of the control.
Inherited from Visual
|
Methods
| Name | Value | Summary |
|---|---|---|
| AddHandler |
void |
Adds a handler for the specified routed event.
Inherited from Interactive
|
| AddHandler |
void |
Adds a handler for the specified routed event.
Inherited from Interactive
|
| AffectsArrange |
void |
Marks a property as affecting the control's arrangement.
Inherited from Layoutable
static
|
| AffectsArrange |
void |
Marks a property as affecting the control's arrangement.
Inherited from Layoutable
static
|
| AffectsMeasure |
void |
Marks a property as affecting the control's measurement.
Inherited from Layoutable
static
|
| AffectsMeasure |
void |
Marks a property as affecting the control's measurement.
Inherited from Layoutable
static
|
| AffectsRender |
void |
Indicates that a property change should cause
InvalidateVisual() to be
called.
Inherited from Visual
static
|
| AffectsRender |
void |
Indicates that a property change should cause
InvalidateVisual() to be
called.
Inherited from Visual
static
|
| ApplyStyling |
bool |
Applies styling to the control if the control is initialized and styling is not
already applied.
Inherited from StyledElement
|
| ApplyTemplate |
void |
Creates the visual children of the control, if necessary
Inherited from TemplatedControl
|
| Arrange |
void |
Arranges the control and its children.
Inherited from Layoutable
|
| ArrangeCore |
void |
The default implementation of the control's arrange pass.
Inherited from Layoutable
|
| ArrangeOverride |
Size |
Arranges the content of the
DataGridRow.
|
| BeginBatchUpdate |
void |
Inherited from AvaloniaObject
|
| BeginEdit |
bool |
Enters editing mode for the current cell and current row (if they're not already in editing mode).
|
| BeginEdit |
bool |
Enters editing mode for the current cell and current row (if they're not already in editing mode).
|
| BeginInit |
void |
Inherited from StyledElement
|
| Bind |
IDisposable |
Binds a
AvaloniaProperty to an observable.
Inherited from AvaloniaObject
|
| Bind |
IDisposable |
Binds a
AvaloniaProperty to an observable.
Inherited from AvaloniaObject
|
| BuildEventRoute |
EventRoute |
Builds an event route for a routed event.
Inherited from Interactive
|
| CancelEdit |
bool |
Cancels editing mode and restores the original value.
|
| CancelEdit |
bool |
Cancels editing mode for the specified DataGridEditingUnit and restores its original value.
|
| CheckAccess |
bool |
Inherited from AvaloniaObject
|
| ClearValue |
void |
Clears a
AvaloniaProperty's local value.
Inherited from AvaloniaObject
|
| ClearValue |
void |
Clears a
AvaloniaProperty's local value.
Inherited from AvaloniaObject
|
| ClearValue |
void |
Clears a
AvaloniaProperty's local value.
Inherited from AvaloniaObject
|
| ClearValue |
void |
Clears a
AvaloniaProperty's local value.
Inherited from AvaloniaObject
|
| CoerceValue |
void |
Coerces the specified
AvaloniaProperty.
Inherited from AvaloniaObject
|
| CollapseRowGroup |
void |
Collapses the DataGridRowGroupHeader that represents a given CollectionViewGroup
|
| CommitEdit |
bool |
Commits editing mode and pushes changes to the backend.
|
| CommitEdit |
bool |
Commits editing mode for the specified DataGridEditingUnit and pushes changes to the backend.
|
| DisableTransitions |
void |
Disables transitions for the control.
Inherited from Animatable
|
| EnableTransitions |
void |
Enables transitions for the control.
Inherited from Animatable
|
| EndBatchUpdate |
void |
Inherited from AvaloniaObject
|
| EndInit |
void |
Inherited from StyledElement
|
| Equals |
bool |
Compares two objects using reference equality.
Inherited from AvaloniaObject
|
| ExpandRowGroup |
void |
Expands the DataGridRowGroupHeader that represents a given CollectionViewGroup
|
| Focus |
void |
Focuses the control.
Inherited from InputElement
|
| GetBaseValue |
Optional |
Gets an
AvaloniaProperty base value.
Inherited from AvaloniaObject
|
| GetGroupFromItem |
Data |
Returns the Group at the indicated level or null if the item is not in the ItemsSource
|
| GetHashCode |
int |
Gets the hash code for the object.
Inherited from AvaloniaObject
|
| Get |
bool |
Gets the value of the IsTemplateFocusTargetProperty attached property on a control.
Inherited from TemplatedControl
static
|
| Get |
IControl |
Gets the element that receives the focus adorner.
Inherited from TemplatedControl
|
| GetValue |
object |
Gets a
AvaloniaProperty value.
Inherited from AvaloniaObject
|
| GetValue |
T |
Gets a
AvaloniaProperty value.
Inherited from AvaloniaObject
|
| GetValue |
T |
Gets a
AvaloniaProperty value.
Inherited from AvaloniaObject
|
| InitializeIfNeeded |
void |
Inherited from StyledElement
|
| InvalidateArrange |
void |
Invalidates the arrangement of the control and queues a new layout pass.
Inherited from Layoutable
|
| InvalidateMeasure |
void |
Invalidates the measurement of the control and queues a new layout pass.
Inherited from Layoutable
|
| InvalidateStyles |
void |
Inherited from Layoutable
|
| InvalidateVisual |
void |
Invalidates the visual and queues a repaint.
Inherited from Visual
|
| IsAnimating |
bool |
Checks whether a
AvaloniaProperty is animating.
Inherited from AvaloniaObject
|
| IsSet |
bool |
Checks whether a
AvaloniaProperty is set on this object.
Inherited from AvaloniaObject
|
| Logical |
void |
Inherited from Visual
|
| Measure |
void |
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
Avalonia.Controls.DataGridRow.ArrangeOverride(System.Windows.Size) pass.
|
| Notify |
void |
Inherited from TemplatedControl
|
| OnApplyTemplate |
void |
Builds the visual tree for the column header when a new template is applied.
|
| On |
void |
Called when the styled element is added to a rooted logical tree.
Inherited from TemplatedControl
|
| On |
void |
Called when the control is added to a rooted visual tree.
Inherited from Visual
|
| On |
void |
Inherited from Control
|
| On |
void |
Raises the AutoGeneratingColumn event.
|
| OnBeginningEdit |
void |
Raises the BeginningEdit event.
|
| OnCellEditEnded |
void |
Raises the CellEditEnded event.
|
| OnCellEditEnding |
void |
Raises the CellEditEnding event.
|
| On |
void | |
| On |
void |
This method raises the CopyingRowClipboardContent event.
|
| OnCurrentCellChanged |
void |
Raises the CurrentCellChanged event.
|
| On |
void |
Called when the
DataContext begins updating.
Inherited from StyledElement
|
| OnDataContextChanged |
void |
Called when the
DataContext property changes.
Inherited from StyledElement
|
| On |
void |
Called when the
DataContext finishes updating.
Inherited from StyledElement
|
| On |
void |
Called when the styled element is removed from a rooted logical tree.
Inherited from TemplatedControl
|
| On |
void |
Called when the control is removed from a rooted visual tree.
Inherited from Visual
|
| On |
void |
Inherited from Control
|
| OnGotFocus |
void |
Called before the
GotFocus event occurs.
Inherited from Control
|
| OnInitialized |
void |
Called when the control finishes initialization.
Inherited from StyledElement
|
| OnKeyDown |
void |
Called before the
KeyDown event occurs.
Inherited from InputElement
|
| OnKeyUp |
void |
Called before the
KeyUp event occurs.
Inherited from InputElement
|
| OnLoadingRow |
void |
Raises the LoadingRow event for row preparation.
|
| OnLoadingRowDetails |
void |
Raises the LoadingRowDetails for row details preparation
|
| OnLoadingRowGroup |
void |
Raises the LoadingRowGroup event
|
| OnLostFocus |
void |
Called before the
LostFocus event occurs.
Inherited from Control
|
| OnMeasureInvalidated |
void |
Called by InvalidateMeasure
Inherited from Layoutable
|
| OnPointerCaptureLost |
void |
Called before the
PointerCaptureLost event occurs.
Inherited from InputElement
|
| OnPointerEnter |
void |
Called before the
PointerEnter event occurs.
Inherited from InputElement
|
| OnPointerLeave |
void |
Called before the
PointerLeave event occurs.
Inherited from InputElement
|
| OnPointerMoved |
void |
Called before the
PointerMoved event occurs.
Inherited from InputElement
|
| OnPointerPressed |
void |
Called before the
PointerPressed event occurs.
Inherited from InputElement
|
| OnPointerReleased |
void |
Called before the
PointerReleased event occurs.
Inherited from InputElement
|
| On |
void |
Scrolls the DataGrid according to the direction of the delta.
|
| On |
void |
Raises the PreparingCellForEdit event.
|
| OnPropertyChanged |
void |
Inherited from InputElement
|
| On |
void |
Inherited from Animatable
|
| OnRowEditEnded |
void |
Raises the RowEditEnded event.
|
| OnRowEditEnding |
void |
Raises the RowEditEnding event.
|
| OnSelectionChanged |
void |
Raises the SelectionChanged event and clears the _selectionChanged.
This event won't get raised again until after _selectionChanged is set back to true.
|
| OnTemplateApplied |
void |
Called when the control's template is applied.
Inherited from TemplatedControl
|
| OnTemplateChanged |
void |
Called when the
Template property changes.
Inherited from TemplatedControl
|
| OnTextInput |
void |
Called before the
TextInput event occurs.
Inherited from InputElement
|
| OnUnloadingRow |
void |
Raises the UnloadingRow event for row recycling.
|
| On |
void |
Raises the UnloadingRowDetails event
|
| OnUnloadingRowGroup |
void |
Raises the UnLoadingRowGroup event
|
| On |
void |
Called when the control's visual parent changes.
Inherited from Layoutable
|
| RaiseEvent |
void |
Raises a routed event.
Inherited from Interactive
|
| RemoveHandler |
void |
Removes a handler for the specified routed event.
Inherited from Interactive
|
| RemoveHandler |
void |
Removes a handler for the specified routed event.
Inherited from Interactive
|
| Render |
void |
Renders the visual to a
DrawingContext.
Inherited from Visual
|
| ScrollIntoView |
void |
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 |
void | |
| Set |
void |
Sets the value of the IsTemplateFocusTargetProperty attached property on a control.
Inherited from TemplatedControl
static
|
| SetValue |
void |
Sets a
AvaloniaProperty value.
Inherited from AvaloniaObject
|
| SetValue |
void |
Sets a
AvaloniaProperty value.
Inherited from AvaloniaObject
|
| SetValue |
IDisposable |
Sets a
AvaloniaProperty value.
Inherited from AvaloniaObject
|
| Update |
void |
Updates the
IsEffectivelyEnabled property value according to the parent
control's enabled state and IsEnabledCore.
Inherited from InputElement
|
| VerifyAccess |
void |
Inherited from AvaloniaObject
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| AddDisposableHandler |
IDisposable |
Adds a handler for the specified routed event and returns a disposable that can terminate the event subscription.
|
| Bind |
IDisposable |
Binds a
AvaloniaProperty to an observable.
|
| Bind |
IDisposable |
Binds a
AvaloniaProperty to an observable.
|
| BindClass |
IDisposable | |
| BringIntoView |
void |
Tries to bring the control into view.
From ControlExtensions
|
| BringIntoView |
void |
Tries to bring the control into view.
From ControlExtensions
|
| Calculate |
int |
Calculates the distance from a visual's ancestor.
From VisualExtensions
|
| Find |
T |
Finds a named element in an
INameScope.
From NameScopeExtensions
|
| FindAncestorOfType |
T |
Finds first ancestor of given type.
From VisualExtensions
|
| Find |
IVisual |
Tries to get the first common ancestor of two visuals.
From VisualExtensions
|
| FindControl |
T |
Finds the named control in the scope of the specified control.
From ControlExtensions
|
| FindDataTemplate |
IDataTemplate? |
Find a data template that matches a piece of data.
|
| FindDescendantOfType |
T |
Finds first descendant of given type.
From VisualExtensions
|
| Find |
T |
Finds first ancestor of given type.
From LogicalExtensions
|
| Find |
T |
Finds first descendant of given type.
From LogicalExtensions
|
| FindNameScope |
INameScope |
From NameScopeExtensions
|
| FindResource |
object? |
Finds the specified resource by searching up the logical tree and then global styles.
|
| Get |
T |
Gets a named element from an
INameScope or throws if no element of the
requested name was found.
From NameScopeExtensions
|
| GetBindingObservable |
IObservable |
Gets an observable for a
AvaloniaProperty.
|
| GetBindingObservable |
IObservable |
Gets an observable for a
AvaloniaProperty.
|
| GetBindingSubject |
ISubject |
Gets a subject for a
AvaloniaProperty.
|
| GetBindingSubject |
ISubject |
Gets a subject for a
AvaloniaProperty.
|
| GetDiagnostic |
Avalonia |
Gets a diagnostic for a
AvaloniaProperty on a AvaloniaObject.
|
| GetInputElementsAt |
IEnumerable |
Returns the active input elements at a point on an
IInputElement.
From InputExtensions
|
| GetLogicalAncestors |
IEnumerable |
Enumerates the ancestors of an
ILogical in the logical tree.
From LogicalExtensions
|
| GetLogicalChildren |
IEnumerable |
Enumerates the children of an
ILogical in the logical tree.
From LogicalExtensions
|
| Get |
IEnumerable |
Enumerates the descendants of an
ILogical in the logical tree.
From LogicalExtensions
|
| GetLogicalParent |
ILogical |
Gets the logical parent of an
ILogical.
From LogicalExtensions
|
| GetLogicalParent |
T |
Gets the logical parent of an
ILogical.
From LogicalExtensions
|
| GetLogicalSiblings |
IEnumerable |
Enumerates the siblings of an
ILogical in the logical tree.
From LogicalExtensions
|
| GetObservable |
IObservable |
Gets an observable for a
AvaloniaProperty.
|
| GetObservable |
IObservable |
Gets an observable for a
AvaloniaProperty.
|
| GetObservable |
IObservable |
Gets an observable for a
RoutedEvent<TEventArgs>.
|
| Get |
IObservable |
Gets an observable that listens for property changed events for an
AvaloniaProperty.
|
| Get |
IObservable |
|
| Get |
IEnumerable |
Enumerates an
ILogical and its ancestors in the logical tree.
From LogicalExtensions
|
| Get |
IEnumerable |
Enumerates an
ILogical and its descendants in the logical tree.
From LogicalExtensions
|
| Get |
IEnumerable |
Enumerates an
IVisual and its ancestors in the visual tree.
From VisualExtensions
|
| Get |
IEnumerable |
Enumerates an
IVisual and its descendants in the visual tree.
From VisualExtensions
|
| GetStyleDiagnostics |
StyleDiagnostics |
Gets a style diagnostics for a
StyledElement.
|
| GetSubject |
ISubject |
Gets a subject for a
AvaloniaProperty.
|
| GetSubject |
ISubject |
Gets a subject for a
AvaloniaProperty.
|
| GetTemplateChildren |
IEnumerable |
From TemplateExtensions
|
| GetVisualAncestors |
IEnumerable |
Enumerates the ancestors of an
IVisual in the visual tree.
From VisualExtensions
|
| GetVisualAt |
IVisual |
Gets the first visual in the visual tree whose bounds contain a point.
From VisualExtensions
|
| GetVisualAt |
IVisual |
Gets the first visual in the visual tree whose bounds contain a point.
From VisualExtensions
|
| GetVisualChildren |
IEnumerable |
Enumerates the children of an
IVisual in the visual tree.
From VisualExtensions
|
| GetVisualDescendants |
IEnumerable |
Enumerates the descendants of an
IVisual in the visual tree.
From VisualExtensions
|
| GetVisualParent |
IVisual |
Gets the visual parent of an
IVisual.
From VisualExtensions
|
| GetVisualParent |
T |
Gets the visual parent of an
IVisual.
From VisualExtensions
|
| GetVisualRoot |
IRenderRoot |
Gets the root visual for an
IVisual.
From VisualExtensions
|
| GetVisualsAt |
IEnumerable |
Enumerates the visible visuals in the visual tree whose bounds contain a point.
From VisualExtensions
|
| GetVisualsAt |
IEnumerable |
Enumerates the visuals in the visual tree whose bounds contain a point.
From VisualExtensions
|
| HitTestCustom |
bool | |
| InputHitTest |
IInputElement? |
Returns the topmost active input element at a point on an
IInputElement.
From InputExtensions
|
| InputHitTest |
IInputElement? |
Returns the topmost active input element at a point on an
IInputElement.
From InputExtensions
|
| IsLogicalAncestorOf |
bool |
Tests whether an
ILogical is an ancestor of another logical.
From LogicalExtensions
|
| IsVisualAncestorOf |
bool |
Tests whether an
IVisual is an ancestor of another visual.
From VisualExtensions
|
| PointToClient |
Point |
Converts a point from screen to client coordinates.
From VisualExtensions
|
| PointToScreen |
PixelPoint |
Converts a point from client to screen coordinates.
From VisualExtensions
|
| RegisterInNameScope |
T | |
| TransformToVisual |
Matrix? |
Returns a transform that transforms the visual's coordinates into the coordinates
of the specified to.
From VisualExtensions
|
| TranslatePoint |
Point? |
Translates a point relative to this visual to coordinates that are relative to the specified visual.
From VisualExtensions
|
| TryFindResource |
bool |
Tries to the specified resource by searching up the logical tree and then global styles.
|