Edit

Parameter Element (WorkflowInfo)

  • Article

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

Used to describe the input and output parameters for a custom Actions or Conditions method call.

Definition

<Conditions>
  <Condition>
        <Parameters>
      <Parameter />
        </Parameter>
  </Condition>
</Conditions>
<Actions>
  <Action>
    <Parameters>
      <Parameter />
    </Parameters
  </Action>
</Actions>

Elements and attributes

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

Attributes

Attribute

Description

**Type**

Required **String**. Partially qualified Microsoft .NET data type. Values are not case-sensitive.

**Example**:

System.Object, mscorlib

**Direction**

Optional **text**. Specifies an input or output parameter. Valid values are **In**, **Out**, and **Optional**. Values are not case-sensitive.

**Name**

Required **text**. Used to associate the **FieldBind** element with the parameter. Values are not case-sensitive.

**InitialValue**

Optional **text**. Used to specify the default initial value that is passed to the parameter. Values are not case-sensitive.

**InitialBinding**

Optional **text**. Specifies the default variable to use for the parameter when creating a new condition or action that contains the parameter.

**Description**

Optional **text**. Specifies the text to display when the parameter is selected in a grid matching parameters names with current values.

**DesignerType**

Optional **text**. Specifies the possible interface elements to use when editing the value of a parameter.

**ShowLookupForDropdown**

Optional **Boolean**. Specifies that a lookup button is displayed for a drop-down list.

**DisplayName**

Optional **text**.Specifies the name to display when showing the parameter in a grid structure matching names of parameters with their current values.

DesignerType attribute

DesignerType

Parameters

UI Element

Text

TextBox

Dependent

String

Single-line text box.

ContentType

Content type identifier

Dialog box for creating or updating a content type.

DataSourceFieldNames

Single parameter

List that contains options retrieved from the ancestor Action or CompositeStep element with a DataSource element that matches the child DataSourceRef element. The result of selecting an element from this list should be the literal value selected.

DataSourceValues

Single parameter

List that contains options retrieved from the ancestor Action or CompositeStep element with a DataSource element that matches the child DataSourceRef element. The result of selecting an element from this list should be the run-time value of the selected field in the data source.

Date

Date/Time

Text box that accepts dates and times.

Dropdown

Single parameter

List that contains options specified as Option child elements of the FieldBind element.

FieldNames

Field

List of all fields in the list or document library with which the workflow is associated.

Hide

None

The client hides the value.

Integer

Int

Text box that accepts an integer.

ItemProperties

Hash table

Dialog box for setting a hash table of name-value pairs.

ListItem

List identifier

List item identifier

Dialog box for selecting a list item.

ListNames

List identifier

List of lists in the current site.

ParameterNames

Name

List that contains the names of variables that are defined in the current workflow.

Person

List of people

Dialog box for selecting accounts on the current site.

SinglePerson

Person

Dialog box for selecting a single account on the current site.

StatusDropdown

Status value

Dropdown list that enables entering a new status value or reusing an existing value.

StringBuilder

String

Single-line text box.

TextArea

String

Text box.

WritableFieldNames

List of names

List that contains all fields in the list or document library with which the workflow is associated that are not read-only, or a list of all document libraries on the current site that are not read-only, depending on the context.

Child elements

None

Parent elements

Parameters

Example

The following example demonstrates how to construct a Parameter element so that the workflow engine can interact with the assembly code.

    <WorkflowInfo>
       <Conditions>
          <Default>…</Default>
          <Condition>…
            <Parameters>
              <Parameter />
            </Parameters>
          </Condition>
       </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>

See also