MultiPage<T> Class

Reference

Definition

Namespace:: Xamarin.Forms

Assembly:: Xamarin.Forms.Core.dll

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 bindable, templatable base class for pages which contain multiple sub-pages.

[Xamarin.Forms.ContentProperty("Children")]
public abstract class MultiPage<T> : Xamarin.Forms.Page, Xamarin.Forms.IItemsView<T>, Xamarin.Forms.IMultiPageController<T>, Xamarin.Forms.IPageContainer<T>, Xamarin.Forms.IViewContainer<T> where T : Page

type MultiPage<'T (requires 'T :> Page)> = class
    inherit Page
    interface IViewContainer<'T (requires 'T :> Page)>
    interface IPageContainer<'T (requires 'T :> Page)>
    interface IItemsView<'T (requires 'T :> Page)>
    interface IMultiPageController<'T (requires 'T :> Page)>

Type Parameters

T

The particular subclass of Page that the MultiPage services.

Inheritance: System.Object

BindableObject

Element

NavigableElement

VisualElement

Page
MultiPage<T>

Derived: Xamarin.Forms.CarouselPage

Xamarin.Forms.TabbedPage

Attributes: ContentPropertyAttribute

Implements: IItemsView<T> IMultiPageController<T> IPageContainer<T> IViewContainer<T>

Remarks

Provides a base implementation for binding and templating pages.

Constructors

MultiPage<T>()

Provides the base initialization for objects derived from the MultiPage<T> class.

Fields

ActionSheetSignalName	This method is for internal use. (Inherited from Page)
AlertSignalName	This method is for internal use. (Inherited from Page)
BusySetSignalName	This method is for internal use. (Inherited from Page)
ItemsSourceProperty	Identifies the ItemsSource property.
ItemTemplateProperty	Identifies the ItemTemplate bindable property.
PromptSignalName	(Inherited from Page)
SelectedItemProperty	Identifies the SelectedItem bindable property.

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)
Children	Gets an IList<Page> of child elements of the MultiPage.
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)
CurrentPage	Gets or sets the currently selected page.
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)
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)
ItemsSource	The source for the items to be displayed.
ItemTemplate	The template for displaying items.
LogicalChildren	For internal use by the Xamarin.Forms platform. (Inherited from Element)
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)
SelectedItem	The currently selected item.
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)
CreateDefault(Object)	Create default provides a default method of creating new pages from objects in a binding scenario.
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, String)	Presents an alert dialog to the application user with an accept and a cancel button. (Inherited from Page)
DisplayAlert(String, String, String)	Presents an alert dialog to the application user with a single cancel button. (Inherited from Page)
DisplayPromptAsync(String, String, String, String, String, Int32, Keyboard, String)	(Inherited from Page)
DisplayPromptAsync(String, String, String, String, String, Int32, Keyboard)	Obsolete. (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)
GetIndex(T)	For internal use by the Xamarin.Forms platform.
GetPageByIndex(Int32)	For internal use by the Xamarin.Forms platform.
GetSizeRequest(Double, Double)	Obsolete. Returns the SizeRequest of the element. Calling this method begins the measure pass of a layout cycle. (Inherited from VisualElement)
GetValue(BindableProperty)	Returns the value that is contained in the BindableProperty. (Inherited from BindableObject)
GetValues(BindableProperty, BindableProperty, BindableProperty)	Obsolete. For internal use by the Xamarin.Forms platform. (Inherited from BindableObject)
GetValues(BindableProperty, BindableProperty)	Obsolete. For internal use by the Xamarin.Forms platform. (Inherited from BindableObject)
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()	Event that is raised when the back button is pressed.
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)	Called when a child has been added to the 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)
OnChildRemoved(Element)	Obsolete. Application developers can override this method to respond when a child is removed. (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)
OnCurrentPageChanged()	Raises the CurrentPageChanged event.
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)
OnPagesChanged(NotifyCollectionChangedEventArgs)	Called when the pages of the MultiPage<T> have been changed.
OnParentSet()	Called when the Page's Parent property has changed. (Inherited from Page)
OnPropertyChanged(String)	Called when a bindable property has changed.
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)
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)
SetIndex(Page, Int32)	For internal use by the Xamarin.Forms platform.
SetupContent(T, Int32)	When overridden in a derived class, performs initialization of `content`.
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)
UnhookContent(T)	Application developers override this method to unregister event handlers for items that they registered in SetupContent(T, Int32).
UpdateChildrenLayout()	Requests that the children Elements of the Page update their layouts. (Inherited from Page)

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)
CurrentPageChanged	Raised when the CurrentPage property changes.
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)
PagesChanged	Raised when the children pages of the MultiPage<T> have changed.
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)
IItemsView<T>.CreateDefault(Object)	For internal use by the Xamarin.Forms platform.
IItemsView<T>.SetupContent(T, Int32)	For internal use by the Xamarin.Forms platform.
IItemsView<T>.UnhookContent(T)	For internal use by the Xamarin.Forms platform.
INameScope.RegisterName(String, Object)	For internal use only. (Inherited from Element)
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

Share via