VisualElement Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A Element that occupies an area on the screen, has a visual appearance, and can obtain touch input.
public ref class VisualElement : Microsoft::Maui::Controls::NavigableElement, Microsoft::Maui::Controls::IAnimatable, Microsoft::Maui::Controls::IVisualElementController, Microsoft::Maui::IView
public class VisualElement : Microsoft.Maui.Controls.NavigableElement, Microsoft.Maui.Controls.IAnimatable, Microsoft.Maui.Controls.IVisualElementController, Microsoft.Maui.IView
type VisualElement = class
inherit NavigableElement
interface IView
interface IElement
interface ITransform
interface IAnimatable
interface IVisualElementController
interface IElementController
Public Class VisualElement
Inherits NavigableElement
Implements IAnimatable, IView, IVisualElementController
- Inheritance
- Derived
- Implements
Remarks
The base class for most Microsoft.Maui.Controls on-screen elements. Provides most properties, events, and methods for presenting an item on screen.
Constructors
| VisualElement() |
Fields
| AnchorXProperty |
Identifies the AnchorX bindable property. |
| AnchorYProperty |
Identifies the AnchorY bindable property. |
| BackgroundColorProperty |
Identifies the BackgroundColor bindable property. |
| BackgroundProperty | |
| BehaviorsProperty |
Identifies the Behaviors bindable property. |
| ClipProperty | |
| ControlsVisualElementMapper | |
| FlowDirectionProperty |
Backing store for the FlowDirection property. |
| HeightProperty |
Identifies the Height bindable property. |
| HeightRequestProperty |
Backing store for the HeightRequest property. |
| InputTransparentProperty |
Identifies the InputTransparent bindable property. |
| IsEnabledProperty |
Identifies the IsEnabled bindable property. |
| IsFocusedProperty |
Identifies the IsFocused bindable property. |
| IsFocusedPropertyKey |
For internal use by the Microsoft.Maui.Controls platform. |
| IsVisibleProperty |
Identifies the IsVisible bindable property. |
| MaximumHeightRequestProperty | |
| MaximumWidthRequestProperty | |
| MinimumHeightRequestProperty |
Backing store for the MinimumHeightRequest property. |
| MinimumWidthRequestProperty |
Backing store for the MinimumWidthRequest property. |
| NavigationProperty | |
| OpacityProperty |
Identifies the Opacity bindable property. |
| RotationProperty |
Identifies the Rotation bindable property. |
| RotationXProperty |
Identifies the RotationX bindable property. |
| RotationYProperty |
Identifies the RotationY bindable property. |
| ScaleProperty |
Identifies the Scale bindable property. |
| ScaleXProperty |
Backing store for the ScaleX property. |
| ScaleYProperty |
Backing store for the ScaleY property. |
| ShadowProperty | |
| StyleProperty | |
| TranslationXProperty |
Identifies the TranslationX bindable property. |
| TranslationYProperty |
Identifies the TranslationY bindable property. |
| TriggersProperty |
Identifies the Triggers bindable property. |
| VisualProperty |
The backing store for the Visual field. |
| WidthProperty |
Identifies the Width bindable property. |
| WidthRequestProperty |
Backing store for the WidthRequest property. |
| WindowProperty | |
| XProperty |
Identifies the X bindable property. |
| YProperty |
Identifies the Y bindable property. |
| ZIndexProperty | |
Properties
| AnchorX |
Gets or sets the X component of the center point for any transform, relative to the bounds of the element. This is a bindable property. |
| AnchorY |
Gets or sets the Y component of the center point for any transform, relative to the bounds of the element. This is a bindable property. |
| AutomationId |
Gets or sets a value that allows the automation framework to find and interact with this element. (Inherited from Element) |
| Background | |
| BackgroundColor |
Gets or sets the color which will fill the background of a VisualElement. This is a bindable property. |
| Batched |
For internal use by the Microsoft.Maui.Controls platform. |
| Behaviors |
Gets the list of Behaviors associated to this element. This is a bindable property. |
| BindingContext |
Gets or sets object that contains the properties that will be targeted by the bound properties that belong to this BindableObject. (Inherited from BindableObject) |
| Bounds |
Gets the bounds of the element. |
| class | (Inherited from NavigableElement) |
| ClassId |
Gets or sets a value used to identify a collection of semantically similar elements. (Inherited from Element) |
| Clip | |
| DesiredSize | |
| DisableLayout |
For internal use by the Microsoft.Maui.Controls platform. |
| Dispatcher | (Inherited from BindableObject) |
| EffectControlProvider |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from Element) |
| Effects |
A list of the effects that are applied to this item. (Inherited from Element) |
| FlowDirection |
Gets or sets the layout flow direction. |
| Frame | |
| Handler | |
| Height |
Gets the current rendered height of this element. This is a read-only bindable property. |
| HeightRequest |
Gets or sets the desired height override of this element. |
| Id |
Gets a value that can be used to uniquely identify an element through the run of an application. (Inherited from Element) |
| InputTransparent |
Gets or sets a value indicating whether this element should be involved in the user interaction cycle. This is a bindable property. |
| IsEnabled |
Gets or sets a value indicating whether this element is enabled in the user interface. This is a bindable property. |
| IsFocused |
Gets a value indicating whether this element is focused currently. This is a bindable property. |
| IsInPlatformLayout | |
| IsLoaded |
Indicates if a VisualElement is connected to the main object tree. |
| IsPlatformEnabled |
For internal use by the Microsoft.Maui.Controls platform. |
| IsPlatformStateConsistent | |
| IsVisible |
Gets or sets a value that determines whether this elements should be part of the visual tree or not. This is a bindable property. |
| LogicalChildren |
Obsolete.
For internal use by the Microsoft.Maui.Controls platform. (Inherited from Element) |
| MaximumHeightRequest | |
| MaximumWidthRequest | |
| MinimumHeightRequest |
Gets or sets a value which overrides the minimum height the element will request during layout. |
| MinimumWidthRequest |
Gets or sets a value which overrides the minimum width the element will request during layout. |
| Navigation | (Inherited from NavigableElement) |
| NavigationProxy | (Inherited from NavigableElement) |
| Opacity |
Gets or sets the opacity value applied to the element when it is rendered. This is a bindable property. |
| Parent |
Gets or sets the parent element of the element. (Inherited from Element) |
| RealParent |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from Element) |
| Resources |
Gets or sets the local resource dictionary. |
| Rotation |
Gets or sets the rotation (in degrees) about the Z-axis (affine rotation) when the element is rendered. |
| RotationX |
Gets or sets the rotation (in degrees) about the X-axis (perspective rotation) when the element is rendered. |
| RotationY |
Gets or sets the rotation (in degrees) about the Y-axis (perspective rotation) when the element is rendered. |
| Scale |
Gets or sets the scale factor applied to the element. |
| ScaleX |
Gets or sets a scale value to apply to the X direction. |
| ScaleY |
Gets or sets a scale value to apply to the Y direction. |
| Shadow | |
| Style | (Inherited from NavigableElement) |
| StyleClass | (Inherited from NavigableElement) |
| StyleId |
Gets or sets a user defined value to uniquely identify the element. (Inherited from Element) |
| TranslationX |
Gets or sets the X translation delta of the element. |
| TranslationY |
Gets or sets the Y translation delta of the element. |
| Triggers |
Gets the list of Trigger associated to this element. This is a bindable property. |
| Visual | |
| Width |
Gets the current rendered width of this element. This is a read-only bindable property. |
| WidthRequest |
Gets or sets the desired width override of this element. |
| Window | |
| X |
Gets the current X position of this element. This is a read-only bindable property. |
| Y |
Gets the current Y position of this element. This is a read-only bindable property. |
| ZIndex | |
Methods
| ApplyBindings() | (Inherited from BindableObject) |
| Arrange(Rect) | |
| ArrangeOverride(Rect) | |
| BatchBegin() |
Signals the start of a batch of changes to the elements properties. |
| BatchCommit() |
Signals the end of a batch of commands to the element and that those commands should now be committed. |
| ChangeVisualState() | |
| ClearValue(BindableProperty) |
Clears any value set by SetValue for |
| ClearValue(BindablePropertyKey) |
Clears any value set by SetValue for the property that is identified by |
| CoerceValue(BindableProperty) | (Inherited from BindableObject) |
| CoerceValue(BindablePropertyKey) | (Inherited from BindableObject) |
| EffectIsAttached(String) |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from Element) |
| FindByName(String) |
Returns the element that has the specified name. (Inherited from Element) |
| Focus() |
Attemps to set focus to this element. |
| GetValue(BindableProperty) |
Returns the value that is contained in the BindableProperty. (Inherited from BindableObject) |
| InvalidateMeasure() | |
| InvalidateMeasureNonVirtual(InvalidationTrigger) |
For internal use by the Microsoft.Maui.Controls platform. |
| InvalidateMeasureOverride() | |
| IsSet(BindableProperty) |
Returns |
| Layout(Rect) |
Updates the bounds of the element during the layout cycle. |
| MapBackgroundColor(IViewHandler, IView) | |
| MapBackgroundImageSource(IViewHandler, IView) | |
| Measure(Double, Double, MeasureFlags) |
Returns the minimum size that a visual element needs in order to be displayed on the device. |
| MeasureOverride(Double, Double) | |
| OnBindingContextChanged() | |
| OnChildAdded(Element) | |
| OnChildRemoved(Element, Int32) | |
| OnChildrenReordered() | |
| OnHandlerChanged() | (Inherited from Element) |
| OnHandlerChanging(HandlerChangingEventArgs) | (Inherited from Element) |
| OnMeasure(Double, Double) | |
| OnParentChanged() | (Inherited from Element) |
| OnParentChanging(ParentChangingEventArgs) | (Inherited from Element) |
| OnParentSet() | (Inherited from NavigableElement) |
| OnPropertyChanged(String) | (Inherited from Element) |
| OnPropertyChanging(String) | (Inherited from BindableObject) |
| OnSizeAllocated(Double, Double) | |
| PlatformSizeChanged() | |
| RemoveBinding(BindableProperty) |
Removes a previously set binding. (Inherited from BindableObject) |
| RemoveDynamicResource(BindableProperty) |
Removes a previously set dynamic resource (Inherited from Element) |
| SetBinding(BindableProperty, BindingBase) |
Assigns a binding to a property. (Inherited from BindableObject) |
| SetDynamicResource(BindableProperty, String) |
Sets the BindableProperty property of this element to be updated via the DynamicResource with the provided key. (Inherited from Element) |
| SetValue(BindableProperty, Object) |
Sets the value of the specified property. (Inherited from BindableObject) |
| SetValue(BindablePropertyKey, Object) |
Sets the value of the propertyKey. (Inherited from BindableObject) |
| SetValueCore(BindableProperty, Object, SetValueFlags) |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from BindableObject) |
| SetValueFromRenderer(BindableProperty, Object) |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from Element) |
| SetValueFromRenderer(BindablePropertyKey, Object) |
For internal use by the Microsoft.Maui.Controls platform. (Inherited from Element) |
| SizeAllocated(Double, Double) | |
| UnapplyBindings() | (Inherited from BindableObject) |
| Unfocus() |
Unsets focus to this element. |
Events
| BatchCommitted | |
| BindingContextChanged | (Inherited from BindableObject) |
| ChildAdded | (Inherited from Element) |
| ChildRemoved | (Inherited from Element) |
| ChildrenReordered | |
| DescendantAdded | (Inherited from Element) |
| DescendantRemoved | (Inherited from Element) |
| FocusChangeRequested | |
| Focused | |
| HandlerChanged | (Inherited from Element) |
| HandlerChanging | (Inherited from Element) |
| Loaded |
Occurs when a VisualElement has been constructed and added to the object tree. This event may occur before the VisualElement has been measured so should not be relied on for size information. |
| MeasureInvalidated | |
| ParentChanged | (Inherited from Element) |
| ParentChanging | (Inherited from Element) |
| PropertyChanged | (Inherited from BindableObject) |
| PropertyChanging | (Inherited from BindableObject) |
| SizeChanged | |
| Unfocused | |
| Unloaded |
Occurs when this VisualElement is no longer connected to the main object tree. |
Explicit Interface Implementations
Extension Methods
| AbortAnimation(IAnimatable, String) |
Stops the animation. |
| Animate(IAnimatable, String, Animation, UInt32, UInt32, Easing, Action<Double,Boolean>, Func<Boolean>) |
Sets the specified parameters and starts the animation. |
| Animate(IAnimatable, String, Action<Double>, Double, Double, UInt32, UInt32, Easing, Action<Double,Boolean>, Func<Boolean>) |
Sets the specified parameters and starts the animation. |
| Animate(IAnimatable, String, Action<Double>, UInt32, UInt32, Easing, Action<Double,Boolean>, Func<Boolean>) |
Sets the specified parameters and starts the animation. |
| Animate<T>(IAnimatable, String, Func<Double,T>, Action<T>, UInt32, UInt32, Easing, Action<T,Boolean>, Func<Boolean>, IAnimationManager) |
Sets the specified parameters and starts the animation. |
| AnimateKinetic(IAnimatable, String, Func<Double,Double,Boolean>, Double, Double, Action, IAnimationManager) |
Sets the specified parameters and starts the kinetic animation. |
| AnimationIsRunning(IAnimatable, String) |
Returns a Boolean value that indicates whether or not the animation that is specified by |
| Batch(IAnimatable) | |
| GetPropertyIfSet<T>(BindableObject, BindableProperty, T) | |
| SetAppTheme<T>(BindableObject, BindableProperty, T, T) | |
| SetAppThemeColor(BindableObject, BindableProperty, Color, Color) | |
| SetBinding(BindableObject, BindableProperty, String, BindingMode, IValueConverter, String) |
Creates and applies a binding to a property. |
| FindByName<T>(Element, String) | |
| CancelAnimations(VisualElement) |
Aborts all animations (e.g. |
| FadeTo(VisualElement, Double, UInt32, Easing) |
Returns a task that performs the fade that is described by the |
| LayoutTo(VisualElement, Rect, UInt32, Easing) |
view
to the rectangle that is specified by the bounds parameter. |
| RelRotateTo(VisualElement, Double, UInt32, Easing) |
Rotates the VisualElement that is specified by |
| RelScaleTo(VisualElement, Double, UInt32, Easing) |
Returns a task that scales the VisualElement that is specified by |
| RotateTo(VisualElement, Double, UInt32, Easing) |
Returns a task that rotates the VisualElement that is specified by |
| RotateXTo(VisualElement, Double, UInt32, Easing) |
Returns a task that skews the X axis of the the VisualElement that is specified by |
| RotateYTo(VisualElement, Double, UInt32, Easing) |
Returns a task that skews the Y axis of the the VisualElement that is specified by |
| ScaleTo(VisualElement, Double, UInt32, Easing) |
Returns a task that scales the VisualElement that is specified by |
| ScaleXTo(VisualElement, Double, UInt32, Easing) |
Returns a task that scales the X axis of the the VisualElement that is specified by |
| ScaleYTo(VisualElement, Double, UInt32, Easing) |
Returns a task that scales the Y axis of the the VisualElement that is specified by |
| TranslateTo(VisualElement, Double, Double, UInt32, Easing) |
Animates an elements TranslationX and TranslationY properties from their current values to the new values. This ensures that the input layout is in the same position as the visual layout. |
| HasVisualStateGroups(VisualElement) |
Returns |
| CheckHandlers(IView) | |
| GetEffectiveFlowDirection(IView) | |
| ComputeDesiredSize(IView, Double, Double) | |
| ComputeFrame(IView, Rect) | |
| ShouldArrangeLeftToRight(IView) | |
| ToHandler(IElement, IMauiContext) | |
| ToPlatform(IElement, IMauiContext) | |
| ToHandler(IView, IMauiContext) | |
| SetSemanticFocus(IView) | |
| CaptureAsync(IView) | |
| GetVisualElementWindow(IVisualTreeElement) |
Gets the Window containing the Visual Tree Element, if the element is contained within one. |
| GetVisualTreeDescendants(IVisualTreeElement) |
Gets the entire hierarchy of descendants as a list of children for a given Visual Tree Element. |
| GetVisualTreeElements(IVisualTreeElement, Point) |
Gets list of a Visual Tree Element's children based off of a given Point. |
| GetVisualTreeElements(IVisualTreeElement, Rect) |
Gets list of a Visual Tree Elements children based off of a rectangle. |
| GetVisualTreeElements(IVisualTreeElement, Double, Double) |
Gets list of a Visual Tree Elements children based off of a given x, y point. |
| GetVisualTreeElements(IVisualTreeElement, Double, Double, Double, Double) |
Gets list of a Visual Tree Elements children based off of a rectangle defined by its coordinates which are specified in platform units, not pixels. |