Nintex Forms 2010 Help

Last updated: Tuesday, September 20, 2016

1 Administration and Configuration
        1.1 Licensing settings
        1.2 Activating Nintex Forms
        1.3 Web Application activation settings
        1.4 Manage device layouts
        1.5 Associating templates to device layouts
        1.6 Manage form controls
        1.7 Manage database
        1.8 Live Forms settings
        1.9 Installing Nintex Live
        1.10 View Live forms
        1.11 Manage Nintex Live Mobile Users
        1.12 Manage Live Mobile Access
        1.13 SharePoint IDs for Nintex Features
        1.14 Licensing options
        1.15 FBA for Nintex Mobile
2 Controls
        2.1 Button
        2.2 Choice
        2.3 Rich Text
        2.4 Hyperlink
        2.5 Image
        2.6 Label
        2.7 Date Time
        2.8 Border
        2.9 List Item
        2.10 List Lookup
        2.11 Multi Line Textbox
        2.12 Page Viewer
        2.13 Panel
        2.14 People
        2.15 Single Line Textbox
        2.16 Yes-No
        2.17 Workflow Diagram
        2.18 List View
        2.19 List Attachment
        2.20 Repeating section
        2.21 Recurrence
        2.22 Calculated Value
        2.23 Managed Metadata
        2.24 External Data Column
        2.25 Control Properties Ribbon
        2.26 Geolocation
        2.27 Change Content Type
        2.28 Project Server Links
        2.29 SQL Request
        2.30 Web Request
        2.31 Page Break Guide
3 Using the Form Designer
        3.1 Getting started with the form designer
        3.2 Shortcut keys
        3.3 Importing and exporting forms
        3.4 Controls In Use
        3.5 Connecting Controls to fields or variables
        3.6 Designing a form for a mobile device
        3.7 Inserting reference fields
        3.8 Inline functions
        3.9 Control Settings
        3.10 Saving and publishing forms
        3.11 Form and Layout settings
        3.12 Live Settings
        3.13 Linked Controls
        3.14 Designing forms in Nintex Workflow
        3.15 CSS Styles
        3.16 Formula Builder
        3.17 Inline functions usage examples
        3.18 Rules
        3.19 Previewing a Form
        3.20 Runtime Functions
        3.21 Lookup Function
        3.22 Form Variables
        3.23 Run Now
        3.24 Forms functionality supported for use with Nintex Mobile
        3.25 Print to PDF
4 Form Interaction with SharePoint
        4.1 Configuring the Start Site Workflow Webpart
        4.2 Configuring the List Form Web Part
        4.3 Designing forms for SharePoint external lists

1 Administration and Configuration

1.1 Licensing settings

Nintex Forms uses a license file (.nlf) for server licensing. A single license file is used to store information about all servers in a farm that are licensed for Nintex Forms.

Importing the License

To import a license:

  1. In Central Administration, navigate to Nintex Forms Management and click Licensing.
  2. On the Licensing page, click the Import button.
  3. In the License file section, click the Browse button to locate the license file. Once the license file has been located, click the Import button.
  4. The Licensing information will then be displayed.

Related Topics

Installing Nintex Live
Activating Nintex Forms
Manage database
Getting started with the form designer

Please contact our sales team for licensing advice at sales@nintex.com.

1.2 Activating Nintex Forms

To design forms using Nintex Forms, feature activation is required on the site collection.
 
The Nintex Forms 2010 Prerequisites Feature must be activated before activating other Nintex Forms features.

Activating 'Nintex Forms 2010 Prerequisites Feature' for the Site Collection

To activate Nintex Forms 2010 Prerequisites Feature in a site collection:

  1. Navigate to the Site Collection home page.
  2. In the Site Actions menu, click on Site Settings.
  3. In the Site Collection Administration group, click on Site collection features.
  4. In the Nintex Forms 2010 Prerequisites Feature section, click on the Activate button.

After a short delay, the page will refresh and the status will become Active

Activating 'Nintex Forms 2010 for Nintex Workflow' for the Site Collection

Activate the Nintex Forms 2010 for Nintex Workflow site collection feature to design start forms and task forms in Nintex Workflow.

Note: Nintex Workflow must be installed and configured prior to activating this feature.

To activate Nintex Forms 2010 for Nintex Workflow in a site collection:

  1. Navigate to the Site Collection home page.
  2. In the Site Actions menu, click on Site Settings.
  3. In the Site Collection Administration group, click on Site collection features.
  4. In the Nintex Forms 2010 for Nintex Workflow section, click on the Activate button.

After a short delay, the page will refresh and the status will become Active

Activating 'Nintex Forms 2010 for SharePoint List Forms' for the Site Collection

Activate the Nintex Forms 2010 for SharePoint List Forms site collection feature to use Nintex Forms to design SharePoint list forms.

To activate Nintex Forms 2010 for SharePoint List Forms in a site collection:

  1. Navigate to the Site Collection home page.
  2. In the Site Actions menu, click on Site Settings.
  3. In the Site Collection Administration group, click on Site collection features.
  4. In the Nintex Forms 2010 for SharePoint List Forms section, click on the Activate button.

After a short delay, the page will refresh and the status will become Active.

Activating 'Nintex Live Forms' for the Site Collection

Activate the Nintex Live Forms site collection feature to allow Nintex Forms designers to publish forms to Nintex Live.
 
Note: The Nintex Live Forms option must also be enabled in the Central Administration Live Forms settings when activating this feature. 

To activate Nintex Live Forms in a site collection:

  1. Navigate to the Site Collection home page.
  2. In the Site Actions menu, click on Site Settings.
  3. In the Site Collection Administration group, click on Site collection features.
  4. In the Nintex Live Forms section, click on the Activate button.

After a short delay, the page will refresh and the status will become Active.

Related Topics

Getting started with the form designer
Live Forms settings
Importing and exporting forms
Configuring the Start Site Workflow Webpart

1.3 Web Application activation settings

To activate Nintex Forms on a Web Application, the Nintex Forms solution must be installed and deployed on the Web Application.

Activating Nintex Forms on the Web Application

To activate the Nintex Forms solution on the Web Application:

  1. Navigate to SharePoint Central Administration.
  2. In the Quick Launch menu, click Application Management.
  3. In the Web Applications section, click the Manage web applications link.
  4. Select the Web Application that Nintex Forms is to be deployed to.
  5. In the Web Applications Ribbon, click on Manage Features.
  6. In the Manage Web Application Features dialog, click Activate on the Nintex Forms feature.

After a short delay, the page will refresh and the status will become Active.

Related Topics

Activating Nintex Forms
Installing Nintex Live
Getting started with the form designer

 

1.4 Manage device layouts

The Manage device layouts page allows the addition, removal and configuration of layouts that are targeted to devices. In addition, a template can be associated with a device layout. Refer to Associating templates to device layouts for more information.

This page displays a summary view of the configured layout options targeted to the device.

Device Layouts

Adding a new device layout

To add a new device layout:

The Device Details page is displayed as follows:

Deleting an existing device layout

To delete a device layout:

Note: There is no warning to confirm deletion at this stage.

Related Topics

Associating templates to device layouts
Form and Layout settings
Designing a form for a mobile device
Getting started with the form designer

1.5 Associating templates to device layouts

A template is a saved form definition that is used to apply default settings for newly created form layouts.

A form export file (.xml) is used to import templates. A template will be added for each layout in the exported form definition. For example: A form is exported with a Default layout, iPad layout and a Smart Phone layout. Whenever one of these three layouts are created, the template settings will be applied. 

Uploading a template

  1. Navigate to Nintex Forms Management and select Manage device layouts.
  2. In the Templates section, click the Browse button.
  3. Navigate to the saved form export file (xml), select the file and click Open.
  4. Click the Upload button.

Once a template has been uploaded, the device templates that were found within the form export file will be listed below the Browse button.

To deactivate a template for one or more specific device layout(s), deselect the Use Template setting in Manage device layouts.

Note: Only one template may be applied for the farm. Uploading a template file will clear all existing templates and apply only the layouts found in the most recent file uploaded.

 
Note: The following items are all included as part of the template.

Related Topics

Importing and exporting forms
Getting started with the form designer
Form and Layout settings
Manage device layouts

1.6 Manage form controls

The Manage Form Controls page lists all of the installed controls that are available for use when designing a form.

For more information on the functionality of the individual controls please refer to the Control help topics. 

Related Topics

Control Settings
Controls In Use
Connecting Controls to fields or variables
Linked Controls

 

 

1.7 Manage database

The Manage database page can be used to configure the database that will store Nintex Forms configuration and application settings.

Database settings

The Nintex Forms installation requires a single database to store the server specific configuration settings. A new database or an existing database can be used.

Use of the default database server and database name is recommended for most cases. Refer to the administrator's guide for advanced scenarios where specifying database information is required. 
Use of Windows authentication is strongly recommended. To use SQL authentication, specify the credentials which will be used to connect to the database.   

To create a new database:
  1. Specify the name of the SQL Server database server, the name of the database and select the authentication settings.
 
To connect to an existing database:
  1. Specify the name of the SQL Server database server where the database is located, the name of the existing database and select the authentication settings.

Failover server

The database may be associated with a failover server that is used in with SQL Server database mirroring.

Related Topics

Manage device layouts
Licensing settings
Manage form controls
Live Forms settings
View Live forms

1.8 Live Forms settings

Use the Live Forms settings page to enable or disable the ability to publish forms to Nintex Live, and allow or disallow anonymous user access.

Note: Ensure that the Nintex Live Framework and the certificates required to enable connectivity to Nintex Live have been installed.

If the "Install Nintex Live" option was not selected during Nintex Forms installation, manually install and deploy the “nintexlivecore.wsp”.

To enable Nintex Live Forms

Note: A database for Nintex Forms must be provisioned before Nintex Live Forms can be enabled. Refer to Manage database for more information.

  1. In Central Administration, navigate to Nintex Forms Management.
  2. Click on Live Forms settings.
  3. In the Enable Nintex Live Forms section, click on Enable.

 

Note: When Nintex Live Forms is disabled, forms already published to Nintex Live will remain active.  Live Form submissions will be held in the Nintex Live message queue until retrieved or cleared*. Re-enabling Nintex Live Forms will retrieve and process all stored form submissions.
To disable all forms published to Nintex Live, please see View Live forms for more information.

*Nintex will endeavour to hold and deliver all undelivered forms, however, periodic clearing of stale content may be necessary. Please contact Nintex if you have special requirements for holding content or clearing held content.

To allow anonymous forms submissions

  1. Under Central Administration, navigate to Nintex Forms Management.
  2. Click on Live Forms settings.
  3. In the Allow anonymous form submissions, select Yes.
  4. In the warning dialog, click the OK button.

Note: Allowing anonymous form submissions may require Microsoft server internet licensing.

Related Topics

Installing Nintex Live
View Live forms
Web Application activation settings
Live Settings
Saving and publishing forms
Manage database

1.9 Installing Nintex Live

Nintex Live is a hosted service provided by Nintex.

The Nintex Live Framework and certificates are required to enable connectivity to Nintex Live.

The Nintex Live components must be installed to enable the Nintex Live features of Nintex Forms. These features allow form designers to publish designated forms to Nintex Live. Nintex Live Forms can be accessed by internet users, either anonymously or via 3rd party authentication providers.

Installing the Nintex Live components

The following steps are required to manually install the Nintex Live Framework and certificates if the "Install Nintex Live" option was not selected during Nintex Forms 2010 installation. The SharePoint PowerShell Command Prompt must be used to install the components.

To launch the SharePoint PowerShell Command Prompt:

  1. Login to the server that is running the Central Administration service as a SharePoint administrator.
  2. Click the Start menu and navigate to All Programs > Microsoft SharePoint 2010 Products > SharePoint 2010 Management Shell.

Installing the Nintex Live Framework

In the SharePoint PowerShell Command Prompt, type:

CD "C:\Program Files\Nintex\Nintex Forms 2010"

Note: The default installation path is "C:\Program Files\Nintex\Nintex Forms 2010", replace with actual location if installed to a different location.

Add-SPSolution -LiteralPath "C:\Program Files\Nintex\Nintex Forms 2010\NintexLiveCore.wsp"

Install-SPSolution -Identity "1ddec2be-094d-4a9b-b9e1-fdca27b07646" -GACDeployment -Force

Note: Wait for the solution to be deployed. Check the status of the solution deployment in the Central Administration > System Settings > Manage farm solutions page.

Install-SPFeature -SolutionId "1ddec2be-094d-4a9b-b9e1-fdca27b07646" -AllExistingFeatures -Force

Remove-PSSnapin Microsoft.SharePoint.PowerShell

Add-PSSnapin Microsoft.SharePoint.PowerShell

Install-LiveService

Importing the Nintex Live certificates

In the SharePoint PowerShell Command Prompt type:

CD "C:\Program Files\Nintex\Nintex Forms 2010\Certs"

Note: The default installation path is "C:\Program Files\Nintex\Nintex Forms 2010", replace with actual location if installed to a different location.

.\CertificateUpload.ps1

Related Topics 

Live Forms settings
View Live forms
Activating Nintex Forms

 

1.10 View Live forms

The View Live forms page displays list forms and workflow start forms that are currently published to Nintex Live. Forms can be viewed or removed.

Use the Select form type drop down to display the different form types available.

The list displays the following: 

To remove a form published to Nintex Live

  1. Select the form by checking it.
  2. Click on Remove. In the confirmation dialog, click OK.

Note: Removing the form does not uncheck the "Publish to Nintex Live" option in the Live Settings. If the form is published again, it will be republished to Nintex Live.  

Note: If the form is removed from Nintex Live and then republished, the Live Form URL will revert to the original URL when first published.

Related Topics

Live Settings
Saving and publishing forms
Installing Nintex Live
View Live forms
Live Forms settings

1.11 Manage Nintex Live Mobile Users

Manage Nintex Live Mobile Users

Enable individual users of the Nintex Mobile App to connect to forms and tasks though the Nintex Live framework or disable individual users from connecting.
 
Related Topics
Manage Live Mobile Access

1.12 Manage Live Mobile Access

Manage Live Mobile Access

Enable or disable users of the Nintex Mobile App to connect to forms and tasks through the Nintex Live framework.
 
The page is displayed as follows:
  •  Live relay service: This lists all the servers in the farm and indicates the status of the live relay service on each. For Nintex Mobile Apps to work via live the relay service, it must be running on at least one server.
  •  Farm Source Name: This is the name of Farm using the relay service. Nintex Mobile will use this to identify where a form comes form and provide additional capabilities based on this name. The name is not validated to be unique, it should be specific to your organisation to avoid confusion by users of the Nintex Mobile App.
  •   Enable Live Mobile Access: Set whether users of the Nintex Mobile App will be able to connect using Nintex Live. This can only be set to Enabled when at least one instance of the relay is running.
Click OK to confirm your changes.
 
Related Topics
Manage Nintex Live Mobile Users

1.13 SharePoint IDs for Nintex Features

Error messages displayed in SharePoint may reference identifiers for Nintex features. Following is the list of Nintex SharePoint feature IDs for Nintex Forms 2010.
 
Note: Some features are hidden. Contact Support if you have further questions.
 
​Nintex SharePoint Feature ​ID
​NintexFormsAdminWeb ​70f4f7da-4fb4-4e30-ba1a-a733efb2e1ac
​NintexFormsFarm ​ada0910e-a663-4db4-a19c-d8a097317b87
​NintexFormsListSite ​202afc3c-7384-4700-978d-6da3d3cce192
​NintexFormsLiveSite ​23fce797-ac15-4451-b8da-cf8ac6de6912
​NintexFormsSitePrerequisites ​716f0ee9-e2b0-41f0-a73c-47ed73f135de
​NintexFormsWebApplication ​0cdf436f-61b0-43d2-b250-4360f0353b63
​NintexFormsWorkflowSite ​ac8addc7-7252-4136-8dcb-9887a277ae2c
​NintexLiveAdminLinks ​29e9a673-31a4-46a3-b0d2-d8e1db1dbd92

1.14 Licensing options

Nintex Forms Licensing Options

Nintex Forms 2013 is available in the following editions. 

Please contact our sales team if you need advice at sales@nintex.com.

Software Assurance

Valid Software Assurance is required in order to update to the latest version of Nintex Forms.

Related Topics

Licensing settings

1.15 FBA for Nintex Mobile

​​This topic describes how to set up Nintex Mobile access through form-based authentication. This topic also includes field descriptions for related administration pages available through Central Administration.

Form Based Authentication (FBA) for Nintex Mobile authenticates users through a web application sign-in page. When FBA for Nintex Mobile is enabled for your SharePoint farm, a separate web application sign-in page is displayed for access to Nintex Mobile. This sign-in page is triggered when a user enters the URL to a related SharePoint site using the Corporate sign-in option for the Nintex Mobile app.

The first time a user attempts to sign into Nintex Mobile with valid site credentials (after FBA is enabled), the user is automatically granted Nintex Mobile access through FBA. Behind the scenes, the first successful sign-in triggers generation of an encrypted token that is issued to Nintex Mobile. The token uses a unique Identity (GUID) to represent the user.  Nintex Mobile continues to use this token for subsequent requests sent to Nintex Forms, such as a retrieval of forms. The FBA endpoints validate requests against the provided token. When the token expires, access is blocked until the user signs in again, which triggers generation of a new token.

When FBA for Nintex Mobile is disabled, Nintex Mobile users are authenticated through the app sign-in screen.

Setting up FBA access to Nintex M​obile​

As administrator, you can enable and disable FBA access to Nintex Mobile.   

To enable FBA access to Nintex Mobile for the SharePoint farm
  1. On the Central Administration Home page, click Nintex Forms Management
  2. Click Manage FBA Mobile Access
  3. Click Enable FBA
  4. To change the token expiration period, select the desired value for Set Nintex Mobile Token Expiry.
  5. Click OK
    Note: If your network infrastructure uses a firewall, ensure that FBA endpoints are externally accessible by Nintex Mobile. These endpoints (<SiteUrl>/_vti_bin/NintexMobile/FBA/) are secured by token validation and thus require the firewall to bypass authentication

To disable FBA access to Nintex Mobile for the SharePoint farm
  1. On the Central Administration Home page, click Nintex Forms Management
  2. Click Manage FBA Mobile Access
  3. Click Disable FBA
  4. Click OK. ​

Manage FBA Mobile Access page​​

The Manage FBA Mobile Access page​ contains the following selections. 
Selection Description
Enable Forms Based Authentication for Nintex Mobile When enabled, authenticates Nintex Mobile users through a web application sign-in page. The following options are available. 
  • Enable FBA
  • Disable FBA
Set Nintex Mobile Token Expiry Number of days before each user-specific encrypted token ​expires. 

2 Controls

2.1 Button

The Button Control

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

Note: The Button control is not supported in Nintex Mobile. The control is not needed in Nintex Mobile because the Save and Cancel buttons are generated individually by platform. 

Control Settings  

Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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 an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
Section Selection Description
General Name The name of the control. The name is used for comparison validation and other control references.​​​

Button action This selects the function of the button. Select JavaScript to specify custom functionality.
Button type Select the display type for the button.
Button label The text to display on the button. 
​Appearance Visible Hide or show control at runtime.
​​Horizontal width The width of the control as a %, pixel or point value. 
Vertical height The height of the control as a %, pixel or point value.  
Formatting 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. 
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 Apply validation for JavaScript button types.
Client click The JavaScript to execute when the user clicks the button.
Connected to The field to bind the input control to. 

If a selection is made in the List Columns:

  • Value returned: The value to return when the button is clicked.
  • Data type returned:  The data type of the returned value when the button is clicked. 
Confirmation message When the user clicks on the button during runtime, they will be prompted with this message prior to the buttons functionality being processed. 
Resize at runtime Allow the control to dynamically adjust its size, and adjust the form length and position of other controls accordingly. ​

Related Topics:

Getting started with the form designer
Controls In Use
Control Settings
Connecting Controls to fields or variables
Shortcut keys
Inserting reference fields
Control Properties Ribbon​​​

2.2 Choice

​​

The Choice Control

The Choice control can be used to make a single or multiple selection on a form.

Control Settings

Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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 an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
Section Selection Description Nintex Mobile
General Name The name of the control. The name is used for comparison validation and other control references.
Yes
Connected to The field to bind the input control to. Yes
Display format Select the type of choice control to display. (Option buttons / Checkbox / List / Drop down) Yes
Choices Enter the choices to be displayed. Yes
Default value source ​Select whether the default value will be inherited from the column definition or whether another specified value will be used.​​ ​Yes
Default value Set a default value for the control. If a control is connected to a SharePoint list column, enter the value or expression value to override the Choice default specified in the SharePoint column.  Yes
Render as buttons When Display Format is set to Options Buttons (also known as "radio buttons" this allows the control to be rendered as styled buttons which can appear like tabs. By using this option with Rules a basic tab-like interface can be built on your form.  ​No
Arrange choices ​Items can be arranged across then down or down then across. Yes
Number of columns Number of columns to use to display the specified choices. Yes
Column alignment Align the choices in fixed columns or allow them to float. Yes
Allow "Fill-in" choices Allows the user at runtime to specify a choice other than those presented.  ​No
Appearance Visible Hide or show the control at runtime. Yes
Enabled Enable the control to receive user input when the form is in input mode.  Yes
Formatting Control CSS class The CSS class to apply to the inner elements of the control. No
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 and Layout settings).  No
Border Draws a line along the select border of the control. No
Border Style The style of the border. No
Border Width (Pixels) The width of the border in pixels. No
Border Color The color of the border. This can either be a HEX code or a named color that is supported by html. No
Padding Width (Pixels) The amount of padding in pixels that will appear between the top, left and right border and the inner control. No
Validation Required The form will not submit unless this control is completed correctly. 

If Yes is selected:

  •  Required error message appears: The error message to display when the required field is not specified.  
Yes
Data Type The data type to convert to during validation. No
Use custom validation Enables the value entered into the control to be validated by a JavaScript function. 

If Yes is selected:

  • Custom validation function: Specify the JavaScript function name for the client side custom validation. Note: The JavaScript function is to be specified in the Custom JavaScript section within the form's Settings. 
  • Custom error message:  The error message to display when an invalid value is entered.  
No
Advanced Help text Help text that will be displayed to the user as a tooltip to guide the completion of the form. No
Control mode Force control to be in Edit mode, Display mode, or set to Auto. No
Store Client ID in JavaScript variable A JavaScript variable will be created that references the Client ID of this control. 

If Yes is selected:

  • Client ID JavaScript variable name: The name of the variable to store the Client ID in.
No
Resize at runtime Allow the control to dynamically adjust its size, and adjust the form length and position of other controls accordingly. ​ No​

Related Topics

Getting started with the form designer
Control Settings
Controls In Use
Connecting Controls to fields or variables
Shortcut keys
Yes-No Control
Inserting reference fields
Control Properties Ribbon

​ 

2.3 Rich Text

The Rich Text Control

Use Rich Text to display formatted text, pictures, hyperlinks and tables on a form. 

Note: The Rich Text control is not supported in Nintex Mobile. ​

Control Settings 

Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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 an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
Section Selection Description
General (unlabeled) To enter or edit content, click in the text area.  
Name The name of the control. The name is used for comparison validation and other control references. ​
Appearance Visible Hide or show the control at runtime.
Formatting 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 selected 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.
Advanced Resize at runtime Allow the control to dynamically adjust its size, and adjust the form length and position of other controls accordingly. ​

Related Topics:

Getting started with the form designer
Control Settings
Controls In Use
Inserting reference fields
Shortcut keys
Multi Line Textbox
Single Line Textbox
Inserting reference fields

​ 

2.4 Hyperlink

The Hyperlink Control

The Hyperlink control can be used to enter a hyperlink URL and display text. 

Control Settings 

Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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.
 
For an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
Section Selection Description Nintex Mobile
General Name The name of the control. This name is used for comparison validation and other control references. 
Yes
Connected to The field to bind the input control to.  Yes
​Appearance Visible Hide or show the control at runtime. Yes
Enabled Enable the control to receive user input when the form is in input mode.  Yes
Formatting ​Control CSS class The CSS class to apply to the inner elements of the control. ​No
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)​
No
Border Draws a line along the selected border of the control. No
Border Style The style of the border. No
Border Width (Pixels) The width of the bordein pixels. No
Border Color The color of the border. This can either be a HEX code or a named color that is supported by html. No
Padding Width (Pixels) The amount of padding in pixels that will appear between the top, left and right border and the inner control. No
Validation Required The form will not submit unless this control is completed correctly.

If Yes is selected:

  • Required error message: The error message to display when the required field is not specified.
​Yes
Use custom validation Enables the value entered into the control to be validated by a JavaScript function.

If Yes is selected:

  • Custom validation function: Specify the JavaScript function name for the client side custom validation. Note: The JavaScript function is to be specified in the Custom JavaScript section within the form's Settings.  
  • Custom error message: The error message to display when the required field is not specified.
No
Advanced Help text Help text that will be displayed to the user as a tooltip to guide the completion of the form. No
Control Mode Force control to be in Edit mode, Display mode, or set to Auto. No
Store Client ID in JavaScript variable A JavaScript variable will be created that references the Client ID of this control. 

If Yes is selected:

  • Client ID JavaScript variable name: The name of the variable to store the Client ID in.  
No
Resize at runtime Allow the control to dynamically adjust its size, and adjust the form length and position of other controls accordingly. ​ No​

Related Topics

Getting started with the form designer
Control Settings
Controls In Use
Connecting Controls to fields or variables
Shortcut keys
Inserting reference fields
Control Properties Ribbon

2.5 Image

The Image Control

The Image control can be used to display an image on a form.

Control Settings

Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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 an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
Section Selection Description Nintex Mobile
General Name The name of the control. This name is used for comparison validation and other control references. 
Yes
Image URL The URL for the image. Yes
Alternate text The alternate text to display to aid accessibility.  Yes
Appearance Visible Hide or show the control at runtime. Yes
Horizontal width The width of the control in %, pixel or point value.  Yes
Vertical height The height of the control in %, pixel or point value.  Yes
Formatting 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).​
​No
Border Draws a line along the selected border of the control. No
Border Style The style of the border. No
Border Width (Pixels) The width of the border in pixels. No
Border Color The color of the border. This can either be a HEX code or a named color that is supported by html. No
Padding Width (Pixels) The amount of padding in pixels that will appear between the top, left and right border and the inner control. No
Advanced Resize at runtime Allow the control to dynamically adjust its size, and adjust the form length and position of other controls accordingly.  No​

Related Topics

Getting started with the form designer
Control Settings
Controls In Use
Label
Shortcut keys
Inserting reference fields
Control Properties Ribbon

2.6 Label

The Label Control

The Label control can be used to place text anywhere on the form. Labels are often placed next to other controls to describe the associated control.

Control Settings

Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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 an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
Section Selection Description Nintex Mobile
General (unlabeled) To enter or edit content, click in the text area.
Yes
Name ​The name of the control. The name is used for comparison validation and other control references.​ Yes

Associated control Select the control that this label describes. This is used for web browser accessibility.
Note: By default, when a Label is associated to a bound control (a control that is associated to a column or workflow variable), the default value of the label will reflect the name of the column or workflow variable the control is bound to. 
Yes
Appearance Visible Hide or show the control at runtime. Yes
Formatting 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) 
​No
Border Draws a line along the select border of the control. ​No
Border Style The style of the border. ​No
Border Width (Pixels) The width of the border in pixels. ​No
Border Color The color of the border. This can either be a HEX code or a named color that is supported by html. ​No
Padding Width (Pixels) The amount of padding in pixels that will appear between the top, left and right border and the inner control. ​No
Advanced Resize at runtime Allow the control to dynamically adjust its size, and adjust the form length and position of other controls accordingly.  ​No​

Related Topics

Getting started with the form designer
Control Settings
Controls In Use
Inserting reference fields
Shortcut keys
Image
Control Properties Ribbon

2.7 Date Time

The Date/ Time Control

The Date/ Time control can be used to either enter a date and time or select a date from a calendar display.

Control Settings 

Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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 an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
Section Selection Description Nintex Mobile
General Name The name of the control. The name is used for comparison validation and other control references. 
Yes
Connected to The field to bind the input control to. Yes
Default value Set a default value for the display. This value will only be used if a default value has not been specified in the column or variable in the Connected to setting.

If Selected date option:

  • Selected date: Select a specific date.  
Yes
Date only Show the date only without the time.  Yes
Appearance Visible Hide or show the control at runtime. Yes
Enabled Enable the control to receive user input when the form is in input mode.  Yes
Formatting Control CSS class The CSS class to apply to the inner input control. No
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).    No
Border Draws a line along the select border of the control. No
Border Style The style of the border. No
Border Width (Pixels) The width of the border in pixels. No
Border Color The color of the border. This can either be a HEX code or a named color that is supported by html. No
Padding Width (Pixels) The amount of padding in pixels that will appear between the top, left and right border and the inner control. No​
Validation Required The form will not submit unless this control is completed correctly.

If Yes is selected:

  • Required error message: The error message to display when the required field is not specified. 
Yes
Compare To Enables the value entered into the control to be validated against a specified value, or the current value in another control. 

If Control is selected:

  • Compare operator: Select the type of comparison to perform.
  • Control to compare: Select the control to compare to.
  • Compare validation error message: The error message to display when an invalid value is entered. 

If Value is selected:

  • Compare operator: Select the type of comparison to perform.
  • Value to compare: A fixed constant value to compare against the current value of the control.
  • Compare validation error message: The error message to display when an invalid value is entered. ​
Yes
Use range validation Enables the value entered into the control to be validated against a specified maximum and minimum value. 

If Yes is selected: 

  • Maximum value: The maximum valid value.
  • Minimum value: The minimum valid value.
  • Range validation error message: The error message to display when an invalid value is entered. 
Yes
Use a regular expression Enables the value entered into the control to be validated against a regular expression. 

If Yes is selected:

  • Regular expression: The regular expression string for validating the input against.
  • Regular expression validation message: The error message to display when an invalid value is entered.
​No
Use custom validation Enables the value entered into the control to be validated by a JavaScript function. 

If Yes is selected:

  • Custom validation function: Specify the JavaScript function name for the client side custom validation. Note: The JavaScript function is to be specified in the Custom JavaScript section within the form's Settings. 
  • Custom error message: The error message to display when an invalid value is entered.
No
Advanced Help text Help text that will be displayed to the user as a tooltip to guide the completion of the form. No
Control Mode Force control to be in Edit mode, Display mode, or set to Auto. No
Convert empty string to null Convert to a null value if the control contains an empty string. No
Null display text If the bound value is null, this text will be displayed instead. No
String format The string format to apply to the displayed value. No
Store Client ID in JavaScript variable A JavaScript variable will be created that references the Client ID of this control. 

If Yes is selected:

  • Client ID JavaScript variable name: The name of the variable to store the Client ID in.
No
Resize at runtime Allow the control to dynamically adjust its size, and adjust the form length and position of other controls accordingly.  ​ No​

Related Topics

Getting started with the form designer
Control Settings
Controls In Use
Connecting Controls to fields or variables
Shortcut keys
Control Properties Ribbon

2.8 Border

The Border Control

The Border control can be used to display a line along one or more borders of the control.   

Control Settings

Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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.

Section Selection Description Nintex Mobile
General Name The name of the control. The name is used for comparison validation and other control references.​ ​Yes
Appearance
Visible Hide or show the control at runtime. 
Yes
Formatting 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) ​No
Border Draws a line along the selected border of the control. Yes
Border Style The style of the border. Yes
Border Width (Pixels) The width of the border in pixels. Yes
Border Color The color of the border. This can either be a HEX code or a named color that is supported by html.
Note: When used in Nintex Mobile layouts, the color must be a HEX or RGB value.
Yes​

Related Topics

Getting started with the form designer
Control Settings
Controls In Use
Shortcut keys
Control Properties Ribbon​​

2.9 List Item

The List Item Control

The List Item control can be used to display an item from a SharePoint list.  

Note: The List Item control is not supported in Nintex Mobile. 

Control Settings

Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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 an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
Section Selection Description
General Source SharePoint site
The URL or GUID of the SharePoint site the list is in.
List The ID or name of the list.
List Item ID The ID of the item in the list to display. 
Appearance Visible Hide or show the control at runtime.
Formatting 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 selected 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.
Advanced Show error message at runtime if list item not found Displays the SharePoint error message at runtime if the item cannot be found.
Resize at runtime Allow the control to dynamically adjust its size, and adjust the form length and position of other controls accordingly. ​

Related Topics

Getting started with the form designer
Control Settings
Controls In Use
List View
List Attachment
List Lookup
Shortcut keys
Inserting reference fields
Control Properties Ribbon

 

2.10 List Lookup

The List Lookup Control

The List Lookup control allows users to make selections based on values in a SharePoint list. The selection the user makes can be used to filter the available values in another List Lookup control on the form.

Control Settings

Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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 an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
Section Selection Description Nintex Mobile
General Name The name of the control. This name is used for comparison validation and other control settings.
Yes
ID connected to The column to bind the item ID of the returned lookup value to. Note: The column names specified in the ID Connected to field, must be of the type "Single line of text". Yes
Text connected to The column to bind the text returned from the lookup to.
Note: When a List Lookup control is used, two pieces of data are returned: the ID of the item selected in the lookup and the text of the item selected in the lookup. Each of these can be bound to a List Column in the current list. The column names specified in the Text Connected to field, must be of the type "Single line of text".  
Note: If you will require Nintex Workflow to act on a returned list item, it will require the ID to refer to the list item.  
Yes
Source SharePoint site The ID or the URL of the SharePoint site that contains the source list. This list can be anywhere within the web application. The site picker will only show sites within the current site collection, however, other sites can be entered as a server relative URL manually. Yes
Source List The list name or ID of the source SharePoint list. The lists available will dynamically be populated based on the specified site. If the system cannot access the site, the list name will need to be specified manually as an expression.   Yes
Source view The SharePoint view to source the items from. Yes
List column name The name of the column to show in the lookup control. Yes
Allow multiple values Allows the user to select multiple values in the control. Yes
Appearance Visible Hide or show the control at runtime. Yes
Enabled Enable the control to receive user input at runtime. Yes
Display format The type of control to render. Available options in single select mode are: "Drop down list" and "Option Buttons", while in multi select mode, you can continue to use the SharePoint List Lookup Control (Default) or checkboxes or a list box similar to that available to the Choice control. Yes
Use custom "Please select" text Indicates whether the control will use custom text for the first item in the drop down list.  Yes
Filtering Filter available selections Filter the selections in the Lookup by another control on the page or by a specific value. 
If By a controls value is selected:
  • Where field: The field in the source list to apply the filter to.
  • Filtered by control: The control on the current form to filter the available items by. Note: If the control to filter is a multi-select lookup control that renders as the standard SharePoint one this will not work. Please change the other controls mode to check boxes or lists.  
 
If By a specified value is selected:
  • Where field: the field in the source list to apply the filter to. 
  • Filtered by value: The value to filter the available items by.
Yes
Action when no filter applied Values to be shown when there is no value applied to the filter; where nothing is selected in the “filtered by control” or there is no valid specified filter value. Yes
Formatting Control CSS class The CSS class to apply to the inner input control. ​No
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). ​No
Border Draws a line along the select border of the control. ​No
Border Style The style of the border. ​No
Border Width (Pixels) ​The width of the border in pixels. ​No
Border Color The color of the border. This can either be a HEX code or a named color that is supported by html. ​No
Padding Width (Pixels) The amount of padding in pixels that will appear between the top, left and right border and the inner control.  ​No
Validation Required The form will not submit unless this control is completed correctly. Yes
Use custom validation Enables custom JavaScript validation for the control. 

If Yes is selected:

  • Custom validation function: Specify the JavaScript function name for the client side custom validation. Note: The JavaScript function is to be specified in the Custom JavaScript section within the form's Settings. 
  • Custom error message: The error message to display when an invalid value is entered.
​No
Advanced Help text Help text that will be displayed to the user as a tooltip to guide the completion of the form. ​No
Control Mode Force control to be in Edit mode, Display mode, or set to Auto. ​No
Prepend ID to value Select Yes to include the item ID number in front of the value. ​No
Store Client ID in JavaScript variable A JavaScript Variable will be created that references the Client ID of this control. 

If Yes is selected:

  • Client ID JavaScript variable name:  The name of the variable to store the Client ID in. 
​No
Resize at runtime Allow the control to dynamically adjust its size, and adjust the form length and position of other controls accordingly. ​No​

Related Topics

Getting started with the form designer
Control Settings
Controls In Use
Connecting Controls to fields or variables
List Attachment
List Item
List View
Shortcut keys
Inserting reference fields
Control Properties Ribbon

 

2.11 Multi Line Textbox

The Multi Line Textbox Control

The Multi Line Textbox control allows users to enter plain text on the form. As with other controls the Multi Line Textbox inherits properties and settings from the field it is connected to. One property not visible in the Control Settings dialog is SharePoint's ability to show the previous history of the field. When enabled in the column settings, this will render at runtime as per the existing SharePoint functionality. We however will take up some of the space allocated to the control to display this history. The control will not grow as more history is collected.

Control Settings

 
Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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 an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
Section Selection Description Nintex Mobile
General Name The name of the control. The name is used for comparison validation and other control references.
Yes
Connected to The field to bind the input control to. Yes
Default value Set a default value for the control. This value will only be used if a default value has not been specified in the column or variable selected in the Connected to setting.     Yes
Rich text Allow rich text format to be entered. 

If Yes is selected:

  • Specify the type of text to allow: Select rich text, or Enhanced rich text. 
Yes
Appearance Visible Hide or show the control at runtime. Yes
Enabled Enable the control to receive user input when the form is in input mode. Yes
Formatting Control CSS class The CSS class to apply to the inner elements of the control. ​No
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).   No
Border Draws a line along the select border of the control. No
Border Style The style of the border. No
Border Width (Pixels) The width of the border in pixels. No
Border Color The color of the border. This can either be a HEX code or a named color that is supported by html. No
Padding Width (Pixels) The amount of padding in pixels that will appear between the top, left and right border and the inner control. No
Validation Required The form will not submit unless this control is completed correctly.

If Yes is selected:

  • Required error message: The error message to display when the required field is not specified.  
​Yes
Use custom validation Enables the value entered into the control to be validated by a JavaScript function. 

If Yes is selected:

  • Custom validation function: Specify the JavaScript function name for the client side custom validation. Note: The JavaScript function is to be specified in the Custom JavaScript section within the form's Settings.  
  • Custom error message: The error message to display when an invalid value is entered.  
No
Advanced Help text Help text that will be displayed to the user as a tooltip to guide the completion of the form. No
Control Mode Force control to be in Edit mode, Display mode, or set to Auto. No
Convert empty string to null Convert to a null value if the control contains an empty string. No
Null display text If the bound value is null, this text will be displayed instead.  No
Store Client ID in JavaScript variable A JavaScript variable will be created that references the Client ID of this control. 

If Yes is selected:

  • Client ID JavaScript variable name: The name of the variable to store the Client ID in.
No
Resize at runtime Allow the control to dynamically adjust its size, and adjust the form length and position of other controls accordingly.  No​

Related Topics

Getting started with the form designer
Control Settings
Controls In Use
Connecting Controls to fields or variables
Single Line Textbox
Rich Text
Shortcut keys
Inserting reference fields
Control Properties Ribbon

2.12 Page Viewer

The Page Viewer Control

The Page Viewer control can be used to display a page on a form. The page viewer control works as an iframe and allows a view of a page or document to be included within the control. 

Note: Some mobile devices and security settings may not support the display of a page from another website within a Nintex Form.

Control Settings

Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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 an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
Section Selection Description Nintex Mobile
General Name The name of the control. The name is used for comparison validation and other control references. ​
Yes
Source The URL of the page/document to show in the page viewer. Yes
Appearance Visible Hide or show the control at runtime Yes
Formatting 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).​
​No
​​​Border Draws a line along the selected border of the control. No
Border Style The style of the border. No
Border Width (Pixels) The width of the border in pixels. No
Border Color The color of the border. This can either be a HEX code or a named color that is supported by html. No
Padding Width (Pixels) The amount of padding in pixels that will appear between the top, left and right border and the inner control.  No
Advanced Resize at runtime Allow the control to dynamically adjust its size, and adjust the form length and position of other controls accordingly. No​

Related Topics

Getting started with the form designer
Control Settings
Controls In Use
Shortcut keys
Inserting reference fields
Control Properties Ribbon

2.13 Panel

The Panel Control

The Panel control can be used to group controls together and optionally display a label and a border around the group. 

To group controls together:

  1. Drag and drop a Panel control onto the Forms Designer.
  2. Drag and drop any controls which are to be grouped and place inside the Panel control.
  3. Configure the controls as desired.

Note: In design mode, controls grouped within a Panel control can be moved around the form canvas collectively.

Control Settings 

Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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 an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
Section Selection Description Nintex Mobile
General Name The name of the control. The name is used for comparison validation and other control references. ​
Yes
Title The title of the panel. If a title is supplied, the panel will render as a HTML fieldset.    Yes
Background image The image to set for the background. Yes
Appearance Visible Hide or show the control in runtime.  Yes
Formatting 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).
​No
Border Draws a line along the selected border of the control. No
Border Style The style of the border. No
Border Width (Pixels) The width of the border in pixels. Set to zero to hide the border.​ No
Border Color The color of the border.  No
Padding Width (Pixels) The amount of padding in pixels that will appear between the top, left and right border and the inner control.  No
Advanced Resize at runtime Allow the control to dynamically adjust its size, and adjust the form length and position of other controls accordingly.   No​

Related Topics

Getting started with the form designer
Control Settings
Controls In Use
Shortcut keys
Inserting reference fields
Control Properties Ribbon

2.14 People

The People Control

The People control allows users to browse and select users from the SharePoint profile database.

Control Settings

Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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 an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
Section Selection Description Nintex Mobile
General Name The name of the control. The name is used for comparison validation and other control references.
Yes
Connected to The field to bind the input control to. Yes
Default value source Only available when connected to a column, this option allows you to override the connected field's default with your own default expression. Yes
Default value Set a default value for the control. This value will only be used if a default value has not been specified in the column or variable selected in the Connected to setting or Default Value Source has been set to "Expression". Yes
Multiple selections Only available when connected to columns of certain data types. Allow multiple people to be selected.  Yes
​​Appearance Visible Hide or show the control in runtime. Yes
Enabled Enable the control to receive user input when the form is in input mode.  Yes
Formatting Control CSS class The CSS class to apply to the inner elements of the control. ​No
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).​ ​No
Border Draws a line along the select border of the control. ​No
Border Style The style of the border. ​No
Border Width (Pixels) The width of the border in pixels. ​No
Border Color The color of the border. This can either be a HEX code or a named color that is supported by html. ​No
Padding Width (Pixels) The amount of padding in pixels that will appear between the top, left and right border and the inner control. ​No
Validation Required The form will not submit unless this control is completed correctly. 

If Yes is selected:

  • Required error message: The error message to display when the required field is not specified.
​Yes
Compare To Enables the value entered into the control to be validated against a specified value or the current value in another control. 

If Control is selected:

  • Compare operator: Select the type of comparison to perform.
  • Control to compare: Select the control to compare to.
  • Compare validation error message: The error message to display when an invalid value is entered. 

 

If Value is selected:

  • Compare operator: Select the type of comparison to perform.
  • Value to compare: Enter the value to compare to.
  • Compare validation error message: The error message to display when an invalid value is entered. 
​No
Use custom validation Enables the value entered into the control to be validated by a JavaScript function.

If Yes is selected:

  • Custom validation function: Specify the JavaScript function name for the client side custom validation. Note: The JavaScript function is to be specified in the Custom JavaScript section within the form's Settings.    
  • Custom error message: The error message to display when an invalid value is entered.
​No
Advanced Entities to include Only available when not connected to a column. The available user entity types that can be specified. ​Yes
Maximum entities The maximum number of users/ groups that can be selected if multiple selection is allowed.  ​Yes
SharePoint group Filter the available entities by a specific SharePoint group. ​Yes
Help text Help text that will be displayed to the user as a tooltip to guide the completion of the form. ​No
Control Mode Force control to be in Edit mode, Display mode, or set to Auto. ​No
Store Client ID in JavaScript variable A JavaScript variable will be created that references the Client ID of this control. 

If Yes is selected:

  • Client ID JavaScript variable name: The name of the variable to store the Client ID in. 
​No
Resize at runtime Allow the control to dynamically adjust its size, and adjust the form length and position of other controls accordingly. ​ ​No​

Related Topics

Getting started with the form designer
Control Settings
Controls In Use
Connecting Controls to fields or variables
Shortcut keys
Inserting reference fields
Control Properties Ribbon

2.15 Single Line Textbox

​​​

The Single Line Textbox Control

The Single Line Textbox control allows users to enter plain text on a form.

Control Settings

Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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 an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
Section Selection Description Nintex Mobile
General Name The name of the control. The name is used for comparison validation and other control references.
Yes
Connected to The field to bind the input control to. Yes
​Default value source Only available when connected, allows you to override the connected fields default with your own default expression. Yes
Default value Set a default value for the control. The value will only be used if a default value has not been specified in the column or variable selected in the Connected to setting or Default Value Source has been set to "Expression". Yes
Data Type Only available when not connected. The data type to convert to during validation.  Yes
Appearance Visible Hide or show the control at runtime. Yes
Enabled Enable the control to receive user input when the form is in input mode.  Yes
Formatting Control CSS class The CSS class to apply to the inner elements of the control.No No
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 and Layout settings.  No
Border Draws a line along the select border of the control. No
Border Style The style of the border. No
Border Width (Pixels) The width of the border in pixels. No
Border Color The color of the border. This can either be a HEX code or a named color that is supported by html. No
Padding Width (Pixels) The amount of padding in pixels that will appear between the top, left and right border and the inner control. No​
Validation Required The form will not submit unless this control is completed correctly.

If Yes is selected:

  • Required error message: The error message to display when the required field is not specified.  
Yes
Compare To Enables the value entered into the control to be validated against a specified value, or the current value in another control. 
If Control is selected:
  • Compare operator: Select the type of comparison to perform.
  • Control to compare: Select the control to compare to.
  • Compare validation error message: The error message to display when an invalid value is entered. 
 
If Value is selected:
  • Compare operator: Select the type of comparison to perform.
  • Value to compare: A fixed constant value to compare against the current value of the control.
  • Compare validation error message: The error message to display when an invalid value is entered. 
Yes
Use range validation Enables the value entered into the control to be validated against a specified maximum and minimum value. 
If Yes is selected:
  • Maximum value: The maximum valid value.
  • Minimum value: The minimum valid value.
  • Range validation error message: The error message to display when an invalid value is entered. 
Yes
Use a regular expression Enables the value entered into the control to be validated against a regular expression. 
If Yes is selected:
  • Regular expression: The regular expression string for validating the input against.
  • Regular expression validation message: The error message to display when an invalid value is entered.
Yes
​​​Use custom validation Enables the value entered into the control to be validated by a JavaScript function. 

If Yes is selected:

  • Custom validation function: Specify the JavaScript function name for the client side custom validation. Note: The JavaScript function is to be specified in the Custom JavaScript section within the form's Settings. 

 

E.g. The property should be ClientValidate when the following function is added to the custom JavaScript in the form.

 

function ClientValidate(source, arguments)
{
      if (arguments.Value % 2 == 0){
        arguments.IsValid = true;
      } else {

 

        arguments.IsValid = false;

 

      }
 }

 

Custom error message: The error message to display when an invalid value is entered.  

Yes
Advanced​ Max length Only available when not connected.​ ​The maximum length of the text that can be entered. ​Yes
Password Hide the password text with asterisks. Yes​
Help text Help text that will be displayed to the user as a tooltip to guide the completion of the form. ​No
Control Mode Force control to be in Edit mode, Display mode, or set to Auto. ​No
Convert empty string to null Convert to a null value if the control contains an empty string. ​No
Null display text If the bound value is null, this text will be displayed instead. ​No
String format The string format to apply to the value. The string format will be determined by the type of data specified by the control. When it is a number the following can be used http://msdn.microsoft.com/en-us/library/0c899ak8.aspx, and http://msdn.microsoft.com/en-us/library/dwhawy9k.aspx. For other types see http://msdn.microsoft.com/en-us/library/26etazsy.aspx ​No
Store Client ID in JavaScript variable A JavaScript variable will be created that references the Client ID of this control. 

If Yes is selected:

  • Client ID JavaScript variable name: The name of the variable to store the Client ID in.  
​No
Resize at runtime Allow the control to dynamically adjust its size, and adjust the form length and position of other controls accordingly.  ​No​
Enable barcode scanning Displays a button next to the control for scanning barcodes. Available in supported Nintex Mobile apps only. Select one of the following options. ​
  • Yes
  • No
  • ​Yes

    Related Topics

    Getting started with the form designer
    Control Settings
    Connecting Controls to fields or variables
    Controls In Use
    Shortcut keys
    Rich Text
    Multi Line Textbox
    Inserting reference fields
    Control Properties Ribbon

    2.16 Yes-No

    The Yes/No Control

    The Yes /No control allows users to check or uncheck a box to show that an item has been selected.

    Control Settings

    Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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 an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
    Section Selection Description Nintex Mobile
    General Name The name of the control. The name is used for comparison validation and other control references.
    ​Yes
    Connected to The field to bind the input control to. Yes
    Text The text to display next to the checkbox. Yes
    Default value source Only available when connected to a column, this option allows you to override the connected field's default with your own default expression.
    Default value Set a default value for the control. If a control is connected to a SharePoint list column, use an expression value to override the Yes/No default specified in the SharePoint column.  Yes
    Appearance Visible Hide or show the control at runtime. Yes
    Enabled Enable the control to receive the user input when the form is in input mode.  Yes
    Formatting Control CSS class The CSS class to apply to the inner elements of the control. ​No
    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).  No
    Border Draws a line along the selected border of the control. No
    Border Style The style of the border. No
    Border Width (Pixels) The width of the border in pixels. No
    Border Color The color of the border. This can either be a HEX code or a named color that is supported by html. No
    Padding Width (Pixels) The amount of padding in pixels that will appear between the top, left and right border and the inner control. No
    Validation Required to be checked The form will not submit unless this control is completed correctly. 

    If Yes is selected:

    • Required error message: The error message to display when the required field is not specified.
    Yes​
    Use custom validation Enables the value entered into the control to be validated by a JavaScript function.

    If Yes is selected:

    • Custom validation function: Specify the JavaScript function name for the client side custom validation. Note: The JavaScript function is to be specified in the Custom JavaScript section within the form's Settings.  
    • Custom error message: The error message to display when an invalid value is entered.
    No
    Advanced Help text Help text that will be displayed to user as a tooltip to guide completion of the form. No
    Control Mode Force control to be in Edit mode, Display mode, or set to Auto.   No
    Store Client ID in JavaScript variable A JavaScript variable will be created that references the Client ID of this control. 

    If Yes is selected:

    • Client ID JavaScript variable name: The name of the variable to store the Client ID in.  
    No
    Resize at runtime Allow the control to dynamically adjust its size, and adjust the form length and position of other controls accordingly.  No​

    Related Topics

    Getting started with the form designer
    Control Settings
    Controls In Use
    Connecting Controls to fields or variables
    Choice Control 
    Inserting reference fields
    Control Properties Ribbon

    2.17 Workflow Diagram

    The Workflow Diagram Control

    The Workflow Diagram control can be used to display a Nintex Workflow on a form.

    Note: The Nintex workflow diagram control will only appear if Nintex Workflow has been installed and configured.

    Note: The Workflow Diagram control is not supported in Nintex Mobile.​

    Control Settings

    Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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 an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
    Section Selection Description
    General Load from context Display the workflow diagram based on the context of the form. When No is selected, displays additional fields. 

    Note: Using this control on a start form will load a preview for the current workflow, a task form will show the status of the current task's workflow and a list form will show the state of the current running workflow (if there are multiple workflows running, SharePoint will look for the first workflow for that list item) or the first completed workflow.

    For more information on manually configuring the workflow diagram to display, refer to manual configuration scenarios.

    Workflow Instance ID The ID of a workflow instance.
    Workflow name The name of the workflow to display.
    SharePoint List The ID or name of the list if required. 
    List Item ID The ID of the list item if required.
    Appearance Visible Hide or show the control at runtime. 
    Formatting 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 selected 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.
    Advanced Displays the control at runtime if the workflow cannot be found. Show control at runtime if workflow not found.
    Resize at runtime Allow the control to dynamically adjust its size, and adjust the form size and position of other controls accordingly. ​

    Manual configuration scenarios

    To display a diagram for a workflow on a list item (will look for the first workflow for the list item), specify the following:

    To display a diagram for a specific running/completed workflow on a list item, specify the following:

    To display a diagram for a site workflow, specify the following:

    To display a diagram for a specific running / completed site workflow, specify the following:

    Related Topics

    Getting started with the form designer
    Control Settings
    Controls In Use
    Inserting reference fields
    Control Properties Ribbon

    2.18 List View

    ​​​

    The List View Control

    The List View control can be used to display a SharePoint List and optionally specify the List view to display.

    Note: The List View control is not supported in Nintex Mobile.​​​​

    Control Settings

    Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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 an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
    Selection Field Description
    General Source SharePoint site The URL or GUID of the SharePoint site the list is in.
    List The ID or name of the list.
    ​​View Name The name of the view in the list that is displayed. If not specified, the default view will be displayed.
    Appearance Visible Hide or show the control at runtime.
    Filtering Filter listed items Filter the listed items by another control on the page, a specific value or custom query.
    Formatting Control CSS class The CSS class to apply to the inner elements of the control.
    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 
    Border
    ​Draws a lin​​​​e along the selected 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.
    Advanced Lookup column filtering

    The type of filtering for the lookup column. Select one of the following options.

    • Default: Filters for ID first. If no ID is found, filters for value ​.
    • By ID: Only filters by ID.
    • By value: Only filters by value.

      Only supported by text value only.


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

    Related Topics

    Getting started with the form designer
    Control Settings
    Controls In Use
    List Attachment
    List Item
    List Lookup
    Shortcut keys
    Inserting reference fields
    Control Properties Ribbon

    2.19 List Attachment

    ​​​

    The Attachments Control

    The Attachments control allows users to attach files to the SharePoint list item that the form is currently adding or editing. For list forms it is the list item of the form. For task forms it will be the attachments for the task list item, not the list item the workflow is running on.

    Note: If the browser being used does not support browsing the file system and selecting attachments, the 'browse' button will be disabled.

     

    Control Settings  

    Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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 an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
    Section Selection Description Nintex Mobile
    General Name The name of the control. The name is used for comparison validation and other control references. ​Yes
    ​Default control When more than one attachment control is on the form, you must assign one of them as the default. If a default is not chosen, you will not be able to publish the form. The attachment control selected as the default will display any "orphaned" attachments on an item. An "orphaned" attachment is an attachment that was attached with no specific Nintex Forms attachment control associated with it. This can happen with items that are added either:   
    • using forms that were published with previous versions of Nintex Forms or
    • other forms such as SharePoint forms.
    Yes
    ​Appearance ​Visible Hide or show the control at runtime. Yes
    ​Formatting ​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). ​No
    Border Draws a line along the select border of the control. No
    ​Border Style The style of the border. No
    ​Border Width (Pixels) The width of the border in pixels. No
    ​Border Color The color of the border. This can either be a HEX code or a named color that is supported by html. No
    Padding Width (Pixels) The amount of padding in pixels that will appear between the top, left and right border and the inner control. No​
    Validation ​Minimum attachments The number of attachments required for form submission.

    Note: When a value is specified for this field, a red asterisk appears in the published form, to the right of the label associated with this control. 

    Yes
    ​Minimum attachments error message The text of the error message displayed if form is submitted without the required number of attachments.

    Example: "Résumé file must be attached."

    Nintex Mobile displays the following error message by default for this validation item. 

    “You have not met the minimum number of required files.”

    Yes
    Maximum attachment setting
      The setting to use for maximum attachments allowed:
    • Unlimited: The number of attachments is not validated.
    • Custom: The number of attachments is validated according to the value specified for Maximum attachments. When the maximum value is reached, the Add Attachment link is disabled. 
    Yes
    ​Maximum attachments The highest number of attachments allowed for form submission.

    Note: This field is displayed only when you select Custom for Maximum attachments setting.

    Nintex Mobile displays the following error message by default for this validation item.  

    “You have exceeded the maximum allowed number of files.”

    Yes
    ​Allowed file formats (enter each format on its own line) The file extensions validated at the time of attachment. Enter each file extension (format) on its own line.

    Example:

    doc
    docx
    pdf

    Note: Separate from the form-specific file formats specified here, the SharePoint server may block file formats (file types). 

    Nintex Mobile displays the following error message for any attached file type that is blocked by the SharePoint server. 

    “The selected file type is blocked by the server. Select a different file type.”

    Yes
    ​Disallowed file format error message The text of the error message displayed if an attempted file attachment fails validation according to Allowed file formats.

    Nintex Mobile displays the following error message by default for this validation item. ​

    “The selected file type is not allowed for this form. Select a different file type.”​

    Yes

    Related Topics

    Getting started with the form designer
    Control Settings
    Controls In Use
    List Item
    List View
    List Lookup
    Shortcut keys
    Inserting reference fields
    Control Properties Ribbon

    2.20 Repeating section

    ​​

    The Repeating Section Control

    The Repeating Section is a control that can contain a set of other controls, and allows a user of the form to insert multiple instances (rows) of the set as required. A typical use is an expenses form where each row is an expense item.

    The following controls are supported within repeating sections:
    Note: When added to a Repeating Section control, child controls are connected to the Repeating Section control and thus cannot be connected to SharePoint columns or fields.​

     

    Control Settings

    Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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 an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
    Section Selection Description Nintex Mobile
    General Name The name of the control. The name is used for comparison validation and other control references.
    Yes
    Connected to The field to bind the input control to. Yes
    Text for add row icon The text for add row item. Yes
    Default rows The default number of rows to be displayed. Yes
    Minimum rows The minimum number of rows to be displayed. Yes
    Maximum rows The maximum number of rows to be displayed.  Yes
    Appearance Visible Hide or show the control at runtime. Yes
    Prevent add/delete in new/edit mode Hides the add/delete links in new and edit mode. Select Yes to remove the ability to add or delete a new row to the repeating section in new and edit mode. Expressions may be used to allow a row to be added or deleted only in new mode, and not edit mode, or vice versa. ​No
    Formatting Item CSS class The CSS item to apply to the item. No
    Alternate item CSS class The CSS class to apply to every alternate item (row). No
    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).  No
    Border Draws a line along the selected border of the control No
    Border Style The style of the border. No
    Border Width (Pixels) The width of the border in pixels.  No
    ​​​Border Color The color of the border.  No​

    Related Topics

    Getting started with the form designer
    Control Settings
    Controls In Use
    Connecting Controls to fields or variables
    Shortcut keys
    Inserting reference fields
    Control Properties Ribbon

    2.21 Recurrence

    The Recurrence Control

    The Recurrence control allows a user to make the calendar item a repeating event. A user can edit the reoccurrence pattern when filling in the form.

    Note: The Recurrence control is only available when a form is designed from a Calendar list.

    Note: The Recurrence control is not supported in Nintex Mobile. ​​

    Control Settings

    Note: For an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
    Section Selection Description
    General Visible Hide or show the control at runtime.
    ​​Formatting 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.​
    Advanced Resize at runtime Allow the control to dynamically adjust its size and adjust the form size and position of other controls accordingly. ​

    Related Topics

    Getting started with the form designer
    Control Settings
    Controls In Use
    Shortcut keys
    Inserting reference fields
    Control Properties Ribbon

     

     

     

     

    ​ 

    2.22 Calculated Value

    The Calculated Value Control

    The Calculated Value control performs a calculation or concatenation (depending on the data type of the values used within the Formula Builder) and displays the result at run time.

    Control Settings

    Note: For an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
    Section Selection Description Nintex Mobile
    General Formula The runtime formula to be calculated. Use the Formula Builder to create the formula.
    Yes
    Name The name of the control. The name is used for comparison validation and other control references.  Yes
    Connected to The field to bind the input control to. Yes
    Save as data type The data type to convert to when the form is saved.

    If Decimal is selected:

    • Decimal places: The number of decimal places.
    • Show as percentage: Format the value as a percentage.

    If Decimal or Integer is selected:

    • Use thousand separator: Whether to use a thousand separator
    Yes
    Value prefix The prefix for the value. Yes
    Value suffix The suffix for the value.   Yes
    Recalculate formula on view mode Recalculate the value when the form is displayed in view mode at run time.  ​No
    Recalculate formula on new mode Recalculate the value when the form is displayed in new mode at run time. By default, this is set to yes.  No
    Recalculate formula on edit mode Recalculate the value when the form is displayed in edit mode at run time. By default, this is set to yes.  No
    Appearance Visible Hide or show the control at run time. Yes
    Enabled Enable the control to receive user input at run time.  Yes
    Formatting Control CSS class The CSS class to apply to the inner elements of the control. No
    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).  No
    Border Draws a line along the selected border of the control. No
    Border Style The style of the border. No
    Border Width (Pixels) The width of the border in pixels. No
    Border Color The color of the border. This can either be a HEX code or a named color that is supported by html. No
    Padding Width (Pixels) The amount of padding in pixels that will appear between the top, left and right border and the inner control. No
    Advanced Help text Text that will be displayed to the user as a tooltip to guide the completion of the form. No
    Control Mode Force control to be in Edit mode, Display mode, or set to Auto. No
    Convert empty string to null Convert to a null value if the control contains an empty string. No
    Null display text If the bound value is null, this value will be displayed instead. No
    Store Client ID in JavaScript variable A JavaScript Variable will be created that references the Client ID of this control.

    If Yes is selected:

    • Client ID JavaScript variable name: The name of the variable to store the Client ID in.
    No
    Resize at runtime Allow the control to dynamically adjust its size, and adjust the form size and position of other controls accordingly. ​ No​

    Related Topics

    Getting started with the form designer
    Control Settings
    Controls In Use
    Shortcut keys
    Inserting reference fields
    Formula Builder
    Control Properties Ribbon

    2.23 Managed Metadata

    The Managed Metadata Control

    Managed metadata is a hierarchical collection of managed terms that must be defined within SharePoint prior to use in Nintex Forms. For more information on managed metadata refer to http://technet.microsoft.com/en-us/library/ee424402.aspx.

    The Managed Metadata control retrieves these managed terms from your SharePoint environment. Once a data selection has been configured, users can select values from a list of set terms, allowing for more accurate selections.   

    Note: The Managed Metadata control is not supported in Nintex Mobile.​​​​​​

    Control Settings

    Note: For an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
    Section Selection Description
    General Name The name of the control. The name is used for comparison validation and other control references.
    Connected to The field to bind the input control to.
    Term set The term set to be used. Click on a term to select the first level of the hierarchy to show in the control. All levels below the term selected will be seen when users choose a value.
    Allow multiple values Specify whether the column will allow more than one value. Note: allowing multiple values will prevent sorting in list views.
    Allow fill in Select whether users will be permitted to add values to the term set. (Only open term sets will allow 'Fill-in') 
    Appearance Visible Hide or show the control at runtime.
    Enabled Enable the control to receive user input at runtime. 
    Formatting Control CSS class The CSS class to apply to the inner elements of the control.
    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 selected 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.
    Validation Required The form will not submit unless this control is completed correctly.
    Use custom validation Enables the custom JavaScript validation for the control. 
    Appearance Help text Text that will be displayed to the user as a tooltip to guide the completion of the form.
    Control Mode Force control to be in Edit mode, Display mode, or set to Auto.
    Store Client ID in JavaScript variable A JavaScript variable will be created that references the Client ID of this control.

    If Yes is selected:

    • Client ID JavaScript variable name: The name of the variable to store the Client ID in.
    Resize at runtime Allow the control to dynamically adjust its size, and adjust the form size and position of other controls accordingly. ​

    Related Topics

    Getting started with the form designer
    Control Settings
    Controls In Use
    Shortcut keys
    Inserting reference fields
    Control Properties Ribbon

     

    2.24 External Data Column

    ​​

    The External Data Column Control

    The External Data Column control enables users to add data from external content types to standard SharePoint lists. Just like an external list, the external data column can display data from any external content type. For more information on external data columns, refer to http://msdn.microsoft.com/en-us/library/ee558737.aspx.

    Note: To use the external data column, the external content type must first be configured. For more information on setting up external content types, refer to http://msdn.microsoft.com/en-us/library/ff728816.aspx

    Note: The External Data Column control is not supported in Nintex Mobile.​​​

    Control Settings

    Note: For an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
    Section Selection Description
    General Name The name of the control. The name is used for comparison validation and other control references.
    Connected to The field to bind the control to.
    External content type Use the external content type picker to choose a content type.
    Display format The format to display the control as (Default picker, Drop down list, Option buttons). Note: This will make a call to the external content type to read in all items in the external list. If you use a drop down list or option buttons, this could present a performance issue if there is a larger number of items.  
    Field to be displayed The field name from the external content type to be displayed. 
    Additional fields When the External Data Column control is bound to an external data column in the list or library, this field lists additional field-specific columns configured for the external data column.
    For example, if you bind the control to the external data column “Customer,” which is configured using the CustomerCRM external type to show the fields CustomerName and PhoneNumber, then these fields are listed here.
    For more information about external data column configuration, see the following Microsoft article: “Create and update an external data column in a list or library.”​​
    Appearance Visible Hide or show the control at runtime.
    Enabled Enable the control to receive user input during runtime. 
    Dialog title The text to display in the dialog box.
    Formatting Control CSS class The CSS class to apply to the inner elements of the control.
    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 selected 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.
    Validation Required The form will not submit unless this control is completed correctly.
    Use custom validation Enables the custom JavaScript validation for the control. 
    Advanced Help text Text that will be displayed to the user as a tooltip to guide the completion of the form.
    Control Mode Force control to be in Edit mode, Display mode, or set to Auto.
    Store Client ID in JavaScript variable A JavaScript variable will be created that references the Client ID of this control.
    If Yes is selected: 
    • Client ID JavaScript variable name: The name of the variable to store the Client ID in.
    Resize at runtime Allow the control to dynamically adjust its size, and adjust the form size and position of other controls accordingly. 

    Related Topics

    Getting started with the form designer
    Control Settings
    Controls In Use
    Shortcut keys
    Inserting reference fields
    Control Properties Ribbon

     

    2.25 Control Properties Ribbon

    Control Properties Ribbon

    The Control Properties Ribbon varies between each control. Please refer to the list below for more information about each property.   

    Manage

    Clipboard

    Font and Style

    General

    Appearance

    Advanced

    Related topics

    Manage form controls
    Form and Layout settings
    Control Settings

    2.26 Geolocation

    The Geolocation Control

    The Geolocation control enables users to specify location by either pressing a button to locate their current longitude and latitude or by manually entering coordinates.
    Note: To use the "Use my location" functionality the client's browser needs to support the appropriate functionality and the use of the form needs to permit the form to use it. If the user's browser or the SharePoint site's master page has disabled HTML5 capabilities then the user will need to specify the location manually.  

    Control Settings

     
    Note: For an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
    Section Selection Description Nintex Mobile
    General Name The name of the control. The name is used for comparison validation and other control references.
    Yes
    Connected to The field to bind the control to. This can either be a SharePoint 2013 Geolocation column or a single line of text. ​Yes
    Location Button Text The text to display on the “Use my location” button. If left blank “Use my location” is displayed. ​No
    Manual Input Enable, Disable or hide the manual input fields for specifying the Geolocation manually. By disabling or hiding this, the control can no longer be marked as required as not all users will be able to specify a location. ​No
    Appearance Visible Hide or show the control at runtime. ​Yes
    Enabled Enable the control to receive user input during runtime.  ​Yes
    Formatting Control CSS class The CSS class to apply to the inner elements of the control. No
    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.   No
    Border Draws a line along the select border of the control. No
    Border Style The style of the border. No
    Border Width (Pixels) The width of the border in pixels. No
    Border Color The color of the border. This can either be a HEX code or a named color that is supported by html. No
    Padding Width (Pixels) The amount of padding in pixels that will appear between the top, left and right border and the inner control. No
    Validation Required The form will not submit unless this control is completed correctly. 
    If Yes is selected:
    Required error message: The error message to display when the required field is not specified.
    ​Yes
    Use custom validation for latitude Enables the custom JavaScript validation for the latitude portion of the control. 
    If Yes is selected:
    Custom validation function: Specify the JavaScript function name for the client side custom validation. Note: The JavaScript function is to be specified in the Custom JavaScript section within the form's Settings. 
    Custom error message: The error message to display when an invalid value is entered.
    No
    Use custom validation for longitude Enables the custom JavaScript validation for the longitude portion of the control. 

    If Yes is selected:

    Custom validation function: Specify the JavaScript function name for the client side custom validation. Note: The JavaScript function is to be specified in the Custom JavaScript section within the form's Settings. 
    Custom error message: The error message to display when an invalid value is entered.
    No
    Advanced Help text Text that will be displayed to the user as a tooltip to guide the completion of the form. No
    Control Mode Force control to be in Edit mode, Display mode, or set to Auto. No
    Resize at runtime Allow the control to dynamically adjust its size, and adjust the form size and position of other controls accordingly.  No​
    Related Topics

    Getting started with the form designer

    Control Settings

    Controls In Use

    Shortcut keys

    Inserting reference fields

    Control Properties Ribbon.

    2.27 Change Content Type

    ​​

    The Change Content Type Control

    The Change Content Type control enables users to change the content type for a list item in a SharePoint list where there are multiple content types on that list. It populates itself based on the context of the list. At runtime it relies on the form being run in edit full desktop mode and hence will not work when running in mobile mode.
    Note: The Change Content Type control is not supported in Nintex Mobile.​
    This control is not included in automatically generated forms. The designer must manually add this control to forms where it is required.
    When changed, the control will refresh the page and load the form available for that content type (whether it is a customised Nintex Form or the default SharePoint form).
     
    Note: In order for the control to show or hide its label the control association must be established via the name of this control and a specific label.
    Note: When the list item is a folder it will only show folder content types, and similarly for documents/items.

    Control Settings

    Note: For an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.
    Section Selection Description
    General Name The name of the control. The name is used for control references to other controls. 
    Appearance Visible Hide or show the control at runtime. 
    Formatting 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.​
    Advanced Resize at runtime Allow the control to dynamically adjust its size, and adjust the form size and position of other controls accordingly. 

    Related Topics
    Getting started with the form designer
    Control Settings
    Controls In Use
    Connecting Controls to fields or variables
    Shortcut keys
    Inserting reference fields
    Control Properties Ribbon

    ​​

    2.28 Project Server Links

    The Project Server Links Control

    The Project Server Links control allows you to link to items in a Project Server Issues list, Risks list, items in the project document, or tasks within a project. This control can only be used on the mentioned Project Server 2010 lists where the links column is present.
     
    To add Project Server links to the Nintex Form in runtime, click on Add new item in the SharePoint list. At the top of the open form, select the Custom Commands tab. Click on Link Items, and then choose the appropriate Project Server item links for your form.  

    Control Settings

    Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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 an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.

    General

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

    Appearance

    Visible
    Hide or show the control at runtime.

    Formatting

    Control CSS class
    The CSS class to apply to the inner elements of the control.
    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 selected 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.

    Related Topics

    Getting started with the form designer
    Control Settings
    Controls In Use
    Inserting reference fields
    Control Properties Ribbon

    2.29 SQL Request

    ​​​​​​​​​* This topic applies to Nintex Forms Enterprise Edition only​

    SQL Request control

    The SQL Request control allows you to look up values from SQL databases. Use this control to populate drop-down lists and other display formats in your forms. Retrieve data from SQL databases by specifying server, database, authentication, stored procedure, and optionally stored procedure parameters for dynamic filtering. Using the values retrieved from the SQL database, the SQL Request control selects the value and display fields. The value field is stored in the specified column (see the control field “Value field”) while the display field is displayed on the form (see the control field “Display field”).​

    Note: The SQL Request control is not supported in Nintex Mobile.

    SQL credentials are retrieved from the SharePoint Secure Store service. You can test configuration using the Run Now dialog box.

    Example scenarios:

    • Display products for user selection and show quantity remaining for selected product.
    • Display product names for user selection, dynamically filtered for the user-specified category and year.

    Ribbon

    The ribbon for the SQL Request control displays the following buttons.

    Run Now: Displays the Run Now dialog box. For more information, see Run Now.

    Note: For an extensive list of the control properties ribbon, including descriptions, see Control Properties Ribbon.

    Control Settings

    Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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.
    Section Selection​ Description
    General Name The name of the control. This name is used for comparison validation and other control settings.
    ID connected to ​The column to which to bind the value field of the returned value. 
    Note: The selected column must be within the current list and must be of the type “Single line of text.”  
    Note: When Label or Text is selected for Display format, this field can only bind to the display field (Display field); Value field cannot be bound. 
    Text connected to ​The column to which to bind the display field of the returned value. 
    Note: The selected column must be within the current list and must be of the type “Single line of text.”  ​
    Display format The type of control to display. Select one of the following options.
    ​ 
    • Check boxes (Multiple-Selection)
    • Drop down list
    • Label
    • Option buttons
    • Text

    Default value: Drop down list

    Server ​Server hosting the SQL database. 
    Database ​The SQL database.
    Connection timeout (seconds) ​Period of time to attempt sending the request.
    Note: Do not specify 0 as this value indicates no limit and causes indefinite waits for connection attempts.
    Default value: 10.
    Authentication type

    ​Select one of the following options.

    • SQL authentication
    • Windows authentication
    Secure Store target application ID Enter the target application ID stored in SharePoint Secure Store Service containing credentials for the service. The Secure Store Service must be in the default application proxy group. To view the proxy group for the service, use the Service Application Associations page in Central Administration. For more information about Secure Store Service on SharePoint, see the Microsoft article Configure the Secure Store Service in SharePoint 2013.
    Query type ​Select one of the following options.
    • Stored procedure
    • SQL

    Default value: Stored procedure.

    Note: To prevent SQL injection, Nintex recommends using stored procedures instead of free-form SQL queries. ​As a further security measure, Nintex recommends leveraging a read-only connection to the database. For more information about preventing SQL injection, see the Open Web Application Security Project (OWASP) article SQL Injection Prevention Cheat Sheet.

    Stored procedure name Specify the name of the stored procedure.

    (This field is displayed when Stored Procedure is selected for Query type.) 

    Stored procedure parameters​ When parameter name/value pairs are specified, filters the results from the stored procedure. You can filter using values of other controls on the form.
    For example, let's say that the form includes named controls "Category" and "Year." You want the form to display product names (Display field) from the stored procedure results (Stored procedure name), but dynamically filtered for the entered category and year. In this scenario, you add a parameter referencing the named control "Category" and another parameter referencing the named control "Year." At runtime, the displayed product names correspond to values entered for these named controls. 
    Click Add to specify a parameter.
    (This field is displayed when Stored Procedure is selected for Query type.)

    Query

    Type a free-form SQL query.

    (This field is displayed when SQL is selected for Query Type.)

    Note: To prevent SQL injection, Nintex recommends using stored procedures instead of free-form SQL queries. For more information about preventing SQL injection, see the Open Web Application Security Project (OWASP) article SQL Injection Prevention Cheat Sheet.

    Note: You can insert references to named controls. Inserted references are formatted as red underlined font. 

    The following example query selects employee IDs and first names based on the value specified for the named control "Title." The employee ID is used as the value field and the name is used as the display field.

    select FirstName, EmployeeID from Employees where Title like 'Title'

    Value field

    Column for retaining value of selected item.

    ​Display field Result column to display on the form.
    ​Execute in new mode ​Default: Yes.
    ​Execute in edit mode ​Default: Yes.
    Execute in view mode ​Default: No.
    Appearance Visible Hide or show the control at runtime.
    Enabled Enable the control to receive user input at runtime.
    Use custom "Please select" text ​Specify whether or not to use custom "Please select" text.
    Formatting Control CSS class The CSS class to apply to the inner input control.
    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. 
    Validation Required The form will not submit unless this control is completed correctly.  
    Required error message Text to display if the control is not completed correctly.
    (This field is displayed when Yes is selected for Required.) 
    Use custom validation Enables custom JavaScript validation for the control. 
    Custom validation function Specify the JavaScript function name for the client side custom validation. Note: The JavaScript function is to be specified in the Custom JavaScript section within the form's Settings. 
    ​(This field is displayed when Yes is selected for Use custom validation.) 
    Custom error message The error message to display when an invalid value is entered. 
    ​(This field is displayed when Yes is selected for Use custom validation.) 
    Advanced Help text Help text that will be displayed to the user as a tooltip to guide the completion of the form.
    Control Mode Force control to be in Edit mode, Display mode, or set to Auto.
    ​Confirm value in connected column When enabled, displays a warning on form submission if bound column values were updated outside Nintex Forms. 
    Note: Columns are bound to the control via the fields ID connected to ​and Text connected to. An example scenario for display of this warning is updating the value of the "Department" column for the related list item using SharePoint and then attempting to submit the form for that list item where the form control is bound to the "Department" column. ​
    Store Client ID in JavaScript variable A JavaScript Variable will be created that references the Client ID of this control. 
    Client ID JavaScript variable name The name of the variable to store the Client ID in. 
    (This field is displayed when Yes is selected for Store Client ID in JavaScript variable.) 
    Resize at runtime Allow the control to dynamically adjust its size, and adjust the form length and position of other controls accordingly.   ​
    ​​​​​

    2.30 Web Request

    ​​​​​​​* This topic applies to Nintex Forms Enterprise Edition only​

    Web Request control

    The Web Request control allows you to look up data using external web services. Use this control to populate form fields using data managed in business applications and cloud services. Call REST APIs by specifying the service URL, request method (GET or POST), and authentication type, or create SOAP envelopes using the POST method. 

    Note: The Web Request control is not supported in Nintex Mobile.​

    Credentials must be stored in the SharePoint Secure Store service. You can test configuration using the Run Now dialog box.​

    Example scenarios: 
    • Display a live weather feed using the Yahoo weather API.​
    • Display products for user selection and filter by specified location using an external web service.
     

    SOAP envelopes

    You can create a SOAP envelope within the request body, using the POST method. The referenced SOAP connections must be correctly encoded. 
    Example configuration (Connection section):
    Selection Setting
    Request Method POST
    ​Request Header
    ​Request Body ​<soapenv:Envelope xmlns:soapenv='http://schemas.xmlsoap.org/soap/envelope/'>
    <soapenv:Body>
    <GetListCollection xmlns='http://schemas.microsoft.com/sharepoint/soap/'></GetListCollection>
    </soapenv:Body>
    </soapenv:Envelope>
    Content Type ​text/xml; charset="utf-8"
    For information about SOAP syntax, see http://www.w3schools.com/webservices/ws_soap_syntax.asp.

    Ribbon

    The ribbon for the Web Service control displays the following buttons.
     
    Run Now: Displays the Run Now dialog box. For more information, see Run Now.

    Note: For an extensive list of the control properties Ribbon, including descriptions, refer to the Control Properties Ribbon.

    Control Settings

    Note: Several settings allow Yes, No or Expression to be selected. Expression allows a formula to be constructed 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.
    Section Selection​ Description
    General Name The name of the control. This name is used for comparison validation and other control settings.
    ID connected to ​The column to which to bind the XPath for value field.
    Note: The selected column must be within the current list and must be of the type “Single line of text.” 
    Note: When Label or Text is selected for Display format, this field can only bind to XPath for displayXPath for value cannot be bound. 
    Text connected to ​The column to which to bind the XPath for display field.
    Note: The selected column must be within the current list and must be of the type “Single line of text.” ​

    Display format

    The type of control to display. Select one of the following options. 

    • Check boxes (multiple selection)
    • Drop down list
    • Label
    • Option buttons
    • Text

    Default value: Drop down list

    Service URL Path to REST or SOAP service. Example: http://sales.crestan.com:8084/ProductService.svc/web/products
    Note: You can insert references to named controls. For example, the form might have a named control for specifying the service URL to use for the call. Inserted references are formatted as red underlined font. 

    Request method

    Select an option.

    • GET
    • POST
    Timeout (seconds)

    Period of time to attempt sending the request.

    Note: The request is not executed if the value is 0.

    Default value: 10.
    Request body ​(This field is displayed when POST is selected for Request method.)
    Content type ​Specify the body type. Example: text/xml; charset="utf-8"
    ​(This field is displayed when POST is selected for Request method.)
    Authentication type

    Select an option.

    • Anonymous: No credentials required.
    • Basic authentication: Credentials required.
    • Windows authentication: Credentials required. 
    ​Secure Store target application ID Enter the target application ID stored in SharePoint Secure Store Service containing credentials for the service. The Secure Store Service must be in the default application proxy group. To view the proxy group for the service, use the Service Application Associations page in Central Administration. For more information about Secure Store Service on SharePoint, see the Microsoft article Configure the Secure Store Service in SharePoint 2013.
    (This field is displayed when the value selected for Authentication Type is something other than Anonymous.) 
    ​XPath for value

    Value element for the XPath expression of the request. Example: //ID

    For information about XPath syntax, see http://www.w3schools.com/xpath/xpath_syntax.asp.

    (This field is displayed when Drop down list is selected for Display format.)

    Note: Items lacking value or display are ignored.

    XPath for display

    Display element for the XPath expression of the request. Example 1: //Name Example 2: //*[name() ='List']/@Title

    For information about XPath syntax, see http://www.w3schools.com/xpath/xpath_syntax.asp​.

    ​(This field is displayed when Drop down list is selected for Display format.)

    Note: Items lacking value or display are ignored.

    Execute in new mode Default: Yes.
    Execute in edit mode Default: Yes.
    ​Execute in view mode Default: No.
    Appearance Visible Hide or show the control at runtime.​
    Enabled Enable the control to receive user input at runtime.
    Use custom "Please select" text Specify whether or not to use custom "Please select" text.
    (This field is displayed when Drop down list is selected for Display format.)
    Filtering Filter available selections​ ​Select one of the following options. 
    • Display all items: Do not filter selections.
    • By a specified value: Filter selections by the specified value.
      Use this option to dynamically change the contents of the control. For example, you can filter the list of product names returned from the request to a specific location by inserting a reference to a named control on the form that is used to specify the location. 
    XPath for Where field ​XPath expression for the field in the source list to apply the filter to.​
    For example, you might specify an XPath expression for a field that lists product names: //ProductName 
    Filtered by value ​The value to filter selections by.
    Note: You can insert references to named controls. ​Inserted references are formatted as red underlined font. 
    For example, you might insert a reference to a named control on the form that is used to specify the location. 
    Formatting Control CSS class The CSS class to apply to the inner input control.
    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. 
    Validation Required The form will not submit unless this control is completed correctly.  
    Required error message Text to display if the control is not completed correctly.
    (This field is displayed when Yes is selected for Required.) 
    Use custom validation Enables custom JavaScript validation for the control. 
    Custom validation function Specify the JavaScript function name for the client side custom validation. Note: The JavaScript function is to be specified in the Custom JavaScript section within the form's Settings. 
    ​(This field is displayed when Yes is selected for Use custom validation.) 
    Custom error message The error message to display when an invalid value is entered. 
    ​(This field is displayed when Yes is selected for Use custom validation.) 
    Advanced Custom headers (Optional.) ​Headers for the request, as name/value pairs. For examples of header values, see "Supported headers" below. 
    Click Add to specify a header. 
    Note: When specifying values, you can insert references to named controls. 
    Help text Help text that will be displayed to the user as a tooltip to guide the completion of the form.
    Control Mode Force control to be in Edit mode, Display mode, or set to Auto.
    Confirm value in connected column ​​When enabled, displays a warning on form submission if bound column values were updated outside Nintex Forms.
    Note: Columns are bound to the control via the fields ID connected to ​and Text connected to. An example scenario for display of this warning is updating the value of the "Department" column for the related list item using SharePoint and then attempting to submit the form for that list item where the form control is bound to the "Department" column. 
    Store Client ID in JavaScript variable A JavaScript Variable will be created that references the Client ID of this control. 
    Client ID JavaScript variable name The name of the variable to store the Client ID in. 
    (This field is displayed when Yes is selected for Store Client ID in JavaScript variable.) 
    Resize at runtime Allow the control to dynamically adjust its size, and adjust the form length and position of other controls accordingly.

    Supported headers

    This section lists supported and unsupported headers for use in the Custom headers field. Examples are provided for supported headers. 

    Examples of supported headers

    Accept-Charset: utf-8
    Accept-Datetime: Thu, 31 May 2007 20:35:00 GMT
    Accept-Encoding: gzip, deflate
    Accept-Language: en-US
    Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
    Cache-Control: no-cache
    Cookie: $Version=1; Skin=new;
    DNT: 1
    From: user@example.com
    Front-End-Https: on
    If-Match: "737060cd8c284d8af7ad3082f209582d"
    If-None-Match: "737060cd8c284d8af7ad3082f209582d"
    If-Range: "737060cd8c284d8af7ad3082f209582d"
    If-Unmodified-Since: Sat, 29 Oct 2014 19:43:31 GMT
    Keep-Alive: 300
    Max-Forwards: 10
    Origin: http://www.example-social-network.com
    Pragma: no-cache
    Proxy-Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
    TE: trailers, deflate
    Upgrade: HTTP/2.0, SHTTP/1.3, IRC/6.9, RTA/x11
    Via: 1.0 fred, 1.1 example.com (Apache/1.1)
    Warning: 199 Miscellaneous warning
    X-Att-Deviceid: GT-P7320/P7320XXLPG
    X-Csrf-Token: i8XNjC4b8KVok4uw5RftR38Wgp2BFwql
    X-Forwarded-For: client1, proxy1, proxy2
    X-Forwarded-Host: en.wikipedia.org
    X-Forwarded-Proto: https
    X-HTTP-Method-Override: DELETE
    X-Requested-With: XMLHttpRequest
    X-wap-profile: http://wap.samsungmobile.com/uaprof/SGH-I777.xml


    Ignored headers (see parenthetical comments)​

    Accept: application/xml (default)
    Connection: keep-alive
    Content-Length: 348 (value is based on length of content)
    Content-Type: application/xml (this value is set in the Content type field)
    Date: Tue, 15 Nov 2014 08:12:31 GMT (default to system time)
    Expect: 100-continue
    Host: en.wikipedia.org:80 (extracted from url)
    If-Modified-Since: Sat, 29 Oct 2014 19:43:31 GMT
    Proxy-Connection: keep-alive
    Range: bytes=500-999
    Referer: http://en.wikipedia.org/wiki/Main_Page
    User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:12.0) Gecko/20100101 Firefox/21.0

    Related Topics

    Getting started with the form designer
    Control Settings
    Controls In Use
    Connecting Controls to fields or variables
    Shortcut keys
    Inserting reference fields
    Control Properties Ribbon​​​​​​​

    2.31 Page Break Guide

    ​​​​​​* This topic applies to Nintex Forms Enterprise Edition only
    ​​​​​​​* Supported for use in Desktop layouts only

    Page Break Guide

    The Page Break Guide control allows you to decide where a form will have page breaks when rendered using Print to PDF.​ Use this control to force a form to break at certain points when being printed.

    Note: The control cannot be nested in other controls. If it overlaps another control, the page will only break after the overlapped control when rendered as a PDF. The control's width cannot be changed.

    Control Settings  

    Section Selection Description
    General Name The name of the control. The name is used for comparison validation and other control references. ​
    ​​

    3 Using the Form Designer

    3.1 Getting started with the form designer

    Getting started with the Nintex Forms designer 

    The Nintex Forms designer allows you to create customized forms within your SharePoint environment quickly and easily. Forms can be consumed on most common mobile devices such as Smart Phones, Windows Phones, iPhones, Androids and iPads. Once a form has been designed in one layout, the forms designer will automatically generate the form on other devices which are selected. You can also publish the form to the cloud with one click, refer to Saving and publishing forms.
     
    Note: For information on how to create a new form for a list or a content type, refer to Create a Form below.

    The Form Designer screen

    The designer screen contains four main areas. The Ribbon at the top, the Form Controls toolbox on the left, the Controls In Use and Rules panes on the right (hidden by default) and the form design canvas in the center.

    The Form Controls toolbox

    The controls toolbox displays the controls which can be added to forms in the design canvas. The controls are divided into categories of related control types and preconfigured controls.
    Click the heading of a category to view the controls in that group. The default categories are:
    * shown only if designing a form for Nintex Workflow.
    The preconfigured controls are automatically generated for content type columns, list columns, task columns and workflow variables that are related to the form. The Connected to property is automatically set to the corresponding related column or variable. 

    Resizing and hiding/unhiding the toolbox

    • To resize the pane: Click and drag on the expander bar on the inside edge of the toolbox.
    • To hide the toolbox: Click the drawing pin icon located on the top right corner of the toolbox header. The toolbox will collapse, leaving a visible tab.
    • To access the toolbox: Hover over the tab. The toolbox will be visible while the mouse remains over it and will be hidden when the mouse is moved away.
    • To make the toolbox remain visible: Click the drawing pin icon to pin the panel open.

    Adding controls to the design canvas

    To begin designing a form, add controls to the canvas and configure each control.
    1. Drag a control from the toolbox and drop it into position onto the design canvas.
    OR
    2. Right-click on the design canvas, select Insert Control and select the required control from the list. 

    Note:

    Selecting Controls

    Select any control on the canvas by left-clicking with the mouse on it.

    To select multiple controls:

    Configuring controls

    Please refer to Control Settings for more information on configuring a control.

    Controls In Use pane

    The Controls In Use pane provides a view of all of the controls which have been added to all of the layouts configured for the form. This is particularly helpful when forms contain numerous controls and layouts, and when replicating control(s) from one layout to another.
    Please refer to Controls In Use for more information on the Controls In Use pane.

    Rules pane

    The Rules pane can be used to add dynamic formatting, visibility or editability changes to controls within any form based on defined conditions.
    Please refer to Rules for more information on the Rules pane.

    The Ribbons

    At the top of the designer screen are two Nintex Forms Ribbons: Design and Tools. The options and related Help topics are all listed below.

    Design Ribbon

    Ribbon Extras 

    • Undo icon: Undo the last action. A stack of up to 50 undo actions is available.

          Note: Changes to Rules cannot be undone; with the exception of deleting a rule.

    • Redo icon: Reverses the most recent Undo action.

    Creating a form

    To create a new form for a List:

    1. Select the List tab on the List Tools Ribbon.

    2. In the Customize List group, click the Nintex Forms button to edit the default list form. If the list contains multiple content types, click the drop- down and select Customize the [Content Type] Form from the menu options.

    To create a new form in Nintex Workflow (requires Nintex Workflow to be installed and configured), refer to Designing forms in Nintex Workflow for more information.

    The Nintex Forms designer will open in the current window.

    To create a new form for a Content Type:

    1. Navigate to the content type's information page (e.g. Site Actions > Site Settings > Site Content Types).

    2. In the Settings section, click on Edit form with Nintex Forms.

    The Nintex Forms designer will open in the current window.

    Note: All lists using the content type will inherit the designed Nintex form.

    Related Topics

    Controls In Use
    Control Settings
    Print to PDF
    Form and Layout settings
    Saving and publishing forms
    Importing and exporting forms
    Live Forms settings
    Manage device layouts
    Designing forms in Nintex Workflow
    Rules
    Form Variables

    3.2 Shortcut keys

    Shortcut Keys

    A shortcut key is a combination of keys that executes a specific function or command within the Nintex Forms application.

    The following are the shortcut keys that are available for use when designing a form in Nintex Forms:

    Shortcut​ keys Description
    Ctrl + Shift + A​ Select all controls on the layout​
    Ctrl + Shift + C​ Copy the selected control(s) to the clipboard
    Ctrl + Shift + X​​ Remove the selected control(s) and copy to the clipboard
    Ctrl + Shift + V​​ Paste the copy/cut control(s)​ from the clipboard
    Ctrl + Shift + B​​ Bring the selected control(s)​ to the front
    Ctrl + Shift + S​ Send the selected control(s)​ to the back
    Ctrl + Z​ Undo last action​
    Ctrl + Y​ Redo most recent undo​
    Delete​ Delete the selected control(s)​​
    ​Ctrl + Shift + F ​Copy the font and styles from the selected control(s) using Format Painter.

    Related Topics

    Getting started with the form designer
    Linked Controls
    Control Settings
    Controls In Use

     

    3.3 Importing and exporting forms

    Importing and Exporting Forms

    Nintex forms can be imported and exported to the local file system as '.xml' files. This is useful when copying forms from one server to another or for other file transfer scenarios.

    The exported file can then be imported into a different SharePoint List, workflow action or another workflow, or as a template.  When exporting a form, all of the configured device layouts are included in the export file.  This results in all device layouts being imported when importing the file as a form or as a template. Please refer to Associating templates to device layouts for more information.

    Exporting a form

    To export the form:

    1. Select the Export button from the Nintex Forms Ribbon in the form designer.
    2. Click the Save button and follow the standard procedure for downloading and saving files from the web browser (consult the web browser documentation for more information on downloading and saving files).

    Importing a form

    Note: When importing a form it will overwrite any of the current form design.

    1. Select the Import button from the Nintex Forms Ribbon in the form designer.
    2. If there are unsaved changes to the form, a warning message dialog will appear.
    3. Click OK.
    4. Use the Browse button to locate the Nintex Forms export file (.xml) to upload.
    5. Click the Import button from the Ribbon.

    Note: When exporting a Nintex Workflow that includes forms edited in Nintex Forms, the forms will be included in the Nintex Workflow export file(.nwf).

    Related Topics

    Associating templates to device layouts
    Form and Layout settings
    Saving and publishing forms

    3.4 Controls In Use

    Controls in Use

    The Controls In Use pane can be used to easily identify which controls are:

    To open the Controls in Use pane

    Selecting a control not on the current layout

    • The control will appear dimmed in the Controls In Use pane. 
    • When dragging onto the current layout, the cursor tooltip will display “Add to layout”. This will create a Linked Control.

    Selecting a control already on the current layout

    • The control will appear active in the Controls In Use pane.
    • When dragging onto the current layout, the cursor tooltip will display “Create a copy of...”. This will create a stand-alone copy of the Control.

     

    Related Topics

    Getting started with the form designer
    Control Settings
    Linked Controls
    Rules
     
     

     

    3.5 Connecting Controls to fields or variables

    Connecting controls to fields or variables

    Use the Connected to property when specifying the field (list column) or workflow variable that the control will read and store data to.  (This is also known as "binding” the control to the field or variable).

    Note: If the form has been saved and changes are made to a field (list column) or workflow variable that is Connected to a control, the control on the form will not be updated. Either manually make the changes to the control settings, or remove the control from the form and re-add the pre-configured control onto the form using the Controls Toolbox. An example would be the choices available for selection in a Choice control. The Choice control on the form will retain the same values as when the form was saved.

    Setting the Connected to property

    1. Configure the list column, workflow variables (only available when designing forms in Nintex Workflow) or task content types.
    2. Select the control and use the Connected to drop down in the Ribbon or set the Connected to property in the Control Settings dialog.

    Note: If a default value is specified for the field or workflow variable that the control is being Connected to, this value will overwrite any default value specified for the control.

    Note: Form controls are not always required to be bound to a column or workflow variable. If the control is not bound, the form can still be published and information collected. The information collected in the form control will be saved within the form even though it is not bound to a column or workflow variable. In order to view the collected information, open the form in view mode.

    Related Topics

    Getting started with the form designer
    Control Settings
    Inserting reference fields
    Linked Controls

    3.6 Designing a form for a mobile device

    Designing a Form for Mobile Devices

    Layouts allow a form to be targeted to different mobile devices using defined screen dimensions set in the Manage device layouts settings.

    To create a form layout for a device

    The first time a device layout is selected for a form, the controls currently on the default layout will be copied to the selected device layout.

    Add or remove controls as required and adjust the position, size, and settings of the controls to suit the device layout.

    Note: The Controls In Use panel may be helpful in identifying controls that are in use on other layouts which are not on the current layout.

    Creating a form layout for the Nintex Mobile App

    Creating a form layout for the Nintex Mobile App is the same as creating a layout for viewing through the browser.

    However, please note:

     

    Related Topics

    Getting started with the form designer
    Importing and exporting forms
    Manage device layouts
    Controls In Use
    Saving and publishing forms
    [[Using the Form Designer/Forms functionality supported for use with Nintex Mobile]]

     

    3.7 Inserting reference fields

    Inserting Reference Fields

    Insert references to create dynamic values to be used in settings or displayed as text. Reference tokens and functions are calculated at runtime and the resulting values are used in the form.

    To insert a referenc​e:

    1. Click  to display the Insert Reference dialog box.
    2. In the Insert Reference dialog box, select the reference category tab and then double-click the reference to add it to the Dynamic text to insert text box.
    3. In the Dynamic text to insert text box, add any required text or function arguments.
    4. Click OK to save changes and close the dialog box.​

    Reference categories

    Reference categories are indicated by tabs in the Insert Reference dialog box. Availability of reference categories depends on the context in which the Insert Reference dialog box is accessed. Following are possible reference categories. 

     

     

     

    Note: Additional references are available when designing a form in Nintex Workflow. Please refer to the Nintex Workflow help file for more information.​

     

    Related Topics

    Getting started with the form designer
    Inline functions
    Inline functions usage examples


    3.8 Inline functions

    Inline Functions

    In any text input that supports inserting reference fields, an inline function can be entered which will be resolved to a value at runtime.

    A number of functions are provided out of the box.

    Functions can also be used as arguments for other functions.

    Function behavior

    The parsing engine replaces any inserted reference tokens first, and then the resulting text is evaluated for functions.

    If a function contains another function as an argument, the inner most function will be evaluated first.

    As reference tokens are replaced first, the reference token can also contain function syntax that will be evaluated.

    Functions cannot refer to named controls.

    Function reference

    And

    Returns true if the first function and the second function returns true.
     
    Usage
    fn-And(greaterthan(value1,value2), lessthan(value3,value4))
     
    Arguments
    • function1: A function which returns a boolean (true/false) value.
    • function2: A function which returns a boolean (true/false) value.
     

    Contains

    Returns true if the first argument contains (at the beginning, at the end, or anywhere within) the second argument.
     
    Usage
    fn-Contains(value1, value2)
     
    Arguments
     

    DoesMemberExistInAudience

    Returns true if the current user belongs to the SharePoint audience.
     
    Usage
    fn-DoesMemberExistInAudience(SharePointAudience)
     
    Argument
     

    EndsWith

    Returns true if the first argument ends with the second argument.
     
    Usage
    fn-EndsWith(value1, value2)
     
    Arguments
     

    Equals

    Returns true if the second argument is equal to the first argument.
     
    Usage
    fn-Equals(value1, value2)
     
    Arguments

     

    GetQueryString

    Returns the value for a specific key in the query string. This can be used to specify default values for the People and Single Line Textbox controls by including query string parameters in the URLs that opens the form in New mode.
    If the key cannot be located in the query string, a blank value will be returned. If there is any potentially damaging JavaScript in the value, it will be removed before being inserted into the form or control settings.

     
    Usage

    fn-GetQueryString(key)
     

    Arguments

     

    GreaterThan

    Returns true if the second argument is greater than the first argument.

    Usage
    fn-GreaterThan(value1, value2)

    Arguments

    GreaterThanOrEqual

    Returns true if the second argument is greater than or equal to the first argument.

    Usage
    fn-GreaterThanOrEqual(value1, value2)

    Arguments

    IsCurrentUser

    Returns true if the current user is the same user specified in the string argument.
     
    Usage
    fn-IsCurrentUser(username)
     
    Argument

    IsDate

    Returns true if the argument is a date.
     
    Usage
    fn-IsDate(value)
     
    Argument
     

    IsMemberOfGroup

    Returns true if the current user belongs to the Windows / SharePoint group specified in the string argument.
     
    Usage
    fn-IsMemberOfGroup(groupname)
     
    Argument
     

    IsNullOrEmpty

    Returns true if the argument is empty or null.
     
    Usage
    fn-IsNullOrEmpty(value)
     
    Argument
     

    IsNumeric

    Returns true if the argument is a number. 
     
    Usage
    fn-IsNumeric(value)
     
    Argument

    LessThan

    Returns true if the second argument is less than the first argument.

    Usage
    fn-LessThan(value1, value2)

    Arguments

    LessThanOrEqual

    Returns true if the second argument is less than or equal to the first argument.

    Usage
    fn-LessThanOrEqual(value1, value2)

    Arguments

    Not

    Returns the reverse of the boolean value. If value is true, then the function returns false. If value is false, function will return true. Use when you want to make sure a value is not equal to one particular value.
     
    Usage
    fn-Not(bool value)
     
    Argument

    Bool value: A value that evaluates to either true or false.

    Or

    Returns true if either the first function or the second function returns true.
     
    Usage
    fn-Or(greaterthan(value1,value2), lessthan(value3,value4))
     
    Arguments

    StartsWith

    Returns true if the first argument starts with the second argument.

    Usage 
    fn-StartsWith(value1, value2)

    Arguments

    SubString

    Extracts and returns a portion of text from a string.
     
    Usage

    fn-SubString(sourceString, startIndex, length)

    Arguments

    Related Topics

    Inserting reference fields
    Inline functions usage examples

    3.9 Control Settings

    Opening Control Settings

    When a control is on the form, there are three ways to open the control settings:  

    Note: If a control has mandatory settings, a message will appear to show which settings require configuration.

    Note: In addition to the tooltip warning message, a yellow warning bar will appear at the top of the design canvas. This will alert the form designer that one or more controls on the form contain incomplete configurations. It will not be possible to publish the form or the associated Nintex Workflow if any of the form's controls have incomplete configurations.

    Related Topics

    Getting started with the form designer
    Connecting Controls to fields or variables
    Controls In Use
    Border
    Button
    Calculated Value
    Change Content Type
    Choice
    Date Time
    External Data Column
    Geolocation
    Hyperlink
    Image
    Label
    List Attachment
    List Item
    List View
    List Lookup
    Managed Metadata
    Multi Line Textbox
    Page Viewer
    Panel
    People
    Recurrence
    Repeating section
    Rich Text
    Single Line Textbox
    Workflow Diagram
    Yes/No  

    3.10 Saving and publishing forms

    Saving and Publishing Forms

    A form must be published in order to make it available to users. Published forms are automatically saved. Use the Save button to save changes to the form design without publishing.

    In addition to the standard SharePoint publishing, forms can also be published to Nintex Live, an internet hosted service. For information on publishing to Nintex Live, refer to Publishing forms to Nintex Live below.

    Saving a form

    To save a form:

    1. In the Nintex Forms Ribbon, click the Save button.
    2. A progress indicator will display while the saving process occurs. If designing and editing a form in Nintex Workflow using Nintex Forms, a confirmation dialog is displayed when the form is saved. 

     

    The Confirm save dialog displays

    • The device specific layouts that will be published with the form.
    • The Live Settings configuration for the form (if Nintex Live Forms has been enabled). The Live Settings configurations can be changed by clicking on the Change link.
    • Any mobile details as far as Nintex Mobile layouts created.
    • The option to skip 'Confirm save" and "Save completed" dialogs. Selecting this option will no longer show the dialogs for the current form, on the current browser, until the option is rest in the "Form Settings" dialog. When selected, a toaster notification will be shown informing the user when the form has been saved successfully.

    Form saved successfully message will be displayed just below the Ribbon at the top right of the design canvas.

     

    Note: If designing and editing a form in Nintex Workflow using Nintex Forms, only the Save button is available in the form designer Ribbon. The form is published when the workflow is published. Refer to Designing forms in Nintex Workflow for more information.

    Publishing a form

    Before a form becomes available to users within SharePoint lists and libraries, it must be published.

    Note: If there are any form or control settings that have not been configured, the Publish button will be disabled.

    To publish a form:

    1. In the Nintex forms Ribbon, click the Publish or the Publish and Close button. The Confirm publishing dialog will open unless configured to be skil.
    2. The Confirm publishing dialog displays:

    -  The device specific layouts that will be published with the form.

    -  The Live Settings configuration for the form (if Nintex Live Forms has been enabled).

    -  The Live Settings configurations can be changed by clicking on the Change link.

        3.  Click Publish.

    This may take a few seconds. A Form published successfully message will display. If the Publish and Close option is selected the form will close immediately after a successful publish.

    Note: The form is automatically saved before it is published. It is not necessary to Save and then Publish a form.

    Note: If a published form has controls that are connected to columns, workflow variables or labels that are associated to a bound control; property changes made to the columns or workflow variables will be automatically synchronized to the Nintex form without needing to republish the form.

    Publishing forms to Nintex Live

    In addition to the standard SharePoint publishing, forms can also be published to Nintex Live to provide access via the internet.

    Note: Only the following form types can be published to Nintex Live:

    To configure settings for Nintex Live publishing:

    1. In the Nintex Forms Ribbon, click on the