This documentation was styled with a demo skin from the Premium Pack 4 add-on for Help & Manual. The contents of the skin are encrypted and not configurable. You can only publish HM projects with this skin. You cannot edit it or change it.
This version is copyright and may only be used for local testing purposes. It may not be distributed.
Please purchase the full version of the Premium Pack to get the configurable skins and remove this notice. The package will also include the Toolbox configuration utility for Premium Pack skins.
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_CHECKED) Then
...
End If