Class PropCommand

Command properties represent an action that can be performed by the device.

Inheritance

object

HandleObject

Property

PropCommand

Implements

IDisposable

Inherited Members

Property.Notification

Property.Type

Property.DisplayName

Property.Name

Property.Description

Property.Tooltip

Property.Visibility

Property.IsLocked

Property.IsLikelyLockedByStream

Property.IsAvailable

Property.IsReadonly

Property.IsSelector

Property.SelectedProperties

HandleObject.Dispose(bool)

HandleObject.Dispose()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: ic4

Assembly: ic4dotnet.dll

Syntax

public class PropCommand : Property, IDisposable

Remarks

A common example for a command property is TriggerSoftware.

PropCommand instances are created in multiple ways:

• By directly querying a PropertyMap for a category property:
  • Find(PropIdCommand)
  • FindCommand(string)
  • TryFind(PropIdCommand, out PropCommand)
  • TryFindCommand(string, out PropCommand)
• By casting a Property object obtained from one of the functions returning generic property objects:
  • Find(string)
  • TryFind(string, out Property)
  • Features
  • All

Properties

IsDone

Checks whether a command has finished executing.

Declaration

public bool IsDone { get; }

Property Value

Type	Description
bool	true, if the command is completed. false, if the command is still executing.

Remarks

If the command was never executed before, the value is true.

Exceptions

Type	Condition
IC4Exception	Check ErrorCode and ToString() for details.

Methods

Execute()

Executes the command.

Declaration

public void Execute()

Exceptions

Type	Condition
IC4Exception	Check ErrorCode and ToString() for details.

Implements

IDisposable