ToolBar.IsClicked Method

Return a logical value indicating whether the specified button is currently clicked or selected.

Namespace: VO
Assembly: VOGUIClasses (in VOGUIClasses.dll) Version: 2.19

Syntax

Copy

 VIRTUAL METHOD IsClicked(
	nID,
	symIDType,
	symTB
) AS USUAL CLIPPER

[ClipperCallingConventionAttribute(new string[] { ... })]
public virtual Usual IsClicked(
	Usual nID = default,
	Usual symIDType = default,
	Usual symTB = default
)

Request Example View Source

Parameters

nID (Optional): Type: Usual
The ID of the desired toolbar button item.
symIDType (Optional): Type: Usual
Symbol indicating the type of data <nButtonID> represents. Valid values are #ButtonID and #MenuItemID. Defaults to #ButtonID.
symTB (Optional): Type: Usual
Symbolic name representing the toolbar to be used. Defaults to the main toolbar.

Return Value

Type: Usual
TRUE if clicked (or selected); otherwise, FALSE.

Examples

Copy

1//check if the first toolbar button is dimmed
2oTB:IsClicked(1)
3//check if the first toolbar button is dimmed, specifying a button ID for
4//the first parameter
5oTB:IsClicked(1, #ButtonID)
6//check if the File Open button is dimmed, specifying a menu item ID for
7//the first parameter
8oTB:IsClicked(IDM_StandardShellMenu_File_Open_ID, #MenuItemID)

Reference

ToolBar Class

VO Namespace