INatAutoToolBar

#### Search Results

Search

# INatAutoToolBar

This document covers the following topics:

- Purpose

- Properties

- Methods

## Purpose

Gives access to a specific toolbar.

## Properties

The following properties are available:

- Parent

- Studio

- Caption

- Visible

### Parent

Used to navigate to the parent interface of this interface.

Natural Data Format | Variant Type | Remark
--- | --- | ---
HANDLE OF OBJECT | VT_DISPATCH (INatAutoToolBars) | 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 toolbar, as defined when the toolbar was created.

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

### Visible

Indicates if the toolbar is currently visible or not. Modifying this property hides or shows the toolbar.

Natural Data Format | Variant Type | Remark
--- | --- | ---
L | VT_BOOL |

## Methods

The following methods are available:

- InsertCommand

- InsertSeparator

- Dock

### InsertCommand

Inserts a command into the toolbar.

#### Parameters

Name | Natural Data Format | Variant Type | Remark
--- | --- | --- | ---
Command | HANDLE OF OBJECT | VT_DISPATCH (INatAutoCommand) |
Index | I4 | VT_I4 | Optional

> Command

>   A command to be added to the toolbar. The command must have been defined before using the method `INatAutoCommands::Add`.

> Index

>   The position in the toolbar where the command shall be inserted. If Index is omitted, the command is inserted at the last position.

### InsertSeparator

Inserts a separator into the toolbar.

#### Parameters

Name | Natural Data Format | Variant Type | Remark
--- | --- | --- | ---
Return value |  |  | None
Index | I4 | VT_I4 | Optional

> Index

>   The position in the toolbar where the separator shall be inserted. If Index is omitted, the separator is inserted at the last position.

### Dock

Docks the toolbar to another toolbar or to the Natural Studio frame window. The docking position of dynamically created toolbars is not retained persistently between Natural Studio sessions.

#### Parameters

Name | Natural Data Format | Variant Type | Remark
--- | --- | --- | ---
AtToolbar | A | VT_BSTR | Optional

> AtToolbar

>   If the toolbar specified in AtToolBar is docked horizontally on the top or bottom of the frame window, the current toolbar is docked on the right of this toolbar.

>   If the toolbar specified in AtToolBar is docked vertically on the left or right hand side of the frame window, the current toolbar is docked below this toolbar.

>   If AtToolBar is not specified or the specified toolbar does not exist or is not visible or is not docked, the current toolbar is docked at the top of the frame window.

### On this page

- Purpose
- Properties
- Methods