C# Class ModernApp4Me.WP8.App.M4MPhoneApplicationPage

The basis class for all PhoneApplicationPages available in the framework.
Inheritance: PhoneApplicationPage
Datei anzeigen Open project: smartnsoft/ModernApp4Me

Protected Properties

Property Type Description
connectivityContainer System.Windows.Controls.Panel
displayLoaderPanelNextTime bool
isMVVMUsed bool
isManagingProgressIndicatorItself bool
loadingPanel System.Windows.Controls.Panel
mainContener System.Windows.Controls.Panel
progressIndicator ProgressIndicator
viewModel ModernApp4Me.Core.ViewModel.M4MBaseViewModel

Protected Methods

Method Description
ComputeViewModel ( ) : Task

This is the place where to load the business objects, from memory, local persistence, via web services, necessary for the entity processing. This callback is invoked from a background thread, and not the UI thread. This method is invoked only once during the M4MPhoneApplicationPage life cycle. Never invoke this method, only the framework should, because this is a callback!

LoadQueryString ( ) : void

This is the place where to retrieve data from the NavigationContext.QueryString. This method is invoked before the M4MPhoneApplicationPage.ComputeViewModel().

OnDisplayConnectivityLayout ( ) : void

Override this in order to personnalize the user experience when a M4MConnectivityException occurs.

OnFullfillDisplayObjects ( ) : void

This is the place where the implementing class can initialize the previously retrieved graphical objects. This method is invoked only once during the M4MPhoneApplicationPage life cycle. It is ensured that this method will be invoked from the UI thread! Never invoke this method, only the framework should, because this is a callback!

OnNavigatedFrom ( System.Windows.Navigation.NavigationEventArgs e ) : void
OnNavigatedTo ( System.Windows.Navigation.NavigationEventArgs e ) : void
Refresh ( ) : System.Threading.Tasks.Task

Invokes this method when you want to reload the business objects, from memory, local persistence, via web services, necessary for the entity processing.

RefreshViewModel ( ) : System.Threading.Tasks.Task

This is the place where you can update the M4MPhoneApplicationPage.viewModel after the invokation of the method M4MPhoneApplicationPage.Refresh(). This callback is invoked from a background thread, and not the UI thread. Never invoke this method, only the framework should, because this is a callback!

RetrieveConnectivityContainer ( ) : System.Windows.Controls.Panel

Override this in order to return the Panel which displays a particular message when a M4MConnectivityException is thrown. This Panel will be displayed or hidden automatically by the M4MPhoneApplicationPage during the life cycle.

RetrieveLoadingContainer ( ) : System.Windows.Controls.Panel

Override this in order to return the Panel which displays a particular message when the app is loading. This Panel will be displayed or hidden automatically by the M4MPhoneApplicationPage during the life cycle.

RetrieveMainContainer ( ) : System.Windows.Controls.Panel

Returns the Panel in which data are displayed. This Panel will be displayed or hidden automatically by the M4MPhoneApplicationPage during the life cycle.

RetrieveProgressIndicator ( ) : ProgressIndicator

Returns the ProgressIndicator of the M4MPhoneApplicationPage.

SendPage ( ) : void

Override this in order to send the PhoneApplicationPage when it is displayed.

Method Details

ComputeViewModel() protected abstract method

This is the place where to load the business objects, from memory, local persistence, via web services, necessary for the entity processing. This callback is invoked from a background thread, and not the UI thread. This method is invoked only once during the M4MPhoneApplicationPage life cycle. Never invoke this method, only the framework should, because this is a callback!
protected abstract ComputeViewModel ( ) : Task
return Task

LoadQueryString() protected method

This is the place where to retrieve data from the NavigationContext.QueryString. This method is invoked before the M4MPhoneApplicationPage.ComputeViewModel().
protected LoadQueryString ( ) : void
return void

OnDisplayConnectivityLayout() protected method

Override this in order to personnalize the user experience when a M4MConnectivityException occurs.
protected OnDisplayConnectivityLayout ( ) : void
return void

OnFullfillDisplayObjects() protected abstract method

This is the place where the implementing class can initialize the previously retrieved graphical objects. This method is invoked only once during the M4MPhoneApplicationPage life cycle. It is ensured that this method will be invoked from the UI thread! Never invoke this method, only the framework should, because this is a callback!
protected abstract OnFullfillDisplayObjects ( ) : void
return void

OnNavigatedFrom() protected method

protected OnNavigatedFrom ( System.Windows.Navigation.NavigationEventArgs e ) : void
e System.Windows.Navigation.NavigationEventArgs
return void

OnNavigatedTo() protected method

protected OnNavigatedTo ( System.Windows.Navigation.NavigationEventArgs e ) : void
e System.Windows.Navigation.NavigationEventArgs
return void

Refresh() protected method

Invokes this method when you want to reload the business objects, from memory, local persistence, via web services, necessary for the entity processing.
protected Refresh ( ) : System.Threading.Tasks.Task
return System.Threading.Tasks.Task

RefreshViewModel() protected method

This is the place where you can update the M4MPhoneApplicationPage.viewModel after the invokation of the method M4MPhoneApplicationPage.Refresh(). This callback is invoked from a background thread, and not the UI thread. Never invoke this method, only the framework should, because this is a callback!
protected RefreshViewModel ( ) : System.Threading.Tasks.Task
return System.Threading.Tasks.Task

RetrieveConnectivityContainer() protected method

Override this in order to return the Panel which displays a particular message when a M4MConnectivityException is thrown. This Panel will be displayed or hidden automatically by the M4MPhoneApplicationPage during the life cycle.
protected RetrieveConnectivityContainer ( ) : System.Windows.Controls.Panel
return System.Windows.Controls.Panel

RetrieveLoadingContainer() protected method

Override this in order to return the Panel which displays a particular message when the app is loading. This Panel will be displayed or hidden automatically by the M4MPhoneApplicationPage during the life cycle.
protected RetrieveLoadingContainer ( ) : System.Windows.Controls.Panel
return System.Windows.Controls.Panel

RetrieveMainContainer() protected abstract method

Returns the Panel in which data are displayed. This Panel will be displayed or hidden automatically by the M4MPhoneApplicationPage during the life cycle.
protected abstract RetrieveMainContainer ( ) : System.Windows.Controls.Panel
return System.Windows.Controls.Panel

RetrieveProgressIndicator() protected abstract method

Returns the ProgressIndicator of the M4MPhoneApplicationPage.
protected abstract RetrieveProgressIndicator ( ) : ProgressIndicator
return ProgressIndicator

SendPage() protected method

Override this in order to send the PhoneApplicationPage when it is displayed.
protected SendPage ( ) : void
return void

Property Details

connectivityContainer protected_oe property

protected Panel,System.Windows.Controls connectivityContainer
return System.Windows.Controls.Panel

displayLoaderPanelNextTime protected_oe property

protected bool displayLoaderPanelNextTime
return bool

isMVVMUsed protected_oe property

protected bool isMVVMUsed
return bool

isManagingProgressIndicatorItself protected_oe property

protected bool isManagingProgressIndicatorItself
return bool

loadingPanel protected_oe property

protected Panel,System.Windows.Controls loadingPanel
return System.Windows.Controls.Panel

mainContener protected_oe property

protected Panel,System.Windows.Controls mainContener
return System.Windows.Controls.Panel

progressIndicator protected_oe property

protected ProgressIndicator progressIndicator
return ProgressIndicator

viewModel protected_oe property

protected M4MBaseViewModel,ModernApp4Me.Core.ViewModel viewModel
return ModernApp4Me.Core.ViewModel.M4MBaseViewModel