Table of Contents

Class AdornerLayer

Namespace
Avalonia.Controls.Primitives
Assembly
Avalonia.Controls.dll

Represents a surface for showing adorners. Adorners are always on top of the adorned element and are positioned to stay relative to the adorned element.

public class AdornerLayer : Canvas, INotifyPropertyChanged, IDataContextProvider, ILogical, IThemeVariantHost, IResourceHost, IResourceNode, IStyleHost, ISetLogicalParent, ISetInheritanceParent, ISupportInitialize, IStyleable, INamed, IInputElement, IDataTemplateHost, ISetterValue, IChildIndexProvider, INavigableContainer
Inheritance
AdornerLayer
Implements
Inherited Members
Extension Methods

Remarks

TODO: Need to track position of adorned elements and move the adorner if they move.

Constructors

AdornerLayer() 

public AdornerLayer()

Fields

AdornedElementProperty

Allows for getting and setting of the adorned element.

public static readonly AttachedProperty<Visual?> AdornedElementProperty

Field Value

AttachedProperty<Visual>

AdornerProperty

Allows for getting and setting of the adorner for control.

public static readonly AttachedProperty<Control?> AdornerProperty

Field Value

AttachedProperty<Control>

DefaultFocusAdornerProperty

Defines the DefaultFocusAdorner property.

public static readonly StyledProperty<ITemplate<Control>?> DefaultFocusAdornerProperty

Field Value

StyledProperty<ITemplate<Control>>

IsClipEnabledProperty

Allows for controlling clipping of the adorner.

public static readonly AttachedProperty<bool> IsClipEnabledProperty

Field Value

AttachedProperty<bool>

Properties

DefaultFocusAdorner

Gets or sets the default control's focus adorner.

public ITemplate<Control>? DefaultFocusAdorner { get; set; }

Property Value

ITemplate<Control>

Methods

ArrangeOverride(Size)

Arranges the control's children.

protected override Size ArrangeOverride(Size finalSize)

Parameters

finalSize Size

The size allocated to the control.

Returns

Size

The space taken.

GetAdornedElement(Visual) 

public static Visual? GetAdornedElement(Visual adorner)

Parameters

adorner Visual

Returns

Visual

GetAdorner(Visual) 

public static Control? GetAdorner(Visual visual)

Parameters

visual Visual

Returns

Control

GetAdornerLayer(Visual) 

public static AdornerLayer? GetAdornerLayer(Visual visual)

Parameters

visual Visual

Returns

AdornerLayer

GetIsClipEnabled(Visual) 

public static bool GetIsClipEnabled(Visual adorner)

Parameters

adorner Visual

Returns

bool

MeasureOverride(Size)

Measures the control.

protected override Size MeasureOverride(Size availableSize)

Parameters

availableSize Size

The available size.

Returns

Size

The desired size of the control.

SetAdornedElement(Visual, Visual?) 

public static void SetAdornedElement(Visual adorner, Visual? adorned)

Parameters

adorner Visual
adorned Visual

SetAdorner(Visual, Control?) 

public static void SetAdorner(Visual visual, Control? adorner)

Parameters

visual Visual
adorner Control

SetIsClipEnabled(Visual, bool) 

public static void SetIsClipEnabled(Visual adorner, bool isClipEnabled)

Parameters

adorner Visual
isClipEnabled bool