C# Class ReactiveUI.RoutableViewModelMixin

Show file Open project: reactiveui/ReactiveUI

Public Methods

Method Description
WhenNavigatedTo ( this This, Func onNavigatedTo ) : IDisposable

This method allows you to set up connections that only operate while the ViewModel has focus, and cleans up when the ViewModel loses focus.

WhenNavigatedToObservable ( this This ) : IObservable

This method will return an observable that fires events every time the topmost ViewModel in the navigation stack is this ViewModel. This allows you to set up connections that only operate while the ViewModel has focus. The observable will complete when the ViewModel is removed completely from the navigation stack. If your ViewModel can be _removed_ from the navigation stack and then reused later, you must call this method and resubscribe each time it is reused.

WhenNavigatingFromObservable ( this This ) : IObservable

This method will return an observable that fires events _just before_ the ViewModel is no longer the topmost ViewModel in the navigation stack. This allows you to clean up anything before losing focus. The observable will complete when the ViewModel is removed completely from the navigation stack. If your ViewModel can be _removed_ from the navigation stack and then reused later, you must call this method and resubscribe each time it is reused.

Method Details

WhenNavigatedTo() public static method

This method allows you to set up connections that only operate while the ViewModel has focus, and cleans up when the ViewModel loses focus.
public static WhenNavigatedTo ( this This, Func onNavigatedTo ) : IDisposable
This this
onNavigatedTo Func Called when the ViewModel is navigated /// to - return an IDisposable that cleans up all of the things that are /// configured in the method.
return IDisposable

WhenNavigatedToObservable() public static method

This method will return an observable that fires events every time the topmost ViewModel in the navigation stack is this ViewModel. This allows you to set up connections that only operate while the ViewModel has focus. The observable will complete when the ViewModel is removed completely from the navigation stack. If your ViewModel can be _removed_ from the navigation stack and then reused later, you must call this method and resubscribe each time it is reused.
public static WhenNavigatedToObservable ( this This ) : IObservable
This this
return IObservable

WhenNavigatingFromObservable() public static method

This method will return an observable that fires events _just before_ the ViewModel is no longer the topmost ViewModel in the navigation stack. This allows you to clean up anything before losing focus. The observable will complete when the ViewModel is removed completely from the navigation stack. If your ViewModel can be _removed_ from the navigation stack and then reused later, you must call this method and resubscribe each time it is reused.
public static WhenNavigatingFromObservable ( this This ) : IObservable
This this
return IObservable