UIVisualizerService
| Name | Value |
|---|---|
| Assembly | Catel.Core |
| Namespace | Catel.Services |
| Available on | .NET Framework 4.5, .NET Framework 4.6, Xamarin - iOS |
public class UIVisualizerService : IUIVisualizerService, ViewModelServiceBase
Base types ViewModelServiceBase
Implements interfaces IUIVisualizerService
Service to show modal or non-modal popup windows. All windows will have to be registered manually or are be resolved via the IViewLocator.
Fields
RegisteredWindows
Dictionary of registered windows.
Constructors
UIVisualizerService(IViewLocator viewLocator)
Initializes a new instance of the UIVisualizerService class.
Parameters
| Name | Description |
|---|---|
| viewLocator | The view locator. |
Exceptions
| Name | Description |
|---|---|
| ArgumentNullException | The viewLocator isnull. |
Methods
CreateWindow(Type windowType, object data, EventHandler<UICompletedEventArgs> completedProc, bool isModal)
This creates the window of the specified type.
Parameters
| Name | Description |
|---|---|
| windowType | The type of the window. |
| data | The data that will be set as data context. |
| completedProc | The completed callback. |
| isModal | True if this is a ShowDialog request. |
Returns
The created window.
CreateWindow(string name, object data, EventHandler<UICompletedEventArgs> completedProc, bool isModal)
This creates the window from a key.
Parameters
| Name | Description |
|---|---|
| name | The name that the window is registered with. |
| data | The data that will be set as data context. |
| completedProc | The completed callback. |
| isModal | True if this is a ShowDialog request. |
Returns
The created window.
EnsureViewIsRegistered(string name)
Ensures that the specified view is registered.
Parameters
| Name | Description |
|---|---|
| name | The name. |
Exceptions
| Name | Description |
|---|---|
| T:Catel.Services.WindowNotRegisteredException |
GetActiveWindow()
Gets the active window to use as parent window of new windows. The default implementation returns the active window of the application.
Returns
The active window.
HandleCloseSubscription(object window, object data, EventHandler<UICompletedEventArgs> completedProc, bool isModal)
Handles the close subscription. The default implementation uses the WeakEventListener.
Parameters
| Name | Description |
|---|---|
| window | The window. |
| data | The data that will be set as data context. |
| completedProc | The completed callback. |
| isModal | True if this is a ShowDialog request. |
IsRegistered(string name)
Determines whether the specified name is registered.
Parameters
| Name | Description |
|---|---|
| name | The name. |
Returns
true if the specified name is registered; otherwise,false.
Exceptions
| Name | Description |
|---|---|
| ArgumentException | The name isnull or whitespace. |
Register(string name, Type windowType, bool throwExceptionIfExists)
Registers the specified view model and the window type. This way, Catel knowns what window to show when a specific view model window is requested.
Parameters
| Name | Description |
|---|---|
| name | Name of the registered window. |
| windowType | Type of the window. |
| throwExceptionIfExists | if set totrue, this method will throw an exception when already registered. |
Exceptions
| Name | Description |
|---|---|
| System.InvalidOperationException | |
| ArgumentException | The name isnull or whitespace. |
RegisterViewForViewModelIfRequired(Type viewModelType)
Registers the view for the specified view model if required.
Parameters
| Name | Description |
|---|---|
| viewModelType | Type of the view model. |
ShowAsync(IViewModel viewModel, EventHandler<UICompletedEventArgs> completedProc)
Shows a window that is registered with the specified view model in a non-modal state.
Parameters
| Name | Description |
|---|---|
| viewModel | The view model. |
| completedProc | The callback procedure that will be invoked as soon as the window is closed. This value can benull. |
Returns
true if the popup window is successfully opened; otherwisefalse.
Exceptions
| Name | Description |
|---|---|
| ArgumentNullException | The viewModel isnull. |
| T:Catel.MVVM.ViewModelNotRegisteredException | The viewModel is not registered by the method first. |
ShowAsync(string name, object data, EventHandler<UICompletedEventArgs> completedProc)
Shows a window that is registered with the specified view model in a non-modal state.
Parameters
| Name | Description |
|---|---|
| name | The name that the window is registered with. |
| data | The data to set as data context. Ifnull, the data context will be untouched. |
| completedProc | The callback procedure that will be invoked as soon as the window is closed. This value can benull. |
Returns
true if the popup window is successfully opened; otherwisefalse.
Exceptions
| Name | Description |
|---|---|
| ArgumentException | The name isnull or whitespace. |
| T:Catel.Services.WindowNotRegisteredException | The name is not registered by the method first. |
ShowDialogAsync(IViewModel viewModel, EventHandler<UICompletedEventArgs> completedProc)
Shows a window that is registered with the specified view model in a modal state.
Parameters
| Name | Description |
|---|---|
| viewModel | The view model. |
| completedProc | The callback procedure that will be invoked as soon as the window is closed. This value can benull. |
Returns
Nullable boolean representing the dialog result.
Exceptions
| Name | Description |
|---|---|
| ArgumentNullException | The viewModel isnull. |
| T:Catel.Services.WindowNotRegisteredException | The viewModel is not registered by the method first. |
ShowDialogAsync(string name, object data, EventHandler<UICompletedEventArgs> completedProc)
Shows a window that is registered with the specified view model in a modal state.
Parameters
| Name | Description |
|---|---|
| name | The name that the window is registered with. |
| data | The data to set as data context. Ifnull, the data context will be untouched. |
| completedProc | The callback procedure that will be invoked as soon as the window is closed. This value can benull. |
Returns
Nullable boolean representing the dialog result.
Exceptions
| Name | Description |
|---|---|
| ArgumentException | The name isnull or whitespace. |
| T:Catel.Services.WindowNotRegisteredException | The name is not registered by the method first. |
ShowWindowAsync(FrameworkElement window, object data, bool showModal)
Shows the window.
Parameters
| Name | Description |
|---|---|
| window | The window. |
| data | The data. |
| showModal | Iftrue, the window should be shown as modal. |
Returns
true if the window is closed with success; otherwisefalse ornull.
Unregister(string name)
This unregisters the specified view model.
Parameters
| Name | Description |
|---|---|
| name | Name of the registered window. |
Returns
true if the view model is unregistered; otherwisefalse.
Have a question about Catel? Use StackOverflow with the Catel tag!