 | Plugin |
Defines a command that can be sent to a plugin.
Inheritance HierarchyNamespace: CompreDriveSDK.Plugins
Assembly: CompreDriveSDK (in CompreDriveSDK.dll) Version: 1.17.16
SyntaxThe PluginCommand type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PluginCommand(String) | Initializes a new instance of the PluginCommand class without value. |
| PluginCommand(String, Boolean) | Initializes a new instance of the PluginCommand class. |
| PluginCommand(String, Double) | Initializes a new instance of the PluginCommand class. |
| PluginCommand(String, String) | Initializes a new instance of the PluginCommand class. |
Properties| Name | Description | |
|---|---|---|
 | ButtonImageData | Gets or sets image data used for the ribbon button. |
| ButtonPath | Gets or sets a path to a button to create for this command. |
| LogCommandResult | Gets or sets a value indicating to CDC if the result of the command should be logged to the main log. |
| Name | Gets or sets the name of the command. |
| NumberSettings | Gets the number settings used in case this is a numeric parameter. |
| TextSettings | Gets the text settings used in case this is a text parameter. |
| Value | Gets or sets the command value. |
| ValueDescription | Gets or sets a description for the value. |
| ValueDisplayName | Gets or sets a display name for the value. |
| ValueType | Gets or sets the type of the command value. |
| ValueUnit | Gets or sets a unit name for the value. |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetBool | Gets the value as boolean. |
| GetDouble | Gets the value as double. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetString | Gets the value as string. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| SetupButton | Setup the ribbon button parameters with the given properties. |
| SetupValueDescription | Setup the value description texts of the command. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Events| Name | Description | |
|---|---|---|
 | ButtonImageDataChanged | Raised when the ButtonImageData property changes. |
| ButtonPathChanged | Raised when the ButtonPath property changes. |
See Also