ICommandParameter Interface#

Interface class for command parameters.

Syntax#

C#

public interface ICommandParameter : IParameter

VB

Public Interface ICommandParameter
    Inherits IParameter

The ICommandParameter type exposes the following members.

Properties#

	Name	Description
	Advanced	The advanced parameter settings, if available. (Inherited from IParameter.)
	FullName	The full name of the parameter including path information. (Inherited from IParameter.)
	IsEmpty	Indicates if the parameter is empty. If true, the parameter is invalid or does not exist. If a requested parameter does not exist in a parameter collection, an empty parameter object will be returned to simplify handling. An empty parameter is never readable or writable. (Inherited from IParameter.)
	IsReadable	Indicates if the parameter is readable. (Inherited from IParameter.)
	IsWritable	Indicates if the parameter is writable. (Inherited from IParameter.)
	Name	The name of the parameter without path information. (Inherited from IParameter.)

Methods#

	Name	Description
	Execute	Executes the command and returns immediately.
	IsExecuting	Indicates if the command is currently executing.
	ParseAndSetValue	Parses the value as string and sets the value. (Inherited from IParameter.)
	ToString	The parameter value as a string. (Inherited from IParameter.)

Events#

	Name	Description
	ParameterChanged	This event fires after any of the parameter properties (value, readability, writability, or advanced parameter settings) have changed. (Inherited from IParameter.)
	ParameterValueChanged	This event fires after the parameter value has changed. (Inherited from IParameter.)

Extension Methods#

	Name	Description
	TryExecute	Executes the command and returns immediately if the parameter is writable. (Defined by ICommandParameterExtensions.)

ICommandParameter.Execute Method#

Executes the command and returns immediately.

Syntax#

C#

void Execute()

VB

Sub Execute

Remarks#

Preconditions:
 

• The parameter must be writable.

Error Safety: Can throw exceptions if the parameter is not writable or if accessing the camera failed.

ICommandParameter.IsExecuting Method#

Indicates if the command is currently executing.

Syntax#

C#

bool IsExecuting()

VB

Function IsExecuting As Boolean

Return Value#

Type: Boolean
Returns true if the command is currently executing, otherwise false.

Remarks#

Thread Safety: This method is synchronized with the source of the parameter collection, if any.

Error Safety: Can throw exceptions if accessing the camera failed.