Overview

A button control is used to trigger specific actions in the workflow of an application, such as navigation, calculation, and saving.

Properties

The properties of a button control are outlined below.

Text

The Text property determines the text that is displayed within the button.

Size

The Size property determines the size of the button and the text within the button.

Button sizes can be configured to be Extra Small, Small, Medium, or Large. The actual sizing of the button may depend on the Cascading Style Sheets (CSS) applied to your application, which can be configured or modified through the Designer's Stylesheets module.

Color Style

The Color Style property of the button will determine the coloring class applied to the button.

The default supported styles are as follows:

• Default (Standard white)
• Primary
• Primary 2
• Info
• Warning
• Warning 2
• Success
• Danger

The actual coloring schemes are dependent on the Cascading Style Sheets (CSS) applied to your application, which can be modified through the the Designer's Stylesheets module.

Use Outline Style

The Use Outline Style property signifies whether or not the system will apply the outline style to the button.

If it is applied, the button will appear white with the text and outline matching the color defined by the Color Style property. Hovering over the button will invert the colors.

The actual coloring schemes are dependent on the Cascading Style Sheets (CSS) applied to your application, which can be modified through the the Designer's Stylesheets module.

Events

The Events selection indicates a series of events that can be triggered when the button is pressed. Currently, the types of events that are supported are as follows:

• Calculate
• Save
• Print
• Email
• Custom Actions
• Navigation
• Reset

Calculate

The Calculate event signifies whether or not the button press will trigger a calculation.

Save

The Save event signifies whether or not the button press will trigger a save action. Save actions require a prior calculation action, so enabling the save action on a button will automatically enable a calculate action for the button.

In order for the save action to occur, database tables must be generated and designed with the Databases module. Note that save actions will not execute in application preview; they will only execute once the application has been published.

By default, a Save event triggers a popup window upon completion. If you want to disable the save popup clicking on the Save event and disable the Disable Save Dialog option.

In very rare cases, it may be preferable to trigger an extra calculation after a save event has fired. To force an extra calculation to execute after a save event, simply enable the Force Extra Calculation checkbox from the Save Event dialog box.

Print

The Print event is defined by the print processes that you have created using the Print Process Designer module. If you do not have any print processes defined, then you will not see any print actions available.

For each defined print process, you will see a Print event, along with the friendly name that you associated with the print process. You can bind multiple print processes to a single button and the same print process to multiple buttons.

See the Print Processes section for additional information.

Email

The Email event is defined by the email processes that you have created using the Email Process Designer module. If you do not have any email processes defined, then you will not see any email actions available.

For each defined email process, you will see an Email event, along with the friendly name that you associated with the email process. You can bind multiple email processes to a single button and the same email process to multiple buttons.

See the Email Processes section for additional information.

Custom Actions

The Custom Actions event is defined by the custom actions that you have created using the Custom Actions Designer module. If you do not have any custom actions defined, then you will not see any custom actions available.

For each defined custom action hook, you will see a Custom Action event, along with the friendly name that you associated with the custom action. You can bind multiple custom actions to a single button and the same custom actions to multiple buttons.

See the Custom Actions section for additional information.

Navigation

The Navigation Event allows designating a page to a button which will redirect the user upon completing any other specified actions (i.e. calculate, save).

There are four Navigation Types:

• Back: Redirects to the previous active page.
• Next: Redirects to the next active page.
• Go To Page: Redirects to a predesignated page.
• External: Redirects to an external URL.

Active page in this context means a page that is visible to the end user. For example, if the page in the page navigation order is made hidden by a rule, the button will take the user to the next visible page. The order of 'previous' and 'next' page is determined according to the page order created in the Page Designer.

External Link Type can be Static where a link value must be entered into the Static Link Value field, or it can be set to By Value Of, where the link value will be determined by the named range selection under the Named Range field. Open in New Tab check box will determine whether the URL will open in a new tab.

After selecting the Navigation Event from Events list, you need to set Navigation Type and Go To Page information in the Navigation Properties modal which is shown when you click on the Navigation Event in the selected Events list. When you press the Save button, the Navigation Event will be created and associated with the button. If the Navigation Event is removed from the selected events, it will be automatically deleted. You need to define the Navigation Properties again if you decide to add a new Navigation Event.

Reset

The Reset Event returns the input fields to their default values in the applicable range. To define the applicable range and configure the Reset Event, click its name after adding it into the Events menu. When Reset All Pages property is enabled, all inputs in all pages of the web application will be reverted back to their default values. When this property is disabled, any number of application pages can be selected from the Pages to Reset field to trigger a reset.

Change Status

If the Save action is configured for a button, the Change Status option will also become visible. Change Status can allow you to configure the record status that is set to the saved record.

The option None will not set the status specifically on the record, indicating that the default status will be applied (i.e. by default, a status of 'New').

The option Static will allow you to define a specific status, based on the statuses defined in the Control Panel's Data page for the application. The status will simply be set to that value when the record is saved using this button.

The option ByValueOf will allow you to define a named range that corresponds to the desired status in order to set the record's status dynamically. For example, you can specify a named range ChangeStatusTo that performs calculations based on the user's input in order to determine the target status for the record.

If using the ByValueOf option, the named range must correspond to the index for the target status. If it is determined to be outside of the range of valid values, the system will revert to the default.

Change User

If the Save action is configured for a button, the Change User option will also become visible. Change User can allow you to configure the user that is assigned to the saved record.

The option None will not set the user specifically on the record, indicating that the default user will be applied (i.e. by default, the assigned user will be the active end user).

The option Static will allow you to define a specific user, based on the users defined in the system. The assigned user will simply be set to that specific user when the record is saved using this button.

The option ByValueOf will allow you to define a named range that corresponds to the desired user in order to set the record's assigned user dynamically. For example, you can specify a named range ChangeUserTo that performs calculations based on the user's input in order to determine the target user for the record.

If using the ByValueOf option, the named range must correspond to a valid user's ID or username. If it is determined to be outside of the range of valid values, the system will revert to the default.

Change Group

If the Save action is configured for a button, the Change Group option will also become visible. Change Group can allow you to configure the group that is assigned to the saved record.

The option None will not set the group specifically on the record, indicating that the default group will be applied (i.e. by default, the assigned group is null).

The option Static will allow you to define a specific group, based on the groups defined in the system. The assigned group will simply be set to that specific group when the record is saved using this button.

The option ByValueOf will allow you to define a named range that corresponds to the desired group in order to set the record's assigned group dynamically. For example, you can specify a named range ChangeGroupTo that performs calculations based on the user's input in order to determine the target group for the record.

If using the ByValueOf option, the named range must correspond to a valid group's ID or name. If it is determined to be outside of the range of valid values, the system will revert to the default.

Enabled

Indicates whether the button control is enabled.

This can be configured as Always or Never to indicate whether the button is statically enabled or not.

Alternatively, if any Boolean Single Named Ranges (SNR) exist (i.e. ranges pointing to a single cell that evaluates to TRUE or FALSE), then the enabled-ness of the button can be configured to reflect the value of that named range using the 'By Value Of' setting.

Visible

Indicates whether the button control is visible.

This can be configured as Always or Never to indicate whether the button is statically visible or not.

Alternatively, if any Boolean Single Named Ranges (SNR) exist (i.e. ranges pointing to a single cell that evaluates to TRUE or FALSE), then the visibility of the button can be configured to reflect the value of that named range using the 'By Value Of' setting.