Shell Class

Definition

A Page that provides fundamental UI features that most applications require, leaving you to focus on the application's core workload.

[Xamarin.Forms.ContentProperty("Items")]
public class Shell : Xamarin.Forms.Page, Xamarin.Forms.IPageContainer<Xamarin.Forms.Page>, Xamarin.Forms.IShellController
type Shell = class
    inherit Page
    interface IShellController
    interface IPageController
    interface IVisualElementController
    interface IElementController
    interface IPageContainer<Page>
Inheritance
Attributes
Implements

Constructors

Shell()

Creates a new Shell element with default values.

Fields

ActionSheetSignalName

This method is for internal use.

(Inherited from Page)
AlertSignalName

This method is for internal use.

(Inherited from Page)
BackButtonBehaviorProperty

Backing store for the GetBackButtonBehavior(BindableObject) and SetBackButtonBehavior(BindableObject, BackButtonBehavior) methods.

BackgroundColorProperty
BusySetSignalName

This method is for internal use.

(Inherited from Page)
CurrentItemProperty

The backing store for the CurrentItem field.

CurrentStateProperty

The backing store for the CurrentState field.

DisabledColorProperty
FlyoutBackdropProperty
FlyoutBackgroundColorProperty

The backing store for the FlyoutBackgroundColor field.

FlyoutBackgroundImageAspectProperty
FlyoutBackgroundImageProperty
FlyoutBackgroundProperty
FlyoutBehaviorProperty

The backing store for the FlyoutBehavior field.

FlyoutHeaderBehaviorProperty

The backing store for the FlyoutHeaderBehavior field.

FlyoutHeaderProperty

The backing store for the FlyoutHeader field.

FlyoutHeaderTemplateProperty

The backing store for the FlyoutHeaderTemplate field.

FlyoutIconProperty

The backing store for the FlyoutIcon field.

FlyoutIsPresentedProperty

The backing store for the FlyoutIsPresented field.

FlyoutVerticalScrollModeProperty
ForegroundColorProperty
ItemsProperty

The backing store for the Items field.

ItemTemplateProperty

The backing store for the ItemTemplate field.

MenuItemTemplateProperty

The backing store for the MenuItemTemplate field.

NavBarHasShadowProperty
NavBarIsVisibleProperty

The backing store for the GetNavBarIsVisible(BindableObject) and SetNavBarIsVisible(BindableObject, Boolean) methods.

PresentationModeProperty
PromptSignalName (Inherited from Page)
SearchHandlerProperty

The backing store for the GetSearchHandler(BindableObject) and SetSearchHandler(BindableObject, SearchHandler) methods.

TabBarBackgroundColorProperty
TabBarDisabledColorProperty
TabBarForegroundColorProperty
TabBarIsVisibleProperty

The backing store for the GetTabBarIsVisible(BindableObject) and SetTabBarIsVisible(BindableObject, Boolean) methods.

TabBarTitleColorProperty
TabBarUnselectedColorProperty
TitleColorProperty
TitleViewProperty

xThe backing store for the GetTitleView(BindableObject) and SetTitleView(BindableObject, View) methods.

UnselectedColorProperty

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)
BackgroundImage
Obsolete.

Identifies the image used as a background for the Page.

(Inherited from Page)
BackgroundImageSource (Inherited from Page)
Batched

For internal use by the Xamarin.Forms 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)
Bounds

Gets the bounds of the element.

(Inherited from VisualElement)
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)
ContainerArea

For internal use by the Xamarin.Forms platform.

(Inherited from Page)
Current

Static property providing access to the current Shell.

CurrentItem

The currently selected ShellItem or FlyoutItem.

CurrentPage
CurrentState

The current navigation state of the Shell.

DisableLayout

For internal use by the Xamarin.Forms platform.

(Inherited from VisualElement)
Dispatcher (Inherited from BindableObject)
EffectControlProvider

For internal use by the Xamarin.Forms 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)
FlyoutBackdrop
FlyoutBackground
FlyoutBackgroundColor

Gets or sets the background color of the Shell Flyout.

FlyoutBackgroundImage
FlyoutBackgroundImageAspect
FlyoutBehavior

Setting the FlyoutBehavior property to Disabled hides the flyout, which is useful when you only have one ShellItem. The other valid FlyoutBehavior values are Flyout (default), and Locked.

FlyoutHeader

The flyout header is the content that optionally appears at the top of the flyout, with its appearance being defined by a View that can be set through the FlyoutHeader property value.

FlyoutHeaderBehavior

Setting the FlyoutHeaderBehavior to CollapseOnScroll collapses the flyout as scrolling occurs. The other valid FlyoutHeaderBehavior values are Default, Fixed, and Scroll (scroll with the menu items).

FlyoutHeaderTemplate

The flyout header appearance can be defined by setting the FlyoutHeaderTemplate property to a DataTemplate.

FlyoutIcon

Gets or sets the icon that, when pressed, opens the Shell Flyout.

FlyoutIsPresented

Gets or sets the visible status of the Shell Flyout.

FlyoutVerticalScrollMode
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)
Icon
Obsolete.

Resource identifier for the Page's associated icon.

(Inherited from Page)
IconImageSource (Inherited from Page)
Id

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

(Inherited from Element)
IgnoresContainerArea

For internal use by the Xamarin.Forms platform.

(Inherited from Page)
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)
InternalChildren

For internal use by the Xamarin.Forms platform.

(Inherited from Page)
IsBusy

Marks the Page as busy. This will cause the platform specific global activity indicator to show a busy state.

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

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

(Inherited from VisualElement)
IsInNativeLayout

For internal use by the Xamarin.Forms platform.

(Inherited from VisualElement)
IsNativeStateConsistent

For internal use by the Xamarin.Forms platform.

(Inherited from VisualElement)
IsPlatformEnabled

For internal use by the Xamarin.Forms platform.

(Inherited from VisualElement)
IsTabStop

Gets or sets a value that indicates whether this element is included in tab navigation. This is a bindable property.

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

The collection of ShellItem objects managed by thisShell.

ItemTemplate

Gets or sets DataTemplate applied to each of the Items.

LogicalChildren

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
MenuItemTemplate

Gets or sets the DataTemplate applied to MenuItem objects in the MenuItems collection.

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

The space between the content of the Page and it's border.

(Inherited from Page)
Parent

Gets or sets the parent element of the element.

(Inherited from Element)
ParentView
Obsolete.

Gets the element which is the closest ancestor of this element that is a VisualElement.

(Inherited from Element)
Platform
Obsolete.
(Inherited from Element)
RealParent

For internal use by the Xamarin.Forms 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)
Style (Inherited from NavigableElement)
StyleClass (Inherited from NavigableElement)
StyleId

Gets or sets a user defined value to uniquely identify the element.

(Inherited from Element)
TabIndex (Inherited from VisualElement)
Title

The Page's title.

(Inherited from Page)
ToolbarItems

A set of ToolbarItems, implemented in a platform-specific manner.

(Inherited from Page)
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)
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)
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)

Methods

ApplyBindings()

Apply the bindings to BindingContext.

(Inherited from BindableObject)
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()

For internal use by the Xamarin.Forms platform.

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

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
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, String)

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

(Inherited from Page)
DisplayPromptAsync(String, String, String, String, String, Int32, Keyboard)
Obsolete.
(Inherited from Page)
DisplayPromptAsync(String, String, String, String, String, Int32, Keyboard, String) (Inherited from Page)
EffectIsAttached(String)

For internal use by the Xamarin.Forms 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()

Forces the Page to perform a layout pass.

(Inherited from Page)
GetBackButtonBehavior(BindableObject)

Gets the value of the BackButtonBehaviorProperty of the obj.

GetBackgroundColor(BindableObject)
GetDisabledColor(BindableObject)
GetFlyoutBackdrop(BindableObject)
GetFlyoutBehavior(BindableObject)

Gets the FlyoutBehavior of the obj.

GetForegroundColor(BindableObject)
GetItemTemplate(BindableObject)
GetMenuItemTemplate(BindableObject)
GetNavBarHasShadow(BindableObject)
GetNavBarIsVisible(BindableObject)

Gets the visibility of the navigation bar of the obj in a Shell application.

GetPresentationMode(BindableObject)
GetSearchHandler(BindableObject)

Gets the SearchHandler for the specified obj.

GetSizeRequest(Double, Double)
Obsolete.

Returns the SizeRequest of the element. Calling this method begins the measure pass of a layout cycle.

(Inherited from VisualElement)
GetTabBarBackgroundColor(BindableObject)
GetTabBarDisabledColor(BindableObject)
GetTabBarForegroundColor(BindableObject)

Gets the title color for tab bar for the obj.

GetTabBarIsVisible(BindableObject)

Gets whether the tab bar is visible in obj.

GetTabBarTitleColor(BindableObject)
GetTabBarUnselectedColor(BindableObject)
GetTitleColor(BindableObject)
GetTitleView(BindableObject)

Gets the title View of obj.

GetUnselectedColor(BindableObject)
GetValue(BindableProperty)

Returns the value that is contained in the BindableProperty.

(Inherited from BindableObject)
GetValues(BindableProperty, BindableProperty)
Obsolete.

For internal use by the Xamarin.Forms platform.

(Inherited from BindableObject)
GetValues(BindableProperty, BindableProperty, BindableProperty)
Obsolete.

For internal use by the Xamarin.Forms platform.

(Inherited from BindableObject)
GoToAsync(ShellNavigationState)
GoToAsync(ShellNavigationState, Boolean)

Asynchronously navigates to , optionally animating.

InvalidateMeasure()

Method that is called to invalidate the layout of this VisualElement. Raises the MeasureInvalidated event.

(Inherited from VisualElement)
InvalidateMeasureNonVirtual(InvalidationTrigger)

For internal use by the Xamarin.Forms platform.

(Inherited from VisualElement)
IsSet(BindableProperty)

Returns true if the target property exists and has been set.

(Inherited from BindableObject)
Layout(Rectangle)

Updates the bounds of the element during the layout cycle.

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

Lays out children Elements into the specified area.

(Inherited from Page)
Measure(Double, Double, MeasureFlags)

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

(Inherited from VisualElement)
NativeSizeChanged()

For internal use by the Xamarin.Forms platform.

(Inherited from VisualElement)
On<T>()

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

(Inherited from Page)
OnAppearing()

When overridden, allows application developers to customize behavior immediately prior to the Page becoming visible.

(Inherited from Page)
OnBackButtonPressed()

Returns true if the CurrentItem was popped in response to a press of the back button.

OnBindingContextChanged()

Developers may override this method to customize behavior in response to the binding context changing.

OnChildAdded(Element)

Application developers can override this method to respond when a child is added.

(Inherited from VisualElement)
OnChildMeasureInvalidated(Object, EventArgs)

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

(Inherited from Page)
OnChildRemoved(Element)
Obsolete.

Application developers can override this method to respond when a child is removed.

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

Invoked whenever the ChildrenReordered event is about to be emitted. Implement this method to add class handling for this event.

(Inherited from VisualElement)
OnDisappearing()

When overridden, allows the application developer to customize behavior as the Page disappears.

(Inherited from Page)
OnMeasure(Double, Double)

Method that is called when a layout measurement happens.

(Inherited from VisualElement)
OnNavigated(ShellNavigatedEventArgs)

Developers may override this method to customize behavior on navigation.

OnNavigating(ShellNavigatingEventArgs)

Developers may override this method to customize behavior prior to navigation.

OnParentSet()

Called when the Page's Parent property has changed.

(Inherited from Page)
OnPropertyChanged(String)

Method that is called when a bound property is changed.

(Inherited from Element)
OnPropertyChanging(String)

Call this method from a child class to notify that a change is going to happen on a property.

(Inherited from BindableObject)
OnSizeAllocated(Double, Double)

Indicates that the Page has been assigned a size.

(Inherited from Page)
OnSizeRequest(Double, Double)
Obsolete.

This method is called during the measure pass of a layout cycle to get the desired size of an element.

(Inherited from VisualElement)
OnTabIndexPropertyChanged(Int32, Int32) (Inherited from VisualElement)
OnTabStopPropertyChanged(Boolean, Boolean) (Inherited from VisualElement)
RemoveBinding(BindableProperty)

Removes a previously set binding.

(Inherited from BindableObject)
RemoveDynamicResource(BindableProperty)

Removes a previously set dynamic resource

(Inherited from Element)
SendAppearing()

For internal use by the Xamarin.Forms platform.

(Inherited from Page)
SendBackButtonPressed()

Calls OnBackButtonPressed().

(Inherited from Page)
SendDisappearing()

For internal use by the Xamarin.Forms platform.

(Inherited from Page)
SetBackButtonBehavior(BindableObject, BackButtonBehavior)

Sets the back button behavior of to .

SetBackgroundColor(BindableObject, Color)
SetBinding(BindableProperty, BindingBase)

Assigns a binding to a property.

(Inherited from BindableObject)
SetDisabledColor(BindableObject, Color)
SetDynamicResource(BindableProperty, String)

Sets the BindableProperty property of this element to be updated via the DynamicResource with the provided key.

(Inherited from Element)
SetFlyoutBackdrop(BindableObject, Brush)
SetFlyoutBehavior(BindableObject, FlyoutBehavior)

Sets the flyout behavior of to .

SetForegroundColor(BindableObject, Color)
SetItemTemplate(BindableObject, DataTemplate)
SetMenuItemTemplate(BindableObject, DataTemplate)
SetNavBarHasShadow(BindableObject, Boolean)
SetNavBarIsVisible(BindableObject, Boolean)

Sets the navigation bar visibility of .

SetPresentationMode(BindableObject, PresentationMode)
SetSearchHandler(BindableObject, SearchHandler)

Sets the SearchHandler for .

SetTabBarBackgroundColor(BindableObject, Color)
SetTabBarDisabledColor(BindableObject, Color)
SetTabBarForegroundColor(BindableObject, Color)
SetTabBarIsVisible(BindableObject, Boolean)

Sets the tab bar visibility of .

SetTabBarTitleColor(BindableObject, Color)
SetTabBarUnselectedColor(BindableObject, Color)
SetTitleColor(BindableObject, Color)
SetTitleView(BindableObject, View)

Sets the title View of .

SetUnselectedColor(BindableObject, Color)
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 Xamarin.Forms platform.

(Inherited from BindableObject)
SetValueFromRenderer(BindableProperty, Object)

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
SetValueFromRenderer(BindablePropertyKey, Object)

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
SizeAllocated(Double, Double)

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

(Inherited from VisualElement)
TabIndexDefaultValueCreator() (Inherited from VisualElement)
TabStopDefaultValueCreator() (Inherited from VisualElement)
UnapplyBindings()

Unapplies all previously set bindings.

(Inherited from BindableObject)
Unfocus()

Unsets focus to this element.

(Inherited from VisualElement)
UpdateChildrenLayout()

Requests that the children Elements of the Page update their layouts.

(Inherited from Page)
VerifyShellUWPFlagEnabled(String, String)

Events

Appearing

Indicates that the Page is about to appear.

(Inherited from Page)
BatchCommitted

For internal use by the Xamarin.Forms platform.

(Inherited from VisualElement)
BindingContextChanged

Raised whenever the BindingContext property changes.

(Inherited from BindableObject)
ChildAdded

Occurs whenever a child element is added to the element.

(Inherited from Element)
ChildRemoved

Occurs whenever a child element is removed from the element.

(Inherited from Element)
ChildrenReordered

Occurs when the Children of a VisualElement have been re-ordered.

(Inherited from VisualElement)
DescendantAdded

Occurs whenever a child element is added to the elements subtree.

(Inherited from Element)
DescendantRemoved

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

(Inherited from Element)
Disappearing

Indicates that the Page is about to cease displaying.

(Inherited from Page)
FocusChangeRequested

For internal use by the Xamarin.Forms platform.

(Inherited from VisualElement)
Focused

Occurs when the element receives focus.

(Inherited from VisualElement)
LayoutChanged

Raised when the layout of the Page has changed.

(Inherited from Page)
MeasureInvalidated

Event that is raised when the layout of a visual element is invalidated.

(Inherited from VisualElement)
Navigated

The library raises this event after performing navigation.

Navigating

The library raises this event immediately prior to performing navigation.

PlatformSet
Obsolete.
(Inherited from Element)
PropertyChanged

Raised when a property has changed.

(Inherited from BindableObject)
PropertyChanging

Raised when a property is about to change.

(Inherited from BindableObject)
SizeChanged

Occurs when either the Width or the Height properties change value on this element.

(Inherited from VisualElement)
Unfocused

Occurs when the element loses focus.

(Inherited from VisualElement)

Explicit Interface Implementations

IDynamicResourceHandler.SetDynamicResource(BindableProperty, String)

For internal use by the Xamarin.Forms platform.

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

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
INameScope.RegisterName(String, Object)

For internal use only.

(Inherited from Element)
IShellController.AddAppearanceObserver(IAppearanceObserver, Element)

For internal use by the Xamarin.Forms platform.

IShellController.AddFlyoutBehaviorObserver(IFlyoutBehaviorObserver)

For internal use by the Xamarin.Forms platform.

IShellController.AppearanceChanged(Element, Boolean)

For internal use by the Xamarin.Forms platform.

IShellController.FlyoutHeader

For internal use by the Xamarin.Forms platform.

IShellController.GenerateFlyoutGrouping()

For internal use by the Xamarin.Forms platform.

IShellController.GetFlyoutItemDataTemplate(BindableObject)
IShellController.GetItems()
IShellController.GetNavigationState(ShellItem, ShellSection, ShellContent, Boolean)

For internal use by the Xamarin.Forms platform.

IShellController.ItemsCollectionChanged
IShellController.OnFlyoutItemSelected(Element)

For internal use by the Xamarin.Forms platform.

IShellController.OnFlyoutItemSelectedAsync(Element)

For internal use by the Xamarin.Forms platform.

IShellController.ProposeNavigation(ShellNavigationSource, ShellItem, ShellSection, ShellContent, IReadOnlyList<Page>, Boolean)

For internal use by the Xamarin.Forms platform.

IShellController.RemoveAppearanceObserver(IAppearanceObserver)

For internal use by the Xamarin.Forms platform.

IShellController.RemoveFlyoutBehaviorObserver(IFlyoutBehaviorObserver)

For internal use by the Xamarin.Forms platform.

IShellController.StructureChanged

For internal use by the Xamarin.Forms platform.

IShellController.UpdateCurrentState(ShellNavigationSource)

For internal use by the Xamarin.Forms platform.

IVisualElementController.EffectiveFlowDirection

Gets the effective visual flow direction for the element on the platform, taking into account the locale and logical flow settings.

(Inherited from VisualElement)
IVisualElementController.InvalidateMeasure(InvalidationTrigger)

This method is for internal use.

(Inherited from VisualElement)

Extension Methods

AbortAnimation(IAnimatable, String)

Stops 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(IAnimatable, String, Animation, 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>)

Sets the specified parameters and starts the animation.

AnimateKinetic(IAnimatable, String, Func<Double,Double,Boolean>, Double, Double, Action)

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)
SetAppThemeColor(BindableObject, BindableProperty, Color, Color)
SetBinding(BindableObject, BindableProperty, String, BindingMode, IValueConverter, String)

Creates and applies a binding to a property.

SetBinding<TSource>(BindableObject, BindableProperty, Expression<Func<TSource,Object>>, BindingMode, IValueConverter, String)
Obsolete.

Creates and applies a binding from an expression.

SetOnAppTheme<T>(BindableObject, BindableProperty, T, T)
AncestorToRoot(Page)

For internal use by the Xamarin.Forms platform.

FindByName<T>(Element, String)

Returns the instance of type T that has name name in the scope that includes element.

FindNextElement(ITabStopElement, Boolean, IDictionary<Int32,List<ITabStopElement>>, Int32)
GetSortedTabIndexesOnParentPage(VisualElement)
GetTabIndexesOnParentPage(ITabStopElement, Int32)
FadeTo(VisualElement, Double, UInt32, Easing)

Returns a task that performs the fade that is described by the opacity, length, and easing parameters.

LayoutTo(VisualElement, Rectangle, 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 performs the rotation that is described by the rotation, length, and easing parameters.

RotateXTo(VisualElement, Double, UInt32, Easing)

Returns a task that skews the Y axis by opacity, taking time length and using easing.

RotateYTo(VisualElement, Double, UInt32, Easing)

Returns a task that skews the X axis by opacity, 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)
ScaleYTo(VisualElement, Double, UInt32, Easing)
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.

Applies to