Diodia ToolbarAssembler Tag Reference

toolband
The toolband tag is the root tag of the toolbar XML definition file. It encapsulates the entire toolbar definition.

Example:

<?xml version="1.0" encoding="utf-8"?>
<toolband name="My Toolbar" company="My Company">
   :
</toolband>

Attributes on the toolband tag:
 
name The name of the toolbar. The name will be visible in the Internet Explorer's "Toolbars" menu. It is also used by the toolbar setup program.
 
company The name of the company manufacturing the toolbar. The toolbar setup program uses the company name to find a proper folder for the toolbar installation, for example C:\Program Files\<company name>\<toolbar name>.
 
guid
The guid tag contains a unique toolbar id. The id is generated by ToolbarAssembler when a new toolbar is created. It is automatically written to the new toolbar definition file. The toolbar id should not be changed.

Example:

<?xml version="1.0" encoding="utf-8"?>
<toolband name="My Toolbar" company="My Company">
   <guid>c22e52bf-17fc-451c-99c7-40de6af11bf8</guid>
   :
</toolband>

Attributes on the guid tag:
 
configuration
The configuration tag is used to create toolbars that dynamically update themselves.

The content of the configuration tag is an address of a zip-file contaning the actual toolbar definition file, i.e. ToolbarDefinition.xml.

The scripts and the graphics used in the toolbar must also be included in the zip-file.

The toolbar checks for a new configuration approximately once every fourth hour.

Example:

<?xml version="1.0" encoding="utf-8"?>
<toolband name="My Toolbar" company="My Company">
   :
   <configuration>http://www.diodia.com/configuration.zip</configuration>
   :
</toolband>

Attributes on the configuration tag:
 
menu
The menu tag creates a menu or a sub-menu in a toolbar. It encapsulates the content of the menu. The menu tag is interpreted a bit differently depending on its position in the toolbar definition file.

If the menu tag is the first control tag (menu, button, ...) inside the toolband tag then the menu tag generates the toolbars main menu. The main menu is the left-most menu in a toolbar. It usually contains a company logo. The main menu is the only control in the toolbar that can contain a bit map wider than 16 pixels.

Example:

<?xml version="1.0" encoding="utf-8"?>
<toolband name="My Toolbar" company="My Company">
   <guid>c22e52bf-17fc-451c-99c7-40de6af11bf8</guid>
   <menu image="my_company_logo.bmp">
      :
   </menu>
   :
</toolband>

If the menu tag is not the first control tag inside the toolband tag, but still placed directly inside the toolband tag, then the menu tag generates a regular menu in the toolbar.

Example:

<?xml version="1.0" encoding="utf-8"?>
<toolband name="My Toolbar" company="My Company">
   :
   <menu caption="Forums">
      :
   </menu>
   :
</toolband>

If the menu tag is placed inside another menu tag then the menu tag creates a sub-menu.

Example:

<?xml version="1.0" encoding="utf-8"?>
<toolband name="My Toolbar" company="My Company">
   :
   <menu caption="News">
      :
      <menu caption="More news">
         :
      </menu>
      :
   </menu>
   :
</toolband>

Attributes on the menu tag:
 
caption A text label to display on the menu.
 
image A bitmap to display on the menu. The bitmap must be exactly 16x16 pixels, unless on the main menu. Bitmaps on the main menu can have any width.
 
command A command to execute when the menu is clicked on. If a command is specified then the menu becomes a so-called mixed menu, i.e. a combination of a button and a menu. Commands are only allowed on regular menus, not on main menus and sub-menus. See the command reference for details on how to use commands.
 
parameter A parameter for the command to execute. Usually an internet address for the Navigate command, or a script name for the script commands.
 
button
The button tag creates either a button in the toolbar or a menu item in a menu. The button tag is always empty (<button ... />).

If the button tag is placed directly inside the toolband tag then the button tag creates a button in the toolbar.

Example:

<?xml version="1.0" encoding="utf-8"?>
<toolband name="My Toolbar" company="My Company">
   :
   <button image="person.bmp"
           command="Navigate"
           parameter="intranet/search?name=##TextBox##"/>
   :
</toolband>

If the button tag is placed inside a menu tag then the button tag creates a menu item.

Example:

<?xml version="1.0" encoding="utf-8"?>
<toolband name="My Toolbar" company="My Company">
   <guid>c22e52bf-17fc-451c-99c7-40de6af11bf8</guid>
   :
   <menu caption="News">
      :
      <button caption="CNN"
              command="Navigate"
              parameter="www.cnn.com"/>
      :
   </menu>
   :
</toolband>

Attributes on the button tag:
 
caption A text label to display on the button.
 
image A bitmap to display on the menu. The bitmap must be exactly 16x16 pixels.
 
command A command to execute when the button is clicked on. See the command reference for details on how to use commands.
 
parameter A parameter for the command to execute. Usually an internet address for the Navigate command, or a script name for the script commands.
 
edit
The edit tag creates a text box in the toolbar. A text box can be used to type in a text string for a query, or to generate input for a script. The edit tag is always empty (<edit ... />).

Example:

<?xml version="1.0" encoding="utf-8"?>
<toolband name="My Toolbar" company="My Company">
   :
   <edit id="Query"
         width="200"
         command="Navigate"
         parameter="www.google.com/search?q=##Query##"/>
   :
</toolband>

Attributes on the edit tag:
 
id A unique text box identifier. The id must be unique within the toolbar definition file. The id is used to extract the content of the text box when executing commands. See the command reference for details on how to use commands.
 
width The width of the text box in pixels.
 
auto-size If the value of auto-size is "yes" then the text box resizes itself to fill out the entire width of the toolbar when the Internet Explorer is resized. The value specified in the width attribute is interpreted as minimum width of the text box.

If the value of auto-size is "no" then the text box maintains the width specified in the width attribute.
 
command A command to execute when the Enter key is hit inside the text box. See the command reference for details on how to use commands.
 
parameter A parameter for the command to execute. Usually an internet address for the Navigate command, or a script name for the script commands.
 
combo-box
The combo-box tag creates a drop-down list in the toolbar. The drop-down list contains a set of pre-defined text strings that the user can choose from. The drop-down list can optionally be combined with a text box, making it possible to enter other values than the pre-defined text strings.

The combo-box tag is very similar to the edit tag. The combo-box can be used if, for example, a set of frequently used search phrases are know beforehand.

The combo-box tag is always empty (<combo-box ... />).

Example:

<?xml version="1.0" encoding="utf-8"?>
<toolband name="My Toolbar" company="My Company">
   :
   <combo-box id="PhoneNo"
              list="Help Desk##Reception##Pizza"
              fixed-list="no"
              command="Navigate"
              parameter="intranet/phone?q=##PhoneNo##"/>
   :
</toolband>

Attributes on the combo-box tag:
 
id A unique drop-down list identifier. The id must be unique within the toolbar definition file. The id is used to extract the content of the drop-down list when executing commands. See the command reference for details on how to use commands.
 
list A list of items to display in the drop-down list. The individual items must be separated with ##, for example

  
list="red##green##blue"
 
fixed-list If the value of fixed-list is "yes" then the user has to choose between the predefined text strings.

If the value of fixed-list is "no" then other values than the predefined text strings can be entered in the text box associated with the drop-down list.
 
width The width of the drop-down list in pixels.
 
auto-size If the value of auto-size is "yes" then the drop-down list resizes itself to fill out the entire width of the toolbar when the Internet Explorer is resized. The value specified in the width attribute is interpreted as minimum width of the drop-down list.

If the value of auto-size is "no" then the drop-down list maintains the width specified in the width attribute.
 
command A command to execute when an item is selected in the drop-down list, or when the Enter key is hit inside the text box associated with the drop-down list. See the command reference for details on how to use commands.
 
parameter A parameter for the command to execute. Usually an internet address for the Navigate command, or a script name for the script commands.
 
label
The label tag displays a text label in the toolbar. It may serve as instructive text before a text box or a drop-down list. The label tag is always empty (<label ... />).

Example:

<?xml version="1.0" encoding="utf-8"?>
<toolband name="My Toolbar" company="My Company">
   :
   <label caption="Find person:"/>
   :
</toolband>

Attributes on the label tag:
 
caption The text string to display in the toolbar.
 
separator
The separator tag is used to group related functionality in a toolbar. The separator tag creates a vertical bar in a toolbar, or a horizontal bar in a menu. The separator tag is always empty and has no attributes  (<separator/>).

Example:

<?xml version="1.0" encoding="utf-8"?>
<toolband name="My Toolbar" company="My Company">
   :
   <menu caption="News">
      :
      <button caption="CNN"
              command="Navigate"
              parameter="www.cnn.com"/>
      <button caption="USA Today"
              command="Navigate"
              parameter="www.usatoday.com"/>
      <separator/>
      <button caption="BBC"
              command="Navigate"
              parameter="www.bbc.co.uk"/>
      :
   </menu>
   :
</toolband>

Attributes on the separator tag:
 

© 2002-2008 Diodia Software