WebServiceFormControlProperties Type

The Web Request control allows you to call REST services using the GET and POST methods, as well as create SOAP envelopes.

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

Syntax


<d2p1:FormControlProperties xmlns:d3p1="http://schemas.datacontract.org/2004/07/Nintex.Forms.SharePoint.FormControls" i:type="d3p1:WebServiceFormControlProperties">
      <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>Web Request</d2p1:DisplayName>
      <d2p1:FormControlTypeUniqueId>aeada2b6-24ad-46e2-894f-562c2a01d38a</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>b212c61d-ef93-4c54-bc83-87169803996b</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>
      <d3p1:CascadeFilterField i:nil="true" />
      <d3p1:CascadeFilterType>None</d3p1:CascadeFilterType>
      <d3p1:CascadeFilterValue i:nil="true" />
      <d3p1:ContentType i:nil="true" />
      <d3p1:CustomHeaders i:nil="true" />
      <d3p1:CustomPleaseSelectText i:nil="true" />
      <d3p1:DataFieldId i:nil="true" />
      <d3p1:DataFieldText i:nil="true" />
      <d3p1:DisplayFormat>DropDownList</d3p1:DisplayFormat>
      <d3p1:ExecuteInEditMode>true</d3p1:ExecuteInEditMode>
      <d3p1:ExecuteInNewMode>true</d3p1:ExecuteInNewMode>
      <d3p1:ExecuteInViewMode>false</d3p1:ExecuteInViewMode>
      <d3p1:FilterOperatorValue>Equals</d3p1:FilterOperatorValue>
      <d3p1:MethodName i:nil="true" />
      <d2p1:ParameterInfo i:nil="true" />
      <d2p1:ParameterType i:nil="true" />
      <d2p1:RequestBody i:nil="true" />
      <d2p1:RequestMethod>GET</d2p1:RequestMethod>
      <d2p1:RequestTimeout>10</d2p1:RequestTimeout>
      <d2p1:SecureStoreTargetApplicationId i:nil="true" />
      <d2p1:ServiceURL i:nil="true" />
      <d2p1:TypeOfAuthentication>Anonymous</d2p1:TypeOfAuthentication>
      <d2p1:UseCustomPleaseSelectText>false</d2p1:UseCustomPleaseSelectText>
      <d2p1:ValidateDataMismatch>Yes</d2p1:ValidateDataMismatch>
      <d2p1:XPathForId i:nil="true" />
      <d2p1:XPathForValue 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

d3p1

 

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 Web Request 1..1

The display name.
FormControlTypeUniqueId String aeada2b6-24ad-46e2-894f-562c2a01d38a 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 Elemen 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 Unspecified 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 blank 1..1

The binding path field name.
DataFieldDisplayName String blank 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 false 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.
CascadeFilterField String blank 1..1 The cascade filter field.
CascadeFilterType String blank 1..1

The type of the cascade. Valid values include:

  • Control
  • None
  • Value
CascadeFilterValue String blank 1..1 The cascade filter value.
ContentType String blank 1..1 The content-type header of the request
CustomHeaders String blank 1..1 A string of Headers for the request, separated by line breaks.
CustomPleaseSelectText String blank 1..1 The custom text to use as the first item in the drop-down list.
DataFieldId String blank 1..1
DataFieldText String blank 1..1
DisplayFormat String DropDownList 1..1
ExecuteInEditMode String true 1..1
ExecuteInNewMode String true 1..1
ExecuteInViewMode String false 1..1
FilterOperatorValue String Equals 1..1
MethodName String blank 1..1
ParameterInfo String blank 1..1
ParameterInfo String blank 1..1 The name of the parameter.
ParameterType String blank 1..1 The datatype of the parameter.
RequestBody String blank 1..1 The request body.
RequestMethod String GET 1..1 The request method.
RequestTimeout String 10 1..1 Length of time (seconds)before the request times out.
SecureStoreTargetApplicationId String blank 1..1 a localized string similar to ID of target application in SharePoint Secure Store service containing credentials.
ServiceURL String blank 1..1 The URL that contains the end points.
TypeOfAuthentication String Anonymous 1..1

Valid values allowed:

  • Anonymous
  • SqlAuthentication
  • WindowsAuthentication
UseCustomPleaseSelectText Boolean false 1..1 True if to use custom please select text; otherwise, false
ValidateDataMismatch String Yes 1..1 Yes if valid data mismatch allowed; otherwise No.
XPathForId String blank 1..1 Localized string similar to XPath for ID.
XPathForValue String blank 1..1 Localized string similar to XPath for value.

Example

The following example contains an example of the complex element.



<d2p1:FormControlProperties xmlns:d3p1="http://schemas.datacontract.org/2004/07/Nintex.Forms.SharePoint.FormControls" i:type="d3p1:WebServiceFormControlProperties">
      <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>Web Request</d2p1:DisplayName>
      <d2p1:FormControlTypeUniqueId>aeada2b6-24ad-46e2-894f-562c2a01d38a</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>b212c61d-ef93-4c54-bc83-87169803996b</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>
      <d3p1:CascadeFilterField i:nil="true" />
      <d3p1:CascadeFilterType>None</d3p1:CascadeFilterType>
      <d3p1:CascadeFilterValue i:nil="true" />
      <d3p1:ContentType i:nil="true" />
      <d3p1:CustomHeaders i:nil="true" />
      <d3p1:CustomPleaseSelectText i:nil="true" />
      <d3p1:DataFieldId i:nil="true" />
      <d3p1:DataFieldText i:nil="true" />
      <d3p1:DisplayFormat>DropDownList</d3p1:DisplayFormat>
      <d3p1:ExecuteInEditMode>true</d3p1:ExecuteInEditMode>
      <d3p1:ExecuteInNewMode>true</d3p1:ExecuteInNewMode>
      <d3p1:ExecuteInViewMode>false</d3p1:ExecuteInViewMode>
      <d3p1:FilterOperatorValue>Equals</d3p1:FilterOperatorValue>
      <d3p1:MethodName i:nil="true" />
      <d2p1:ParameterInfo i:nil="true" />
      <d2p1:ParameterType i:nil="true" />
      <d2p1:RequestBody i:nil="true" />
      <d2p1:RequestMethod>GET</d2p1:RequestMethod>
      <d2p1:RequestTimeout>10</d2p1:RequestTimeout>
      <d2p1:SecureStoreTargetApplicationId i:nil="true" />
      <d2p1:ServiceURL i:nil="true" />
      <d2p1:TypeOfAuthentication>Anonymous</d2p1:TypeOfAuthentication>
      <d2p1:UseCustomPleaseSelectText>false</d2p1:UseCustomPleaseSelectText>
      <d2p1:ValidateDataMismatch>Yes</d2p1:ValidateDataMismatch>
      <d2p1:XPathForId i:nil="true" />
      <d2p1:XPathForValue i:nil="true" />
</d2p1:FormControlProperties>

Related information

Form XML Complex Elements