ToolBar_GetState

<< Click to Display Table of Contents >>

Navigation:  ThinBASIC Modules > UI (User Interface) > CONTROLS > Control Types > ToolBar Control > ToolBar Control Commands >

ToolBar_GetState

 

Description

 

Retrieves the state descriptor bits for a specific button in a ToolBar.

 

Syntax

 

n = ToolBar_GetState(hWnd, ctrlID, [BYCMD] item)

 

Returns

 

Number

 

The descriptor bits may consist of one or more of the number of buttons (and separators) currently present on the ToolBar.

%TBSTATE_DISABLED                The button is disabled and grayed. (value=0)

%TBSTATE_CHECKED                The button is checked.

%TBSTATE_PRESSED                The button is pressed.

%TBSTATE_ENABLED                The button is enabled.

%TBSTATE_HIDDEN                The button is hidden.

%TBSTATE_INDETERMINATE        The button is indeterminate and grayed.

%TBSTATE_MARKED                The button is highlighted.

 

Attention: this is a bit state so use OR to check more than one state.

 

Parameters

 

Name

Type

Optional

Meaning

hWnd

Number

No

Handle of the dialog containing the control

ctrlID

Number

No

Control identifier assigned to the control during CONTROL ADD ...

item

Number

No

The position number of button to be checked.

If BYCMD is specified, the command value is used to identify the button

 

Remarks

 

Restrictions

 

See also

 

Examples

 

If ToolBar_GetState(hDlg, %tlbMain, %myButton) = (%TBSTATE_ENABLED Or %TBSTATE_CHECKEDThen

...

End If