TextBoxFormControlProperties Type

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

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

Syntax


<d2p1:FormControlProperties i:type="d2p1:TextBoxFormControlProperties">
      <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>c0a89c70-0781-4bd4-8623-f73675005e05</d2p1:FormControlTypeUniqueId>
      <d2p1:FormType>String</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>String</d2p1:DataField>
      <d2p1:DataFieldDisplayName>String</d2p1:DataFieldDisplayName>
      <d2p1:ExposeClientIdAsJavascriptVariable>Boolean</d2p1:ExposeClientIdAsJavascriptVariable>
      <d2p1:ExposedClientIdJavascriptVariable i:nil="true" />
      <d2p1:HelpText></d2p1:HelpText>
      <d2p1:HelpTextSet></d2p1:HelpTextSet>
      <d2p1:IsEnabled>Boolean</d2p1:IsEnabled>
      <d2p1:IsRequired>Boolean</d2p1:IsRequired>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:RequiredErrorMessage i:nil="true" />
      <d2p1:UseCustomValidation>Boolean</d2p1:UseCustomValidation>
      <d2p1:ApplyFormatInEditMode>Boolean</d2p1:ApplyFormatInEditMode>
      <d2p1:ConvertEmptyStringToNull>Boolean</d2p1:ConvertEmptyStringToNull>
      <d2p1:DataFormatString i:nil="true" />
      <d2p1:HtmlEncodeFormatString>Boolean</d2p1:HtmlEncodeFormatString>
      <d2p1:NullDisplayText i:nil="true" />
      <d2p1:Barcode>Boolean</d2p1:Barcode>
      <d2p1:CompareErrorMessage i:nil="true" />
      <d2p1:CompareOperator>String</d2p1:CompareOperator>
      <d2p1:CompareTo>String</d2p1:CompareTo>
      <d2p1:ControlToCompare i:nil="true" />
      <d2p1:DataType>String</d2p1:DataType>
      <d2p1:DefaultValue i:nil="true" />
      <d2p1:DefaultValueSource>String</d2p1:DefaultValueSource>
      <d2p1:IsPassword>Boolean</d2p1:IsPassword>
      <d2p1:Lcid i:nil="true" />
      <d2p1:MaxLength>Integer</d2p1:MaxLength>
      <d2p1:MaximumValue i:nil="true" />
      <d2p1:MinimumValue i:nil="true" />
      <d2p1:RangeErrorMessage i:nil="true" />
      <d2p1:RegularExpression i:nil="true" />
      <d2p1:RegularExpressionErrorMessage i:nil="true" />
      <d2p1:ShowAsPercent>Boolean</d2p1:ShowAsPercent>
      <d2p1:UseCompareValidation>Boolean</d2p1:UseCompareValidation>
      <d2p1:UseRangeValidation>Boolean</d2p1:UseRangeValidation>
      <d2p1:UseRegularExpressionValidation>Boolean</d2p1:UseRegularExpressionValidation>
      <d2p1:ValueToCompare i:nil="true" />
</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 false 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 Title 1..1

The display name.
FormControlTypeUniqueId String c0a89c70-0781-4bd4-8623-f73675005e05 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 Complex Element blank 1..*

The insert references.
InternalPropertyBag Complex Element blank 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 SharePoint 1..1

The source. Values include: External, SharePoint, Unspecified, and Workflow.
VerticalAlign String 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 false 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 String 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 List:Title 1..1

The binding path field name.
DataFieldDisplayName String Title 1..1

The display name of the data field.
ExposeClientIdAsJavascriptVariable Boolean false 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 Title 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.
ApplyFormatInEditMode Boolean false 1..1

True if [apply format in edit mode]; otherwise, false.
ConvertEmptyStringToNull Boolean false 1..1

True if [convert empty string to null]; otherwise, false.
DataFormatString String blank 1..1

The data format string.
HtmlEncodeFormatString Boolean false 1..1

True if [HTML encode format string]; otherwise, false.
NullDisplayText String blank 1..1

The null display text.
Barcode Boolean false 1..1  
CompareErrorMessage String blank 1..1  
CompareOperator String DataTypeCheck 1..1  
CompareTo String None 1..1  
ControlToCompare String blank 1..1  
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 String 1..1

True if default value; otherwise, false.
DefaultValueSource String Inherit 1..1

The default value source. Values include: Expression, and Inherit.
IsPassword Boolean false 1..1 True if this instance is password; otherwise, false.
Lcid String blank 1..1 The culture identifier. In most cases, the culture identifier is mapped to the corresponding NLS locale identifier.
MaxLength String 255 1..1 The length of the max.
MaximumValue String blank 1..1 The maximum value.
MinimumValue String blank 1..1 The maximum value.
RangeErrorMessage String blank 1..1 The range error message.
RegularExpression String blank 1..1 The regular expression.
RegularExpressionErrorMessage String blank 1..1 The regular expression error message.
ShowAsPercent Boolean false 1..1 True if this instance is a percentage; otherwise, false.
UseCompareValidation Boolean false 1..1 True if use compare validation; otherwise, false.
UseRangeValidation Boolean false 1..1 True if use range validation; otherwise, false.
UseRegularExpressionValidation Boolean false 1..1 True if use regular expression validation; otherwise, false.
ValueToCompare Boolean blank 1..1 The value to compare.

Example

The following example contains an example of the complex element.



<d2p1:FormControlProperties i:type="d2p1:TextBoxFormControlProperties">
      <d2p1:Border />
      <d2p1:BorderColor>#000000</d2p1:BorderColor>
      <d2p1:BorderStyle>Solid</d2p1:BorderStyle>
      <d2p1:BorderWidth>2</d2p1:BorderWidth>
      <d2p1:CanResizeAtRuntime>false</d2p1:CanResizeAtRuntime>
      <d2p1:ControlVersion>101.1.1.0</d2p1:ControlVersion>
      <d2p1:CssClass i:nil="true" />
      <d2p1:DisplayName>Title</d2p1:DisplayName>
      <d2p1:FormControlTypeUniqueId>c0a89c70-0781-4bd4-8623-f73675005e05</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>4221440d-7c44-4207-8a54-cb982aff9312</d2p1:UniqueId>
      <d2p1:VariableSource>SharePoint</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>List:Title</d2p1:DataField>
      <d2p1:DataFieldDisplayName>Title</d2p1:DataFieldDisplayName>
      <d2p1:ExposeClientIdAsJavascriptVariable>false</d2p1:ExposeClientIdAsJavascriptVariable>
      <d2p1:ExposedClientIdJavascriptVariable i:nil="true" />
      <d2p1:HelpText></d2p1:HelpText>
      <d2p1:HelpTextSet></d2p1:HelpTextSet>
      <d2p1:IsEnabled>true</d2p1:IsEnabled>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:Name>Title</d2p1:Name>
      <d2p1:RequiredErrorMessage i:nil="true" />
      <d2p1:UseCustomValidation>false</d2p1:UseCustomValidation>
      <d2p1:ApplyFormatInEditMode>false</d2p1:ApplyFormatInEditMode>
      <d2p1:ConvertEmptyStringToNull>false</d2p1:ConvertEmptyStringToNull>
      <d2p1:DataFormatString i:nil="true" />
      <d2p1:HtmlEncodeFormatString>false</d2p1:HtmlEncodeFormatString>
      <d2p1:NullDisplayText i:nil="true" />
      <d2p1:Barcode>false</d2p1:Barcode>
      <d2p1:CompareErrorMessage i:nil="true" />
      <d2p1:CompareOperator>DataTypeCheck</d2p1:CompareOperator>
      <d2p1:CompareTo>None</d2p1:CompareTo>
      <d2p1:ControlToCompare i:nil="true" />
      <d2p1:DataType>String</d2p1:DataType>
      <d2p1:DefaultValue i:nil="true" />
      <d2p1:DefaultValueSource>Inherit</d2p1:DefaultValueSource>
      <d2p1:IsPassword>false</d2p1:IsPassword>
      <d2p1:Lcid i:nil="true" />
      <d2p1:MaxLength>255</d2p1:MaxLength>
      <d2p1:MaximumValue i:nil="true" />
      <d2p1:MinimumValue i:nil="true" />
      <d2p1:RangeErrorMessage i:nil="true" />
      <d2p1:RegularExpression i:nil="true" />
      <d2p1:RegularExpressionErrorMessage i:nil="true" />
      <d2p1:ShowAsPercent>false</d2p1:ShowAsPercent>
      <d2p1:UseCompareValidation>false</d2p1:UseCompareValidation>
      <d2p1:UseRangeValidation>false</d2p1:UseRangeValidation>
      <d2p1:UseRegularExpressionValidation>false</d2p1:UseRegularExpressionValidation>
      <d2p1:ValueToCompare i:nil="true" />
</d2p1:FormControlProperties>

Related information

Form XML Complex Elements