Frame Class

Definition

Namespace:

Microsoft.Maui.Controls

Assembly:

Microsoft.Maui.Controls.dll

An element containing a single child, with some framing options.

public ref class Frame : Microsoft::Maui::Controls::ContentView, Microsoft::Maui::Controls::IBorderElement, Microsoft::Maui::Controls::IElementConfiguration<Microsoft::Maui::Controls::Frame ^>

[Microsoft.Maui.Controls.ContentProperty("Content")]
public class Frame : Microsoft.Maui.Controls.ContentView, Microsoft.Maui.Controls.IBorderElement, Microsoft.Maui.Controls.IElementConfiguration<Microsoft.Maui.Controls.Frame>

[<Microsoft.Maui.Controls.ContentProperty("Content")>]
type Frame = class
    inherit ContentView
    interface IElementConfiguration<Frame>
    interface IPaddingElement
    interface IBorderElement
    interface IView
    interface IElement
    interface ITransform

Public Class Frame
Inherits ContentView
Implements IBorderElement, IElementConfiguration(Of Frame)

Inheritance

Object

BindableObject

Element

NavigableElement

VisualElement

View

Layout

TemplatedView

ContentView

Frame

Attributes

ContentPropertyAttribute

Implements

IBorderElement IElementConfiguration<Frame> IPaddingElement IElement ITransform IView

Remarks

Frame have a default Padding of 20.

The following example shows how to construct a new Frame with an Outline color.

MainPage = new ContentPage () {
  Content = new Frame {
    Content = new Label { Text = "I'm Framous!" },
    BorderColor = Color.Silver,
    VerticalOptions = LayoutOptions.CenterAndExpand,
    HorizontalOptions = LayoutOptions.Center
  }
};

Constructors

Frame()

Initializes a new instance of the Frame class.

Fields

BorderColorProperty	Backing store for the BorderColor property.
CornerRadiusProperty	Backing store for the CornerRadius property.
HasShadowProperty	Identifies the HasShadow bindable property.
propertyMapper	(Inherited from View)

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. (Inherited from VisualElement)
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. (Inherited from VisualElement)
AutomationId	Gets or sets a value that allows the automation framework to find and interact with this element. (Inherited from Element)
Background	(Inherited from VisualElement)
BackgroundColor	Gets or sets the color which will fill the background of a VisualElement. This is a bindable property. (Inherited from VisualElement)
Batched	For internal use by the Microsoft.Maui.Controls platform. (Inherited from VisualElement)
Behaviors	Gets the list of Behaviors associated to this element. This is a bindable property. (Inherited from VisualElement)
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)
BorderColor	Gets or sets the border color for the frame.
Bounds	Gets the bounds of the element. (Inherited from VisualElement)
CascadeInputTransparent	(Inherited from Layout)
Children	(Inherited from Layout)
class	(Inherited from NavigableElement)
ClassId	Gets or sets a value used to identify a collection of semantically similar elements. (Inherited from Element)
Clip	(Inherited from VisualElement)
Content	Gets or sets the content of the ContentView. (Inherited from ContentView)
ControlTemplate	Gets or sets the control template that is used to display content. (Inherited from TemplatedView)
CornerRadius	Gets or sets the corner radius of the frame.
DesiredSize	(Inherited from VisualElement)
DisableLayout	For internal use by the Microsoft.Maui.Controls platform. (Inherited from VisualElement)
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. (Inherited from VisualElement)
Frame	(Inherited from VisualElement)
GestureController	(Inherited from View)
GestureRecognizers	The collection of gesture recognizers associated with this view. (Inherited from View)
Handler	(Inherited from VisualElement)
HasShadow	Gets or sets a flag indicating if the Frame has a shadow displayed. This is a bindable property.
Height	Gets the current rendered height of this element. This is a read-only bindable property. (Inherited from VisualElement)
HeightRequest	Gets or sets the desired height override of this element. (Inherited from VisualElement)
HorizontalOptions	Gets or sets the LayoutOptions that define how the element gets laid in a layout cycle. This is a bindable property. (Inherited from View)
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. (Inherited from VisualElement)
IsClippedToBounds	(Inherited from Layout)
IsEnabled	Gets or sets a value indicating whether this element is enabled in the user interface. This is a bindable property. (Inherited from VisualElement)
IsFocused	Gets a value indicating whether this element is focused currently. This is a bindable property. (Inherited from VisualElement)
IsInPlatformLayout	(Inherited from VisualElement)
IsLoaded	Indicates if a VisualElement is connected to the main object tree. (Inherited from VisualElement)
IsPlatformEnabled	For internal use by the Microsoft.Maui.Controls platform. (Inherited from VisualElement)
IsPlatformStateConsistent	(Inherited from VisualElement)
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. (Inherited from VisualElement)
LogicalChildren	Obsolete. For internal use by the Microsoft.Maui.Controls platform. (Inherited from Element)
Margin	Gets or sets the margin for the view. (Inherited from View)
MaximumHeightRequest	(Inherited from VisualElement)
MaximumWidthRequest	(Inherited from VisualElement)
MinimumHeightRequest	Gets or sets a value which overrides the minimum height the element will request during layout. (Inherited from VisualElement)
MinimumWidthRequest	Gets or sets a value which overrides the minimum width the element will request during layout. (Inherited from VisualElement)
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. (Inherited from VisualElement)
Padding	(Inherited from Layout)
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. (Inherited from VisualElement)
Rotation	Gets or sets the rotation (in degrees) about the Z-axis (affine rotation) when the element is rendered. (Inherited from VisualElement)
RotationX	Gets or sets the rotation (in degrees) about the X-axis (perspective rotation) when the element is rendered. (Inherited from VisualElement)
RotationY	Gets or sets the rotation (in degrees) about the Y-axis (perspective rotation) when the element is rendered. (Inherited from VisualElement)
Scale	Gets or sets the scale factor applied to the element. (Inherited from VisualElement)
ScaleX	Gets or sets a scale value to apply to the X direction. (Inherited from VisualElement)
ScaleY	Gets or sets a scale value to apply to the Y direction. (Inherited from VisualElement)
Shadow	(Inherited from VisualElement)
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. (Inherited from VisualElement)
TranslationY	Gets or sets the Y translation delta of the element. (Inherited from VisualElement)
Triggers	Gets the list of Trigger associated to this element. This is a bindable property. (Inherited from VisualElement)
VerticalOptions	Gets or sets the LayoutOptions that define how the element gets laid in a layout cycle. This is a bindable property. (Inherited from View)
Visual	(Inherited from VisualElement)
Width	Gets the current rendered width of this element. This is a read-only bindable property. (Inherited from VisualElement)
WidthRequest	Gets or sets the desired width override of this element. (Inherited from VisualElement)
Window	(Inherited from VisualElement)
X	Gets the current X position of this element. This is a read-only bindable property. (Inherited from VisualElement)
Y	Gets the current Y position of this element. This is a read-only bindable property. (Inherited from VisualElement)
ZIndex	(Inherited from VisualElement)

Methods

ApplyBindings()	(Inherited from BindableObject)
Arrange(Rect)	(Inherited from VisualElement)
ArrangeOverride(Rect)	(Inherited from TemplatedView)
BatchBegin()	Signals the start of a batch of changes to the elements properties. (Inherited from VisualElement)
BatchCommit()	Signals the end of a batch of commands to the element and that those commands should now be committed. (Inherited from VisualElement)
ChangeVisualState()	(Inherited from VisualElement)
ClearValue(BindableProperty)	Clears any value set by SetValue for property. (Inherited from BindableObject)
ClearValue(BindablePropertyKey)	Clears any value set by SetValue for the property that is identified by propertyKey. (Inherited from BindableObject)
CoerceValue(BindableProperty)	(Inherited from BindableObject)
CoerceValue(BindablePropertyKey)	(Inherited from BindableObject)
CrossPlatformArrange(Rect)	(Inherited from Layout)
CrossPlatformMeasure(Double, Double)	(Inherited from Layout)
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. (Inherited from VisualElement)
ForceLayout()	(Inherited from Layout)
GetChildElements(Point)	Returns the child elements that are visually beneath the specified point. (Inherited from View)
GetRendererOverrides<T>()	(Inherited from View)
GetTemplateChild(String)	(Inherited from TemplatedView)
GetValue(BindableProperty)	Returns the value that is contained in the BindableProperty. (Inherited from BindableObject)
InvalidateLayout()	(Inherited from Layout)
InvalidateMeasure()	(Inherited from VisualElement)
InvalidateMeasureNonVirtual(InvalidationTrigger)	For internal use by the Microsoft.Maui.Controls platform. (Inherited from VisualElement)
InvalidateMeasureOverride()	(Inherited from Layout)
IsSet(BindableProperty)	Returns true if the target property exists and has been set. (Inherited from BindableObject)
Layout(Rect)	Updates the bounds of the element during the layout cycle. (Inherited from VisualElement)
LayoutChildren(Double, Double, Double, Double)	(Inherited from TemplatedView)
LowerChild(View)	(Inherited from Layout)
Measure(Double, Double, MeasureFlags)	(Inherited from Layout)
MeasureOverride(Double, Double)	(Inherited from TemplatedView)
On<T>()	Returns the platform-specific instance of this TElement, on which a platform-specific method may be called.
OnApplyTemplate()	(Inherited from TemplatedView)
OnBindingContextChanged()	(Inherited from ContentView)
OnChildAdded(Element)	(Inherited from VisualElement)
OnChildMeasureInvalidated()	(Inherited from Layout)
OnChildMeasureInvalidated(Object, EventArgs)	(Inherited from Layout)
OnChildRemoved(Element, Int32)	(Inherited from TemplatedView)
OnChildrenReordered()	(Inherited from VisualElement)
OnHandlerChanged()	(Inherited from Element)
OnHandlerChanging(HandlerChangingEventArgs)	(Inherited from Element)
OnMeasure(Double, Double)	(Inherited from TemplatedView)
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)	(Inherited from Layout)
PlatformSizeChanged()	(Inherited from VisualElement)
RaiseChild(View)	(Inherited from Layout)
RemoveBinding(BindableProperty)	Removes a previously set binding. (Inherited from BindableObject)
RemoveDynamicResource(BindableProperty)	Removes a previously set dynamic resource (Inherited from Element)
ResolveControlTemplate()	(Inherited from TemplatedView)
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)
ShouldInvalidateOnChildAdded(View)	(Inherited from Layout)
ShouldInvalidateOnChildRemoved(View)	(Inherited from Layout)
SizeAllocated(Double, Double)	(Inherited from VisualElement)
UnapplyBindings()	(Inherited from BindableObject)
Unfocus()	Unsets focus to this element. (Inherited from VisualElement)
UpdateChildrenLayout()	(Inherited from Layout)

Events

BatchCommitted	(Inherited from VisualElement)
BindingContextChanged	(Inherited from BindableObject)
ChildAdded	(Inherited from Element)
ChildRemoved	(Inherited from Element)
ChildrenReordered	(Inherited from VisualElement)
DescendantAdded	(Inherited from Element)
DescendantRemoved	(Inherited from Element)
FocusChangeRequested	(Inherited from VisualElement)
Focused	(Inherited from VisualElement)
HandlerChanged	(Inherited from Element)
HandlerChanging	(Inherited from Element)
LayoutChanged	(Inherited from Layout)
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. (Inherited from VisualElement)
MeasureInvalidated	(Inherited from VisualElement)
ParentChanged	(Inherited from Element)
ParentChanging	(Inherited from Element)
PropertyChanged	(Inherited from BindableObject)
PropertyChanging	(Inherited from BindableObject)
SizeChanged	(Inherited from VisualElement)
Unfocused	(Inherited from VisualElement)
Unloaded	Occurs when this VisualElement is no longer connected to the main object tree. (Inherited from VisualElement)

Explicit Interface Implementations

IBorderElement.BorderColorDefaultValue
IBorderElement.BorderWidth
IBorderElement.BorderWidthDefaultValue
IBorderElement.CornerRadius
IBorderElement.CornerRadiusDefaultValue
IBorderElement.IsBackgroundColorSet()
IBorderElement.IsBackgroundSet()
IBorderElement.IsBorderColorSet()
IBorderElement.IsBorderWidthSet()
IBorderElement.IsCornerRadiusSet()
IBorderElement.OnBorderColorPropertyChanged(Color, Color)
IContentView.Content	(Inherited from ContentView)
IContentView.CrossPlatformArrange(Rect)	(Inherited from TemplatedView)
IContentView.CrossPlatformMeasure(Double, Double)	(Inherited from TemplatedView)
IContentView.PresentedContent	(Inherited from ContentView)
IContextFlyoutElement.ContextFlyout	(Inherited from Element)
IDynamicResourceHandler.SetDynamicResource(BindableProperty, String)	(Inherited from BindableObject)
IEffectControlProvider.RegisterEffect(Effect)	(Inherited from Element)
IElement.Handler	(Inherited from VisualElement)
IElement.Parent	(Inherited from Element)
IElementController.Descendants()	(Inherited from Element)
IElementController.LogicalChildren	(Inherited from Element)
IElementController.SetValueFromRenderer(BindableProperty, Object)	(Inherited from Element)
IGestureController.CompositeGestureRecognizers	(Inherited from View)
IHotReloadableView.Reload()	(Inherited from View)
IHotReloadableView.ReloadHandler	(Inherited from View)
IHotReloadableView.TransferState(IView)	(Inherited from View)
INameScope.RegisterName(String, Object)	(Inherited from Element)
INameScope.UnregisterName(String)	(Inherited from Element)
IPaddingElement.OnPaddingPropertyChanged(Thickness, Thickness)	(Inherited from Layout)
IPaddingElement.PaddingDefaultValueCreator()
IPropertyMapperView.GetPropertyMapperOverrides()	(Inherited from View)
IReplaceableView.ReplacedView	(Inherited from View)
IToolTipElement.ToolTip	(Inherited from Element)
IView.Arrange(Rect)	(Inherited from VisualElement)
IView.Background	(Inherited from VisualElement)
IView.Clip	(Inherited from VisualElement)
IView.FlowDirection	(Inherited from VisualElement)
IView.Height	(Inherited from VisualElement)
IView.HorizontalLayoutAlignment	(Inherited from View)
IView.InvalidateArrange()	(Inherited from VisualElement)
IView.InvalidateMeasure()	(Inherited from VisualElement)
IView.IsFocused	(Inherited from VisualElement)
IView.Margin	(Inherited from View)
IView.MaximumHeight	(Inherited from VisualElement)
IView.MaximumWidth	(Inherited from VisualElement)
IView.Measure(Double, Double)	(Inherited from Layout)
IView.MinimumHeight	(Inherited from VisualElement)
IView.MinimumWidth	(Inherited from VisualElement)
IView.Semantics	(Inherited from VisualElement)
IView.Shadow
IView.VerticalLayoutAlignment	(Inherited from View)
IView.Visibility	(Inherited from VisualElement)
IView.Width	(Inherited from VisualElement)
IVisualElementController.EffectiveFlowDirection	(Inherited from VisualElement)
IVisualElementController.InvalidateMeasure(InvalidationTrigger)	(Inherited from VisualElement)
IVisualTreeElement.GetVisualChildren()	(Inherited from Layout)
IVisualTreeElement.GetVisualParent()	(Inherited from Element)

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 handle is running.
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. LayoutTo, TranslateTo, ScaleTo, etc.) on the view element.
FadeTo(VisualElement, Double, UInt32, Easing)	Returns a task that performs the fade that is described by the opacity, length, and easing parameters.
LayoutTo(VisualElement, Rect, UInt32, Easing)	Returns a task that eases the bounds of the VisualElement that is specified by the view to the rectangle that is specified by the bounds parameter.
RelRotateTo(VisualElement, Double, UInt32, Easing)	Rotates the VisualElement that is specified by view from its current rotation by drotation.
RelScaleTo(VisualElement, Double, UInt32, Easing)	Returns a task that scales the VisualElement that is specified by view from its current scale to dscale.
RotateTo(VisualElement, Double, UInt32, Easing)	Returns a task that rotates the VisualElement that is specified by view that is described by the rotation, length, and easing parameters.
RotateXTo(VisualElement, Double, UInt32, Easing)	Returns a task that skews the X axis of the the VisualElement that is specified by view by rotation, taking time length and using easing.
RotateYTo(VisualElement, Double, UInt32, Easing)	Returns a task that skews the Y axis of the the VisualElement that is specified by view by rotation, taking time length and using easing.
ScaleTo(VisualElement, Double, UInt32, Easing)	Returns a task that scales the VisualElement that is specified by view to the absolute scale factor scale.
ScaleXTo(VisualElement, Double, UInt32, Easing)	Returns a task that scales the X axis of the the VisualElement that is specified by view to the absolute scale factor scale.
ScaleYTo(VisualElement, Double, UInt32, Easing)	Returns a task that scales the Y axis of the the VisualElement that is specified by view to the absolute scale factor scale.
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 true if element has one or more visual state groups associated with it. Otherwise, returns false.
CheckHandlers(IView)
ArrangeContent(IContentView, Rect)
ComputeDesiredSize(IView, Double, Double)
ComputeFrame(IView, Rect)
MeasureContent(IContentView, Thickness, Double, Double)
MeasureContent(IContentView, Double, Double)
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.