Application Application Class

Definition

Class that represents a cross-platform mobile application.

public class Application : Xamarin.Forms.Element, Xamarin.Forms.IApplicationController, Xamarin.Forms.IElementConfiguration<Xamarin.Forms.Application>
type Application = class
    inherit Element
    interface IApplicationController
    interface IElementConfiguration<Application>
Inheritance
Implements

Remarks

The Application class is the core of a Xamarin.Forms application. It sets the root page of the application, persists primitive type data across invocations of the application in the Properties dictionary, and provides events to respond to pushing and popping of modal views. Visual studio creates this class for the developer in the appropriate project in a new Xamarin.Forms solution.

Both Visual Studio for Mac and Visual Studio create a XAML file for the application when the developer creates a Xamarin.Forms solution. The following example code a typical Application class, with an entry in its resource dictionary, from such a XAML file.


<Application xmlns="http://xamarin.com/schemas/2014/forms"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             x:Class="App1.App">
  <Application.Resources>
     <Color x:Key="ButtonBackgroundColor">Red</Color>
  </Application.Resources>
</Application>

Constructors

Application() Application()

Initializes a new Application instance.

Properties

AppLinks AppLinks

Gets the object that developers use to register or unregister application links.

AutomationId AutomationId

Gets or sets a value that allows the automation framework to find and interact with this element.

(Inherited from Element)
BindingContext 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)
ClassId ClassId

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

(Inherited from Element)
Current Current

Gets the current application.

EffectControlProvider EffectControlProvider

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
Effects Effects

A list of the effects that are applied to this item.

(Inherited from Element)
Id Id

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

(Inherited from Element)
LogicalChildren LogicalChildren

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
LogWarningsToApplicationOutput LogWarningsToApplicationOutput

Gets or sets whether runtime warnings are sent to the application's output.

MainPage MainPage

Gets or sets the root page of the application.

NavigationProxy NavigationProxy

For internal use by the Xamarin.Forms platform.

PanGestureId PanGestureId

For internal use by the Xamarin.Forms platform.

Parent Parent

Gets or sets the parent element of the element.

(Inherited from Element)
ParentView ParentView

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

(Inherited from Element)
Platform Platform

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
Properties Properties

Gets a dictionary of persistent properties for this Application object.

RealParent RealParent

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
Resources Resources

Gets or sets the resource dictionary for this Application object.

StyleId StyleId

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

(Inherited from Element)

Methods

ApplyBindings() ApplyBindings()

Apply the bindings to BindingContext.

(Inherited from BindableObject)
ClearCurrent() ClearCurrent()

For internal use by the Xamarin.Forms platform.

ClearValue(BindableProperty) ClearValue(BindableProperty)

Clears any value set by SetValue for property.

(Inherited from BindableObject)
ClearValue(BindablePropertyKey) ClearValue(BindablePropertyKey)

Clears any value set by SetValue for the property that is identified by propertyKey.

(Inherited from BindableObject)
Descendants() Descendants()

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
EffectIsAttached(String) EffectIsAttached(String)

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
FindByName(String) FindByName(String)

Returns the element that has the specified name.

(Inherited from Element)
GetValue(BindableProperty) GetValue(BindableProperty)

Returns the value that is contained the BindableProperty.

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

For internal use by the Xamarin.Forms platform.

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

For internal use by the Xamarin.Forms platform.

(Inherited from BindableObject)
IsApplicationOrNull(Element) IsApplicationOrNull(Element)

For internal use by the Xamarin.Forms platform.

IsSet(BindableProperty) IsSet(BindableProperty)

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

(Inherited from BindableObject)
On<T>() On<T>()

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

OnAppLinkRequestReceived(Uri) OnAppLinkRequestReceived(Uri)

App developers override this method to respond when the user initiates an app link request.

OnBindingContextChanged() OnBindingContextChanged()

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

(Inherited from Element)
OnChildAdded(Element) OnChildAdded(Element)

Invoked whenever the ChildAdded event needs to be emitted. Implement this method to add class handling for this event.

(Inherited from Element)
OnChildRemoved(Element) OnChildRemoved(Element)

Invoked whenever the ChildRemoved event needs to be emitted. Implement this method to add class handling for this event.

(Inherited from Element)
OnParentSet() OnParentSet()

Throws InvalidOperationException.

OnPropertyChanged(String) OnPropertyChanged(String)

Method that is called when a bound property is changed.

(Inherited from Element)
OnPropertyChanging(String) OnPropertyChanging(String)

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

(Inherited from BindableObject)
OnResume() OnResume()

Application developers override this method to perform actions when the application resumes from a sleeping state.

OnSleep() OnSleep()

Application developers override this method to perform actions when the application enters the sleeping state.

OnStart() OnStart()

Application developers override this method to perform actions when the application starts.

Quit() Quit()

Quits the application.

RemoveBinding(BindableProperty) RemoveBinding(BindableProperty)

Removes a previously set binding.

(Inherited from BindableObject)
RemoveDynamicResource(BindableProperty) RemoveDynamicResource(BindableProperty)

Removes a previously set dynamic resource

(Inherited from Element)
SavePropertiesAsync() SavePropertiesAsync()

Asynchronously persists the Properties dictionary for the application object.

SendOnAppLinkRequestReceived(Uri) SendOnAppLinkRequestReceived(Uri)

For internal use by the Xamarin.Forms platform.

SendResume() SendResume()

For internal use by the Xamarin.Forms platform.

SendSleep() SendSleep()

For internal use by the Xamarin.Forms platform.

SendSleepAsync() SendSleepAsync()

For internal use by the Xamarin.Forms platform.

SendStart() SendStart()

For internal use by the Xamarin.Forms platform.

SetAppIndexingProvider(IAppIndexingProvider) SetAppIndexingProvider(IAppIndexingProvider)

For internal use by the Xamarin.Forms platform.

SetBinding(BindableProperty, BindingBase) SetBinding(BindableProperty, BindingBase)

Assigns a binding to a property.

(Inherited from BindableObject)
SetCurrentApplication(Application) SetCurrentApplication(Application)

For internal use by the Xamarin.Forms platform.

SetDynamicResource(BindableProperty, String) SetDynamicResource(BindableProperty, String)

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

(Inherited from Element)
SetValue(BindableProperty, Object) SetValue(BindableProperty, Object)

Sets the value of the specified property.

(Inherited from BindableObject)
SetValue(BindablePropertyKey, Object) SetValue(BindablePropertyKey, Object)

Sets the value of the propertyKey.

(Inherited from BindableObject)
SetValueCore(BindableProperty, Object, SetValueFlags) SetValueCore(BindableProperty, Object, SetValueFlags)

For internal use by the Xamarin.Forms platform.

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

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
SetValueFromRenderer(BindablePropertyKey, Object) SetValueFromRenderer(BindablePropertyKey, Object)

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
UnapplyBindings() UnapplyBindings()

Unapplies all previously set bindings.

(Inherited from BindableObject)

Events

BindingContextChanged BindingContextChanged

Raised whenever the BindingContext property changes.

(Inherited from BindableObject)
ChildAdded ChildAdded

Occurs whenever a child element is added to the element.

(Inherited from Element)
ChildRemoved ChildRemoved

Occurs whenever a child element is removed from the element.

(Inherited from Element)
DescendantAdded DescendantAdded

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

(Inherited from Element)
DescendantRemoved DescendantRemoved

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

(Inherited from Element)
ModalPopped ModalPopped

Event that is raised after a view has been popped modally.

ModalPopping ModalPopping

Event that is raised when a view is modally popped.

ModalPushed ModalPushed

Event that is raised after a view has been pushed modally.

ModalPushing ModalPushing

Event that is raised when a view is modally pushed.

PageAppearing PageAppearing

Event that is raised when a page is about to appear on the screen.

PageDisappearing PageDisappearing

Event that is raised when a page is about to disappear from the screen.

PlatformSet PlatformSet

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
PropertyChanged PropertyChanged

Raised when a property has changed.

(Inherited from BindableObject)
PropertyChanging PropertyChanging

Raised when a property is about to change.

(Inherited from BindableObject)

Explicit Interface Implementations

IDynamicResourceHandler.SetDynamicResource(BindableProperty, String) IDynamicResourceHandler.SetDynamicResource(BindableProperty, String)

For internal use by the Xamarin.Forms platform.

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

For internal use by the Xamarin.Forms platform.

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

For internal use only.

(Inherited from Element)

Extension Methods

SetBinding(BindableObject, BindableProperty, String, BindingMode, IValueConverter, String) 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) SetBinding<TSource>(BindableObject, BindableProperty, Expression<Func<TSource,Object>>, BindingMode, IValueConverter, String)

Creates and applies a binding from an expression.

GetGroup<TView,TItem>(TItem) GetGroup<TView,TItem>(TItem)

For internal use by platform renderers.

GetGroupHeaderContent<TView,TItem>(TItem) GetGroupHeaderContent<TView,TItem>(TItem)

For internal use by platform renderers.

GetIndex<TView,TItem>(TItem) GetIndex<TView,TItem>(TItem)

For internal use by platform renderers.

GetIsGroupHeader<TView,TItem>(TItem) GetIsGroupHeader<TView,TItem>(TItem)

For internal use by platform renderers.

SetIsGroupHeader<TView,TItem>(TItem, Boolean) SetIsGroupHeader<TView,TItem>(TItem, Boolean)

For internal use by platform renderers.

FindByName<T>(Element, String) FindByName<T>(Element, String)

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

LoadFromXaml<TXaml>(TXaml, String) LoadFromXaml<TXaml>(TXaml, String)

Returns an initialized view by loading the specified xaml.

LoadFromXaml<TXaml>(TXaml, Type) LoadFromXaml<TXaml>(TXaml, Type)

Returns a TXaml with the properties that are defined in the application manifest for callingType.

Applies to