CalculationFormControlProperties Type

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.

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

Syntax


<d2p1:FormControlProperties i:type="d2p1:CalculationFormControlProperties">
    <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>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:PaddingWidthInteger</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:ApplyFormatInEditMode>Boolean</d2p1:ApplyFormatInEditMode>
    <d2p1:ConvertEmptyStringToNull>Boolean</d2p1:ConvertEmptyStringToNull>
    <d2p1:DataFormatString></d2p1:DataFormatString>
    <d2p1:HtmlEncodeFormatString>Boolean</d2p1:HtmlEncodeFormatString>
    <d2p1:NullDisplayText i:nil="true" />
    <d2p1:DataType>String</d2p1:DataType>
    <d2p1:Decimals>Integer</d2p1:Decimals>
    <d2p1:Formula i:nil="true" />
    <d2p1:RecalculateOnEdit>Boolean</d2p1:RecalculateOnEdit>
    <d2p1:RecalculateOnNew>Boolean</d2p1:RecalculateOnNew>
    <d2p1:RecalculateOnView>Boolean</d2p1:RecalculateOnView>
    <d2p1:ShowAsPercent>Boolean</d2p1:ShowAsPercent>
    <d2p1:ShowThousandSeparator>Boolean</d2p1:ShowThousandSeparator>
    <d2p1:ValuePrefix i:nil="true" />
    <d2p1:ValueSuffix 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 Form/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
ApplyFormatInEditMode Boolean false 1..1

True if [apply format in edit mode]; otherwise, false.
BackgroundColor String blank 1..1

The color of the background.
Bold Boolean false 1..1

True if bold; otherwise, false.
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.
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
ControlVersion   101.1.1.0 1..1

The version number of the control.

ConvertEmptyStringToNull Boolean blank 1..1

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

The CSS class.
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.
DataFormatString String blank 1..1

The data format string.
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.
Decimals Integer 0 1..1

The number of decimal places.
DisplayName Calculated Value blank 1..1

The display name.

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.
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.
FormControlTypeUniqueId String blank 1..1

The form control type unique id.
FormType String ListForm 1..1

The type of the form.
Formula String blank 1..1

The associated data field.
HelpText String blank 1..1

The help text.
HelpTextSet String blank 1..1

The help text set.
HorizontalAlignment String NotSet 1..1

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

True if [HTML encode format string]; otherwise, false.
InRepeater Boolean false 1..1

Value is true if in repeater; otherwise, false.
InsertReferences String blank 1..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.
IsEnabled Boolean true 1..1

True if this instance is enabled; otherwise, false.
IsLocked Boolean false 1..1

True if this instance is locked; otherwise, false.
IsRequired Boolean true 1..1

True if this instance is required; otherwise, false.
IsVisible Boolean true 1..1

True if this instance is visible; otherwise, false.
Italics Boolean false 1..1

True if italics; otherwise, false.

Name

 String blank 1..1

The name of the control.
NullDisplayText String blank 1..1

The null display text.
PaddingWidth Integer 0 1..1

The width of the padding.
RecalculateOnEdit Boolean true 1..1

True or false.
RecalculateOnNew Boolean true 1..1

True or false.
RecalculateOnView Boolean false 1..1

True or false.
RequiredErrorMessage String blank 1..1

The required error message.
ShowAsPercent Boolean false 1..1

True if this instance is a percentage; otherwise, false.
ShowThousandSeparator Integer false 1..1

The number of decimal places.
StrikeThrough Boolean false 1..1

True if [strike through]; otherwise, false.
TabIndex Integer 0 1..1

The index of the tab.
ThemeClass String blank 1..1

The theme class.
Underline Boolean false 1..1

True if use custom validation; otherwise, false.
UniqueId String GUID 1..1

The unique id. For more information see "Guid Structure" on MSDN/
UseCustomValidation Boolean false 1..1

True if use custom validation; otherwise, false.
ValuePrefix Integer blank 1..1

The number of decimal places.
ValueSuffix Integer blank 1..1

The number of decimal places.
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.

Example

The following example contains an example of the complex element.



<d2p1:FormControlProperties i:type="d2p1:CalculationFormControlProperties">
    <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>Calculated Value</d2p1:DisplayName>
    <d2p1:FormControlTypeUniqueId>c0a89c70-0781-4bd4-8623-f73675005e17</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>3c1404b7-ae25-4b40-b4c0-ffd14fcc766a</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:ApplyFormatInEditMode>false</d2p1:ApplyFormatInEditMode>
    <d2p1:ConvertEmptyStringToNull>false</d2p1:ConvertEmptyStringToNull>
    <d2p1:DataFormatString></d2p1:DataFormatString>
    <d2p1:HtmlEncodeFormatString>false</d2p1:HtmlEncodeFormatString>
    <d2p1:NullDisplayText i:nil="true" />
    <d2p1:DataType>String</d2p1:DataType>
    <d2p1:Decimals>0</d2p1:Decimals>
    <d2p1:Formula i:nil="true" />
    <d2p1:RecalculateOnEdit>true</d2p1:RecalculateOnEdit>
    <d2p1:RecalculateOnNew>true</d2p1:RecalculateOnNew>
    <d2p1:RecalculateOnView>false</d2p1:RecalculateOnView>
    <d2p1:ShowAsPercent>false</d2p1:ShowAsPercent>
    <d2p1:ShowThousandSeparator>false</d2p1:ShowThousandSeparator>
    <d2p1:ValuePrefix i:nil="true" />
    <d2p1:ValueSuffix i:nil="true" />
</d2p1:FormControlProperties>

Related information

Form XML Complex Elements