OfficeBar Parameters
Click an item in the list to the left to find out more about it.


Width & Height
The width and height of the applet are set in the HTML code you add to the web page. Be sure to change the dimensions in the <object> and the <embed> tags.

OfficeBar's height must be sufficient to display all the bars, plus the heights of any drop-down menus shown.

OfficeBar's width must be sufficient to display the last item on the widest bar. Any bars that don't specify a newrow or full width will be placed beside the previous bar if space allows, so if you make the applet wider than this minimum, the extra space may be used to move bars upwards, thus requiring less height for the applet.

You can use the Testmode parameter to help determine the best dimensions for the applet after setting everything up the way you want it.

Parameters
The parameters below should be added to your datafile in the form NAME=VALUE (for instance, BgColor=FF0000). Each parameter should be on a separate line. You can leave blank lines in the list to organize the parameters into groups if you want to. The parameter names are not case-sensitive, and neither are the values, so BgColor=FF0000 is the same as bgcolor=ff0000. You can add the parameters to your file in any order. Most parameters have a default value which we show in bold text below: if you don't include the parameter in your datafile, the default value will be used automatically.

BgColor
Sets the background color of the applet. The default value is 9EBEF5. (Note that OfficeBar can only change the background color after the applet has loaded. To have the same background color shown before the browser starts loading the applet, change the BgColor setting in the HTML code too.)

BgGradientColor
Sets the secondary color of a gradient-filled background. The default is C3DAF9. If no gradient-fill is wanted, set this to match the BgColor.

BgGradientVertical
A choice of yes or no according to whether the background gradient should be vertical (Yes) or horizontal (No). The default is No. This is ignored if your BgColor and BgGradientColor parameters are the same.

BgContent
The absolute or relative URL of an optional JPEG of SWF image placed below the bars, such as a site logo. If OfficeBar displays any drop-down menus the applet must be tall enough to display them, and this can leave some 'dead space' below the bars. The BgContent image fills this space, and the menus drop over the top of it.

BgContentLeft
Sets the horizontal position of the BgContent image (if used) in pixels. The default value is 0 and any positive or negative value is allowed.

BgContentTop
Sets the vertical position of the BgContent image (if used) in pixels. The default value is 0 and any positive or negative value is allowed. The 0 position maps to the point immediately below the bottom-most bar. To move the image upwards behind the bars, use a negative value.

Transparent
A yes or no parameter, with a default of no. If set to 'yes', the background of the applet will be made transparent, showing the content (such as a page background) behind the applet.

AllowDrag
A choice of yes or no to specify whether users can click-and-drag the 'grip' at the left of a bar to drag the bar horizontally. The default is yes. This parameter is ignored if the grip is not shown (see MenuBarsShowGrip and ToolBarsShowGrip) and the bars are not draggable.

BarColor
Sets the primary fill color of all non-flat menu bars and toolbars. The default is DDECFE.

BarGradientColor
Sets the secondary color of all non-flat menu bars and toolbars to create gradient-filled bars. The default is 81A9E2. If no gradient fill is wanted, set this to match BarColor.

BarBorderColor
Sets the color of each bars bottom border, a thin line running along the bottom of each bar. The default is 3B619C. This parameter is ignored if the bar is flat (see FlatMenuBars and FlatToolBars).

BarCornerRadius
A number which sets the radius of the rounded corners of all non-flat bars. This can be 0 (for a square corner) or a value between 1 and 12. The default value is 3.

FlatMenuBars
A choice of yes or no which specifies whether all bars set to be menu-bars should be flat. If Yes, the bars will be transparent, showing the applet background color(s), and will have no corners or border. The default is yes.

FlatToolBars
A choice of yes or no which specifies whether all bars set to be toolbars should be flat. If Yes, the bars will be transparent, showing the applet background color(s), and will have no corners or border. The default is no.

GripDarkColor
Sets the darker of the two colors that create the optional drag-grip shown at the left of the bars. The default is 274176.

GripLightColor
Sets the lighter of the two colors that create the optional drag-grip shown at the left of the bars. The default is FFFFFF.

MenuBarsShowGrip
A choice of yes or no which specifies whether the optional drag-grip should be shown at the left of bars set to be menu-bars. The default is yes.

ToolBarsShowGrip
A choice of yes or no which specifies whether the optional drag-grip should be shown at the left of bars set to be toolbars. The default is yes.

ButtonBorderColor
Sets the color of the border shown around buttons when focused, pressed or selected. The default is 000080.

ButtonFocusColor
Sets the fill color of a button when unselected and the mouse moves over it. The default is FFF4CC.

ButtonFocusGradientColor
Sets the secondary gradient-fill color of a button when unselected and the mouse moves over it. The default is FFD091. If no gradient-fill is wanted, set this to match ButtonFocusColor.

ButtonPressColor
Sets the fill color of a button when clicked. The default is FE914E.

ButtonPressGradientColor
Sets the secondary gradient-fill color of a button when clicked. The default is FFD38E. If no gradient-fill is wanted, set this to match ButtonPressColor.

ButtonSelectColor
Sets the fill color of a button when selected and not focused. The default is FFD58C.

ButtonSelectGradientColor
Sets the secondary gradient-fill color of an item when selected and not focused. The default is FFAD55. If no gradient-fill is wanted, set this to match ButtonSelectColor.

CaptionFont
Sets the name, size and style of font to use for buttons, with each part separated by commas. The default is Sans,8,plain.

  • Name: You can include any number of font names, separated by pipe symbols (|), and the applet will use the first font available on the user's system. To ensure compatibility, finish with one of these generic names: Sans, Serif or Typewriter.
  • Size: The size of the font in points.
  • Style: The style can be plain, bold, italic or bold-italic.
An example font parameter would be: Comic Sans MS|Verdana|Arial|Sans,9,bold.

CaptionTextColor
Sets the text color of buttons. The default is 000000.

CaptionTextDisabledColor
Sets the text color of a button if disabled. The default is 8D8D8D.

CaptionTextFocusColor
Sets the text color of a button when the mouse moves over it. The default is 000000.

CaptionTextPressColor
Sets the text color of a button when clicked. The default is 000000.

CaptionTextSelectColor
Sets the text color of a button when selected. The default is 000000.

SeparatorDarkColor
Sets the darker of the two colors that create vertical separator lines on the bars. The default is 6A8CCB.

SeparatorLightColor
Sets the lighter of the two colors that create vertical separator lines on the bars. The default is F1F9FF.

TooltipBorderColor
Sets the color of the border around the optional tooltips shown when the mouse hovers over a button. The default is 000000.

TooltipFillColor
Sets the fill color of the the optional tooltips shown when the mouse hovers over a button. The default is FFFFE1.

TooltipTextColor
Sets the text color of the optional tooltips shown when the mouse hovers over a button. The default is 000000.

TooltipFont
Sets the name, size and style of font to use for the optional tooltips, with each part separated by commas. The default is Sans,8,plain. This parameter is constructed in the same way as CaptionFont.

EmptyText
If a menu contains no items, OfficeBar automatically adds a single disabled item. This parameter specifies the text caption of that item. The default is (empty).

MenuBorderColor
Sets the color of the border shown around menus. The default is 002D96.

MenuColor
Sets the fill color of all menus. The default is F6F6F6.

MenuFont
Sets the name, size and style of font to use for items on menus, with each part separated by commas. The default is Sans,8,plain. This parameter is constructed in the same way as CaptionFont.

MenuOpacity
A number from 0 to 100 which specifies the percentage opacity of menus, where 0 is fully transparent and 100 is fully opaque. The default is 100.

MenuSelectorBorderColor
Sets the color of the border around the selector shown when the mouse moves over an item on a menu. The default is 000080.

MenuSelectorColor
Sets the fill color of the selector shown when the mouse moves over a menu item. The default is FFEEC2.

MenuSelectorGradientColor
Sets the secondary gradient-fill color of the selector shown when the mouse moves over a menu item. The default is FFEEC2. If no gradient-fill is wanted for the selectors, set this color to match your MenuSelectorColor.

MenuSeparatorColor
Sets the color of horizontal separator-lines placed on menus. The default is 6A8CCB.

MenuShadowColor
Sets the color of the optional drop-shadows applied to menus. The default is C0CEF5.

MenuShadowOpacity
Sets the opacity level of the drop-shadows applied to menus, where 0 is fully transparent and 100 is fully opaque. If no drop-shadows are wanted, set this to 0. The default is 35.

MenuShowSidebar
A choice of yes or no to specify whether sidebars should be shown in menus. The default is yes. If set to 'no', the two parameters below are ignored, and menus will be narrower. Separators on menus without sidebars will be centered in the menu, and icons for menu items won't be loaded or displayed.

MenuSidebarColor
Sets the color of the narrow side-bar strip shown at the left side of menus. The default is E3EFFF.

MenuSidebarGradientColor
Sets the secondary gradient color of the sidebar strip shown at the left of menus. The default is 87ADE4. If a solid sidebar is wanted, set this to match the MenuSidebarColor.

MenuTextColor
Sets the text color of menu items’ captions. The default is 000000.

MenuTextDisabledColor
Sets the text color of a menu item’s caption if the item is disabled. The default is 8D8D8D.

MenuTextFocusColor
Sets the text color of a menu item’s caption when the mouse moves over it. The default is 000000.

MinMenuWidth
A number which sets a minimum width (in pixels) for all menus. If set to 0, menus will autosize to fit the width of their contents. To force very narrow menus to be widened to a minimum width, set the required width in this parameter. The default is 100, meaning that any menu whose normal width would be less than 100 will be expanded to 100 pixels.

DefaultTarget
Every button that doesn’t open a menu, and every menu item, can link to a separate URL and can open it into a particular frame or window: we provide numbered Target parameters for that. However, you probably want most (or maybe all) the links to open into one particular frame. Enter the frame name in this parameter, and every item without its own Target parameter will open the link into this 'default' frame. You can use the HTML names _self, _top, _parent, _blank or _new, or any frame name you’ve defined in your own framesets. If you leave this parameter out of your datafile, links will open into _self (the frame or window containing the applet).

LoadProgressBorderColor
While OfficeBar loads any images you are using, it displays a progress bar. This parameter sets the border color of that bar. The default is 000080.

LoadProgressFillColor
This parameter sets the fill color of the progress bar (the part of the bar that indicates the loading progress). The default is 9EBEF5.

LoadText
Specifies the text to be displayed while OfficeBar loads any images you are using. The default text is Loading.... The text you choose must be short enough to fit into the width of the applet - OfficeBar does not wrap this text onto a second line.

LoadTextColor
Sets the color of the LoadText shown while OfficeBar loads images. The default is 000080.

SoundButtonClick
Specifies the absolute or relative URL of an MP3 audio file to play when the mouse is clicked on a button that doesn’t open a menu. If you don't want to play a sound for this event, just leave this parameter out of your datafile.

SoundButtonRelease
Specifies the absolute or relative URL of an MP3 audio file to play when the mouse is released after clicking a linking button. If you don't want to play a sound for this event, just leave this parameter out of your datafile.

SoundMenuOpen
Specifies the absolute or relative URL of an MP3 audio file to play when a menu opens. If you don't want to play a sound for this event, just leave this parameter out of your datafile.

SoundMenuSelect
Specifies the absolute or relative URL of an MP3 audio file to play when an item on a menu is selected. If you don't want to play a sound for this event, just leave this parameter out of your datafile.

ShowVersion
A yes or no value. This parameter is included in all Cool Focus Flash applets, and its default is no. If set to 'yes', the version number of the applet (and other details) will be shown when the applet starts. This is included only for troubleshooting purposes, to help you determine which version of an applet you're using. It should be set to 'no' (or removed from your datafile) before you publish your page.

Note: If the applet is not registered, this information will always be shown when the applet starts, regardless of the ShowVersion parameter's setting.

Testmode
A yes or no value, with a default of 'no'. This parameter is included to help you determine the best dimensions for the applet. (Because of this, it's best to use this parameter when you've got everything in the applet the way you want it.) Set this parameter to 'yes', then view the applet in your browser and click anywhere inside the applet. You'll see the minimum width and height displayed in a tooltip message, and you can copy these values into the page's HTML code. When you're done, remember to set the Testmode parameter back to 'no' or delete it from your datafile.


Bars
The three parameters below are used to add a new bar to OfficeBar. Unusually for Cool Focus applets, all three parameters are optional — the number of bars is actually determined by looking at the button parameters. If you don’t include these parameters for a bar, that bar will use the default settings: it will be a toolbar with NewRow and FullWidth set to ‘No’.

The parameters have numbers after their names, and the numbers must be consecutive, starting from 1.

Bar1, Bar2, ..., Barn
These parameters specify the type of bar you want to add. The value can be either menu or toolbar (not case-sensitive). The default is toolbar. The difference between menus and toolbars are:

  • Buttons on menu bars are always assumed to open menus when clicked. If you add a bar set to be a menu bar and it contains no buttons, OfficeBar will add a disabled item using the EmptyText caption.
  • Buttons on menu bars never display an arrowhead to indicate that they open a menu (because this is what menus always do!).
  • Menu bars observe the FlatMenuBars and MenuBarsShowGrip parameters; toolbars observe the FlatToolBars and ToolBarsShowGrip parameters.

NewRow1, NewRow2, ..., NewRown
A yes or no parameter which specifies whether the Bar with the same number suffix should be placed on the next row down from the previous bar. If set to ‘No’, OfficeBar will try to place this bar to the right of the previous bar (if the applet is wide enough). The default is no.

FullWidth1, FullWidth2, ..., FullWidthn
A yes or no parameter which specifies whether the bar with the same number suffix should be widened to the full width of the applet. If ‘No’, the bar will be autosized to fit the buttons it contains. The default is no. Note that if this parameter is set to Yes, the bar will automatically be placed on a row by itself, ignoring the NewRow parameter.


Bar Buttons
The 6 parameters below place buttons on the bars. A button can consist of a caption only, an icon only, or icon + caption. For every button you must include either a Caption parameter, an Icon parameter, or both.

Each parameter is prefixed with a number and a hyphen, and has a number suffix, such as 2-Caption1. The prefix indicates the bar this button belongs to, and the suffix indicates its position on the bar. So 2-Caption1 adds a button to the second bar as the first (left-most) button. The suffixes must start from 1, and must be consecutive. If you wanted to add 5 buttons to a bar but forgot to include a Caption4 or Icon4 parameter, OfficeBar would stop looking for more buttons on this bar and would only display the first three buttons.

1-Caption1, 1-Caption2, ..., 1-Captionn
This parameter specifies an optional text caption for a button on a bar. If the button should show only an icon, leave this parameter out of your datafile for this button. To create a vertical separator on the bar, set the value of this parameter to a hyphen (-) and leave the parameters below out of your datafile.

1-Icon1, 1-Icon2, ..., 1-Iconn
This parameter specifies the absolute or relative URL of a non-progressive JPEG or a SWF icon image to use for this button. If you only want a caption for this button, leave this parameter out of your datafile.

1-Disabled1, 1-Disabled2, ..., 1-Disabledn
A choice of yes or no which specifies whether this button is disabled. The default, of course, is no, so you only need to include this parameter if you want the button to be disabled. A disabled button ignores mouse-hover and mouse-click. Its caption (if it has one) is displayed using the CaptionTextDisabledColor.

1-URL1, 1-URL2, ..., 1-URLn
The optional URL to which the button with the same number suffix and prefix should link when clicked. If the button opens a menu, it cannot act as a link and this parameter should not be included.

1-Target1, 1-Target2, ..., 1-Targetn
The name of the frame or window into which the button URL with the same number suffix and prefix should open. If you don't include this parameter, the frame name set in the DefaultTarget parameter will be used.

1-Tooltip1, 1-Tooltip2, ..., 1-Tooltipn
An optional short message which will appear in a tooltip when the mouse hovers over this button. If no tooltip should be shown, leave this parameter out of your datafile. Note that the tooltip does not wrap onto multiple lines, so the length of the text should be kept short. OfficeBar does try to ensure that the tooltip is not placed off-screen.


Menu Items
The 5 parameters below create up to 2 levels of menu items for each button, which are shown when the button is clicked. A menu item must have a Caption parameter; the other parameters are optional.

These parameters are all prefixed with either two or three numbers and hyphens, and have one number after their names. These numbers tell OfficeBar which button the item belongs to and which position it takes on the menu. Here's an explanation of the prefixes and suffix:

Suffix: The number that appears after the word Caption (or Icon, or URL, etc.) denotes its position on the menu. So Caption1 appears at the top of the menu, Caption2 below it, and so on.

Prefixes: The prefixes denote the item's parentage. For example, 2-1-Caption3 means that if you locate the 2nd bar and click the 1st button on it, you’ll see this item as the 3rd item on the menu. As another example, 1-4-2-Item1 means that if you click the 4th button on the 1st bar, then move the mouse to the 2nd menu item down, a submenu will open and you’ll see this item as the 1st item on that submenu.

OfficeBar determines whether a button opens a menu simply by looking for the first Caption parameter that menu would contain. So when OfficeBar creates the first button on the first bar (1-Caption1 or 1-Icon1) it looks for a parameter named 1-1-Caption1. If that parameter exists, a menu is created for the button; otherwise that button doesn’t open a menu. The same method is used to determine whether a menu item opens a submenu when the mouse moves over it.

1-1-Caption1, 1-1-Caption2, ..., 1-1-Captionn
This parameter specifies the caption of the menu item. Every menu item must have a caption. To create a horizontal separator bar on the menu, set the caption to a hyphen (-) and leave the remaining parameters for this item out of your datafile.

1-1-Icon1, 1-1-Icon2, ..., 1-1-Iconn
This parameter specifies the absolute or relative URL of a non-progressive JPEG or a SWF icon image to use for this menu item. If you only want a caption for this item, leave this parameter out of your datafile.

1-1-Disabled1, 1-1-Disabled2, ..., 1-1-Disabledn
A choice of yes or no which specifies whether this menu item is disabled. The default is no, so you only need to include this parameter if you want the item to be disabled. A disabled item ignores mouse-hover and mouse-click. Its caption (if it has one) is displayed using the MenuTextDisabledColor.

1-1-URL1, 1-1-URL2, ..., 1-1-URLn
The optional URL to which this menu item should link when clicked. If the item opens a submenu, it cannot act as a link and this parameter should not be included.

1-1-Target1, 1-1-Target2, ..., 1-1-Targetn
The name of the frame or window into which the item URL should open. If you don't include this parameter, the frame name set in the DefaultTarget parameter will be used.