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.

This control is supported in Nintex Mobile, except for noted fields.

Control settings

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

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

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

Section Field Description Nintex Mobile

General

Name

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

Yes

 

Title

(Responsive Forms Designer only)

Title of the control. The title is displayed as the label for the control.

Yes

 

Description

(Responsive Forms Designer only)

Description of the control. The description displays additional information or instructions for the control.

Yes
 

ID connected to

The column to bind the item ID of the returned lookup value to. For more information, see Connect controls to fields.

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. For more information, see Connect controls to fields.

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 run time.

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.

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

(Classic Forms Designer only)

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.

Note:  Custom JavaScript is available in the Classic Forms Designer only.

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
 

Prepend ID to value

Select Yes to include the item ID number in front of the value.

No

 

Display semicolon separated data in view mode

Determines separators used for data in view mode. When Yes is selected, separates data using semicolons. When No is selected, separates data using new lines. Default value: No.

Note: The default value is Yes for imported forms from earlier versions of Nintex Workflow that do not support new line separators.

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.

Note:  Custom JavaScript is available in the Classic Forms Designer only.

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

Forms 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