Grid Class
Definition
Defines a flexible grid area that consists of columns and rows.
public class Grid
Constructors
| Name | Description |
|---|---|
| Grid | Default constructor. |
Grid Constructor
Default constructor.
public Grid()
Methods
| Name | Description |
|---|---|
| GetColumn | Helper for reading Column property from a Control. |
| GetColumnSpan | Helper for reading ColumnSpan property from a Control. |
| GetIsSharedSizeScope | Helper for reading IsSharedSizeScope property from a Control. |
| GetRow | Helper for reading Row property from a Control. |
| GetRowSpan | Helper for reading RowSpan property from a Control. |
| SetColumn | Helper for setting Column property on a Control. |
| SetColumnSpan | Helper for setting ColumnSpan property on a Control. |
| SetIsSharedSizeScope | Helper for setting IsSharedSizeScope property on a Control. |
| SetRow | Helper for setting Row property on a Control. |
| SetRowSpan | Helper for setting RowSpan property on a Control. |
| Render | Renders the visual to a Avalonia.Media.DrawingContext. Inherited from Panel. |
| Focus | Focuses the control. Inherited from InputElement. |
| GetIsHoldWithMouseEnabled | Inherited from InputElement. |
| GetIsHoldingEnabled | Inherited from InputElement. |
| SetIsHoldWithMouseEnabled | Inherited from InputElement. |
| SetIsHoldingEnabled | Inherited from InputElement. |
| AddHandler (2 overloads) | Adds a handler for the specified routed event. Inherited from Interactive. |
| RaiseEvent | Raises a routed event. Inherited from Interactive. |
| RemoveHandler (2 overloads) | Removes a handler for the specified routed event. Inherited from Interactive. |
| ApplyTemplate | Creates the visual children of the control, if necessary Inherited from Layoutable. |
| Arrange | Arranges the control and its children. Inherited from Layoutable. |
| 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. |
| Measure | Carries out a measure of the control. Inherited from Layoutable. |
| UpdateLayout | Executes a layout pass. Inherited from Layoutable. |
| GetFlowDirection | Gets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| InvalidateVisual | Invalidates the visual and queues a repaint. Inherited from Visual. |
| SetFlowDirection | Sets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| ApplyStyling | Applies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement. |
| BeginInit | Inherited from StyledElement. |
| EndInit | Inherited from StyledElement. |
| TryGetResource | Inherited from StyledElement. |
| Bind (8 overloads) | Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject. |
| CheckAccess | Returns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject. |
| ClearValue (4 overloads) | Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject. |
| CoerceValue | Coerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject. |
| Equals | Compares two objects using reference equality. Inherited from AvaloniaObject. |
| GetBaseValue | Inherited from AvaloniaObject. |
| GetHashCode | Gets the hash code for the object. Inherited from AvaloniaObject. |
| GetValue (3 overloads) | Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| IsAnimating | Checks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject. |
| IsSet | Checks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject. |
| SetCurrentValue (2 overloads) | Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject. |
| SetValue (3 overloads) | Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| VerifyAccess | Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject. |
GetColumn Method
Helper for reading Column property from a Control.
public int GetColumn(Avalonia.Controls.Control element)
Parameters
element Avalonia.Controls.Control
Control to read Column property from.
Returns
int
Column property value.
GetColumnSpan Method
Helper for reading ColumnSpan property from a Control.
public int GetColumnSpan(Avalonia.Controls.Control element)
Parameters
element Avalonia.Controls.Control
Control to read ColumnSpan property from.
Returns
int
ColumnSpan property value.
GetIsSharedSizeScope Method
Helper for reading IsSharedSizeScope property from a Control.
public bool GetIsSharedSizeScope(Avalonia.Controls.Control element)
Parameters
element Avalonia.Controls.Control
Control to read IsSharedSizeScope property from.
Returns
bool
IsSharedSizeScope property value.
GetRow Method
Helper for reading Row property from a Control.
public int GetRow(Avalonia.Controls.Control element)
Parameters
element Avalonia.Controls.Control
Control to read Row property from.
Returns
int
Row property value.
GetRowSpan Method
Helper for reading RowSpan property from a Control.
public int GetRowSpan(Avalonia.Controls.Control element)
Parameters
element Avalonia.Controls.Control
Control to read RowSpan property from.
Returns
int
RowSpan property value.
SetColumn Method
Helper for setting Column property on a Control.
public void SetColumn(Avalonia.Controls.Control element, int value)
Parameters
element Avalonia.Controls.Control
Control to set Column property on.
value int
Column property value.
SetColumnSpan Method
Helper for setting ColumnSpan property on a Control.
public void SetColumnSpan(Avalonia.Controls.Control element, int value)
Parameters
element Avalonia.Controls.Control
Control to set ColumnSpan property on.
value int
ColumnSpan property value.
SetIsSharedSizeScope Method
Helper for setting IsSharedSizeScope property on a Control.
public void SetIsSharedSizeScope(Avalonia.Controls.Control element, bool value)
Parameters
element Avalonia.Controls.Control
Control to set IsSharedSizeScope property on.
value bool
IsSharedSizeScope property value.
SetRow Method
Helper for setting Row property on a Control.
public void SetRow(Avalonia.Controls.Control element, int value)
Parameters
element Avalonia.Controls.Control
Control to set Row property on.
value int
Row property value.
SetRowSpan Method
Helper for setting RowSpan property on a Control.
public void SetRowSpan(Avalonia.Controls.Control element, int value)
Parameters
element Avalonia.Controls.Control
Control to set RowSpan property on.
value int
RowSpan property value.
Properties
| Name | Description |
|---|---|
| ColumnDefinitions | Returns a ColumnDefinitions of column definitions. |
| ColumnSpacing | Gets or sets the size of the spacing to place between grid columns. |
| RowDefinitions | Returns a RowDefinitions of row definitions. |
| RowSpacing | Gets or sets the size of the spacing to place between grid rows. |
| ShowGridLines | ShowGridLines property. |
| Background | Gets or Sets Panel background brush. Inherited from Panel. |
| Children | Gets the children of the Avalonia.Controls.Panel. Inherited from Panel. |
| IsItemsHost | Gets whether the Avalonia.Controls.Panel hosts the items created by an Avalonia.Controls.Presenters.ItemsPresenter. Inherited from Panel. |
| 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. |
| DataTemplates | Gets or sets the data templates for the control. Inherited from Control. |
| FocusAdorner | Gets or sets the control's focus adorner. Inherited from Control. |
| 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. |
| Tag | Gets or sets a user-defined object attached to the control. Inherited from Control. |
| Cursor | Gets or sets associated mouse cursor. Inherited from InputElement. |
| Focusable | Gets or sets a value indicating whether the control can receive focus. Inherited from InputElement. |
| GestureRecognizers | Inherited from InputElement. |
| IsEffectivelyEnabled | Gets a value indicating whether this control and all its parents are enabled. Inherited from InputElement. |
| IsEnabled | Gets or sets a value indicating whether the control is enabled for user interaction. 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. |
| IsKeyboardFocusWithin | Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. Inherited from InputElement. |
| IsPointerOver | Gets a value indicating whether the pointer is currently over the control. Inherited from InputElement. |
| IsTabStop | Gets or sets a value that indicates whether the control is included in tab navigation. Inherited from InputElement. |
| KeyBindings | Inherited from InputElement. |
| 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. |
| DesiredSize | Gets the size that this element computed during the measure pass of the layout process. Inherited from Layoutable. |
| 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. |
| IsArrangeValid | Gets a value indicating whether the control's layouts arrange is valid. Inherited from Layoutable. |
| IsMeasureValid | Gets a value indicating whether the control's layout measure is valid. Inherited from Layoutable. |
| Margin | Gets or sets the margin around the element. Inherited from Layoutable. |
| 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. |
| 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. |
| 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. |
| Width | Gets or sets the width of the element. Inherited from Layoutable. |
| Bounds | Gets the bounds of the control relative to its parent. Inherited from Visual. |
| CacheMode | Gets or sets the cache mode of the visual. Inherited from Visual. |
| Clip | Gets or sets the geometry clip for this visual. Inherited from Visual. |
| ClipToBounds | Gets or sets a value indicating whether the control should be clipped to its bounds. Inherited from Visual. |
| Effect | Gets or sets the effect of the control. Inherited from Visual. |
| FlowDirection | Gets or sets the text flow direction. Inherited from Visual. |
| HasMirrorTransform | Gets or sets a value indicating whether to apply mirror transform on this control. Inherited from Visual. |
| IsEffectivelyVisible | Gets a value indicating whether this control and all its parents are visible. Inherited from Visual. |
| IsVisible | Gets or sets a value indicating whether this control is visible. Inherited from Visual. |
| 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. |
| 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. |
| ZIndex | Gets or sets the Z index of the control. Inherited from Visual. |
| ActualThemeVariant | Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. Inherited from StyledElement. |
| Classes | Gets or sets the styled element's classes. Inherited from StyledElement. |
| DataContext | Gets or sets the control's data context. Inherited from StyledElement. |
| IsInitialized | Gets a value that indicates whether the element has finished initialization. Inherited from StyledElement. |
| Name | Gets or sets the name of the styled element. Inherited from StyledElement. |
| Parent | Gets the styled element's logical parent. Inherited from StyledElement. |
| Resources | Gets or sets the styled element's resource dictionary. Inherited from StyledElement. |
| StyleKey | Gets the type by which the element is styled. Inherited from StyledElement. |
| Styles | Gets the styles for the styled element. Inherited from StyledElement. |
| 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. |
| Dispatcher | Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject. |
| Item | Inherited from AvaloniaObject. |
ColumnDefinitions Property
Returns a ColumnDefinitions of column definitions.
public Avalonia.Controls.ColumnDefinitions ColumnDefinitions { get; set; }
ColumnSpacing Property
Gets or sets the size of the spacing to place between grid columns.
public double ColumnSpacing { get; set; }
RowDefinitions Property
Returns a RowDefinitions of row definitions.
public Avalonia.Controls.RowDefinitions RowDefinitions { get; set; }
RowSpacing Property
Gets or sets the size of the spacing to place between grid rows.
public double RowSpacing { get; set; }
ShowGridLines Property
ShowGridLines property.
public bool ShowGridLines { get; set; }
Fields
ColumnProperty Field
Column property. This is an attached property. Grid defines Column property, so that it can be set on any element treated as a cell. Column property specifies child's position with respect to columns.
public Avalonia.AttachedProperty<int> ColumnProperty
Remarks
Columns are 0 - based. In order to appear in first column, element
should have Column property set to 0.
Default value for the property is 0.
ColumnSpacingProperty Field
Defines the Avalonia.Controls.Grid.ColumnSpacing property.
public Avalonia.StyledProperty<double> ColumnSpacingProperty
ColumnSpanProperty Field
ColumnSpan property. This is an attached property. Grid defines ColumnSpan, so that it can be set on any element treated as a cell. ColumnSpan property specifies child's width with respect to columns. Example, ColumnSpan == 2 means that child will span across two columns.
public Avalonia.AttachedProperty<int> ColumnSpanProperty
Remarks
Default value for the property is 1.
IsSharedSizeScopeProperty Field
IsSharedSizeScope property marks scoping element for shared size.
public Avalonia.AttachedProperty<bool> IsSharedSizeScopeProperty
RowProperty Field
Row property. This is an attached property. Grid defines Row, so that it can be set on any element treated as a cell. Row property specifies child's position with respect to rows.
Rows are 0 - based. In order to appear in first row, element
should have Row property set to 0.
Default value for the property is 0.
public Avalonia.AttachedProperty<int> RowProperty
RowSpacingProperty Field
Defines the Avalonia.Controls.Grid.RowSpacing property.
public Avalonia.StyledProperty<double> RowSpacingProperty
RowSpanProperty Field
RowSpan property. This is an attached property. Grid defines RowSpan, so that it can be set on any element treated as a cell. RowSpan property specifies child's height with respect to row grid lines. Example, RowSpan == 3 means that child will span across three rows.
public Avalonia.AttachedProperty<int> RowSpanProperty
Remarks
Default value for the property is 1.
ShowGridLinesProperty Field
ShowGridLines property. This property is used mostly
for simplification of visual debugging. When it is set
to true grid lines are drawn to visualize location
of grid lines.
public Avalonia.StyledProperty<bool> ShowGridLinesProperty
Events
| Name | Description |
|---|---|
| Loaded | Occurs when the control has been fully constructed in the visual tree and both layout and render are complete. Inherited from Control. |
| SizeChanged | Occurs when the bounds (actual size) of the control have changed. Inherited from Control. |
| Unloaded | Occurs when the control is removed from the visual tree. Inherited from Control. |
| ContextCanceled | Occurs when the context input gesture continues into another gesture, to notify the element that the context flyout should not be opened. Inherited from InputElement. |
| ContextRequested | Occurs when the user has completed a context input gesture, such as a right-click. Inherited from InputElement. |
| DoubleTapped | Occurs when a double-tap gesture occurs on the control. Inherited from InputElement. |
| GettingFocus | Occurs before the control receives focus. Inherited from InputElement. |
| GotFocus | Occurs when the control receives focus. Inherited from InputElement. |
| Holding | Occurs when a hold gesture occurs on the control. Inherited from InputElement. |
| 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. |
| LosingFocus | Occurs before the control loses focus. Inherited from InputElement. |
| LostFocus | Occurs when the control loses focus. Inherited from InputElement. |
| Pinch | Occurs when a pinch gesture occurs on the control. Inherited from InputElement. |
| PinchEnded | Occurs when a pinch gesture ends on the control. 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. |
| PointerTouchPadGestureMagnify | Occurs when a touchpad magnify gesture occurs on the control. Inherited from InputElement. |
| PointerTouchPadGestureRotate | Occurs when a touchpad rotate gesture occurs on the control. Inherited from InputElement. |
| PointerTouchPadGestureSwipe | Occurs when a touchpad swipe gesture occurs on the control. Inherited from InputElement. |
| PointerWheelChanged | Occurs when the mouse is scrolled over the control. Inherited from InputElement. |
| PullGesture | Occurs when a pull gesture occurs on the control. Inherited from InputElement. |
| PullGestureEnded | Occurs when a pull gesture ends on the control. Inherited from InputElement. |
| RightTapped | Occurs when a right tap gesture occurs on the control. Inherited from InputElement. |
| ScrollGesture | Occurs when a scroll gesture occurs on the control. Inherited from InputElement. |
| ScrollGestureEnded | Occurs when a scroll gesture ends on the control. Inherited from InputElement. |
| ScrollGestureInertiaStarting | Occurs when a scroll gesture inertia starts on the control. Inherited from InputElement. |
| SwipeGesture | Occurs when a swipe gesture occurs on the control. Inherited from InputElement. |
| Tapped | Occurs when a tap gesture occurs on the control. Inherited from InputElement. |
| 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. |
| EffectiveViewportChanged | Occurs when the element's effective viewport changes. Inherited from Layoutable. |
| LayoutUpdated | Occurs when a layout pass completes for the control. Inherited from Layoutable. |
| AttachedToVisualTree | Raised when the control is attached to a rooted visual tree. Inherited from Visual. |
| DetachedFromVisualTree | Raised when the control is detached from a rooted visual tree. Inherited from Visual. |
| 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. |
| DataContextChanged | Occurs when the Avalonia.StyledElement.DataContext property changes. Inherited from StyledElement. |
| DetachedFromLogicalTree | Raised when the styled element is detached from a rooted logical tree. Inherited from StyledElement. |
| Initialized | Occurs when the styled element has finished initialization. Inherited from StyledElement. |
| ResourcesChanged | Occurs when a resource in this styled element or a parent styled element has changed. Inherited from StyledElement. |
| PropertyChanged | Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject. |