SPWorkflowAssociation.CreateListAssociation Method
Creates a workflow association that can then be added to a list.
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online
Syntax
Visual Basic (Declaration)
Public Shared Function CreateListAssociation ( _ baseTemplate As SPWorkflowTemplate, _ name As String, _ taskList As SPList, _ historyList As SPList _ ) As SPWorkflowAssociation
Visual Basic (Usage)
Dim baseTemplate As SPWorkflowTemplate Dim name As String Dim taskList As SPList Dim historyList As SPList Dim returnValue As SPWorkflowAssociation returnValue = SPWorkflowAssociation.CreateListAssociation(baseTemplate, _ name, taskList, historyList)
C#
public static SPWorkflowAssociation CreateListAssociation( SPWorkflowTemplate baseTemplate, string name, SPList taskList, SPList historyList )
Parameters
- baseTemplate
- Type: Microsoft.SharePoint.Workflow.SPWorkflowTemplate
The workflow template on which to base this workflow association.
- name
- Type: System.String
The name to give this workflow association.
- taskList
- Type: Microsoft.SharePoint.SPList
The task list on which to create workflow tasks for this workflow association.
- historyList
- Type: Microsoft.SharePoint.SPList
The list to which to log workflow history events.
Return Value
Type: Microsoft.SharePoint.Workflow.SPWorkflowAssociationAn SPWorkflowAssociation that represents the workflow association.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException |
The argument passed to the baseTemplate parameter is Nothing; or the argument to the name parameter is Nothing; or the template requires a task list (the default) and the argument to the taskList parameter is Nothing; or the template requires a history list (the default) and the argument to the historyList parameter is Nothing. |
| ArgumentException |
The string passed to the name parameter contains only spaces or tabs. |
Remarks
To associate a workflow template with a list or document library, use the AddWorkflowAssociation method of the SPList object. This method takes an SPWorkflowAssociation object and adds it to the specified list.
See Also