ButtonTool property (Main Control)

Visual Basic example
Visual C++ 4.0 example

Syntax short ButtonTool (short iButtonIndex);

Overview: Refer to Annotation Toolbar.

Remarks

Contains the tool associated with the specified button of the annotation toolbar. This is actually an array of values that indicate the tools associated with every button in the annotation toolbar.

If ButtonToolCount for the specified button is one, then the button has one tool associated with it, and the ButtonTool property and the Tool property contain the ANNTOOL_XXX constant corresponding to that tool.

If ButtonToolCount for the specified button is >1 then there are several tools associated with the specified button. In that case, ButtonTool() and the Tool property contain the ANNTOOL_XXX constant corresponding to the currently selected tool. When the user clicks on a button having more than one tool, a menu is displayed. The ButtonMenuXXX properties describe the menu items and the tools associated with the specified button.

For example, if ButtonToolCount(2) contains the value 1, then there is only one tool associated with the third button of the annotation toolbar. The constant for that tool is contained in ButtonTool(2).

If ButtonToolCount(2) contains the value 3, then there are three tools associated with the third button of the annotation toolbar. Clicking on this button will display a menu. The text for the menu is set in the ButtonMenuText and ButtonMenuTextID properties. The tools associated with the menu are set in the ButtonMenuTool property.