INatAutoCommand

#### Search Results

Search

# INatAutoCommand

This document covers the following topics:

- Purpose

- Properties

## Purpose

A command defined by a plug-in.

## Properties

The following properties are available:

- Parent

- Studio

- Caption

- ImageID

- CommandID

- Enabled

- Checked

### Parent

Used to navigate to the parent interface of this interface.

Natural Data Format | Variant Type | Remark
--- | --- | ---
HANDLE OF OBJECT | VT_DISPATCH (INatAutoCommands) | Get only

### Studio

Used to navigate to the root interface.

Natural Data Format | Variant Type | Remark
--- | --- | ---
HANDLE OF OBJECT | VT_DISPATCH (INatAutoStudio) | Get only

### Caption

A string used to identify the command in menus and toolbars.

Natural Data Format | Variant Type | Remark
--- | --- | ---
A | VT_BSTR | Get only

### ImageID

Index of the image that represents the command visually. This index can be used in the method `INatAutoCommands::Add` to specify an image for a new command.

Natural Data Format | Variant Type | Remark
--- | --- | ---
I4 | VT_I4 | Get only

### CommandID

Numeric ID of the command. When the user later selects the command in the user interface, this ID is passed to the plug-in in the method `INaturalStudioPlugIn::OnCommand`.

Natural Data Format | Variant Type | Remark
--- | --- | ---
I4 | VT_I4 | Get only

### Enabled

Indicates if the command shall be enabled or disabled, or if Natural Studio shall ask the plug-in for the status of the command on a regular basis through the method `OnCommandStatus`.

Natural Data Format | Variant Type | Remark
--- | --- | ---
I2 | VT_I2 |

#### Values

0 | Natural Studio asks the plug-in for the enabled status of the command through the method `OnCommandStatus`. This is the default.
-1 | The command is disabled.
1 | The command is enabled.

### Checked

Indicates if the command shall have a check mark or not, or if Natural Studio shall ask the plug-in for the checked status of the command on a regular basis through the method `OnCommandStatus`.

Natural Data Format | Variant Type | Remark
--- | --- | ---
I2 | VT_I2 |

#### Values

0 | Natural Studio asks the plug-in for the checked status of the command through the method `OnCommandStatus`. This is the default.
-1 | The command has no check mark.
1 | The command has a check mark.

### On this page

- Purpose
- Properties