Avalonia API Reference
Visual Class
Base class for controls that provides rendering and related visual properties.
Definition
Namespace: Avalonia
Assembly: Avalonia.Base (in Avalonia.Base.dll) Version: 11.3.999
Assembly: Avalonia.Base (in Avalonia.Base.dll) Version: 11.3.999
C#
[UsableDuringInitializationAttribute]
public class Visual : StyledElementVB
<UsableDuringInitializationAttribute>
Public Class Visual
Inherits StyledElementF#
[<UsableDuringInitializationAttribute>]
type Visual =
class
inherit StyledElement
end- Inheritance
- Object AvaloniaObject Animatable StyledElement Visual
- Derived
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.
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. |
| ItemAvaloniaProperty |
Gets or sets the value of a AvaloniaProperty.
(Inherited from AvaloniaObject) |
| ItemIndexerDescriptor |
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
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. |