Component: Toolbar
The toolbar component displays one or more horizontal buttons which can be used to carry out actions or open forms.
The toolbar component typically works with other components such as form fields or grid, to allow the end-user to invoke actions such as opening modal popup forms.
This is an example of a toolbar component showing 2 buttons which respectively open a form to create a new record, and send the selected grid row to a form to be edited or deleted:
Toolbar components should be dragged from the form designer toolbox into the data entry form.
Click on the Toolbar component to open up the component properties modal popup dialogue.
The form has 3 tabs, and an Apply button to save the changes and close the form, and a Cancel button to close the form without saving. Note that saving a component must be followed by saving the form design in order to persist the settings.
The Details and Styles tabs are discussed in the Components section. The Toolbar tab is specific to this component.
Toolbar
This tab allows buttons and their respective behaviour to be configured.
There are 2 panels side-by-side.
Buttons
Buttons are shown vertically in the designer, but are shown horizontally at run-time. Buttons can be re-ordered by dragging the move icon on the left to re-position the button up or down the list. This equates at run-time to their corresponding horizontal position.
The delete button on the right is used to remove the button from the list.
When each button is selected, its corresponding properties are shown in the Button Properties panel.
Add
This button is used to create new buttons. The following modal popup is displayed.
The button name cannot be blank or a duplicate of an existing button in the list. When the button is saved, it is added to the end of the list of existing buttons.
Button Properties
The properties of the selected button are shown in these fields.
ID
This is a read-only generated GUID to uniquely identify the button.
Name
This is the read-only name of the button which you typed when adding it.
Caption
This is the text displayed on the button at run-time.
Tooltip
This is the text displayed as a popup when the mouse hovers over the button at run-time. This is typically a more verbose description of the function of the button.
Icon
This is the icon displayed to the left of the Caption at run-time.
Visible
Whether the button is visible or not.
Form
This is a list of all forms. When the button is clicked, this form is opened.
Modal
The form can be opened modally as a popup window, or non-modally as a standard form. Modal forms capture all user interaction until it is closed. Typically, modal forms would be used to capture input before updating the underlying grid.
Grid
The button can interact with other components. All grids on the current form are displayed in this list.
Column
This is a list of columns configured in the selected grid. This is typically used when a button wishes to open a form associated with a specific record selected in the grid. For example this could be the ID of a line item in the line items grid on an invoice form.
Source
This is a list of fields on the current form. It is used to specify which form field value will be sent to the form to be opened. For example this could be the invoice ID sent to a LineItem form to allow the line item form to know which invoice to allocate the selected line item.
Destination
This is a list of fields on the selected Form above. It is used to identify which field on the form to be opened will be populated with the value of the Source field on this form. For example this could be the invoice ID on the LineItem form to allow the line item form to know which invoice the new line item is to be allocated to.
Apply
Clicking this button will apply all button changes to the form, however you must save the form in the designer in order to persist any changes. The form will close.
Last updated