TabbedPage Class

Definition

MultiPage<T> that displays an array of tabs across the top of the screen, each of which loads content onto the screen.

public ref class TabbedPage : Microsoft::Maui::Controls::MultiPage<Microsoft::Maui::Controls::Page ^>, Microsoft::Maui::Controls::IElementConfiguration<Microsoft::Maui::Controls::TabbedPage ^>, Microsoft::Maui::ITabbedView
[Microsoft.Maui.Controls.ContentProperty("Children")]
public class TabbedPage : Microsoft.Maui.Controls.MultiPage<Microsoft.Maui.Controls.Page>, Microsoft.Maui.Controls.IElementConfiguration<Microsoft.Maui.Controls.TabbedPage>, Microsoft.Maui.ITabbedView
[<Microsoft.Maui.Controls.ContentProperty("Children")>]
type TabbedPage = class
    inherit MultiPage<Page>
    interface ITabbedView
    interface IView
    interface IElement
    interface ITransform
    interface IElementConfiguration<TabbedPage>
[<Microsoft.Maui.Controls.ContentProperty("Children")>]
type TabbedPage = class
    inherit MultiPage<Page>
    interface IElementConfiguration<TabbedPage>
    interface ITabbedView
    interface IView
    interface IElement
    interface ITransform
Public Class TabbedPage
Inherits MultiPage(Of Page)
Implements IElementConfiguration(Of TabbedPage), ITabbedView
Inheritance
Attributes
Implements

Remarks

The user interface of a tabbed page consists of a list of tabs and a larger detail area. On iOS, the list of tabs appears at the bottom of the screen, and the detail area is above. On Android and Windows phones, the tabs appear across the top of the screen. The user can scroll the collection of tabs that are across the top of the screen if that collection is too large to fit on one screen.

App developers can create tabbed pages in either of two ways. First, application developers can assign a list of objects of a single class, or its subclasses, to the ItemsSource property and assign a DataTemplate to the ItemTemplate property to return pages for objects of the least derived type. Second, app developers can add a succession of Page objects to the Children property. Both methods are shown in the code examples below.

The following example code shows how to display data of a specific type by assigning a DataTemplate to the ItemTemplate property. Note how NamedColorPage gets its color by binding its ColorProperty field.

using System;
using Microsoft.Maui.Controls;

namespace MinimalTabbed
{
    class TabbedPageDemoPage : TabbedPage
    {
        public TabbedPageDemoPage ()
        {
            this.Title = "TabbedPage";

            this.ItemsSource = new NamedColor[] {
                new NamedColor ("Red", Color.Red),
                new NamedColor ("Yellow", Color.Yellow),
                new NamedColor ("Green", Color.Green),
                new NamedColor ("Aqua", Color.Aqua),
                new NamedColor ("Blue", Color.Blue),
                new NamedColor ("Purple", Color.Purple)
            };

            this.ItemTemplate = new DataTemplate (() => { 
                return new NamedColorPage (); 
            });
        }
    }

    // Data type:
    class NamedColor
    {
        public NamedColor (string name, Color color)
        {
            this.Name = name;
            this.Color = color;
        }

        public string Name { private set; get; }

        public Color Color { private set; get; }

        public override string ToString ()
        {
            return Name;
        }
    }

    // Format page
    class NamedColorPage : ContentPage
    {
        public NamedColorPage ()
        {
            // This binding is necessary to label the tabs in
            // the TabbedPage.
            this.SetBinding (ContentPage.TitleProperty, "Name");
            // BoxView to show the color.
            BoxView boxView = new BoxView {
                WidthRequest = 100,
                HeightRequest = 100,
                HorizontalOptions = LayoutOptions.Center
            };
            boxView.SetBinding (BoxView.ColorProperty, "Color");

            // Build the page
            this.Content = boxView;
        }
    }
}


The example below creates a tabbed view with two ContentPage instances.

class TabbedPageDemoPage2 : TabbedPage
{
    public TabbedPageDemoPage2 ()
    {
        this.Title = "TabbedPage";
        this.Children.Add (new ContentPage 
            {
                Title = "Blue",
                Content = new BoxView
                {
                    Color = Color.Blue,
                    HeightRequest = 100f,
                    VerticalOptions = LayoutOptions.Center
                },
            }
        );
        this.Children.Add (new ContentPage {
            Title = "Blue and Red",
            Content = new StackLayout {
                Children = {
                    new BoxView { Color = Color.Blue },
                    new BoxView { Color = Color.Red}
                }
            }
        });
    }
}

Constructors

TabbedPage()

Creates a new TabbedPage element with default values.

Fields

ActionSheetSignalName

The identifier used by the internal messaging system to display an action sheet.

(Inherited from Page)
AlertSignalName

The identifier used by the internal messaging system to display an alert dialog.

(Inherited from Page)
BarBackgroundColorProperty

Bindable property for BarBackgroundColor.

BarBackgroundProperty

Bindable property for BarBackground.

BarTextColorProperty

Bindable property for BarTextColor.

BusySetSignalName

The identifier used by the internal messaging system to set IsBusy.

(Inherited from Page)
ControlsTabbedPageMapper
PromptSignalName

The identifier used by the internal messaging system to display a prompt dialog.

(Inherited from Page)
SelectedTabColorProperty

Bindable property for SelectedTabColor.

UnselectedTabColorProperty

Bindable property for UnselectedTabColor.

Properties

AnchorX

Gets or sets the X component of the center point for any transform operation, 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 operation, 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

Gets or sets the Brush which will be used to fill the background of an element. This is a bindable property.

(Inherited from VisualElement)
BackgroundColor

Gets or sets the Color which will fill the background of an element. This is a bindable property.

(Inherited from VisualElement)
BackgroundImageSource

Gets or sets the ImageSource that will be used as the background for this page. This is a bindable property.

(Inherited from Page)
BarBackground
BarBackgroundColor

Gets or sets the background color of the bar.

BarTextColor

Gets or sets the color of text on the bar.

Batched

Gets a value that indicates there are batched changes done for this element.

(Inherited from VisualElement)
Behaviors

Gets the list of Behavior objects associated to this element. This is a read-only bindable property.

(Inherited from VisualElement)
BindingContext

Gets or sets an object that contains the properties that will be targeted by the bound properties that belong to this BindableObject. This is a bindable property.

(Inherited from BindableObject)
Bounds

Gets the bounds of the element in device-independent units.

(Inherited from VisualElement)
Children (Inherited from MultiPage<T>)
class (Inherited from NavigableElement)
ClassId

Gets or sets a value used to identify a collection of semantically similar elements.

(Inherited from Element)
Clip

Specifies the clipping region for an element. This is a bindable property.

(Inherited from VisualElement)
ContainerArea

Gets or sets the area this page is contained in.

(Inherited from Page)
CurrentPage (Inherited from MultiPage<T>)
DesiredSize

Gets the size that this element computed during the measure pass of the layout process.

(Inherited from VisualElement)
DisableLayout

Gets a value that indicates that layout for this element is disabled.

(Inherited from VisualElement)
Dispatcher

Gets the dispatcher that was available when this bindable object was created, otherwise tries to find the nearest available dispatcher (probably the window's/app's).

(Inherited from BindableObject)
EffectControlProvider

For internal use by .NET MAUI.

(Inherited from Element)
Effects

Gets or sets the styles and properties that will be applied to the element during runtime.

(Inherited from Element)
FlowDirection

Gets or sets the layout flow direction. This is a bindable property.

(Inherited from VisualElement)
Frame

Gets or sets the frame this element resides in on screen.

(Inherited from VisualElement)
Handler

Gets or sets the IViewHandler associated to this element.

(Inherited from VisualElement)
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. This is a bindable property.

(Inherited from VisualElement)
IconImageSource

Gets or sets the ImageSource to be used for the icon associated to this page. This is a bindable property.

(Inherited from Page)
Id

Gets a value that can be used to uniquely identify an element throughout the run of your application.

(Inherited from Element)
IgnoresContainerArea

Gets or sets a value that determines whether to ignore the ContainerArea. This is a bindable property.

(Inherited from Page)
InputTransparent

Gets or sets a value indicating whether this element responds to hit testing during user interaction. This is a bindable property.

(Inherited from VisualElement)
InternalChildren

Gets the internal collection of child elements contained in this page.

(Inherited from Page)
IsBusy

Gets or sets the page busy state. This will cause the platform specific global activity indicator to show a busy state. This is a bindable property.

(Inherited from Page)
IsEnabled

Gets or sets a value indicating whether this element is enabled in the user interface. This is a bindable property.

(Inherited from VisualElement)
IsEnabledCore

This value represents the cumulative IsEnabled value. All types that override this property need to also invoke the RefreshIsEnabledProperty() method if the value will change.

(Inherited from VisualElement)
IsFocused

Gets a value indicating whether this element is focused currently. This is a bindable property.

(Inherited from VisualElement)
IsInPlatformLayout

Gets or sets a value that indicates that this element is currently going through the platform layout cycle.

(Inherited from VisualElement)
IsLoaded

Indicates if an element is connected to the main object tree.

(Inherited from VisualElement)
IsPlatformEnabled

Gets or sets a value that indicates whether this elements's platform equivalent element is enabled.

(Inherited from VisualElement)
IsPlatformStateConsistent

Gets or sets a value that indicates that this element is currently consistent with the platform equivalent element state.

(Inherited from VisualElement)
IsVisible

Gets or sets a value that determines whether this element will be visible on screen and take up space in layouts. This is a bindable property.

(Inherited from VisualElement)
ItemsSource (Inherited from MultiPage<T>)
ItemTemplate (Inherited from MultiPage<T>)
LogicalChildren
Obsolete.

For internal use by the Microsoft.Maui.Controls platform.

(Inherited from Element)
MaximumHeightRequest

Gets or sets the maximum height the element will request during layout. This is a bindable property.

(Inherited from VisualElement)
MaximumWidthRequest

Gets or sets the maximum width the element will request during layout. This is a bindable property.

(Inherited from VisualElement)
MenuBarItems

Gets the MenuBarItem objects for this page, implemented in a platform-specific manner.

(Inherited from Page)
MinimumHeightRequest

Gets or sets the minimum height the element will request during layout. This is a bindable property.

(Inherited from VisualElement)
MinimumWidthRequest

Gets or sets the minimum width the element will request during layout. This is a bindable property.

(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. The range of this value is 0 to 1; values outside this range will be set to the nearest valid value. This is a bindable property.

(Inherited from VisualElement)
Padding

Gets or sets the space between the content of the page and its border. This is a bindable property.

(Inherited from Page)
Parent

Gets or sets the parent Element of this element.

(Inherited from Element)
RealParent

For internal use by .NET MAUI.

(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. This is a bindable property.

(Inherited from VisualElement)
RotationX

Gets or sets the rotation (in degrees) about the X-axis (perspective rotation) when the element is rendered. This is a bindable property.

(Inherited from VisualElement)
RotationY

Gets or sets the rotation (in degrees) about the Y-axis (perspective rotation) when the element is rendered. This is a bindable property.

(Inherited from VisualElement)
Scale

Gets or sets the scale factor applied to the element. This is a bindable property.

(Inherited from VisualElement)
ScaleX

Gets or sets a scale value to apply to the X direction. This is a bindable property.

(Inherited from VisualElement)
ScaleY

Gets or sets a scale value to apply to the Y direction. This is a bindable property.

(Inherited from VisualElement)
SelectedItem (Inherited from MultiPage<T>)
SelectedTabColor
Shadow

Gets or sets the shadow effect cast by the element. This is a bindable property.

(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)
Title

Gets or sets the page's title.

(Inherited from Page)
ToolbarItems

Gets the ToolbarItem objects for this page, implemented in a platform-specific manner.

(Inherited from Page)
TranslationX

Gets or sets the X translation delta of the element. This is a bindable property.

(Inherited from VisualElement)
TranslationY

Gets or sets the Y translation delta of the element. This is a bindable property.

(Inherited from VisualElement)
Triggers

Gets the list of TriggerBase objects associated to this element. This is a read-only bindable property.

(Inherited from VisualElement)
UnselectedTabColor
Visual

Gets or sets a IVisual implementation that overrides the visual appearance of an element. This is a bindable property.

(Inherited from VisualElement)
Width

Gets the current 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. This is a bindable property.

(Inherited from VisualElement)
Window

Gets the Window that is associated with an element. This is a read-only bindable property.

(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

Gets or sets the front-to-back z-index of an element within a layout. This is a bindable property.

(Inherited from VisualElement)

Methods

AddLogicalChild(Element)

Adds an Element to the logical children.

(Inherited from Element)
ApplyBindings()

Applies all the current bindings to BindingContext.

(Inherited from BindableObject)
Arrange(Rect)

Positions child objects and determines a size for an element.

(Inherited from VisualElement)
ArrangeOverride(Rect)

Allows subclasses to override Arrange(Rect) even though the interface has to be explicitly implemented to avoid conflict with the old Arrange(Rect) method.

(Inherited from VisualElement)
BatchBegin()

Signals the start of a batch of changes to the elements properties. This can benefit performance if a bigger number of property values are changed.

(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()

Changes the current visual state based on this elements current property values.

(Inherited from VisualElement)
ClearLogicalChildren()

Removes all child Elements.

(Inherited from Element)
ClearValue(BindableProperty)

Clears any value that is previously set for a bindable property.

(Inherited from BindableObject)
ClearValue(BindablePropertyKey)

Clears any value that is previously set for a bindable property, identified by its key.

(Inherited from BindableObject)
CoerceValue(BindableProperty)

Coerces the value of the specified bindable property. This is done by invoking BindableProperty.CoerceValueDelegate of the specified bindable property.

(Inherited from BindableObject)
CoerceValue(BindablePropertyKey)

Coerces the value of the specified bindable property. This is done by invoking BindableProperty.CoerceValueDelegate of the specified bindable property.

(Inherited from BindableObject)
CreateDefault(Object)
DisplayActionSheet(String, String, String, FlowDirection, String[])

Displays a platform action sheet, allowing the application user to choose from several buttons.

(Inherited from Page)
DisplayActionSheet(String, String, String, String[])

Displays a native platform action sheet, allowing the application user to choose from several buttons.

(Inherited from Page)
DisplayAlert(String, String, String)

Presents an alert dialog to the application user with a single cancel button.

(Inherited from Page)
DisplayAlert(String, String, String, FlowDirection)

Presents an alert dialog to the application user with a single cancel button.

(Inherited from Page)
DisplayAlert(String, String, String, String)

Presents an alert dialog to the application user with an accept and a cancel button.

(Inherited from Page)
DisplayAlert(String, String, String, String, FlowDirection)

Displays an alert dialog to the application user with a single cancel button.

(Inherited from Page)
DisplayPromptAsync(String, String, String, String, String, Int32, Keyboard, String)

Displays a prompt dialog to the application user with the intent to capture a single string value.

(Inherited from Page)
EffectIsAttached(String)

For internal use by .NET MAUI.

(Inherited from Element)
FindByName(String)

Returns the element that has the specified name.

(Inherited from Element)
Focus()

Attempts to set focus to this element.

(Inherited from VisualElement)
ForceLayout()

Forces the page to perform a layout pass.

(Inherited from Page)
GetPageByIndex(Int32) (Inherited from MultiPage<T>)
GetParentWindow()

Retrieves the parent window that contains the page.

(Inherited from Page)
GetValue(BindableProperty)

Returns the value that is contained in the given bindable property.

(Inherited from BindableObject)
InsertLogicalChild(Int32, Element)

Inserts an Element to the logical children at the specified index.

(Inherited from Element)
InvalidateMeasure()

Marks the current measure of an element as invalidated.

(Inherited from VisualElement)
InvalidateMeasureNonVirtual(InvalidationTrigger)

Invalidates the measure of an element.

(Inherited from VisualElement)
InvalidateMeasureOverride()

Provides a way to allow subclasses (e.g., Layout) to override InvalidateMeasure() even though the interface has to be explicitly implemented to avoid conflict with the InvalidateMeasure() method.

(Inherited from VisualElement)
IsSet(BindableProperty)

Determines whether or not a bindable property exists and has a value set.

(Inherited from BindableObject)
Layout(Rect)

Updates the bounds of the element during the layout cycle.

(Inherited from VisualElement)
LayoutChildren(Double, Double, Double, Double)
Measure(Double, Double, MeasureFlags)

Returns the minimum size that an element needs in order to be displayed on the device.

(Inherited from VisualElement)
MeasureOverride(Double, Double)

Provides a way to allow subclasses to override Measure(Double, Double, MeasureFlags) even though the interface has to be explicitly implemented to avoid conflict with the old Measure method.

(Inherited from VisualElement)
On<T>()

Returns the platform-specific instance of this TElement, on which a platform-specific method may be called.

OnAppearing()

When overridden in a derived class, allows application developers to customize behavior immediately prior to the page becoming visible.

(Inherited from Page)
OnBackButtonPressed() (Inherited from MultiPage<T>)
OnBindingContextChanged()

Invoked whenever the binding context of the page changes. Override this method to add class handling for this event.

(Inherited from Page)
OnChildAdded(Element) (Inherited from MultiPage<T>)
OnChildMeasureInvalidated(Object, EventArgs)

Indicates that the preferred size of a child Element has changed.

(Inherited from Page)
OnChildRemoved(Element, Int32) (Inherited from VisualElement)
OnChildrenReordered()

Raises the ChildrenReordered event.

(Inherited from VisualElement)
OnCurrentPageChanged() (Inherited from MultiPage<T>)
OnDisappearing()

When overridden in a derived class, allows the application developer to customize behavior as the page disappears.

(Inherited from Page)
OnHandlerChanged()

When overridden in a derived class, should raise the HandlerChanged event.

(Inherited from Element)
OnHandlerChanging(HandlerChangingEventArgs)

When overridden in a derived class, should raise the HandlerChanging event.

(Inherited from Element)
OnMeasure(Double, Double)

Method that is called when a layout measurement happens.

(Inherited from VisualElement)
OnNavigatedFrom(NavigatedFromEventArgs)

When overridden in a derived class, allows application developers to customize behavior immediately after the page was being navigated away from.

(Inherited from Page)
OnNavigatedTo(NavigatedToEventArgs)

When overridden in a derived class, allows application developers to customize behavior immediately after the page was navigated to.

(Inherited from Page)
OnNavigatingFrom(NavigatingFromEventArgs)

When overridden in a derived class, allows application developers to customize behavior immediately prior to the page being navigated away from.

(Inherited from Page)
OnPagesChanged(NotifyCollectionChangedEventArgs) (Inherited from MultiPage<T>)
OnParentChanged()

When overridden in a derived class, should raise the ParentChanged event.

(Inherited from Element)
OnParentChanging(ParentChangingEventArgs)

When overridden in a derived class, should raise the ParentChanging event.

(Inherited from Element)
OnParentSet()

Called when the page's Parent property has changed.

(Inherited from Page)
OnPropertyChanged(String) (Inherited from MultiPage<T>)
OnPropertyChanging(String)

Raises the PropertyChanging event.

(Inherited from BindableObject)
OnSizeAllocated(Double, Double)

Indicates that the page has been assigned a size.

(Inherited from Page)
PlatformSizeChanged()

Signals that the platform equivalent element for this element's size has changed and a new layout cycle might be needed.

(Inherited from VisualElement)
RefreshIsEnabledProperty()

This method must always be called if some event occurs and the value of the IsEnabledCore property will change.

(Inherited from VisualElement)
RemoveBinding(BindableProperty)

Removes a previously set binding from a bindable property.

(Inherited from BindableObject)
RemoveDynamicResource(BindableProperty)

Removes a previously set dynamic resource.

(Inherited from Element)
RemoveLogicalChild(Element)

Removes the first occurrence of a specific Element from the logical children.

(Inherited from Element)
SendAppearing()

Sends the signal to the page that it is about to visually appear on screen.

(Inherited from Page)
SendBackButtonPressed()

Calls OnBackButtonPressed().

(Inherited from Page)
SendDisappearing()

Sends the signal to the page that it is about to be visually hidden from the screen.

(Inherited from Page)
SetBinding(BindableProperty, BindingBase)

Assigns a binding to a bindable 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)
SetupContent(T, Int32) (Inherited from MultiPage<T>)
SetValue(BindableProperty, Object)

Sets the value of the specified bindable property.

(Inherited from BindableObject)
SetValue(BindablePropertyKey, Object)

Sets the value of the specified bindable property.

(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 .NET MAUI.

(Inherited from Element)
SetValueFromRenderer(BindablePropertyKey, Object)

For internal use by .NET MAUI.

(Inherited from Element)
SizeAllocated(Double, Double)

Method that is called during a layout cycle to signal the start of a sub-tree layout.

(Inherited from VisualElement)
UnapplyBindings()

Removes all current bindings from the current context.

(Inherited from BindableObject)
Unfocus()

Unsets keyboard focus on this element.

(Inherited from VisualElement)
UnhookContent(T) (Inherited from MultiPage<T>)
UpdateChildrenLayout()

Requests that the child Elements of the page update their layouts.

(Inherited from Page)

Events

Appearing

Raised when this page is visually appearing on screen.

(Inherited from Page)
BatchCommitted

Occurs when a batch of property changes have been committed by calling BatchCommit().

(Inherited from VisualElement)
BindingContextChanged

Occurs when the value of the BindingContext property changes.

(Inherited from BindableObject)
ChildAdded

Raised whenever a child element is added to the element.

(Inherited from Element)
ChildRemoved

Raised whenever a child element is removed from the element.

(Inherited from Element)
ChildrenReordered

Occurs when the order of this element's children changes.

(Inherited from VisualElement)
CurrentPageChanged (Inherited from MultiPage<T>)
DescendantAdded

Raised whenever a child element is added to the element's subtree.

(Inherited from Element)
DescendantRemoved

Raised whenever a child element is removed from the elements subtree.

(Inherited from Element)
Disappearing

Raised when this page is visually disappearing from the screen.

(Inherited from Page)
FocusChangeRequested
Obsolete.
(Inherited from VisualElement)
Focused

Occurs when this element is focused.

(Inherited from VisualElement)
HandlerChanged

Raised whenever the element's handler has changed.

(Inherited from Element)
HandlerChanging

Raised whenever the element's handler starts to change.

(Inherited from Element)
LayoutChanged

Raised when the children of this page, and thus potentially the layout, have changed.

(Inherited from Page)
Loaded

Occurs when an element has been constructed and added to the object tree.

(Inherited from VisualElement)
MeasureInvalidated

Occurs when the current measure of an element has been invalidated.

(Inherited from VisualElement)
NavigatedFrom

Raised after the page was navigated away from.

(Inherited from Page)
NavigatedTo

Raised after the page was navigated to.

(Inherited from Page)
NavigatingFrom

Raised before navigating away from the page.

(Inherited from Page)
PagesChanged (Inherited from MultiPage<T>)
ParentChanged

Raised whenever the element's parent has changed.

(Inherited from Element)
ParentChanging

Raised whenever the element's starts to change.

(Inherited from Element)
PropertyChanged

Occurs when a property value changes.

(Inherited from BindableObject)
PropertyChanging

Occurs when a property value is changing.

(Inherited from BindableObject)
SizeChanged

Occurs when the size of an element changed.

(Inherited from VisualElement)
Unfocused

Occurs when this element is unfocused.

(Inherited from VisualElement)
Unloaded

Occurs when an element is no longer connected to the main object tree.

(Inherited from VisualElement)

Explicit Interface Implementations

IContextFlyoutElement.ContextFlyout

Gets the ContextFlyout for the view. Menu flyouts, menu flyout subitems, and menu flyout separators can be added to the context flyout.

(Inherited from Element)
IDynamicResourceHandler.SetDynamicResource(BindableProperty, String) (Inherited from BindableObject)
IEffectControlProvider.RegisterEffect(Effect) (Inherited from Element)
IElement.Handler

Gets or sets the View Handler of the Element.

(Inherited from VisualElement)
IElement.Parent

Gets the Parent of the Element.

(Inherited from Element)
IElementController.Descendants()

For internal use by .NET MAUI.

(Inherited from Element)
IElementController.LogicalChildren

For internal use by .NET MAUI.

(Inherited from Element)
IElementController.SetValueFromRenderer(BindableProperty, Object)

For internal use by .NET MAUI.

(Inherited from Element)
IItemsView<T>.CreateDefault(Object) (Inherited from MultiPage<T>)
IItemsView<T>.SetupContent(T, Int32) (Inherited from MultiPage<T>)
IItemsView<T>.UnhookContent(T) (Inherited from MultiPage<T>)
INameScope.RegisterName(String, Object)

For internal use by .NET MAUI.

(Inherited from Element)
INameScope.UnregisterName(String)

For internal use by .NET MAUI.

(Inherited from Element)
IPaddingElement.OnPaddingPropertyChanged(Thickness, Thickness) (Inherited from Page)
IPaddingElement.PaddingDefaultValueCreator() (Inherited from Page)
ISafeAreaView.IgnoreSafeArea

Specifies how the View's content should be positioned in relation to obstructions. If this value is false, the content will be positioned only in the unobstructed portion of the screen. If this value is true, the content may be positioned anywhere on the screen. This includes the portion of the screen behind toolbars, screen cutouts, etc.

(Inherited from Page)
IToolbarElement.Toolbar (Inherited from Page)
IToolTipElement.ToolTip

Represents a small rectangular pop-up window that displays a brief description of a view's purpose when the user rests the pointer on the view.

(Inherited from Element)
IView.Arrange(Rect)

Positions child elements and determines a size for an Element.

(Inherited from VisualElement)
IView.Background

Gets the paint which will fill the background of a View.

(Inherited from Page)
IView.Clip

Gets the Path used to define the outline of the contents of a View.

(Inherited from VisualElement)
IView.FlowDirection

Direction in which the UI elements are scanned by the eye

(Inherited from VisualElement)
IView.Height

Gets the specified height of the IView.

(Inherited from VisualElement)
IView.HorizontalLayoutAlignment

Determines the horizontal aspect of this element's arrangement in a container

(Inherited from VisualElement)
IView.InvalidateArrange()

Method that is called to invalidate the layout of this View.

(Inherited from VisualElement)
IView.InvalidateMeasure()

Signals that the current measure value of this View is no longer valid and must be recomputed during the next measure pass.

(Inherited from VisualElement)
IView.IsFocused

Gets a value indicating whether this View is focused currently.

(Inherited from VisualElement)
IView.Margin

The Margin represents the distance between an view and its adjacent views.

(Inherited from VisualElement)
IView.MaximumHeight

Gets the specified maximum height constraint of the IView, between zero and double.PositiveInfinity.

(Inherited from VisualElement)
IView.MaximumWidth

Gets the specified maximum width constraint of the IView, between zero and double.PositiveInfinity.

(Inherited from VisualElement)
IView.Measure(Double, Double)

Updates the size of an View.

(Inherited from VisualElement)
IView.MinimumHeight

Gets the specified minimum height constraint of the IView, between zero and double.PositiveInfinity.

(Inherited from VisualElement)
IView.MinimumWidth

Gets the specified minimum width constraint of the IView, between zero and double.PositiveInfinity.

(Inherited from VisualElement)
IView.Semantics

Adds semantics to every View for accessibility

(Inherited from VisualElement)
IView.Shadow

Paints a shadow around the target View.

(Inherited from VisualElement)
IView.VerticalLayoutAlignment

Determines the vertical aspect of this element's arrangement in a container

(Inherited from VisualElement)
IView.Visibility

Gets a value that determines whether this View should be part of the visual tree or not.

(Inherited from VisualElement)
IView.Width

Gets the specified width of the IView.

(Inherited from VisualElement)
IVisualElementController.EffectiveFlowDirection

For internal use by .NET MAUI.

(Inherited from VisualElement)
IVisualElementController.InvalidateMeasure(InvalidationTrigger)

For internal use by .NET MAUI.

(Inherited from VisualElement)
IVisualTreeElement.GetVisualChildren()

Gets a readonly list of the element's visual children.

(Inherited from Element)
IVisualTreeElement.GetVisualParent()

Gets the element's visual parent.

(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.

AncestorToRoot(Page)

For internal use by the Microsoft.Maui.Controls platform.

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)
ComputeDesiredSize(IView, Double, Double)
ComputeFrame(IView, Rect)
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.

Applies to