Parameter 要素 (WorkflowConfig)Parameter Element (WorkflowConfig)

適用されます: SharePoint 2016 |SharePoint Foundation 2013 |SharePoint オンライン |SharePoint Server 2013Applies to: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

ワークフロー開始フォームの単一パラメータを表します。Represents a single parameter for the workflow initiation form.

定義Definition

<Parameter 
  Name="Text" 
  Type="Text" 
/>

要素と属性Elements and attributes

以下のセクションで、属性、子要素、親要素について説明します。The following sections describe attributes, child elements, and parent elements.

属性Attributes

属性Attribute

説明Description

NameName

テキストが必要です。Required Text. パラメーターの名前を指定します。Specifies the name of the parameter. Name 属性の値は、対応するフィールド要素の Name 属性と同じである必要があります。The Name attribute value must be the same as the Name attribute of the corresponding Field element.

Name 属性の値も、パラメータのワークフロー変数の名前と同じである必要があります。The Name attribute value is also the same as the name of the workflow variable that represents the parameter.

TypeType

パラメータの System データ型。The System data type of the parameter.

子要素Child elements

なしNone

親要素Parent elements

パラメーター要素 (WorkflowConfig)Parameters Element (WorkflowConfig)

注釈Remarks

フィールド要素 (WorkflowConfig) に含まれる各Field 要素 (フィールド)要素は、必要があります、対応するパラメーター (WorkflowConfig)要素、パラメーター要素 (WorkflowConfig)要素では、一致する名前の属性を持つ。For each Field Element (Field) element contained in the Fields Element (WorkflowConfig) element, there must be a corresponding Parameter Element (WorkflowConfig) element, in the Parameters Element (WorkflowConfig) element, with a matching Name attribute. パラメーター要素 (WorkflowConfig) は、フィールドのシステム データ型を指定します。The Parameter Element (WorkflowConfig) element specifies the System data type of the field.

フィールド要素 (WorkflowConfig) には、 Field 要素 (フィールド)の要素のコレクションが含まれています。The Fields Element (WorkflowConfig) element contains a collection of Field Element (Field) elements. Field 要素 (フィールド)の各要素は、ワークフローの開始フォームのデータ フィールドを表します。Each Field Element (Field) element represents a data field on the workflow initiation form.

パラメーター要素 (WorkflowConfig) は、また、同じ名前のワークフロー変数を表します。The Parameter Element (WorkflowConfig) element also represents a workflow variable of the same name. ユーザーは、ワークフローの開始フォームを送信するときに SharePoint Foundation には、 InitiationDataプロパティの一部としてワークフロー インスタンスには、各パラメーターに指定された値が渡されます。When the user submits the workflow initiation form, SharePoint Foundation passes the value specified for each parameter to the workflow instance as part of the InitiationData property.

開始要素 (WorkflowConfig)の要素の URL 属性を使用すると、ワークフローのワークフローの開始フォームへのパスを指定します。Use the URL attribute of the Initiation Element (WorkflowConfig)element to specify the path to the workflow initiation form for the workflow.

Example

次の例では、このワークフローで使用するワークフロー開始フォームの場所を示す URL 属性を Initiation 要素に指定しています。 The following example Initiation element contains a URL attribute that specifies the location of the workflow initiation form to use for this workflow.

Initiation 要素には Fields 要素も含まれ、Fields 要素には開始フォーム上の 1 つのデータ フィールドを定義する Field 要素が含まれます。Parameters 要素には対応する Parameter 要素が含まれ、これに一致する Name 属性は Field 要素のデータ型を指定します。The element also contains a Fields element, which in turn contains a Field element that defines the single data field on the initiation form. Note that the Parameters element contains a corresponding Parameter element, with a matching Name attribute value, that specifies the data type of the Field element.

この例は見やすいように編集されています。This example has been edited for clarity.

    <Initiation 
        URL="Workflows/Notify Me/Notify Me.aspx">
      <Fields>
        <Field 
          Name="Reason_for_Review" 
          …
          DisplayName="Reason for Review" 
          …
        >
          <Default>Standard review of new documents</Default>
        </Field>
      </Fields>
      <Parameters>
        <Parameter Name="Reason_for_Review" Type="System.String" />
      </Parameters>
    </Initiation>

関連項目See also