Table of Contents

Interface ICreatesCommandBinding

Namespace
ReactiveUI
Assembly
ReactiveUI.dll

Classes that implement this interface and registered inside Splat will be used to potentially provide binding to a ICommand in the ViewModel to a Control in the View.

public interface ICreatesCommandBinding
Extension Methods
WhenAnyMixin.WhenAny<TSender, TRet, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12>(TSender?, Expression<Func<TSender, T1>>, Expression<Func<TSender, T2>>, Expression<Func<TSender, T3>>, Expression<Func<TSender, T4>>, Expression<Func<TSender, T5>>, Expression<Func<TSender, T6>>, Expression<Func<TSender, T7>>, Expression<Func<TSender, T8>>, Expression<Func<TSender, T9>>, Expression<Func<TSender, T10>>, Expression<Func<TSender, T11>>, Expression<Func<TSender, T12>>, Func<IObservedChange<TSender, T1>, IObservedChange<TSender, T2>, IObservedChange<TSender, T3>, IObservedChange<TSender, T4>, IObservedChange<TSender, T5>, IObservedChange<TSender, T6>, IObservedChange<TSender, T7>, IObservedChange<TSender, T8>, IObservedChange<TSender, T9>, IObservedChange<TSender, T10>, IObservedChange<TSender, T11>, IObservedChange<TSender, T12>, TRet>)
WhenAnyMixin.WhenAny<TSender, TRet, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12>(TSender?, Expression<Func<TSender, T1>>, Expression<Func<TSender, T2>>, Expression<Func<TSender, T3>>, Expression<Func<TSender, T4>>, Expression<Func<TSender, T5>>, Expression<Func<TSender, T6>>, Expression<Func<TSender, T7>>, Expression<Func<TSender, T8>>, Expression<Func<TSender, T9>>, Expression<Func<TSender, T10>>, Expression<Func<TSender, T11>>, Expression<Func<TSender, T12>>, Func<IObservedChange<TSender, T1>, IObservedChange<TSender, T2>, IObservedChange<TSender, T3>, IObservedChange<TSender, T4>, IObservedChange<TSender, T5>, IObservedChange<TSender, T6>, IObservedChange<TSender, T7>, IObservedChange<TSender, T8>, IObservedChange<TSender, T9>, IObservedChange<TSender, T10>, IObservedChange<TSender, T11>, IObservedChange<TSender, T12>, TRet>, bool)

Methods

BindCommandToObject(ICommand?, object?, IObservable<object?>)

Bind an ICommand to a UI object, in the "default" way. The meaning of this is dependent on the implementation. Implement this if you have a new type of UI control that doesn't have Command/CommandParameter like WPF or has a non-standard event name for "Invoke".

IDisposable? BindCommandToObject(ICommand? command, object? target, IObservable<object?> commandParameter)

Parameters

command ICommand

The command to bind.

target object

The target object, usually a UI control of some kind.

commandParameter IObservable<object>

An IObservable source whose latest value will be passed as the command parameter to the command. Hosts will always pass a valid IObservable, but this may be Observable.Empty.

Returns

IDisposable

An IDisposable which will disconnect the binding when disposed.

BindCommandToObject<TEventArgs>(ICommand?, object?, IObservable<object?>, string)

Bind an ICommand to a UI object to a specific event. This event may be a standard .NET event, or it could be an event derived in another manner (i.e. in MonoTouch).

IDisposable? BindCommandToObject<TEventArgs>(ICommand? command, object? target, IObservable<object?> commandParameter, string eventName)

Parameters

command ICommand

The command to bind.

target object

The target object, usually a UI control of some kind.

commandParameter IObservable<object>

An IObservable source whose latest value will be passed as the command parameter to the command. Hosts will always pass a valid IObservable, but this may be Observable.Empty.

eventName string

The event to bind to.

Returns

IDisposable

An IDisposable which will disconnect the binding when disposed.

Type Parameters

TEventArgs

The event argument type.

GetAffinityForObject(Type, bool)

Returns a positive integer when this class supports BindCommandToObject for this particular Type. If the method isn't supported at all, return a non-positive integer. When multiple implementations return a positive value, the host will use the one which returns the highest value. When in doubt, return '2' or '0'.

int GetAffinityForObject(Type type, bool hasEventTarget)

Parameters

type Type

The type to query for.

hasEventTarget bool

If true, the host intends to use a custom event target.

Returns

int

A positive integer if BCTO is supported, zero or a negative value otherwise.