FieldBind Element (WorkflowActions)
This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
The FieldBind element is a child of the RuleDesigner element. These elements are used together to create a readable sentence that describes a condition that needs to be evaluated or an activity that must be executed. When constructed properly, these elements can also be used to insert variables (such as hyperlinks) within the sentence, so that the code-free workflow editor can substitute dynamic values into the workflow while it is running. The FieldBind element maps the inputs from the workflow creator to parameters that are then passed to Windows SharePoint Services 3.0.
<RuleDesigner>
<FieldBind>
<Option />
</FieldBind>
</RuleDesigner>
Attributes
Attribute |
Description |
|---|---|
DesignerType |
Required text. Specifies the type of control or user input that is presented to the workflow creator when building sentences in the workflow editor. .gif "Note") Note
If you do not specify a DesignerType, the default DesignerType attribute is used. The default DesignerType is a text box followed by an ellipses button and a lookup button.
Note
A code-free workflow editor should treat the values returned to it from the server as case-insensitive.
|
Field |
Required text. Represents a Parameter element used to build workflows. The Field attribute maps directly to one or more Parameter elements when a parameter type and direction are defined. Note
If you use more than one parameter for a Field attribute, the parameter names should be separated by commas (for example, Field="Variable,ValueType").
|
Function |
Optional Boolean. When set to true, this attribute inserts the name of the Action method into the sentence. |
Id |
Required Integer (non-negative). Id is used as the relational key between a FieldBind element and the Sentence property of the parent RuleDesigner element, much like a primary key is used in a database. |
OperatorTypeFrom |
Required text. Used only when DesignerType attribute is set to Operator. This attribute determines the types of operators that are available to the user, based on the .NET data type listed in the corresponding Parameter element. The parameter specified for the OperatorTypeFrom attribute can be different from the parameter listed in the Field attribute. |
Text |
Required text. Text displayed to the user as a hyperlink in the condition sentence. |
TypeFrom |
Optional text. Specifies the .NET data types that are valid for use with an instance of the FieldBind element. The TypeFrom attribute is associated with a Parameter element that contains the type definition. |
Value |
Reserved for future use. |
DesignerType Attribute
Value |
Data Bound |
Default Builder |
Show Drop-down |
Advanced Builder |
Control Description |
|---|---|---|---|---|---|
Boolean |
Yes |
No |
Yes |
No |
Drop-down list box with the choices true and false populated. |
ChooseDoclibItem |
No |
No |
No |
Yes |
Document library item selector. |
ChooseListItem |
No |
No |
No |
Yes |
Default. |
CreateListItem |
No |
No |
No |
Yes |
Default. |
Date |
Yes |
Yes |
No |
No |
Date/Time selector. |
Dropdown |
No |
No |
Yes |
No |
Drop-down list box control. Static items can be populated by adding Option elements. |
No |
No |
No |
Yes |
E-mail advanced control. The form displays standard e-mail fields including To, From, CC, Subject and Body. |
|
FieldNames |
No |
No |
Yes |
No |
Drop-down list box control populated with all field names in the current list or document library. |
Float |
Yes |
No |
No |
No |
Text box. Allows entry of floating point values. |
Hyperlink |
Yes |
Yes |
No |
No |
URL browser. Select local or remote resources using a standard link builder. |
Integer |
Yes |
No |
No |
No |
Text box. Accepts non-negative integer values. |
ListNames |
No |
No |
Yes |
No |
Drop-down list box control populated with all lists in the current Web site. |
Operator |
No |
No |
Yes |
No |
Drop-down list box control that includes operators used to evaluate each side of the RuleDesigner sentence. Operators are static and must be added in Options elements. |
ParameterNames |
No |
No |
Yes |
No |
Drop-down list box populated with all local variables that have been entered for use by the workflow. |
Person |
Yes |
Yes |
No |
No |
Person or Group selector. You can choose only one person or group from either built-in, local users or groups or users and groups from a domain. |
SinglePerson |
Yes |
Yes |
No |
No |
Person or Group selector. You choose only one person or group from either built-in, local users or groups or users and groups from a domain. |
Stringbuilder |
No |
No |
No |
Yes |
Inline text box editor. Use to create simple strings. |
Survey |
No |
No |
No |
Yes |
Default. |
Text |
Yes |
No |
No |
No |
Default. |
TextArea |
Yes |
Yes |
No |
No |
Default. |
UpdateListItem |
No |
No |
No |
Yes |
Default. |
writablefieldNames |
No |
No |
Yes |
No |
Drop-down list box populated either with a list of fields in the current list or a list of document libraries that are editable. All other fields are hidden. |
Properties of DesignerTypes
Property |
Description |
|---|---|
Data Bound |
Control that can be data bound to a SharePoint list or document library item. |
Default Builder |
Displays a button with ellipses. Depending on the DesignerType, this property opens either a Date/Time or Text Editor dialog box. |
Show Dropdown |
Displays a control for a drop-down list box. Depending on the DesignerType, the values may be populated. You can add Options elements to any Show DropDown controls that are not already populated. |
Advanced Builder |
Displays advanced builders based on the DesignerType. Advanced DesignerTypes can have multiple properties. For example, the e-mail advanced builder allows entry of To, From, CC, Subject and Body fields. |
Child Elements
Parent Elements
Example
The following example demonstrates how to construct the FieldBind element within the RuleDesigner parent element so that it displays correctly in the workflow designer.
<RuleDesigner Sentence="%1">
<FieldBind Field="MyParameter1"
Text="text" Id="1"
DesignerType="Dropdown"
TypeFrom="MyParameter1">
<Option Name="Display Name" Value="Display Value"/>
</FieldBind>
</RuleDesigner>