FieldBind element

Article
06/29/2022

(ruleDesignerType complexType) (Action4)

Applies to: SharePoint Server 2013

The FieldBind element is a child of the RuleDesigner element. Used together, these elements create a readable sentence that describes a condition that needs to be evaluated or an activity that must be executed. These elements can also be used to insert variables (such as hyperlinks) within the sentence, so that the visual workflow designer can substitute dynamic values into a workflow while it is running. The FieldBind element maps the inputs from the workflow creator to parameters that are then passed to SharePoint Foundation. Note that using custom designer types or custom field types is not supported when creating workflows using SharePoint Designer.

Usage

    <RuleDesigner>
        <FieldBind>
            <Option />
            <DataSourceRef />
        </FieldBind>
    </RuleDesigner>

Element information

Element type
Namespace
Schema file	Actions4.xsd

Definition

    <xs:element name="FieldBind" minOccurs="0" maxOccurs="unbounded">
               <xs:complexType>
               <xs:choice>
         <xs:element name="Option" minOccurs="0" maxOccurs="unbounded">
         <xs:attribute name="Name" type="s:string" use="required" />
         <xs:attribute name="Value" type="s:string" use="required" />
         <xs:attribute name="TypeFilter" type="s:string" />
         <xs:attribute name="UnaryHides" type="s:string" />
      </xs:element>
         <xs:element name="DataSourceRef" minOccurs="1" maxOccurs="unbounded">
         <xs:attribute name="Ref" type="s:string" />
      </xs:element>
           </xs:choice>
         <xs:attribute name="Field"   type="s:string" />
         <xs:attribute name="Text"   type="s:string"  />
         <xs:attribute name="Id" type="s:positiveInteger"  use="required"  />
         <xs:attribute name="DesignerType" type="s:string" use="required"  />
         <xs:attribute name="OperatorTypeFrom" type="s:string" />
         <xs:attribute name="TypeFrom"   type="s:string"  />
         <xs:attribute name="Function"   type="s:boolean" />
         <xs:attribute name="Value"   type="s:string" />
         <xs:attribute name="EventCategory"   type="s:string" />
         <xs:attribute name="DisplayName"   type="s:string" />
           </xs:complexType>
    </xs:element>

Elements and attributes

If the schema defines specific requirements, such as sequence, minOccurs, maxOccurs, and choice, see the definition section.

Parent elements

Element	Type	Description
RuleDesigner	ruleDesignerType
RuleDesigner	ruleDesignerType
RuleDesigner	ruleDesignerType
RuleDesigner	ruleDesignerType
RuleDesigner	ruleDesignerType

Child elements

Element	Type	Description
DataSourceRef
Option

Attributes

Attribute	Type	Required	Description	Possible values
DesignerType	s:string	required	Specifies the type of control or user input that is presented in the workflow editor user interface. If you do not specify a DesignerType attribute, the default is used. The default DesignerType is a text box followed by an ellipsis button (...) and a lookup button.	Values of the s:string type.
DisplayName	s:string	optional	The name of the designer type as rendered in the user interface.	Values of the s:string type.
EventCategory	s:string	optional	The category associated with the event; for example, ListItemEvent or ProjectEvent.	Values of the s:string type.
Field	s:string	optional	Represents a Parameter element that is used to build a workflow. The Field attribute maps directly to one or more Parameter elements when a parameter type and direction are defined. If you use more than one parameter for a given Field attribute, separate the parameter by using commas (for example, Field="Variable,ValueType").	Values of the s:string type.
Function	s:boolean	optional	When set to true, this attribute inserts the name of the associate Action method into the sentence.	Values of the s:boolean type.
Id	s:positiveInteger	required	An integer that serves as a relational key to associate a FieldBind element with the Sentence property of the parent RuleDesigner element.	Values of the s:positiveInteger type.
OperatorTypeFrom	s:string	optional	Specifies the types of operators that are available to the user, based on the Microsoft .NET data type listed in the corresponding Parameter element. The parameter that is specified for the OperatorTypeFrom attribute can be different from the parameter that is listed in the Field attribute. Note: This attribute is used only when the DesignerType attribute is set to Operator.	Values of the s:string type.
Text	s:string	optional	Text displayed to the user as a hyperlink in the condition sentence.	Values of the s:string type.
TypeFrom	s:string	optional	Specifies the .NET data types that are valid for use with an instance of the FieldBind element. This attribute is associated with the Parameter element that contains the type definition.	Values of the s:string type.
Value	s:string	optional	Reserved for future use.	Values of the s:string type.

Share via