Format Builder
Using the Palette
The Format Builder palette allows you to store commonly used message format items and insert them into your message format definitions. These items are stored in an XML document, and you can use the standard Windows drag and drop feature to copy items from the palette into your message format definition.
The palette contains some common date formats, literals, and strings. You can use these items in the message formats you create, as well as adding your own items to the palette.
Displaying the Palette Window
Adding Items to the Palette
Adding Palette Items to a Message Format
Using the File Menu
Using the Shortcut Menu
Displaying the Palette Window
To turn the palette display on or off, choose View—>Show palette. If the palette is not currently displayed, it opens in a separate window next to the Format Builder window. If the palette is currently displayed, its window closes.
Adding Items to the Palette
To add items to the palette:
- From the navigation tree, choose the item you want to add to the palette.
- Click and hold the left mouse button and drag the item into the palette window.
- When the item is placed in the position you want it (as a sibling of the selected item), release the mouse button. The item is copied from the navigation tree to the palette window.
Note: You cannot add any node that depends on the existence of another node to the palette. For example, you cannot add Field or Group References, and you cannot add items that have a Repeat Field specified.
Adding comments is possible, but not recommended since comments do not have unique names and therefore are indistinguishable on the palette.
Adding Palette Items to a Message Format
To copy items from the palette to a message format:
- From the palette window, choose the item you want to add to your message format.
- Click and hold the left mouse button and drag the item into the left pane of the Format Builder window.
- When the item is placed in the position you want it (as the child or sibling of the desired item), release the mouse button. The item is copied from the palette to the message format.
Using the File Menu
The following commands are available from the palette's File menu.
Menu Command
|
Description
|
Open
|
Opens an existing message format.
|
Save
|
Saves any message format items you have added to the palette, or any existing items you have modified.
|
Hide palette
|
Closes the palette window.
|
Using the Shortcut Menu
The following commands are available from the palette's shortcut menu. You can access the shortcut menu by right-clicking within the palette window.
Note: Some commands may be unavailable, depending on the item you have selected in the tree.
Menu Command
|
Description
|
Insert
|
Inserts a new group in the palette. When you select this command, a window displays asking you to supply the name of the new group.
|
Rename
|
Displays a window asking you to supply the new name of the group.
|
Delete
|
Deletes the selected item.
|
Move Up
|
Moves the selected item up one position under its parent.
|
Move Down
|
Moves the selected item down one position under its parent.
|
Promote
|
Promotes the selected item to the next highest level in the tree. For example, Field1 is the child object of Group1. Selecting Field1 and clicking the Promote tool makes it a sibling of Group1.
|
Demote
|
Demotes the selected item to the next lower level in the tree. For example, Group1 is the sibling of Field1. Field1 immediately follows Group1 in the tree. Selecting Field1 and clicking the Demote tool makes it a child of Group1.
|