RuleDesigner Element (WorkflowInfo)

Article
06/29/2022

Applies to: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Complex type element that contains information that is needed to render a workflow sentence in a declarative, code-free workflow editor, such as Microsoft SharePoint Designer 2010.

Definition

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

Elements and attributes

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute	Description
Sentence	Required text. Text displayed in the workflow editor that represents the workflow rule. The rule sentence can contain static text and also text that is dynamically generated at run time. Variables can be embedded into the sentence using the notation %1, %2, and so on. Each variable maps to a FieldBind element Id. Then, during workflow design, the text that is displayed for these variables is the Text attribute of the FieldBind element.

**Sentence**

Required **text**. Text displayed in the workflow editor that represents the workflow rule. The rule sentence can contain static text and also text that is dynamically generated at run time.

Variables can be embedded into the sentence using the notation %1, %2, and so on. Each variable maps to a **FieldBind** element **Id**. Then, during workflow design, the text that is displayed for these variables is the **Text** attribute of the **FieldBind** element.

Child elements

FieldBind

Parent elements

Default

Condition

Action

Example

The following XML demonstrates how to construct a RuleDesigner element so that it can be displayed in a code-free workflow editor.

    <WorkflowInfo>
      <Conditions>…</Conditions>
      <Actions Sequential="then" Parallel="and">
        <Action Name="Update my custom SharePoint list"
                ClassName="CustomActivities.OrderListFunctions"
                Assembly="CustomActivities"
                Category="My Custom Actions"
                CreatesTask="true"
                CreatesInList="UpdateList"
                AppliesTo="all"
                ListModeration="false"
                UsesCurrentItem="true">
          <RuleDesigner Sentence="Update %1">
            <FieldBind Field="UpdateList"
                       Function="UpdateOrderList"
                       DesignerType="ChooseListItem"
                       ID="1"
                       Text="My Custom List">
            </FieldBind>
          </RuleDesigner>
          <Parameters>
            <Parameter Type="System.String, mscorlib"
                       Direction="In"
                       Name="UpdateList" />
          </Parameters>
        </Action>
      </Actions>
    </WorkflowInfo>