Show_Status_Help - cCJStatusBar
Is called when there is new statusbar help information to be displayed in the statusbar
Type: Procedure
Parameters
| Parameter | Type | Description |
|---|---|---|
| sStatusHelp | String | Statusbar help text |
Syntax
Procedure Show_Status_Help String sStatusHelp
Call Example
Send Show_Status_Help sStatusHelp
Description
Within the framework, the message Show_Status_Help is sent to the statusbar each time there is new status information to display. It passes the new text to be displayed. The purpose of Show_Status_Help is to display the help information in the idle pane. It does this be setting the psIdleText property.
The Idle pane is designated by setting a statusbar pane's piID property to sbpIDIdlePane. Often this will be the first status pane.
This method can be augmented.
Sample
In this sample, the status help is only updates the Idle Pane if the hypothetical property pbDisableStatus is false.
Procedure Show_Status_Help String sStatusHelp
Boolean bDisableStatus
Get pbDisableStatus to bDisableStatus
If not bDisableStatus Begin
Forward Send Show_Status_Help sStatusHelp
End
End_Procedure
See Also