Interface IToolBarButton
A single tool bar button in a PowerBuilder tool bar.
Namespace: HP.LFT.SDK.PowerBuilder
Assembly: HP.LFT.SDK.dll
Syntax
public interface IToolBarButtonProperties
HasEllipses
Indicates whether the toolbar button's text is truncated and an ellipsis (...) is displayed.
Declaration
bool HasEllipses { get; }Property Value
| Type | Description |
|---|---|
| bool |
Index
The 0-based index number of the toolbar button. The index does not include hidden and separator buttons.
Declaration
int Index { get; }Property Value
| Type | Description |
|---|---|
| int |
IsChecked
Indicates whether the toolbar button is a dual-state (toggle) push button and is currently selected (pushed).
Declaration
bool IsChecked { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsEnabled
Indicates whether the toolbar button is enabled.
Declaration
bool IsEnabled { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsHighlighted
Indicates whether the toolbar button is highlighted (surrounded by a dotted line).
Declaration
bool IsHighlighted { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsHot
Indicates whether the toolbar button is "hot". (Appears highlighted on mouseover.)
Declaration
bool IsHot { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsIndeterminate
Indicates whether the toolbar button is disabled.
Declaration
bool IsIndeterminate { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsMarked
Indicates whether the toolbar button is marked. The interpretation of a marked button is application dependent.
Declaration
bool IsMarked { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsPressed
Indicates whether the toolbar button is currently being clicked.
Declaration
bool IsPressed { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsSelected
Indicates whether the toolbar button is currently either pressed (currently being clicked) or checked (a dual-state push button that is currently selected).
Declaration
bool IsSelected { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsWrap
Indicates whether the toolbar button is enabled and followed by a line break.
Declaration
bool IsWrap { get; }Property Value
| Type | Description |
|---|---|
| bool |
Name
The name of the toolbar button.
Declaration
string Name { get; }Property Value
| Type | Description |
|---|---|
| string |
Methods
Press(MouseButton)
Presses the specified toolbar button.
Declaration
void Press(MouseButton button = MouseButton.Left)Parameters
| Type | Name | Description |
|---|---|---|
| MouseButton | button | Optional: The mouse button used to press on the toolbar button.(default value: left button) |
ShowDropdown()
Opens the dropdown menu associated with this toolbar button by clicking the arrow part of the button.
Declaration
void ShowDropdown()