)} ,System.String)} ,System.Action{System.EventHandler{--1}},System.Action{System.EventHandler{--1}})}

ICreatesCommandBinding.BindCommandToObject(ICommand?, T?, IObservable) method¶

Defined in

Type: ICreatesCommandBinding Namespace: ReactiveUI Assembly: ReactiveUI.Core.dll

Applies to

net10.0, net10.0-maccatalyst26.0, net10.0-desktop1.0, net10.0-browserwasm1.0, net10.0-tvos26.0, net10.0-windows10.0.19041, net10.0-macos26.0, net10.0-ios26.0, net10.0-android36.0, net9.0, net9.0-tvos18.0, net9.0-macos15.0, net9.0-maccatalyst18.0, net9.0-windows10.0.19041, net9.0-ios18.0, net9.0-desktop1.0, net8.0, net8.0-windows10.0.19041, net8.0-ios18.0, net8.0-maccatalyst18.0, net8.0-macos15.0, net8.0-tvos18.0, net8.0-ios17.5, net8.0-maccatalyst17.5, net8.0-macos14.5, netstandard2.1, net481, net462, net471

Overloads¶

1. IDisposable? BindCommandToObject<T>(ICommand? command, T? target, IObservable<object?> commandParameter) where T : class
2. IDisposable? BindCommandToObject<T, TEventArgs>(ICommand? command, T? target, IObservable<object?> commandParameter, string eventName) where T : class
3. IDisposable? BindCommandToObject<T, TEventArgs>(ICommand? command, T? target, IObservable<object?> commandParameter, Action<EventHandler<TEventArgs>> addHandler, Action<EventHandler<TEventArgs>> removeHandler) where T : class where TEventArgs : EventArgs

1. Overload¶

Attributes: [RequiresUnreferencedCode("String/reflection-based event binding may require members removed by trimming.")]

IDisposable? BindCommandToObject<T>(ICommand? command, T? target, IObservable<object?> commandParameter) where T : class

Summary: Bind an ICommand to a UI object, in the "default" way. The meaning of this is dependent on the implementation. This method will discover which event to bind to (e.g., Click, MouseUp) based on the control type. 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".

Type parameters

Name	Description
`T`	The type of the target object to which the command is bound. Must be a reference type.

Parameters

Name	Type	Description
`command`	ICommand?	The command to bind. Can be null.
`target`	`T?`	The target object, usually a UI control of some kind. Can be null.
`commandParameter`	IObservable	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, or null if no binding was created.

2. Overload¶

Attributes: [RequiresUnreferencedCode("String/reflection-based event binding may require members removed by trimming.")]

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

Summary: 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). This method is fully AOT-compatible as it uses generic type parameters instead of reflection.

Type parameters

Name	Description
`T`	The type of the target object to which the command is bound. Must be a reference type.
`TEventArgs`	The event argument type.

Parameters

Name	Type	Description
`command`	ICommand?	The command to bind. Can be null.
`target`	`T?`	The target object, usually a UI control of some kind. Can be null.
`commandParameter`	IObservable	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, or null if no binding was created.

3. Overload¶

IDisposable? BindCommandToObject<T, TEventArgs>(ICommand? command, T? target, IObservable<object?> commandParameter, Action<EventHandler<TEventArgs>> addHandler, Action<EventHandler<TEventArgs>> removeHandler) where T : class where TEventArgs : EventArgs

Summary: Binds a command to a specific event on a target object using explicit add/remove handler delegates.

Type parameters

Name	Description
`T`	The type of the target object.
`TEventArgs`	The event arguments type.

Parameters

Name	Type	Description
`command`	ICommand?	The command to bind. If `null`, no binding is created.
`target`	`T?`	The target object.
`commandParameter`	IObservable	An observable that supplies command parameter values.
`addHandler`	Action>	Adds the handler to the target event.
`removeHandler`	Action>	Removes the handler from the target event.

Returns: IDisposable? -- A disposable that unbinds the command.

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when `target`, `addHandler`, or `removeHandler` is `null`.