Button control

You are here:

Reflects the current release of Nintex for SharePoint 2016. For your version, please access assistance through the Help button in the product.

Button control

The Button control can be used to initiate an action, such as submitting a form or initiating a custom JavaScript.

Control settings

Following are the fields and options visible in the control settings dialog box for this form control.

Note: Several settings allow selection of Yes, No, or Expression. Selecting Expression allows you to construct a formula from reference tokens and functions. The expression must resolve to a Yes/No value at runtime to be valid. If the expression does not resolve to a Yes/No value, it will revert to the default.

Note: For information about the control properties tab in the Nintex Forms ribbon, see Control properties tab.

Section	Field	Description
General	Name	The name of the control. The name is used for comparison validation and other control references.
	Button action	Function of the button control. Choose one of the following options. Save: Saves entered data to the list and closes the form. Save and Submit: Saves entered data to the list and closes the form. Cancel: Discards entered data and closes the form. Save and Continue: Saves entered data to the list without validating for required controls (rule or control configuration). JavaScript: Option for specifying custom functionality.
	Button type	Text or image appearance of the button control. Choose one of the following options. Button: Superimposes the text on a clickable rectangle. Image: Displays the specified image within a clickable rectangle. Link: Formats the text as a link.
	Button label	The text to display on the button control. For Image type, displays text when image cannot be displayed.
Appearance	Visible	Hide or show the control at runtime.
	Horizontal width	The width of the control based on percentage (%), pixels, or points. Default: 100%
	Vertical height	The height of the control based on percentage (%), pixels, or points. Default: 100%
Formatting (Classic Forms Designer only)	CSS class	The CSS class to apply to the control. This is used to apply advanced styling options. The Custom CSS class is defined in Form Settings (refer to Form and Layout settings).
	Border	Draws a line along the select border of the control.
	Border Style	The style of the border.
	Border Width (Pixels)	The width of the border in pixels.
	Border Color	The color of the border. This can either be a HEX code or a named color that is supported by html.
	Padding Width (Pixels)	The amount of padding in pixels that will appear between the top, left and right border and the inner control.
Ribbon	Show on Ribbon	Show this button on the Ribbon toolbar (if available) in addition to the form.
	Ribbon icon URL	If shown on the Ribbon toolbar, specify the URL of the icon (32x32px) to use.
	Ribbon button order	Determines the order in which buttons will appear on the ribbon toolbar. Default: 10
	Ribbon button group name	The name of the Ribbon toolbar group to display the button.
Advanced	Visible when in view mode	Hide or show the control in view mode. If Yes is selected: View mode text: The text displayed on the button when the form is in view mode. Enable when in view mode: Allow the button to operate when the form is in view mode.
	Causes validation	(Displayed for the following button types: Save, Save and Submit, Cancel, JavaScript.) Apply validation for JavaScript button types.
	Client click	(Displayed for the following button types: Save, Save and Submit, Cancel, JavaScript.) The JavaScript to execute when the user clicks the button. Note: This feature is available in the Classic Forms Designer only.
	Connected to	The field to bind the input control to. For more information, see Connect controls to fields.
	Value returned	(Displayed when the control is connected to a list column.) The value to return when the button is clicked. Note: This feature is available in the Classic Forms Designer only.
	Data type returned	(Displayed when the control is connected to a list column.) The data type of the returned value when the button is clicked. Note: This feature is available in the Classic Forms Designer only.
	Confirmation message	Prompts the user for confirmation when the button is clicked during runtime, displaying the specified text. If no text is specified, then the user is not prompted for confirmation.
	Resize at runtime	Allow the control to dynamically adjust its size, and adjust the form length and position of other controls accordingly.
	Close the form	(Displayed for the following button types: Save and Continue.) Closes the form when the button is clicked. Default value: No Note: This feature is available in the Classic Forms Designer only.
	Redirect URL	(Displayed for the following button types: Save, Save and Submit, Cancel.) The URL to redirect to after the form is closed through this button control.

Section

Field

Description

General

Name

The name of the control. The name is used for comparison validation and other control references.

Button action

Function of the button control. Choose one of the following options.

Save: Saves entered data to the list and closes the form.
Save and Submit: Saves entered data to the list and closes the form.
Cancel: Discards entered data and closes the form.
Save and Continue: Saves entered data to the list without validating for required controls (rule or control configuration).
JavaScript: Option for specifying custom functionality.

Button type

Text or image appearance of the button control. Choose one of the following options.

Button: Superimposes the text on a clickable rectangle.
Image: Displays the specified image within a clickable rectangle.
Link: Formats the text as a link.

Button label

The text to display on the button control. For Image type, displays text when image cannot be displayed.

Appearance

Visible

Hide or show the control at runtime.

Horizontal width

The width of the control based on percentage (%), pixels, or points. Default: 100%

Vertical height

The height of the control based on percentage (%), pixels, or points. Default: 100%

Formatting

(Classic Forms Designer only)

CSS class

The CSS class to apply to the control. This is used to apply advanced styling options. The Custom CSS class is defined in Form Settings (refer to Form and Layout settings).

Border

Draws a line along the select border of the control.

Border Style

The style of the border.

Border Width (Pixels)

The width of the border in pixels.

Border Color

The color of the border. This can either be a HEX code or a named color that is supported by html.

Padding Width (Pixels)

The amount of padding in pixels that will appear between the top, left and right border and the inner control.

Ribbon

Show on Ribbon

Show this button on the Ribbon toolbar (if available) in addition to the form.

Ribbon icon URL

If shown on the Ribbon toolbar, specify the URL of the icon (32x32px) to use.

Ribbon button order

Determines the order in which buttons will appear on the ribbon toolbar. Default: 10

Ribbon button group name

The name of the Ribbon toolbar group to display the button.

Advanced

Visible when in view mode

Hide or show the control in view mode.

If Yes is selected:

View mode text: The text displayed on the button when the form is in view mode.
Enable when in view mode: Allow the button to operate when the form is in view mode.

Causes validation

(Displayed for the following button types: Save, Save and Submit, Cancel, JavaScript.) Apply validation for JavaScript button types.

Client click

(Displayed for the following button types: Save, Save and Submit, Cancel, JavaScript.) The JavaScript to execute when the user clicks the button.

Note: This feature is available in the Classic Forms Designer only.

Connected to

The field to bind the input control to. For more information, see Connect controls to fields.

Value returned

(Displayed when the control is connected to a list column.) The value to return when the button is clicked.

Note: This feature is available in the Classic Forms Designer only.

Data type returned

(Displayed when the control is connected to a list column.) The data type of the returned value when the button is clicked.

Note: This feature is available in the Classic Forms Designer only.

Confirmation message

Prompts the user for confirmation when the button is clicked during runtime, displaying the specified text. If no text is specified, then the user is not prompted for confirmation.

Resize at runtime

Allow the control to dynamically adjust its size, and adjust the form length and position of other controls accordingly.

Close the form

(Displayed for the following button types: Save and Continue.) Closes the form when the button is clicked. Default value: No

Note: This feature is available in the Classic Forms Designer only.

Redirect URL

(Displayed for the following button types: Save, Save and Submit, Cancel.) The URL to redirect to after the form is closed through this button control.