SPContentType.WorkflowAssociations property
取得表示這個內容類型的工作流程關聯的SPWorkflowAssociationCollection物件。
Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'宣告
Public ReadOnly Property WorkflowAssociations As SPWorkflowAssociationCollection
Get
'用途
Dim instance As SPContentType
Dim value As SPWorkflowAssociationCollection
value = instance.WorkflowAssociations
public SPWorkflowAssociationCollection WorkflowAssociations { get; }
Property value
Type: Microsoft.SharePoint.Workflow.SPWorkflowAssociationCollection
內容類型相關聯的工作流程的集合。
備註
WorkflowAssociations屬性會傳回SPWorkflowAssociationCollection物件與工作流程關聯的內容類型的集合。使用作為索引子的Id屬性的值，或將工作流程關聯的名稱傳遞到GetAssociationByName方法，您可以從集合擷取關聯。
集合中每個工作流程關聯必須有唯一的值， Name屬性中。當您新增新的工作流程關聯時，您應該測試看看是否該名稱的工作流程關聯已經存在於集合中。如果您的工作流程關聯已經是集合的成員，而您想要更新現有的關聯，而是呼叫Update方法。
您可以藉由呼叫GetAssociationByName方法來測試的內容類型的集合中的工作流程關聯存在。如果該方法的傳回值不是a null reference (Nothing in Visual Basic)，然後關聯已在集合中。下列範例示範這項技巧。
If contentType.WorkflowAssociations.GetAssociationByName(workflowAssociation.Name, site.Locale) Is Nothing Then
contentType.WorkflowAssociations.Add(workflowAssociation)
Else
contentType.WorkflowAssociations.Update(workflowAssociation)
End If
if (contentType.WorkflowAssociations.GetAssociationByName(workflowAssociation.Name, site.Locale) == null)
{
contentType.WorkflowAssociations.Add(workflowAssociation);
}
else
{
contentType.WorkflowAssociations.Update(workflowAssociation);
}
Examples
下列範例是一個主控台應用程式，會建立工作流程關聯、 將它加入至工作流程關聯的站台內容類型的集合，然後再傳播至子系內容類型的變更。
Imports System
Imports Microsoft.SharePoint
Imports Microsoft.SharePoint.Workflow
Module ConsoleApp
Sub Main()
Console.WriteLine()
Dim siteCollection As SPSite = New SPSite("https://localhost")
Dim site As SPWeb = siteCollection.OpenWeb()
Dim siteContentType As SPContentType = site.ContentTypes("Test Document")
Dim taskListTitle As String = "Tasks"
Dim historyListTitle As String = "Workflow History"
Dim workflowName As String = "Red-Yellow-Green"
' Get a template.
Dim workflowTemplate As SPWorkflowTemplate = Nothing
For Each template As SPWorkflowTemplate In site.WorkflowTemplates
workflowTemplate = template
' We'll take a template everyone has
If workflowTemplate.Name = "Three-state" Then
Exit For
End If
Next template
' Create an association.
Dim workflowAssociation As SPWorkflowAssociation = _
SPWorkflowAssociation.CreateSiteContentTypeAssociation(workflowTemplate, _
workflowName, _
taskListTitle, _
historyListTitle)
' Add the association to the content type or update it if it already exists.
Console.Write("Workflow association {0} has been ", workflowAssociation.Name)
If siteContentType.WorkflowAssociations.GetAssociationByName(workflowAssociation.Name, site.Locale) Is Nothing Then
siteContentType.WorkflowAssociations.Add(workflowAssociation)
Console.WriteLine("added.")
Else
siteContentType.WorkflowAssociations.Update(workflowAssociation)
Console.WriteLine("updated.")
End If
' Propagate to children of this content type.
siteContentType.UpdateWorkflowAssociationsOnChildren(False, True, True, False)
' Clean up.
site.Dispose()
siteCollection.Dispose()
Console.WriteLine()
Console.Write("Press ENTER to continue...")
Console.ReadLine()
End Sub
End Module
using System;
using Microsoft.SharePoint;
using Microsoft.SharePoint.Workflow;
namespace Test
{
class ConsoleApp
{
static void Main(string[] args)
{
Console.WriteLine();
SPSite siteCollection = new SPSite("https://localhost");
SPWeb site = siteCollection.OpenWeb();
SPContentType siteContentType = site.ContentTypes["Test Document"];
string taskListTitle = "Tasks";
string historyListTitle = "Workflow History";
string workflowName = "Red-Yellow-Green";
// Get a template.
SPWorkflowTemplate workflowTemplate = null;
foreach (SPWorkflowTemplate template in site.WorkflowTemplates)
{
workflowTemplate = template;
// We'll take a template everyone has.
if (workflowTemplate.Name == "Three-state") break;
}
// Create an association.
SPWorkflowAssociation workflowAssociation =
SPWorkflowAssociation.CreateSiteContentTypeAssociation(workflowTemplate,
workflowName,
taskListTitle,
historyListTitle);
// Add the association to the content type or update it if it already exists.
Console.Write("Workflow association {0} has been ", workflowAssociation.Name);
if (siteContentType.WorkflowAssociations.GetAssociationByName(workflowAssociation.Name, site.Locale) == null)
{
siteContentType.WorkflowAssociations.Add(workflowAssociation);
Console.WriteLine("added.");
}
else
{
siteContentType.WorkflowAssociations.Update(workflowAssociation);
Console.WriteLine("updated.");
}
// Propagate to children of this content type.
siteContentType.UpdateWorkflowAssociationsOnChildren(false, // Do not generate full change list
true, // Push down to derived content types
true, // Push down to list content types
false); // Do not throw exception if sealed or readonly
site.Dispose();
siteCollection.Dispose();
Console.WriteLine();
Console.Write("Press ENTER to continue...");
Console.ReadLine();
}
}
}
下列範例會移除先前的範例所建立的工作流程關聯的主控台應用程式。
Imports System
Imports Microsoft.SharePoint
Imports Microsoft.SharePoint.Workflow
Module ConsoleApp
Sub Main()
Dim site As SPSite = New SPSite("https://localhost")
Try
Dim web As SPWeb = site.OpenWeb()
Try
Dim ctName As String = "Test Document"
Dim wfName As String = "Red-Yellow-Green"
Dim contentType As SPContentType = web.ContentTypes(ctName)
If Not contentType Is Nothing Then
Dim wfAssociation As SPWorkflowAssociation = _
contentType.WorkflowAssociations.GetAssociationByName(wfName, web.Locale)
If Not wfAssociation Is Nothing Then
' Remove the workflow association.
contentType.WorkflowAssociations.Remove(wfAssociation)
Console.WriteLine("The association with {0} workflow has been removed.", wfAssociation.Name)
Else
Console.WriteLine("An association with {0} workflow was not found.", wfName)
End If
Else
Console.WriteLine("Content type {0} does not exist.", ctName)
End If
Finally
web.Dispose()
End Try
Finally
site.Dispose()
End Try
Console.Write(vbCrLf + "Press ENTER to continue...")
Console.ReadLine()
End Sub
End Module
using System;
using Microsoft.SharePoint;
using Microsoft.SharePoint.Workflow;
namespace Test
{
class ConsoleApp
{
static void Main(string[] args)
{
using (SPSite site = new SPSite("https://localhost"))
{
using (SPWeb web = site.OpenWeb())
{
string ctName = "Test Document";
string wfName = "Red-Yellow-Green";
SPContentType contentType = web.ContentTypes[ctName];
if (null != contentType)
{
SPWorkflowAssociation wfAssociation =
contentType.WorkflowAssociations.GetAssociationByName(wfName, web.Locale);
if (null != wfAssociation)
{
// Remove the workflow association.
contentType.WorkflowAssociations.Remove(wfAssociation);
Console.WriteLine("The association with {0} workflow has been removed.", wfAssociation.Name);
}
else
{
Console.WriteLine("An association with {0} workflow was not found.", wfName);
}
}
else
{
Console.WriteLine("Content type {0} does not exist.", ctName);
}
}
}
Console.Write("\nPress ENTER to continue...");
Console.ReadLine();
}
}
}
請參閱
參照
Microsoft.SharePoint namespace