Form complex element

The form element defines the form-level elements and as contains the complex elements that define aspects of the Nintex form such as the form layouts, control layouts, and the inventory of form control properties.

Syntax


<Form>
      <AddListFormWebPartSubmitMessage>Boolean</AddListFormWebPartSubmitMessage>
      <Category>Boolean</Category>
      <Css>Boolean</Css>
      <CssUrls>Boolean</CssUrls>
      <Description>Boolean</Description>
      <FormControls>Boolean</FormControls>
      <FormCssClass>Boolean</FormCssClass>
      <FormLayouts>Boolean</FormLayouts>
      <FormType>Boolean</FormType>
      <HideConfirmSuccessDialog>Boolean</HideConfirmSuccessDialog>
      <Icon>Boolean</Icon>
      <Id>Boolean</Id>
      <ListFormWebPartSubmitMessage>Boolean</ListFormWebPartSubmitMessage>
      <LiveSettings>Boolean</LiveSettings>
      <Name>String</Name>
      <Rules>Boolean</Rules>
      <Script>Boolean</Script>
      <ScriptUrls>Boolean</ScriptUrls>
      <ShowGridLines>Boolean</ShowGridLines>
      <TimeZone>Boolean</TimeZone>
      <UseDefaults>Boolean</UseDefaults>
      <UseServerTimezone>Boolean</UseServerTimezone>
      <UserFormVariables>String</UserFormVariables>
      <Version>String</Version>
      <WakeUpWfForVars>Boolean</WakeUpWfForVars>
</Form>

Element Characteristics

Characteristic	Description
Data type and length	String
Default value	None
Cardinality	1..1: Required element that occurs only once.

Element Attributes

Attribute	Description
	Required.

Relationships

Relationship	Element
Parent element	Root Element
Child elements	See the child element table.

Parent Element Namespace

Prefix	Namespace
xmlns	http://schemas.datacontract.org/2004/07/Nintex.Forms
i	http://www.w3.org/2001/XMLSchema-instance

Parent Element

Attribute	Description
	Required.

Child Elements

Name	Data Type	Default value	Cardinality	Description
AddListFormWebPartSubmitMessage	Boolean	false	1..1	Indicates whether to show grid lines.
Category	String	blank	1..1	The form category.
Css	String	default CSS	1..1	Contains the form CSS
CssUrls	Complex Element		1..*	A reference link to the CSS URLs.
Description	String	blank	1..1	The form description.
FormControls	Complex Element		1..*	The form items.
FormCssClass	String	blank	1..1	The form CSS class.
FormLayouts	Complex Element		1..*	Contains the form layouts.
FormType	String	Global	1..1	Sets the type of the form. For more information on the enumeration, see FormType Enumeration.
HideConfirmSuccessDialog	Boolean	false	1..1	Indicates whether show the confirm or success dialog box.
Icon	String	blank	1..1	Absolute or relative path to the form icon URL.
Id	String	GUID	1..1	Sets the unique id associated with this form.
ListFormWebPartSubmitMessage	String	Default Submit Message	1..1	Sets the text for the submit message.
LiveSettings	Complex Element		1..*	Sets the LiveSettings property.
Name	String	blank	1..1	Sets a value indicating the form name.
Rules	String	blank	1..1	Sets the rules of the form.
Script	String	blank	1..1	Contains the script.
ScriptUrls	Complex Element		1..*	Absolute or relative path to the script URLs.
ShowGridLines	Boolean	true	1..1	Indicates whether show grid lines.
TimeZone	Boolean	true	1..1	Indicates the timezone of the form in Live.
UseDefaults	Boolean	true	1..1	Indicates whether to UseDefaults.
UseServerTimezone	Boolean	false	1..1	Indicates whether to UseDefaults.
UserFormVariables	String	blank	1..1	Contains references to the form variables.
Version	String	101.1.10	1..1	The version of the form.
WakeUpWfForVars	Boolean	false	1..1	Indicates whether the task form to wake up the workflow to retrieve the workflow variables instead of reading them from the FormData extended property off the task item.

Remarks

The Form Name element has several possible points of confusion.

The Form XML for SharePoint 2013 contains the Name element (above) in the base complex type element that contains the primary elements of the form. The name element is blank by default, and is not used by Nintex Forms. A unique instance of a form is identified by the ListId and ContentTypeId. Interactions from the Forms designer and Forms filler are handled through the same internal service that provides the internal working to the API. The API does not use the name of the form.

Nintex App Studio allows for an override of the form name and description. In the Forms designer under Forms settings you can deselect under Nintex Mobile Settings group use Form Name and Form Description. This will give you the option to provide a name and description for the form of the form. This information will get stored in the Form XML, and will be used by the mobile version.

The confusion comes in because form contentype for the form also has a name and a description. These are in the domain of SharePoint. The content type name shows up in the SharePoint List and is what you can select from the list. This is not part of the form description data, meaning it not part of Nintex Forms but rather belongs in the arena of SharePoint and how SharePoint handles contenttypes.

Example

The following example contains an example of the complex element.

Related information

Form XML Complex Elements