piId - cCJStatusBarPane
This is the pane ID, which must be a unique number. There are several special IDs for Idle pane, CapsLock, NumLock and ScrollLock
Type: Property
Access: Read/Write
Data Type: Integer
Parameters: None
Syntax
Property Integer piId
| Access Type | Syntax |
|---|---|
| Read Access: | Get piId to IntegerVariable |
| Write Access: | Set piId to IntegerVariable/Value |
Description
piId is the statusbar pane's ID. Each statusbar pane must be assigned a unique ID. Duplicates will result in a runtime error. Normally, pane IDs are auto assigned. There are several special IDs that can be manually assigned. Those are
| Constant | Meaning |
|---|---|
| sbpIDAutoAssign | This indicates that the piID will be will be auto assigned during pane's end_construct_object. |
| sbpIDIdlePane | This is used to display idle text (i.e., statusbar help text) and the psDescription text of cCJMenuItems during mouse hover event. Typically this is applied to the first pane. |
| sbpIDCapslock | Indicates whether CAPS Lock is on or off. |
| sbpIDNumLock | Indicates whether Num Lock is on or off. |
| sbpIDScrollLock | Indicates whether Scroll Lock is on or off. |
Default values is sbpIDAutoAssign
Sample
This sample shows a statusbar that uses all of the special panes.
Object oStatusBar is a cCJStatusBar
Object oStatusIdle is a cCJStatusBarPane
Set piId to sbpIDIdlePane
Set pbStyleStretch to True
End_Object
Object oStatusView is a cCJStatusBarPane
Set phoViewPane to Self
Set pbStyleStretch to True
End_Object
Object oStatusCaps is a cCJStatusBarPane
Set piId to sbpIDCapslock
End_Object
Object oStatusNumLock is a cCJStatusBarPane
Set piId to sbpIDNumLock
End_Object
Object oStatusScrollLock is a cCJStatusBarPane
Set piId to sbpIDScrollLock
End_Object
End_Object
piID and Images
When images are assigned to a statusbar pane using psImage, the image's ID in the imagelist will be the same as piID. See piIconId for more.
See Also