Button component for Axiom forms

The display text for the button. For example, you might want the button to display the text "Refresh".

NOTE: This setting is ignored if the button style is set to Image. You can also optionally omit the button text if a symbol is specified for the button.

Optional. The tooltip text for the component. When a user hovers the cursor over the component, the text displays in a tooltip.

Optional. The name of the button group that the button belongs to. You can define a new button group name by typing the name into the box, or you can select from any previously defined group name (within the current form).

Button groups only apply when you want to use multiple buttons as selectors. Only one button in the group can be the selected button. For more information, see Using buttons as selectors (button groups).

NOTE: This setting is only available when using the default button behavior of Command.

The current state of the button in the button group, selected or not selected. This setting serves two purposes:

• It specifies which button is selected within the button group initially, when the user first opens the Axiom form. By default, this is disabled, which means the button is not selected. If you want this button to be selected initially, enable this setting.

• When a user views the Axiom form and selects the button (or selects another button in the group, thereby causing this button to become not selected), the change in the selected status will be submitted back to the source file and placed in this cell on the Form Control Sheet. Formulas can reference this cell in order to dynamically change the form based on the current status of this button.

Only one button within a button group can be selected at any one time.

NOTE: This setting is only available when using the default button behavior of Command, and only applies when the button belongs to a button group.

Specifies whether a save-to-database occurs when a form update is triggered by this component.

• If disabled (default), then clicking the button does not trigger a save-to-database.

• If enabled, then a save-to-database will occur as part of the form update process when the button is clicked. The save occurs after editable values have been submitted to the source file and after data has been refreshed in the source file. A save-to-database process must be enabled and configured within the source file. For more information, see Saving data from an Axiom form.

NOTE: This setting is only available when using the button behaviors of Command or Dialog Panel Action.

The behavior of the button determines what occurs when the button is pressed. Some button behaviors have additional button properties to configure the behavior. See Button behaviors.

By default, the behavior is set to Command. This provides the basic button behavior as well as the ability to optionally perform a command. The Command property can be left blank if you do not want to perform a command.

The display style of the button. This option is available for all button behaviors except Upload Plan File Attachment.

• Push: The button displays as a standard rectangular button. The user clicks the button to perform the button action.

• Link: The button displays as if it is a hyperlink. The user clicks the link to perform the button action. The button text defines the hyperlink text.

• Image: The button displays as an image. The user clicks on the image to perform the button action.

For more information and examples of the different button styles, see Using different button styles.

Optional. The symbol to use for the button. The symbol applies as follows:

• For push and link buttons, the selected symbol displays on the button in addition to the button text (or instead of the button text, if the text is blank).

• For image buttons, you can optionally use a symbol for the button image instead of specifying an image file.

To select a symbol, click the [...] button to open the Choose Symbol dialog. Within this dialog, you can scroll through the available symbols, or you can use the filter box at the top to find symbols based on symbol names. For example, you can type file to see all of the symbols that have the word "file" in the name.

When you have found the symbol that you want to use, select it and then click OK. The selected symbol shows in the Form Designer / Form Assistant, and the actual symbol name is written to the corresponding field in the Form Control sheet.

NOTE: If you select an image path for an image button, then the Symbol fields are hidden. If you originally selected an image path but now you want to select a symbol, you must first clear the selected image path in order to make the Symbol fields available again. (If you specify both an image path and a symbol by manually editing the Form Control Sheet, the symbol takes precedence.)

The symbol to display when the button is selected. This is intended to be used when the button is part of a Button Group, to indicate that the button is the currently selected button in the group (based on the Is Selected property).

This setting only applies to image buttons, and only if a symbol is specified for the button. The selected symbol is specified in the same way.

The position of the symbol on the button (Left or Right). This setting only applies to push and link buttons, and only if a symbol is specified for the button. By default, the symbol displays on the left side of the button.

If the text is blank, then this setting does not apply, and the symbol is centered on the button.

Specifies the path to the image file to use for the button. This setting only applies if the button style is Image.

Click the [...] button to browse to the image within the Reports Library. If the image is not already saved in the Reports Library, you can right-click a folder and select Import to import the image (if you have the appropriate rights to do so). The image must be in PNG or JPG format.

NOTES:  

• End users must have permission to the image file in order to see it rendered. It is recommended to create a dedicated Images folder in the Reports Library and store all images in this location. You can grant access to this folder using the Everyone role, or you can create subfolders and grant access to users and roles as needed.

• The next time you open this file after saving, the path to the image will be automatically converted into a system-managed document shortcut (you can tell the difference by the presence of a _tid parameter on the end of the shortcut). This is to make the file reference "repairable" in cases where the file is renamed or moved. Note that if the path is a result of a formula instead of directly within the cell, then the conversion will not occur and the file reference will not be repairable.

You can select either an image path or a symbol for the image button. If you select a symbol, then the Image Path fields are hidden. If you originally selected a symbol but now you want to select an image path, you must first clear the selected symbol in order to make the Image Path fields available again. (If you specify both an image path and a symbol by manually editing the Form Control Sheet, the symbol takes precedence.)

The path to the image file to display when the button is selected. This is intended to be used when the button is part of a Button Group, to indicate that the button is the currently selected button in the group (based on the Is Selected property).

This setting only applies if the button style is Image and if an Image Path is specified. The selected image is specified in the same way.

Optional. Defines a confirmation message to display before performing any button actions.

If a confirmation message is defined, then when a user clicks the button in the Axiom form, a message box will display the message. The user can click OK to proceed with the button actions, or click Cancel to abort the form update and any assigned command.

NOTE: This setting is only available as described when using the default button behavior of Command. The setting is also available when using the Multi-Select button behavior, but in that case it defines the header text for the multi-select dialog.

Optional. Specifies a command shortcut to perform when the user clicks the button.

Click the [...] button to define or edit the command shortcut. Click the button to clear the shortcut.

By default, the button properties only accommodate a single command. You can add multiple commands by clicking the Add link underneath the Command box.

For more information, see Using buttons to perform commands.

NOTES:  

• The command syntax placed in the Control Sheet for the Command setting should not be manually modified or built using a formula. All changes to the command should be made using the Form Assistant or the Form Designer.

• This setting only applies when the button behavior is Command, Show Dialog Panel, or Dialog Panel Action.

The name of the component. This is for identification in the file; this name does not display on the Axiom form canvas.

The name of the component identifies the corresponding settings for the component on the Form Control Sheet. The component names are also useful if you have multiple types of the same component within an Axiom form, so that you can tell which component you are currently editing.

Component names must be unique within a file and must start with a letter. Names can only contain letters, numbers, and underscores. Names are validated when the file is saved; an invalid name will prevent the save.

NOTE: Spaces are not allowed in component names and will be automatically removed by Axiom Software. For example, if you enter "My Component" as the component name, it will be automatically adjusted to "MyComponent".

Specifies whether the component is visible on the Axiom form (On/Off). By default this is set to On.

This setting can be used to dynamically show or hide the component using a formula. Keep in mind that if you have multiple components that you need to dynamically show or hide based on the same condition, then it is preferable to place those components on a dedicated layer and then show or hide the entire layer instead of the individual components.

NOTE: This setting is only available on the Form Control Sheet; it cannot be set in the Form Assistant or in the Form Designer.

The layer that the component belongs to on the Axiom form canvas. In the Form Assistant and the Form Designer, this displays as the layer name (for example: Layer 1). In the Form Control Sheet, this is recorded as the layer ID (for example: 1).

If the canvas only has one layer, then the component is automatically assigned to that layer and cannot be changed. If the canvas has multiple layers, you can assign the component to any layer using the drop-down list. By default, the component will be assigned to whichever layer is selected in the Layers box when you initially drag the component onto the canvas. For more information on layers, see Using multiple layers on the canvas.

If desired, you can jump to the applicable layer settings on the Form Control Sheet by clicking the binoculars icon next to the drop-down list.

Optional. The styles used to determine the formatting of the component. You can assign one or more styles.

Click the Select component styles button [...] to open the Choose Style dialog. Using this dialog, you can select one or more styles to apply to the component. The available styles depend on the component type and the skin assigned to the form. For more information, see Using component styles.

Some components have several styles that are specifically designed for that component type, while other components may only have the "generic" styles that are available to all components. When using a generic style, keep in mind that they may not be useful for all components. You can view a description of each style and view the effective formatting applied by the selected styles within the Choose Style dialog.

The reference location determines how the x-position and y-position of a component are evaluated. By default the reference location is UpperLeft.

NOTE: This setting is not exposed in the advanced component settings. It can be changed on the canvas by double-clicking the corner selection handles of a component, or you can edit the setting on the Form Control Sheet directly.

The x-position determines the component's position along the horizontal axis, and the y-position determines the component's position along the vertical axis. Both are evaluated relative to the reference location. Positions can be set in pixels (default) or percentages.

The order in which the component is rendered in the layer. A component with a larger order number will display above a component with a smaller order number.

For components that support tab navigation (tabbing to the next editable component), the rendering order also determines the tabbing order.

NOTE: On the Form Control Sheet, this setting is labeled as Z-Index.

Updates the form, including optionally performing a save-to-database. The button can also be assigned one or more optional commands. For more information on configuring the button to perform commands, see Using buttons to perform commands.

Opens a designated Dialog Panel component as a modal dialog over the current form. For more information, see Dialog Panel component for Axiom forms.

Performs a designated dialog action on the currently open Dialog Panel component. Available actions are OK, Apply, or Cancel. This behavior only applies when the button is part of a Dialog Panel component; otherwise the button simply triggers a regular form update. For more information, see Dialog Panel component for Axiom forms.

Updates the form (including a save-to-database), and then opens a dialog where the user can complete the active process task for the current plan file. For more information, see Completing the current process task in a form-enabled plan file.

Updates the form (including a save-to-database), and then opens a dialog where the user can complete the active workflow task for the current plan file. This option relates to the legacy workflow feature. For more information, see Completing the current workflow task in Axiom forms.