Layoutable Class
Definition
Implements layout-related functionality for a control.
public class Layoutable
Constructors
| Name | Description |
|---|---|
| Layoutable | No summary available. |
Layoutable Constructor
public Layoutable()
Methods
| Name | Description |
|---|---|
| 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 |
| Arrange | Arranges the control and its children. |
| BeginInit | 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. |
| EndInit | Inherited from StyledElement. |
| Equals | Compares two objects using reference equality. Inherited from AvaloniaObject. |
| GetBaseValue | Inherited from AvaloniaObject. |
| GetFlowDirection | Gets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| GetHashCode | Gets the hash code for the object. Inherited from AvaloniaObject. |
| GetValue (3 overloads) | Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| InvalidateArrange | Invalidates the arrangement of the control and queues a new layout pass. |
| InvalidateMeasure | Invalidates the measurement of the control and queues a new layout pass. |
| InvalidateVisual | Invalidates the visual and queues a repaint. Inherited from Visual. |
| 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. |
| Measure | Carries out a measure of the control. |
| Render | Renders the visual to a Avalonia.Media.DrawingContext. Inherited from Visual. |
| SetCurrentValue (2 overloads) | Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject. |
| SetFlowDirection | Sets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| SetValue (3 overloads) | Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| TryGetResource | Inherited from StyledElement. |
| UpdateLayout | Executes a layout pass. |
| VerifyAccess | Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject. |
ApplyTemplate Method
Creates the visual children of the control, if necessary
public void ApplyTemplate()
Arrange Method
Arranges the control and its children.
public void Arrange(Avalonia.Rect rect)
Parameters
rect Avalonia.Rect
The control's new bounds.
InvalidateArrange Method
Invalidates the arrangement of the control and queues a new layout pass.
public void InvalidateArrange()
InvalidateMeasure Method
Invalidates the measurement of the control and queues a new layout pass.
public void InvalidateMeasure()
Measure Method
Carries out a measure of the control.
public void Measure(Avalonia.Size availableSize)
Parameters
availableSize Avalonia.Size
The available size for the control.
UpdateLayout Method
Executes a layout pass.
public void UpdateLayout()
Remarks
You should not usually need to call this method explictly, the layout manager will schedule layout passes itself.
Properties
| Name | Description |
|---|---|
| ActualThemeVariant | Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. Inherited from StyledElement. |
| 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. |
| 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. |
| ClipToBounds | Gets or sets a value indicating whether the control should be clipped to its bounds. Inherited from Visual. |
| DataContext | Gets or sets the control's data context. Inherited from StyledElement. |
| DesiredSize | Gets the size that this element computed during the measure pass of the layout process. |
| Dispatcher | Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject. |
| 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. |
| Height | Gets or sets the height of the element. |
| HorizontalAlignment | Gets or sets the element's preferred horizontal alignment in its parent. |
| IsArrangeValid | Gets a value indicating whether the control's layouts arrange is valid. |
| IsEffectivelyVisible | Gets a value indicating whether this control and all its parents are visible. Inherited from Visual. |
| IsInitialized | Gets a value that indicates whether the element has finished initialization. Inherited from StyledElement. |
| IsMeasureValid | Gets a value indicating whether the control's layout measure is valid. |
| IsVisible | Gets or sets a value indicating whether this control is visible. Inherited from Visual. |
| Item | Inherited from AvaloniaObject. |
| Margin | Gets or sets the margin around the element. |
| MaxHeight | Gets or sets the maximum height of the element. |
| MaxWidth | Gets or sets the maximum width of the element. |
| MinHeight | Gets or sets the minimum height of the element. |
| MinWidth | Gets or sets the minimum width of the element. |
| 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. |
| Parent | Gets the styled element's logical parent. 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. |
| 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. |
| UseLayoutRounding | Gets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time. |
| VerticalAlignment | Gets or sets the element's preferred vertical alignment in its parent. |
| Width | Gets or sets the width of the element. |
| ZIndex | Gets or sets the Z index of the control. Inherited from Visual. |
DesiredSize Property
Gets the size that this element computed during the measure pass of the layout process.
public Avalonia.Size DesiredSize { get; set; }
Height Property
Gets or sets the height of the element.
public double Height { get; set; }
HorizontalAlignment Property
Gets or sets the element's preferred horizontal alignment in its parent.
public Avalonia.Layout.HorizontalAlignment HorizontalAlignment { get; set; }
IsArrangeValid Property
Gets a value indicating whether the control's layouts arrange is valid.
public bool IsArrangeValid { get; set; }
IsMeasureValid Property
Gets a value indicating whether the control's layout measure is valid.
public bool IsMeasureValid { get; set; }
Margin Property
Gets or sets the margin around the element.
public Avalonia.Thickness Margin { get; set; }
MaxHeight Property
Gets or sets the maximum height of the element.
public double MaxHeight { get; set; }
MaxWidth Property
Gets or sets the maximum width of the element.
public double MaxWidth { get; set; }
MinHeight Property
Gets or sets the minimum height of the element.
public double MinHeight { get; set; }
MinWidth Property
Gets or sets the minimum width of the element.
public double MinWidth { get; set; }
UseLayoutRounding Property
Gets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time.
public bool UseLayoutRounding { get; set; }
VerticalAlignment Property
Gets or sets the element's preferred vertical alignment in its parent.
public Avalonia.Layout.VerticalAlignment VerticalAlignment { get; set; }
Width Property
Gets or sets the width of the element.
public double Width { get; set; }
Fields
DesiredSizeProperty Field
Defines the Avalonia.Layout.Layoutable.DesiredSize property.
public Avalonia.DirectProperty<TOwner,TValue><Avalonia.Layout.Layoutable, Avalonia.Size> DesiredSizeProperty
HeightProperty Field
Defines the Avalonia.Layout.Layoutable.Height property.
public Avalonia.StyledProperty<TValue><double> HeightProperty
HorizontalAlignmentProperty Field
Defines the Avalonia.Layout.Layoutable.HorizontalAlignment property.
public Avalonia.StyledProperty<TValue><Avalonia.Layout.HorizontalAlignment> HorizontalAlignmentProperty
MarginProperty Field
Defines the Avalonia.Layout.Layoutable.Margin property.
public Avalonia.StyledProperty<TValue><Avalonia.Thickness> MarginProperty
MaxHeightProperty Field
Defines the Avalonia.Layout.Layoutable.MaxHeight property.
public Avalonia.StyledProperty<TValue><double> MaxHeightProperty
MaxWidthProperty Field
Defines the Avalonia.Layout.Layoutable.MaxWidth property.
public Avalonia.StyledProperty<TValue><double> MaxWidthProperty
MinHeightProperty Field
Defines the Avalonia.Layout.Layoutable.MinHeight property.
public Avalonia.StyledProperty<TValue><double> MinHeightProperty
MinWidthProperty Field
Defines the Avalonia.Layout.Layoutable.MinWidth property.
public Avalonia.StyledProperty<TValue><double> MinWidthProperty
UseLayoutRoundingProperty Field
Defines the Avalonia.Layout.Layoutable.UseLayoutRounding property.
public Avalonia.StyledProperty<TValue><bool> UseLayoutRoundingProperty
VerticalAlignmentProperty Field
Defines the Avalonia.Layout.Layoutable.VerticalAlignment property.
public Avalonia.StyledProperty<TValue><Avalonia.Layout.VerticalAlignment> VerticalAlignmentProperty
WidthProperty Field
Defines the Avalonia.Layout.Layoutable.Width property.
public Avalonia.StyledProperty<TValue><double> WidthProperty
Events
| Name | Description |
|---|---|
| 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. |
| 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. |
| DetachedFromVisualTree | Raised when the control is detached from a rooted visual tree. Inherited from Visual. |
| EffectiveViewportChanged | Occurs when the element's effective viewport changes. |
| Initialized | Occurs when the styled element has finished initialization. Inherited from StyledElement. |
| LayoutUpdated | Occurs when a layout pass completes for the control. |
| PropertyChanged | Raised when a Avalonia.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. |
EffectiveViewportChanged Event
Occurs when the element's effective viewport changes.
public event EventHandler<Avalonia.Layout.EffectiveViewportChangedEventArgs> EffectiveViewportChanged
LayoutUpdated Event
Occurs when a layout pass completes for the control.
public event EventHandler LayoutUpdated