ChoiceFormControlProperties Type

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

This topic describes the syntax of the FormControlProperty complex element with the type attribute of ChoiceFormControlProperties.

Syntax


<d2p1:FormControlProperties i:type="d2p1:ChoiceFormControlProperties">
     <d2p1:Border />
     <d2p1:BorderColor>String</d2p1:BorderColor>
     <d2p1:BorderStyle>String</d2p1:BorderStyle>
     <d2p1:BorderWidth>Integer</d2p1:BorderWidth>
     <d2p1:CanResizeAtRuntime>Boolean</d2p1:CanResizeAtRuntime>
     <d2p1:ControlVersion>String</d2p1:ControlVersion>
     <d2p1:CssClass i:nil="true" />
     <d2p1:DisplayName>String</d2p1:DisplayName>
     <d2p1:FormControlTypeUniqueId>String</d2p1:FormControlTypeUniqueId>
     <d2p1:FormType>ListForm</d2p1:FormType>
     <d2p1:InRepeater>Boolean</d2p1:InRepeater>
     <d2p1:InsertReferences xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
     <d2p1:InternalPropertyBag xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
     <d2p1:IsDirty>Boolean</d2p1:IsDirty>
     <d2p1:IsLocked>Boolean</d2p1:IsLocked>
     <d2p1:IsVisible>Boolean</d2p1:IsVisible>
     <d2p1:PaddingWidth>Integer</d2p1:PaddingWidth>
     <d2p1:TabIndex>Integer</d2p1:TabIndex>
     <d2p1:UniqueId>String</d2p1:UniqueId>
     <d2p1:VariableSource>String</d2p1:VariableSource>
     <d2p1:VerticalAlign>String</d2p1:VerticalAlign>
     <d2p1:BackgroundColor i:nil="true" />
     <d2p1:Bold>Boolean</d2p1:Bold>
     <d2p1:FontColor i:nil="true" />
     <d2p1:FontFamily i:nil="true" />
     <d2p1:FontFamilyItemId i:nil="true" />
     <d2p1:FontSize i:nil="true" />
     <d2p1:FontSizeItemId i:nil="true" />
     <d2p1:HorizontalAlignment>String</d2p1:HorizontalAlignment>
     <d2p1:Italics>Boolean</d2p1:Italics>
     <d2p1:StrikeThrough>Boolean</d2p1:StrikeThrough>
     <d2p1:ThemeClass i:nil="true" />
     <d2p1:Underline>Boolean</d2p1:Underline>
     <d2p1:ControlCssClass i:nil="true" />
     <d2p1:ControlMode>String</d2p1:ControlMode>
     <d2p1:CustomErrorMessage i:nil="true" />
     <d2p1:CustomValidationFunction i:nil="true" />
     <d2p1:DataField i:nil="true" />
     <d2p1:DataFieldDisplayName i:nil="true" />
          <d2p1:ExposeClientIdAsJavascriptVariable>Boolean</d2p1:ExposeClientIdAsJavascriptVariable>
          <d2p1:ExposedClientIdJavascriptVariable i:nil="true" />
     <d2p1:HelpText i:nil="true" />
     <d2p1:HelpTextSet i:nil="true" />
     <d2p1:IsEnabled>Boolean</d2p1:IsEnabled>
     <d2p1:IsRequired>Boolean</d2p1:IsRequired>
     <d2p1:Name i:nil="true" />
     <d2p1:RequiredErrorMessage i:nil="true" />
     <d2p1:UseCustomValidation>Boolean</d2p1:UseCustomValidation>
     <d2p1:Choices xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
       <d4p1:string>String</d4p1:string>
       <d4p1:string>String</d4p1:string>
       <d4p1:string>String</d4p1:string>
     </d2p1:Choices>
     <d2p1:CustomPleaseSelectText i:nil="true" />
     <d2p1:CustomSpecifyValueText i:nil="true" />
     <d2p1:DataType>String</d2p1:DataType>
     <d2p1:DefaultValue i:nil="true" />
     <d2p1:DefaultValueSource>String</d2p1:DefaultValueSource>
     <d2p1:DisplayFormat>String</d2p1:DisplayFormat>
     <d2p1:FillInChoice>Boolean</d2p1:FillInChoice>
     <d2p1:RenderAsTabs>Boolean</d2p1:RenderAsTabs>
     <d2p1:RepeatColumns>Integer</d2p1:RepeatColumns>
     <d2p1:RepeatDirection>String</d2p1:RepeatDirection>
     <d2p1:RepeatLayout>String</d2p1:RepeatLayout>
     <d2p1:UseCustomPleaseSelectText>Boolean</d2p1:UseCustomPleaseSelectText>
     <d2p1:UseCustomSpecifyValueText>Boolean</d2p1:UseCustomSpecifyValueText>
</d2p1:FormControlProperties>

        

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 FormForm/FormControls
Child elements See the child element table.

Parent Element Namespace

Prefix Namespace
d2p1 http://schemas.datacontract.org/2004/07/Nintex.Forms.FormControls

Parent Element

Attribute Description
  Required

Child Elements

Name Data Type Default value Cardinality Description
Border String blank 1..1

The line style. Values include: Bottom, Left, Right, and Top.

BorderColor String #000000 1..1

The color of the line.

BorderStyle String Solid 1..1

The line style. Values include: Dashed, Dotted, Double, Groove, Inset, None, None, NotSet, Outset, Ridge, and Solid. For more information see the base enumeration documentation on MSDN.

BorderWidth Integer 2 1..1

The width of the line in pixels.

CanResizeAtRuntime Boolean true 1..1

Indicates if the control can resize at run time.

ControlVersion String 101.1.1.0 1..1

The version number of the control.

CssClass String blank 1..1

The CSS class.

DisplayName String Choice 1..1

The display name.

FormControlTypeUniqueId String GUID 1..1

The form control type unique id.

FormType String ListForm 1..1

The type of the form.

InRepeater Boolean false 1..1

Value is true if in repeater; otherwise, false.

InsertReferences String blank 1..*

The insert references.

InternalPropertyBag String blank 1..1

The internal property bag.

IsDirty Boolean false 1..1

True if the object is dirty; otherwise, false. The value indicating whether the control exists in any layout. If this flag is set then it is safe to delete the control from the list.

IsLocked Boolean false 1..1

True if this instance is locked; otherwise, false.

IsVisible Boolean true 1..1

True if this instance is visible; otherwise, false.

PaddingWidth Integer 0 1..1

The width of the padding.

TabIndex Integer 0 1..1

The index of the tab.

UniqueId String GUID 1..1

The unique id. For more information see "Guid Structure" on MSDN/

VariableSource String Unspecified 1..1

The source. Values include: External, SharePoint, Unspecified, and Workflow.

VerticalAlign Integer NotSet 1..1

The width of the padding. Valid values include:

  • Bottom

    Text or object is aligned with the bottom of the enclosing control.

  • Middle

    Text or object is aligned with the center of the enclosing control.

  • NotSet

    Vertical alignment is not set.

  • Top

    Text or object is aligned with the top of the enclosing control.

BackgroundColor String blank 1..1

The color of the background.

Bold Boolean blank 1..1

True if bold; otherwise, false.

FontColor String blank 1..1

The color of the font.

FontFamily String blank 1..1

The font family.

FontFamilyItemId String blank 1..1

The font family item id.

FontSize String blank 1..1

The size of the font.

FontSizeItemId String blank 1..1

The font size item id.

HorizontalAlignment String NotSet 1..1

The horizontal alignment. Values include: Center, Justify, Left, NotSet, and Right. For more information, see "Horizontal Enumeration" in MSDN.

Italics Boolean false 1..1

True if italics; otherwise, false.

StrikeThrough Boolean false 1..1

True if [strike through]; otherwise, false.

ThemeClass String blank 1..1

The theme class.

Underline Boolean false 1..1

True if use custom validation; otherwise, false.

ControlCssClass String blank 1..1

The control CSS class.

ControlMode Boolean Auto 1..1

Species the mode of the control. Valid values include:

  • Auto
  • Edit
  • ReadOnly
CustomErrorMessage String blank 1..1

The required error message.

CustomValidationFunction String blank 1..1

The custom validation function.

DataField String blank 1..1

The binding path field name.

DataFieldDisplayName String blank 1..1

The display name of the data field.

ExposeClientIdAsJavascriptVariable Boolean blank 1..1

True if expose client id as JavaScript variable; otherwise, false.

ExposedClientIdJavascriptVariable String blank 1..1

The exposed client id JavaScript variable.

HelpText String blank 1..1

The help text.

HelpTextSet String blank 1..1

The help text set.

IsEnabled Boolean true 1..1

True if this instance is enabled; otherwise, false.

IsRequired Boolean true 1..1

True if this instance is required; otherwise, false.

Name String blank 1..1

The name of the control.

RequiredErrorMessage String blank 1..1

The required error message.

UseCustomValidation Boolean false 1..1

True if use custom validation; otherwise, false.

Choices String blank 1..* The text for the control. Each choice is a child in a <string/> element.
CustomPleaseSelectText String blank 1..1 The custom please select text.
CustomSpecifyValueText String blank 1..1 The custom specify value text.
DataType String String 1..1

The type of the data. The ValidationDataType enumeration represents the different data types that the CompareValidator and RangeValidator controls can validate. When you specify a data type for validation control and the input control being validated passes validation, the value of the input control can be parsed to the specified data type. For more information, see "ValidationDataType Enumeration" in MSDN.

DefaultValue Boolean blank 1..1

True if default value; otherwise, false.

DefaultValueSource String blaInheritnk 1..1

The default value source. Values include: Expression, and Inherit.

DisplayFormat String CheckBoxList 1..1

The display format. Use the following values:

  • CheckBoxList

    A multi-select check box list.

  • Default

    The default native picker.

  • DropDownList

    The default native picker.

  • ListBox

    A multi-select list.

  • RadioButtonList

    A single select radio button list.

FillInChoice Boolean false 1..1 True if default AllowFillInChoices value; otherwise, false.
RenderAsTabs Boolean false 1..1 True if render as tabs; otherwise, false.
RepeatColumns Integer 1 1..1 The repeat columns.
RepeatDirection String Vertical 1..1

The repeat direction.Use the following values:

  • Horizontal

    Items of a list are displayed horizontally in rows from left to right, then top to bottom, until all items are rendered.

  • Vertical

    Items of a list are displayed vertically in columns from top to bottom, and then left to right, until all items are rendered.

RepeatLayout String Table 1..1

The repeat layout. Use the following values:

  • Flow

    Items are displayed without a table structure. Rendered markup consists of a span element and items are separated by br elements.

  • OrderedList

    Items are displayed without a table structure. Rendered markup consists of an ol element that contains li elements.

  • Table

    Items are displayed in a table.

  • UnorderedList

    Items are displayed without a table structure. Rendered markup consists of a ul element that contains li elements.

UseCustomPleaseSelectText Boolean false 1..1 True if to use custom please select text; otherwise, false.
UseCustomSpecifyValueText Boolean false 1..1 True if use custom specify value text; otherwise, false.

Remarks

/// remarkes

Example

The following example contains an example of the complex element.



<d2p1:FormControlProperties i:type="d2p1:ChoiceFormControlProperties">
     <d2p1:Border />
     <d2p1:BorderColor>#000000</d2p1:BorderColor>
     <d2p1:BorderStyle>Solid</d2p1:BorderStyle>
     <d2p1:BorderWidth>2</d2p1:BorderWidth>
     <d2p1:CanResizeAtRuntime>true</d2p1:CanResizeAtRuntime>
     <d2p1:ControlVersion>101.1.1.0</d2p1:ControlVersion>
     <d2p1:CssClass i:nil="true" />
     <d2p1:DisplayName>Choice</d2p1:DisplayName>
     <d2p1:FormControlTypeUniqueId>c0a89c70-0781-4bd4-8623-f73675005e02</d2p1:FormControlTypeUniqueId>
     <d2p1:FormType>ListForm</d2p1:FormType>
     <d2p1:InRepeater>false</d2p1:InRepeater>
     <d2p1:InsertReferences xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
     <d2p1:InternalPropertyBag xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
     <d2p1:IsDirty>false</d2p1:IsDirty>
     <d2p1:IsLocked>false</d2p1:IsLocked>
     <d2p1:IsVisible>true</d2p1:IsVisible>
     <d2p1:PaddingWidth>0</d2p1:PaddingWidth>
     <d2p1:TabIndex>0</d2p1:TabIndex>
     <d2p1:UniqueId>b7276ffb-47d6-4678-8992-3dc391fbfef3</d2p1:UniqueId>
     <d2p1:VariableSource>Unspecified</d2p1:VariableSource>
     <d2p1:VerticalAlign>NotSet</d2p1:VerticalAlign>
     <d2p1:BackgroundColor i:nil="true" />
     <d2p1:Bold>false</d2p1:Bold>
     <d2p1:FontColor i:nil="true" />
     <d2p1:FontFamily i:nil="true" />
     <d2p1:FontFamilyItemId i:nil="true" />
     <d2p1:FontSize i:nil="true" />
     <d2p1:FontSizeItemId i:nil="true" />
     <d2p1:HorizontalAlignment>NotSet</d2p1:HorizontalAlignment>
     <d2p1:Italics>false</d2p1:Italics>
     <d2p1:StrikeThrough>false</d2p1:StrikeThrough>
     <d2p1:ThemeClass i:nil="true" />
     <d2p1:Underline>false</d2p1:Underline>
     <d2p1:ControlCssClass i:nil="true" />
     <d2p1:ControlMode>Auto</d2p1:ControlMode>
     <d2p1:CustomErrorMessage i:nil="true" />
     <d2p1:CustomValidationFunction i:nil="true" />
     <d2p1:DataField i:nil="true" />
     <d2p1:DataFieldDisplayName i:nil="true" />
     <d2p1:ExposeClientIdAsJavascriptVariable>false</d2p1:ExposeClientIdAsJavascriptVariable>
     <d2p1:ExposedClientIdJavascriptVariable i:nil="true" />
     <d2p1:HelpText i:nil="true" />
     <d2p1:HelpTextSet i:nil="true" />
     <d2p1:IsEnabled>true</d2p1:IsEnabled>
     <d2p1:IsRequired>false</d2p1:IsRequired>
     <d2p1:Name i:nil="true" />
     <d2p1:RequiredErrorMessage i:nil="true" />
     <d2p1:UseCustomValidation>false</d2p1:UseCustomValidation>
     <d2p1:Choices xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
       <d4p1:string>Option 1</d4p1:string>
       <d4p1:string>Option 2</d4p1:string>
       <d4p1:string>Option 3</d4p1:string>
     </d2p1:Choices>
     <d2p1:CustomPleaseSelectText i:nil="true" />
     <d2p1:CustomSpecifyValueText i:nil="true" />
     <d2p1:DataType>String</d2p1:DataType>
     <d2p1:DefaultValue i:nil="true" />
     <d2p1:DefaultValueSource>Inherit</d2p1:DefaultValueSource>
     <d2p1:DisplayFormat>CheckBoxList</d2p1:DisplayFormat>
     <d2p1:FillInChoice>false</d2p1:FillInChoice>
     <d2p1:RenderAsTabs>false</d2p1:RenderAsTabs>
     <d2p1:RepeatColumns>1</d2p1:RepeatColumns>
     <d2p1:RepeatDirection>Vertical</d2p1:RepeatDirection>
     <d2p1:RepeatLayout>Table</d2p1:RepeatLayout>
     <d2p1:UseCustomPleaseSelectText>false</d2p1:UseCustomPleaseSelectText>
     <d2p1:UseCustomSpecifyValueText>false</d2p1:UseCustomSpecifyValueText>
</d2p1:FormControlProperties>


        

Related information

Form XML Complex Elements