View Location

View Location (IViewFor)

View Location is a feature of ReactiveUI that allows you to associate Views with ViewModels and set them up Automagically.


The easiest way to use View Location is via the ViewModelViewHost control, which is a View (on Cocoa, a UIView/NSView, and on XAML-based platforms a Control) which has a single ViewModel property. When the ViewModel property is set, View Location looks up the associated View and loads it into the container.

ViewModelViewHost is great for lists - so much so, that if you Bind to ItemsSource on XAML-based platforms and don't set a DataTemplate nor the DisplayMemberPath property, one gets configured that just uses ViewModelViewHost.

<ListBox x:Name="ToasterList" />
// Now ListBox automatically gets a DataTemplate
this.OneWayBind(ViewModel, vm => vm.ToasterList, v => v.ToasterList.ItemsSource);

This is not supported by Xamarin.Forms! You have to use a DataTemplate there and specify your view class.

Registering new Views

To use View Location, you must first register types, via Splat's Service Location feature.

Locator.CurrentMutable.Register(() => new ToasterView(), typeof(IViewFor<ToasterViewModel>));

View Location internally uses a class called ViewLocator which can either be replaced, or the default one used. The ResolveView method will return the View associated with a given ViewModel object.

Manually setting the view

Sometimes you need to manually set the view for the items in an ItemsControl or one of its subclasses. The easiest option is to set DisplayMemberPath, which will cause ReactiveUI to not assign a value to ItemTemplate and will instead show the referenced property as text. A more powerful option is manually setting a value for ItemTemplate, which gives you full control over how each item is displayed.

<!--  ReactiveUI will set ItemTemplate to ViewModelViewHost -->
<ItemsControl />

<!--  ReactiveUI ignores this one because ItemTemplate is already set -->

<!--  ReactiveUI ignores this one because DisplayMemberPath is already set -->
<ItemsControl DisplayMemberPath="SomeValue" /> 

It's possible you want to use DisplayMemberPath, but don't know the value for it at compile time. Trying to bind the property will result in the following exception: "InvalidOperationException: Cannot set both DisplayMemberPath and ItemTemplate". This is because ReactiveUI looks at the control on initialization, does not see any preset value for DisplayMemberPath nor ItemTemplate and decides to set ItemTemplate to ViewModelViewHost. Then, when the ViewModel is attached to the View, the binding tries to set the value for DisplayMemberPath, and the aforementioned exception occurs. The solution is to set a dummy value for DisplayMemberPath, which will be replaced by the binding but will stop ReactiveUI from trying to set ItemTemplate.

<!-- The dummy value will cause ReactiveUI to ignore this control -->
<ItemsControl Name="MyItemsControl" DisplayMemberPath="DummyValue" /> 
//This binding will override the dummy value
this.OneWayBind(ViewModel, vm => vm.MyDisplayMemberPath, v => v.MyItemsControl.DisplayMemberPath);

Overriding ViewLocator

If you want to override the view locator, then you want to start by creating a class that inherits from IViewLocator.

public class ConventionalViewLocator : IViewLocator
    public IViewFor ResolveView<T>(T viewModel, string contract = null) where T : class
        // Find view's by chopping of the 'Model' on the view model name
        // MyApp.ShellViewModel => MyApp.ShellView
        var viewModelName = viewModel.GetType().FullName;
        var viewTypeName = viewModelName.TrimEnd("Model".ToCharArray());

            var viewType = Type.GetType(viewTypeName);
            if (viewType == null)
                this.Log().Error($"Could not find the view {viewTypeName} for view model {viewModelName}.");
                return null;
            return Activator.CreateInstance(viewType) as IViewFor;
        catch (Exception)
            this.Log().Error($"Could not instantiate view {viewTypeName}.");

Then, while bootstrapping your app you'll want to tell ReactiveUI about your new view locator:

// Make sure Splat and ReactiveUI are already configured in the locator
// so that our override runs last

Locator.CurrentMutable.RegisterLazySingleton(() => new ConventionalViewLocator(), typeof(IViewLocator));