Class InteractionBindingMixins

Namespace

ReactiveUI

Assembly

ReactiveUI.dll

This class provides extension methods for the ReactiveUI view binding mechanism.

public static class InteractionBindingMixins

Inheritance

object

InteractionBindingMixins

Examples

this.WhenActivated(disposables =>
{
    this.BindInteraction(ViewModel, vm => vm.ShowDialog, HandleDialogAsync)
        .DisposeWith(disposables);
});

Remarks

Interaction bindings are usually established within a view's activation block to ensure registrations are disposed when the view is no longer visible. The helpers resolve the IInteraction<TInput, TOutput> on the view model via an expression and hook it to a handler that can await UI prompts such as dialogs.

Methods

BindInteraction<TViewModel, TView, TInput, TOutput>(TView, TViewModel?, Expression<Func<TViewModel, IInteraction<TInput, TOutput>>>, Func<IInteractionContext<TInput, TOutput>, Task>)

Binds the IInteraction<TInput, TOutput> on a ViewModel to the specified handler.

[RequiresDynamicCode("BindInteraction uses expression binding which requires dynamic code generation")]
[RequiresUnreferencedCode("BindInteraction uses expression binding which may require unreferenced code")]
public static IDisposable BindInteraction<TViewModel, TView, TInput, TOutput>(this TView view, TViewModel? viewModel, Expression<Func<TViewModel, IInteraction<TInput, TOutput>>> propertyName, Func<IInteractionContext<TInput, TOutput>, Task> handler) where TViewModel : class where TView : class, IViewFor

Parameters

view TView

The view to bind to.

viewModel TViewModel

The view model to bind to.

propertyName Expression<Func<TViewModel, IInteraction<TInput, TOutput>>>

The name of the property on the View Model.

handler Func<IInteractionContext<TInput, TOutput>, Task>

The handler.

Returns

IDisposable

An object that when disposed, disconnects the binding.

Type Parameters

TViewModel

The type of the view model.

TView

The type of the view being bound.

TInput

The interaction's input type.

TOutput

The interaction's output type.

BindInteraction<TViewModel, TView, TInput, TOutput, TDontCare>(TView, TViewModel?, Expression<Func<TViewModel, IInteraction<TInput, TOutput>>>, Func<IInteractionContext<TInput, TOutput>, IObservable<TDontCare>>)

Binds the IInteraction<TInput, TOutput> on a ViewModel to the specified handler.

[RequiresDynamicCode("BindInteraction uses expression binding which requires dynamic code generation")]
[RequiresUnreferencedCode("BindInteraction uses expression binding which may require unreferenced code")]
public static IDisposable BindInteraction<TViewModel, TView, TInput, TOutput, TDontCare>(this TView view, TViewModel? viewModel, Expression<Func<TViewModel, IInteraction<TInput, TOutput>>> propertyName, Func<IInteractionContext<TInput, TOutput>, IObservable<TDontCare>> handler) where TViewModel : class where TView : class, IViewFor

Parameters

view TView

The view to bind to.

viewModel TViewModel

The view model to bind to.

propertyName Expression<Func<TViewModel, IInteraction<TInput, TOutput>>>

The name of the property on the View Model.

handler Func<IInteractionContext<TInput, TOutput>, IObservable<TDontCare>>

The handler.

Returns

IDisposable

An object that when disposed, disconnects the binding.

Type Parameters

TViewModel

The type of the view model.

TView

The type of the view being bound.

TInput

The interaction's input type.

TOutput

The interaction's output type.

TDontCare

The interaction's signal type.