Tree, Grid, and Tree Grid layouts -
Adding a button
|
|
Tree, Grid, and Tree Grid layouts have action areas that can display buttons, above and below the repeating area (the image is of a grid layout):
The repeating area of these layouts can display an express action button; the action areas display action buttons. Both types of button can initiate a range of actions when clicked, either on the selected data row or rows, or to launch some other action such as creating a new work object.
Follow these instructions to add a button to a Tree, Grid, or Tree Grid layout.
For buttons in harnesses, sections, and non-repeating layouts, see Harness, Section, and Flow Action forms - placing a button in a cell.
Click the down arrow (
) in
the Basic control group (
) and select the
Button control (
). Drag the Button control to the cell that is to
contain it.
When the pointer changes shape to indicate that a single cell is selected, release the mouse button to drop the control.
If the cell is not empty, the dropped button replaces the current contents of the cell.
2. Complete the
GridAction properties panel — Top fields
Select the button, and then click the magnifying glass (
) icon to display the Cell Properties panel (for express action buttons) or the Action Cell Properties panel (for buttons in action areas). With one exception, the fields here govern the grid, not its button. That exception is the Show when active checkbox on the Advanced tab of the properties panel of a cell in a repeating row where you place an express action button. Check this checkbox to have the express action button only appear for the row that is currently selected. If this option is not checked, the button will appear at all times for all rows in the grid.
Buttons in these layouts use the GridAction gadget. To access the gadget's properties panel, click the magnifying glass beside the Use Section field:
Fill in the fields at the top of the PegaGadget-GridAction panel that appears:
Field |
Description |
|
Type |
Select Selected Item for the action to apply to the currently-selected row in the repeating area, such as inserting a row before or after the selected item. Select Item for the action to apply to some other object, perhaps creating a new work object or initiating some other activity or flow. |
|
Label |
Enter a label for the button. As a best practice, start the text with a verb. Consider the collection of buttons that appear at runtime collectively; provide button each with a clear and distinctive label. For example, Cancel order. To allow users to execute the button activity using a shortcut key combination, include an
ampersand character (&) immediately before a letter in
the caption text. At runtime, users can press the
|
|
Tooltip |
Enter a sentence or phrase identifying to users the purpose and function of the button. Providing a tooltip is important for explaining the button's function to users with assistive devices.
|
|
Description |
Not used. |
3. Complete the
GridAction Properties panel — Action tab
4. Complete the
GridAction Properties panel — Advanced tab
There are four sections on this tab.
|
Icon Class |
Use this field to specify an icon for the button. If you set this, the button does not need a label; however, make sure the button has a meaningful tooltip to help users understand its function. To find the image path to enter in this field, select |
|
Show |
You may want to make the button visible only under certain circumstances, or only to users with specific privileges.
|
|
Enable |
you may want to make the button enabled only under certain circumstances, or only for users with specific privileges.
|
|
Additional Parameters |
If the button's action, or the When rule it references, requires additional parameters, you can specify them in this section. Click the + button to add a row, select an existing parameter or create a new one, and specify a value for it |
Click OK to accept all your changes.
If you use
shortcut keys in your application, be careful to choose
distinct letters for each button; you can't have
Optionally, if
this button is within a cell of a section that includes
parameter declarations on the 
As a best practice, start the Tooltip text for an
input field with a verb; for example, Cancel the order. 
> User Interface > Galleries > Image Gallery and browse the available images. When you find a good image for the button, select it, copy its Path from the Selected Image display and paste the path in this field. At runtime, the button displays the image you selected.