Summary
Encapsulates a composite user interaction.
- Namespace
- ReactiveUI
- Interfaces
-
- IReactiveCommand
<TParam, IList <TResult> > - IObservable
<IList <TResult> > - IReactiveCommand
- IDisposable
- I
Handle Observable Errors - ICommand
- IReactiveCommand
- Base Types
-
- object
- ReactiveCommandBase
<TParam, IList <TResult> >
graph BT
Type-->Base0["ReactiveCommandBase<TParam, IList<TResult>>"]
Base0-->Base1["object"]
Type-.->Interface0["IReactiveCommand<TParam, IList<TResult>>"]
Type-.->Interface1["IObservable<IList<TResult>>"]
Type-.->Interface2["IReactiveCommand"]
click Interface2 "/api/ReactiveUI/IReactiveCommand"
Type-.->Interface3["IDisposable"]
Type-.->Interface4["IHandleObservableErrors"]
click Interface4 "/api/ReactiveUI/IHandleObservableErrors"
Type-.->Interface5["ICommand"]
Type["CombinedReactiveCommand<TParam, TResult>"]
class Type type-node
Syntax
public class CombinedReactiveCommand<TParam, TResult> :
ReactiveCommandBase<TParam, IList<TResult>>, IReactiveCommand<TParam, IList<TResult>>,
IObservable<IList<TResult>>, IReactiveCommand, IDisposable, IHandleObservableErrors, ICommand
Remarks
This class provides the bulk of the actual implementation for combined reactive commands. You should not
create instances of this class directly, but rather via the static creation methods on the non-generic
ReactiveCommand
class.
A CombinedReactiveCommand
combines multiple reactive commands into a single command. Executing
the combined command executes all child commands. Since all child commands will receive the same execution
parameter, all child commands must accept a parameter of the same type.
In order for the combined command to be executable, all child commands must themselves be executable.
In addition, any canExecute
observable passed in during construction must also yield true
.
Type Parameters
Name | Description |
---|---|
TParam | The type of parameter values passed in during command execution. |
TResult | The type of the values that are the result of command execution. |
Properties
Name | Value | Summary |
---|---|---|
CanExecute | IObservable |
Gets an observable whose value indicates whether the command can currently execute.
|
IsExecuting | IObservable |
Gets an observable whose value indicates whether the command is currently executing.
|
ThrownExceptions | IObservable |
Gets a observable which will fire whenever an exception would normally terminate ReactiveUI
internal state.
|
Methods
Name | Value | Summary |
---|---|---|
Dispose |
void |
Disposes of the managed resources.
|
Execute |
IObservable |
Gets an observable that, when subscribed, executes this command.
|
Execute |
IObservable |
Gets an observable that, when subscribed, executes this command.
|
Subscribe |
IDisposable |
Subscribes to execution results from this command.
|