Partager via


SPContentType.WorkflowAssociations - Propriété

Obtient un objet SPWorkflowAssociationCollection qui représente les associations de flux de travail pour ce type de contenu.

Espace de noms :  Microsoft.SharePoint
Assembly :  Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Public ReadOnly Property WorkflowAssociations As SPWorkflowAssociationCollection
    Get
'Utilisation
Dim instance As SPContentType
Dim value As SPWorkflowAssociationCollection

value = instance.WorkflowAssociations
public SPWorkflowAssociationCollection WorkflowAssociations { get; }

Valeur de propriété

Type : Microsoft.SharePoint.Workflow.SPWorkflowAssociationCollection
La collection de flux de travail associé au type de contenu.

Remarques

La propriété WorkflowAssociations retourne un objet SPWorkflowAssociationCollection avec une collection du type de contenu des associations de flux de travail. Vous pouvez récupérer une association à partir de la collection à l'aide de la valeur de la propriété Id en tant qu'indexeur ou en passant le nom de l'association flux de travail à la méthode GetAssociationByName .

Chaque association de flux de travail dans une collection doit avoir une valeur unique dans la propriété Name . Lorsque vous ajoutez une nouvelle association de flux de travail, vous devez le tester pour voir si une flux de travail association portant ce nom existe déjà dans la collection. Si l'association de flux de travail est déjà un membre de la collection et que vous souhaitez mettre à jour l'association existante, appelez la méthode Update à la place.

Vous pouvez tester l'existence d'une association de flux de travail dans une collection du type de contenu en appelant la méthode GetAssociationByName . Si la valeur de retour de cette méthode n'est pas une référence Null (Rien dans Visual Basic), l'association est déjà dans la collection. L'exemple suivant illustre cette technique.

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);
}

Exemples

L'exemple suivant est une application console qui crée une association de flux de travail et l'ajoute à la collection du type de contenu de site des associations de flux de travail puis propage la modification aux enfants du type de contenu.

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();
        }
    }
}

L'exemple suivant est une application console qui supprime l'association de flux de travail qui est créée par l'exemple précédent.

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();
        }
    }
}

Voir aussi

Référence

SPContentType classe

SPContentType - Membres

Microsoft.SharePoint - Espace de noms

Add(SPWorkflowAssociation)

Remove(SPWorkflowAssociation)

Autres ressources

Introduction to Workflows in Windows SharePoint Services