Visual Class

Base class for controls that provides rendering and related visual properties.

Definition

Namespace: Avalonia
Assembly: Avalonia.Base (in Avalonia.Base.dll)

C#

[UsableDuringInitializationAttribute]
public class Visual : StyledElement

VB

<UsableDuringInitializationAttribute>
Public Class Visual
	Inherits StyledElement

F#

[<UsableDuringInitializationAttribute>]
type Visual = 
    class
        inherit StyledElement
    end

Inheritance	Object → AvaloniaObject → Animatable → StyledElement → Visual
Derived	Avalonia.Layout.Layoutable

Remarks

The Visual class represents elements that have a visual on-screen representation and stores all the information needed for an IRenderer to render the control. To traverse the visual tree, use the extension methods defined in VisualExtensions.

Constructors

Visual()

Initializes a new instance of the Visual class.

Properties

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.
BypassFlowDirectionPolicies	Gets a value indicating whether control bypass FlowDirecton policies.
Classes	Gets or sets the styled element's classes. (Inherited from StyledElement)
Clip	Gets or sets the geometry clip for this visual.
ClipToBounds	Gets or sets a value indicating whether the control should be clipped to its bounds.
DataContext	Gets or sets the control's data context. (Inherited from StyledElement)
Effect	Gets or sets the effect of the control.
FlowDirection	Gets or sets the text flow direction.
HasMirrorTransform	Gets or sets a value indicating whether to apply mirror transform on this control.
InheritanceParent	Gets or sets the parent object that inherited AvaloniaProperty values are inherited from. (Inherited from AvaloniaObject)
IsEffectivelyVisible	Gets a value indicating whether this control and all its parents are visible.
IsInitialized	Gets a value that indicates whether the element has finished initialization. (Inherited from StyledElement)
IsVisible	Gets or sets a value indicating whether this control is visible.
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)
LogicalChildren	Gets the styled element's logical children. (Inherited from StyledElement)
Name	Gets or sets the name of the styled element. (Inherited from StyledElement)
Opacity	Gets or sets the opacity of the control.
OpacityMask	Gets or sets the opacity mask of the control.
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.
RenderTransformOrigin	Gets or sets the transform origin of the control.
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)
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)
VisualChildren	Gets the control's child visuals.
VisualRoot	Gets the root of the visual tree, if the control is attached to a visual tree.
ZIndex	Gets or sets the Z index of the control.

Methods

AffectsRender(T)(AvaloniaProperty[])	Indicates that a property change should cause InvalidateVisual() to be called.
ApplyStyling()	Applies styling to the control if the control is initialized and styling is not already applied. (Inherited from StyledElement)
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)
CheckAccess()	Returns a value indicating whether the current thread is the UI thread. (Inherited from AvaloniaObject)
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)
GetBaseValue(T)(StyledProperty(T))	Gets an AvaloniaProperty base value. (Inherited from AvaloniaObject)
GetFlowDirection(Visual)	Gets the value of the attached FlowDirectionProperty on a control.
GetHashCode()	Gets the hash code for the object. (Inherited from AvaloniaObject)
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)
InvalidateMirrorTransform()	Computes the HasMirrorTransform value according to the FlowDirection and BypassFlowDirectionPolicies
InvalidateVisual()	Invalidates the visual and queues a repaint.
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)	(Overrides StyledElement.LogicalChildrenCollectionChanged(Object, NotifyCollectionChangedEventArgs))
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.
OnAttachedToVisualTreeCore(VisualTreeAttachmentEventArgs)	Calls the OnAttachedToVisualTree(VisualTreeAttachmentEventArgs) method for this control and all of its visual descendants.
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.
OnDetachedFromVisualTreeCore(VisualTreeAttachmentEventArgs)	Calls the OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs) method for this control and all of its visual descendants.
OnInitialized()	Called when the control finishes initialization. (Inherited from StyledElement)
OnPropertyChanged(AvaloniaPropertyChangedEventArgs)	(Overrides StyledElement.OnPropertyChanged(AvaloniaPropertyChangedEventArgs))
OnPropertyChangedCore(AvaloniaPropertyChangedEventArgs)	(Inherited from Animatable)
OnVisualParentChanged(Visual, Visual)	Called when the control's visual parent changes.
RaisePropertyChanged(T)(DirectPropertyBase(T), T, T)	Raises the PropertyChanged event for a direct property. (Inherited from AvaloniaObject)
Render(DrawingContext)	Renders the visual to a DrawingContext.
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)
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)
SetFlowDirection(Visual, FlowDirection)	Sets the value of the attached FlowDirectionProperty on 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)
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.
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.
Initialized	Occurs when the styled element has finished initialization. (Inherited from StyledElement)
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)

Fields

BoundsProperty	Defines the Bounds property.
ClipProperty	Defines the Clip property.
ClipToBoundsProperty	Defines the ClipToBounds property.
EffectProperty	Defines the Effect property.
FlowDirectionProperty	Defines the FlowDirection property.
HasMirrorTransformProperty	Defines the HasMirrorTransform property.
IsVisibleProperty	Defines the IsVisible property.
OpacityMaskProperty	Defines the OpacityMask property.
OpacityProperty	Defines the Opacity property.
RenderTransformOriginProperty	Defines the RenderTransformOrigin property.
RenderTransformProperty	Defines the RenderTransform property.
VisualParentProperty	Defines the VisualParent property.
ZIndexProperty	Defines the ZIndex property.

Extension Methods

Bind(AvaloniaProperty, IBinding, Object)	Binds a property on an AvaloniaObject to an IBinding. (Defined by AvaloniaObjectExtensions)
Bind(T)(AvaloniaProperty(T), IObservable(BindingValue(T)), BindingPriority)	Binds an AvaloniaProperty to an observable. (Defined by AvaloniaObjectExtensions)
Bind(T)(AvaloniaProperty(T), IObservable(T), BindingPriority)	Binds an AvaloniaProperty to an observable. (Defined by AvaloniaObjectExtensions)
BindClass(String, IBinding, Object)	(Defined by StyledElementExtensions)
CalculateDistanceFromAncestor(Visual)	Calculates the distance from a visual's ancestor. (Defined by VisualExtensions)
FindAncestorOfType(T)(Boolean)	Finds first ancestor of given type. (Defined by VisualExtensions)
FindCommonVisualAncestor(Visual)	Tries to get the first common ancestor of two visuals. (Defined by VisualExtensions)
FindDescendantOfType(T)(Boolean)	Finds first descendant of given type. (Defined by VisualExtensions)
GetBaseValue(AvaloniaProperty)	Gets an AvaloniaProperty base value. (Defined by AvaloniaObjectExtensions)
GetBaseValue(T)(AvaloniaProperty(T))	Gets an AvaloniaProperty base value. (Defined by AvaloniaObjectExtensions)
GetBindingObservable(AvaloniaProperty)	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetBindingObservable(T)(AvaloniaProperty(T))	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetBindingObservable(TResult)(AvaloniaProperty, Func(Object, TResult))	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetBindingObservable(TSource, TResult)(AvaloniaProperty(TSource), Func(TSource, TResult))	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetBindingSubject(AvaloniaProperty, BindingPriority)	Gets a subject for a AvaloniaProperty. (Defined by AvaloniaObjectReactiveExtensions)
GetBindingSubject(T)(AvaloniaProperty(T), BindingPriority)	Gets a subject for a AvaloniaProperty. (Defined by AvaloniaObjectReactiveExtensions)
GetDiagnostic(AvaloniaProperty)	Gets a diagnostic for a AvaloniaProperty on a AvaloniaObject. (Defined by AvaloniaObjectExtensions)
GetObservable(AvaloniaProperty)	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetObservable(T)(AvaloniaProperty(T))	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetObservable(TResult)(AvaloniaProperty, Func(Object, TResult))	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetObservable(TSource, TResult)(AvaloniaProperty(TSource), Func(TSource, TResult))	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetPropertyChangedObservable(AvaloniaProperty)	Gets an observable that listens for property changed events for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetSelfAndVisualAncestors()	Enumerates an Visual and its ancestors in the visual tree. (Defined by VisualExtensions)
GetSelfAndVisualDescendants()	Enumerates an Visual and its descendants in the visual tree. (Defined by VisualExtensions)
GetSubject(AvaloniaProperty, BindingPriority)	Gets a subject for an AvaloniaProperty. (Defined by AvaloniaObjectReactiveExtensions)
GetSubject(T)(AvaloniaProperty(T), BindingPriority)	Gets a subject for an AvaloniaProperty. (Defined by AvaloniaObjectReactiveExtensions)
GetTransformedBounds()	(Defined by VisualExtensions)
GetValue(T)(AvaloniaProperty(T))	Gets a AvaloniaProperty value. (Defined by AvaloniaObjectExtensions)
GetValueStoreDiagnostic()	Gets a value store diagnostics for a AvaloniaObject. (Defined by AvaloniaObjectExtensions)
GetVisualAncestors()	Enumerates the ancestors of an Visual in the visual tree. (Defined by VisualExtensions)
GetVisualAt(Point)	Gets the first visual in the visual tree whose bounds contain a point. (Defined by VisualExtensions)
GetVisualAt(Point, Func(Visual, Boolean))	Gets the first visual in the visual tree whose bounds contain a point. (Defined by VisualExtensions)
GetVisualChildren()	Enumerates the children of an Visual in the visual tree. (Defined by VisualExtensions)
GetVisualDescendants()	Enumerates the descendants of an Visual in the visual tree. (Defined by VisualExtensions)
GetVisualParent()	Gets the visual parent of an Visual. (Defined by VisualExtensions)
GetVisualParent(T)()	Gets the visual parent of an Visual. (Defined by VisualExtensions)
GetVisualRoot()	Gets the root visual for an Visual. (Defined by VisualExtensions)
GetVisualsAt(Point)	Enumerates the visible visuals in the visual tree whose bounds contain a point. (Defined by VisualExtensions)
GetVisualsAt(Point, Func(Visual, Boolean))	Enumerates the visuals in the visual tree whose bounds contain a point. (Defined by VisualExtensions)
IsAttachedToVisualTree()	Returns a value indicating whether this control is attached to a visual root. (Defined by VisualExtensions)
IsVisualAncestorOf(Visual)	Tests whether an Visual is an ancestor of another visual. (Defined by VisualExtensions)
PointToClient(PixelPoint)	Converts a point from screen to client coordinates. (Defined by VisualExtensions)
PointToScreen(Point)	Converts a point from client to screen coordinates. (Defined by VisualExtensions)
TransformToVisual(Visual)	Returns a transform that transforms the visual's coordinates into the coordinates of the specified to. (Defined by VisualExtensions)
TranslatePoint(Point, Visual)	Translates a point relative to this visual to coordinates that are relative to the specified visual. (Defined by VisualExtensions)

See Also

Reference

Avalonia Namespace