Bar.Format
Description
Syntax
- Bar.Format(barname, sKeywords)
Parameters
- barname
- (string) name of the bar to format
- sKeywords
- (string) any combination of the format keywords as a space-separated list
-
Possible Values
- autohide n
- where n=number of milliseconds to hide after
- Note that "Show if bump" in the PPConfig Command List Properties window must be set to something other than "None", otherwise the bar will not appear on screen edge bump.
- back bgImgPath
- where bgImgPath=path to the background image, using forward slashes as the path delimiter, & in quotes. Since the parameter sKeywords is itself in quotes, the inner pair must be escaped.
- Changes the background to file.bmp or use back none to remove background; put file name in double quotes if it contains blanks.
- Use with "back2" to toggle between two backgrounds each time the command is executed.
- Use "back none" to specify no background image.
- Always add the "refresh" keyword when changing a bar's background, in order to show the change.
- back2 bgImgPath
- See "back".
- position n
- Position n is the nth item in the menu of positions that appears in PPCD drop-down for Bar Position. There are 23 possible values for n:
- 1
- floating
- 2
- locked
- 3
- left caption
- 4
- middle caption
- 5
- right caption
- 6
- left screenbar
- 7
- top screenbar
- 8
- right screenbar
- 9
- bottom screenbar
- 10
- taskbar
- 11
- taskbar no start
- 12
- fix top right
- 13
- fixed top right offset
- 14
- fixed top center
- 15
- fixed top left
- 16
- fixed left center
- 17
- fixed bottom left
- 18
- fixed bottom center
- 19
- fixed bottom right
- 20
- left of active
- 21
- right of active
- 22
- above active
- 23
- below active
- refresh
- Closes & reopens the bar.
- Use with "back", "back2" & "position" keywords to see the changes.
Examples
- Bar.Format("DocsBar", "autohide 500")
- Sets the bar named "DocsBar" to automatically hide after 500ms when the mouse is moved off it.
- Bar.Format("DocsBar", "autohide -500")
- Toggles the bar named "DocsBar" between automatically hiding after 500ms when the mouse is moved off it, and not automatically hiding.
- Bar.Format("Links", "back \"C:/graphics/lines.bmp\" refresh")
- Each time this command is called, it will toggle the background of bar "Links" between "c:\graphics\lines.bmp" and no background.
- Bar.Format("Links", "back \"C:/graphics/lines.bmp\" back2 none refresh")
- Each time this command is called, it will toggle the background of bar "Links" between "c:\graphics\lines.bmp" and no background.
- Bar.Format("Places", "position 22 refresh")
- Sets the bar named "Places" to be above the active window.
- Bar.Format("Places", "position -23 refresh")
- Toggles the bar named "Places" between its current position & being positioned "Below active", refreshing it to show the change.
Notes
- The resulting new bar configuration is always saved in the .pcf file.