Caption Property

Description

Gets or sets the text that is displayed for the pane in the status bar customization window.

Property Type

Read-write property

Syntax (Visual Basic)

Public Property Caption() As String

Remarks

The Caption is the text that is displayed for the pane in the status bar customization window.

To enable customization, use EnableCustomization. This method will enable a status bar customization window to appear when the status bar is right-clicked. The customization window allows all the panes in the status bar to be hidden or displayed (if already hidden). All panes will be displayed in the window with the exception of the pane with Id equal to 0. The items displayed in the window are the Caption of the pane and the Value of the pane. Also indicated is the Visibility of the pane.

If using a StatusBarSliderPane or StatusBarSwitchPane, the SliderPaneClick and SwitchPaneClick events can be used to update the Caption and Value to show exactly what switch is selected in a switch pane or what percentage is selected in a slider. Alternatively, they can be used to display any custom message in the customization window.

Note that the Text, which is what is visible on the status bar, is not displayed in the customization window. The Caption and Value of the pane can be set to any text that is desired in the customization window.

See Also

• StatusBarProgressPane Object
• EnableCustomization Method
• SliderPaneClick Event
• SwitchPaneClick Event
• Value Property
• Visible Property
• StatusBarSliderPane Object
• StatusBarSwitchPane Object
• Text Property

---

Copyright (c) 1998-2024 Codejock Technologies. All rights reserved.