Canvas Class
A panel that displays child controls at arbitrary locations.
Definition
Namespace: Avalonia.Controls
Assembly: Avalonia.Controls (in Avalonia.Controls.dll)
- C#
- VB
- F#
public class Canvas : Panel, INavigableContainer
Public Class Canvas
Inherits Panel
Implements INavigableContainer
type Canvas =
class
inherit Panel
interface INavigableContainer
end
Inheritance | Object → AvaloniaObject → Animatable → StyledElement → Visual → Layoutable → Interactive → InputElement → Control → Panel → Canvas |
Derived | Avalonia.Controls.Primitives.AdornerLayer Avalonia.Controls.Primitives.OverlayLayer Avalonia.Controls.Primitives.TextSelectorLayer |
Implements | INavigableContainer |
Remarks
Unlike other Panel implementations, the Canvas doesn't lay out its children in any particular layout. Instead, the positioning of each child control is defined by the Canvas.Left
, Canvas.Top
, Canvas.Right
and Canvas.Bottom
attached properties.
Constructors
Canvas() | Initializes a new instance of the Canvas class |
Properties
ActualThemeVariant | Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. (Inherited from StyledElement) |
Background | Gets or Sets Panel background brush. (Inherited from Panel) |
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) |
Children | Gets the children of the Panel. (Inherited from Panel) |
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) |
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) |
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) |
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) |
GestureRecognizers | (Inherited from InputElement) |
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. (Inherited from Layoutable) |
HorizontalAlignment | Gets or sets the element's preferred horizontal alignment in its parent. (Inherited from Layoutable) |
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) |
IsItemsHost | Gets whether the Panel hosts the items created by an ItemsPresenter. (Inherited from Panel) |
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) |
IsTabStop | Gets or sets a value that indicates whether the control is included in tab navigation. (Inherited from InputElement) |
IsVisible | Gets or sets a value indicating whether this control is visible. (Inherited from Visual) |
Item(AvaloniaProperty) | Gets or sets the value of a AvaloniaProperty. (Inherited from AvaloniaObject) |
Item(IndexerDescriptor) | Gets or sets a binding for a AvaloniaProperty. (Inherited from AvaloniaObject) |
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) |
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) |
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) |
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) |
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) |
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) |
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) |
AddHandler(TEventArgs)(RoutedEvent(TEventArgs), EventHandler(TEventArgs), 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 Layoutable) |
Arrange(Rect) | Arranges the control and its children. (Inherited from Layoutable) |
ArrangeChild(Control, Size) | Arranges a single child. |
ArrangeCore(Rect) | The default implementation of the control's arrange pass. (Inherited from Layoutable) |
ArrangeOverride(Size) | Arranges the control's children. (Overrides Layoutable.ArrangeOverride(Size)) |
BeginInit() | Signals the object that initialization is starting. (Inherited from StyledElement) |
Bind(AvaloniaProperty, IBinding) | Binds a AvaloniaProperty to an IBinding. (Inherited from AvaloniaObject) |
Bind(AvaloniaProperty, IObservable(Object), BindingPriority) | Binds a AvaloniaProperty to an observable. (Inherited from AvaloniaObject) |
Bind(T)(DirectPropertyBase(T), IObservable(T)) | Binds a AvaloniaProperty to an observable. (Inherited from AvaloniaObject) |
Bind(T)(DirectPropertyBase(T), IObservable(BindingValue(T))) | Binds a AvaloniaProperty to an observable. (Inherited from AvaloniaObject) |
Bind(T)(DirectPropertyBase(T), IObservable(Object)) | Binds a AvaloniaProperty to an observable. (Inherited from AvaloniaObject) |
Bind(T)(StyledProperty(T), IObservable(T), BindingPriority) | Binds a AvaloniaProperty to an observable. (Inherited from AvaloniaObject) |
Bind(T)(StyledProperty(T), IObservable(BindingValue(T)), BindingPriority) | Binds a AvaloniaProperty to an observable. (Inherited from AvaloniaObject) |
Bind(T)(StyledProperty(T), IObservable(Object), BindingPriority) | Binds a AvaloniaProperty to an observable. (Inherited from AvaloniaObject) |
BuildEventRoute(RoutedEvent) | Builds an event route for a routed event. (Inherited from Interactive) |
CheckAccess() | Returns a value indicating whether the current thread is the UI thread. (Inherited from AvaloniaObject) |
ChildrenChanged(Object, NotifyCollectionChangedEventArgs) | Called when the Children collection changes. (Inherited from Panel) |
ClearValue(AvaloniaProperty) | Clears a AvaloniaProperty's local value. (Inherited from AvaloniaObject) |
ClearValue(T)(AvaloniaProperty(T)) | Clears a AvaloniaProperty's local value. (Inherited from AvaloniaObject) |
ClearValue(T)(DirectPropertyBase(T)) | Clears a AvaloniaProperty's local value. (Inherited from AvaloniaObject) |
ClearValue(T)(StyledProperty(T)) | Clears a AvaloniaProperty's local value. (Inherited from AvaloniaObject) |
CoerceValue(AvaloniaProperty) | Coerces the specified AvaloniaProperty. (Inherited from AvaloniaObject) |
EndInit() | Signals the object that initialization is complete. (Inherited from StyledElement) |
Equals(Object) | Compares two objects using reference equality. (Inherited from AvaloniaObject) |
Finalize() | Allows 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) |
GetBaseValue(T)(StyledProperty(T)) | Gets an AvaloniaProperty base value. (Inherited from AvaloniaObject) |
GetBottom(AvaloniaObject) | Gets the value of the Bottom attached property for a control. |
GetHashCode() | Gets the hash code for the object. (Inherited from AvaloniaObject) |
GetLeft(AvaloniaObject) | Gets the value of the Left attached property for a control. |
GetRight(AvaloniaObject) | Gets the value of the Right attached property for a control. |
GetTemplateFocusTarget() | Gets the element that receives the focus adorner. (Inherited from Control) |
GetTop(AvaloniaObject) | Gets the value of the Top attached property for a control. |
GetType() | Gets the Type of the current instance. (Inherited from Object) |
GetValue(AvaloniaProperty) | Gets a AvaloniaProperty value. (Inherited from AvaloniaObject) |
GetValue(T)(DirectPropertyBase(T)) | Gets a AvaloniaProperty value. (Inherited from AvaloniaObject) |
GetValue(T)(StyledProperty(T)) | 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 control. (Overrides Layoutable.MeasureOverride(Size)) |
MemberwiseClone() | Creates a shallow copy of the current Object. (Inherited from Object) |
OnAttachedToLogicalTree(LogicalTreeAttachmentEventArgs) | Called when the styled element is added to a rooted logical tree. (Inherited from StyledElement) |
OnAttachedToVisualTree(VisualTreeAttachmentEventArgs) | Called when the control is added to a rooted visual tree. (Inherited from Visual) |
OnAttachedToVisualTreeCore(VisualTreeAttachmentEventArgs) | Calls the OnAttachedToVisualTree(VisualTreeAttachmentEventArgs) method for this control and all of its visual descendants. (Inherited from Control) |
OnCreateAutomationPeer() | Returns a new, type-specific AutomationPeer implementation for the control. (Inherited from Control) |
OnDataContextBeginUpdate() | Called when the DataContext begins updating. (Inherited from StyledElement) |
OnDataContextChanged(EventArgs) | Called when the DataContext property changes. (Inherited from StyledElement) |
OnDataContextEndUpdate() | Called when the DataContext finishes updating. (Inherited from StyledElement) |
OnDetachedFromLogicalTree(LogicalTreeAttachmentEventArgs) | Called when the styled element is removed from a rooted logical tree. (Inherited from StyledElement) |
OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs) | Called when the control is removed from a rooted visual tree. (Inherited from Visual) |
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) |
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) | Called before the PointerWheelChanged event occurs. (Inherited from InputElement) |
OnPropertyChanged(AvaloniaPropertyChangedEventArgs) | (Inherited from Control) |
OnPropertyChangedCore(AvaloniaPropertyChangedEventArgs) | (Inherited from Animatable) |
OnSizeChanged(SizeChangedEventArgs) | Invoked just before the SizeChanged event. (Inherited from Control) |
OnTextInput(TextInputEventArgs) | Called before the TextInput event occurs. (Inherited from InputElement) |
OnUnloaded(RoutedEventArgs) | Invoked just before the Unloaded event. (Inherited from Control) |
OnVisualParentChanged(Visual, Visual) | Called when the control's visual parent changes. (Inherited from Layoutable) |
RaiseEvent(RoutedEventArgs) | Raises a routed event. (Inherited from Interactive) |
RaisePropertyChanged(T)(DirectPropertyBase(T), 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) |
RemoveHandler(TEventArgs)(RoutedEvent(TEventArgs), EventHandler(TEventArgs)) | Removes a handler for the specified routed event. (Inherited from Interactive) |
Render(DrawingContext) | Renders the visual to a DrawingContext. (Inherited from Panel) |
SetAndRaise(T)(DirectPropertyBase(T), T, T) | Sets the backing field for a direct avalonia property, raising the PropertyChanged event if the value has changed. (Inherited from AvaloniaObject) |
SetBottom(AvaloniaObject, Double) | Sets the value of the Bottom attached property for a control. |
SetCurrentValue(AvaloniaProperty, Object) | Sets the value of a dependency property without changing its value source. (Inherited from AvaloniaObject) |
SetCurrentValue(T)(StyledProperty(T), T) | Sets the value of a dependency property without changing its value source. (Inherited from AvaloniaObject) |
SetLeft(AvaloniaObject, Double) | Sets the value of the Left attached property for a control. |
SetRight(AvaloniaObject, Double) | Sets the value of the Right attached property for a control. |
SetTop(AvaloniaObject, Double) | Sets the value of the Top attached property for a control. |
SetValue(AvaloniaProperty, Object, BindingPriority) | Sets a AvaloniaProperty value. (Inherited from AvaloniaObject) |
SetValue(T)(DirectPropertyBase(T), T) | Sets a AvaloniaProperty value. (Inherited from AvaloniaObject) |
SetValue(T)(StyledProperty(T), T, BindingPriority) | Sets a AvaloniaProperty value. (Inherited from AvaloniaObject) |
ToString() | Returns 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) |
ContextRequested | Occurs when the user has completed a context input gesture, such as a right-click. (Inherited from Control) |
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) |
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) |
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) |
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) |
SizeChanged | Occurs when the bounds (actual size) of the control have changed. (Inherited from Control) |
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) |
Unloaded | Occurs when the control is removed from the visual tree. (Inherited from Control) |
Fields
BottomProperty | Defines the Bottom attached property. |
LeftProperty | Defines the Left attached property. |
RightProperty | Defines the Right attached property. |
TopProperty | Defines the Top attached property. |