Übersicht über das Objektmodell für Workflows in SharePoint-Foundation
Letzte Änderung: Donnerstag, 15. April 2010
Gilt für: SharePoint Foundation 2010
Nachdem Sie Ihre Workflowlösung bereitgestellt haben, können Sie mithilfe des Microsoft SharePoint Foundation-Objektmodells Workflowprozesse abfragen und Workflowaktionen programmgesteuert ausführen, z. B. Hinzufügen eines Workflows zu einer Liste oder Starten eines Workflows für ein Element.
Microsoft.SharePoint.Workflow-Hauptobjekte
Der Microsoft.SharePoint.Workflow-Namespace stellt die Workflowfunktion in SharePoint Foundation dar.
Das SPWorkflowTemplateCollection-Objekt stellt die Workflowvorlagen dar, die gegenwärtig für eine Website bereitgestellt sind. Jedes SPWorkflowTemplate-Objekt stellt eine Webvorlage dar und enthält Eigenschaften, über die Sie Informationen zur Vorlage abrufen oder festlegen können, z. B. die Instanziierungsdaten sowie die Verlaufs- und Aufgabenlisten der Vorlage.
Verwenden Sie zum Zuordnen eines Workflows zu einer Liste oder Dokumentbibliothek die AddWorkflowAssociation-Methode des SPList-Objekts. Verwenden Sie zum Zuordnen eines Workflows zu einem Inhaltstyp die AddWorkflowAssociation-Methode des SPContentType-Objekts. Die beiden Methoden verwenden ein SPWorkflowAssociation-Objekt und fügen es der angegebenen Liste bzw. dem angegebenen Listentyp hinzu. Verwenden Sie zum Erstellen der entsprechenden Workflowzuordnung die Methode CreateListAssociation, CreateListContentTypeAssociation oder CreateSiteContentTypeAssociation des SPWorkflowAssociation-Objekts selbst.
Wie beim Hinzufügen eines Workflows über die Benutzeroberfläche wird beim programmgesteuerten Zuordnen eines Workflows der Liste eine Statusspalte für den Workflow hinzugefügt.
Verwenden Sie die RemoveWorkflowAssociation-Methode zum Entfernen einer Workflowzuordnung von einer Liste bzw. die RemoveWorkflowAssociation-Methode zum Entfernen einer Workflowzuordnung von einer Website oder einem Listeninhaltstyp.
Jedes SPWorkflowAssociation-Objekt stellt eine Webvorlage dar, die einer bestimmten Liste oder einem bestimmten Inhaltstyp zugeordnet ist, und Eigenschaften enthält, die benutzerdefinierte Informationen zur Zuordnung des jeweiligen Workflows zu einer bestimmten Liste oder einem bestimmten Inhaltstyp enthält. Diese Informationen geben den Aktivierungsstatus des Workflows, den Startmodus (automatisch oder manuell) und den Listen- oder Inhaltstyp an, dem der Workflow zugeordnet ist.
Die SPWorkflowCollection-Auflistung stellt die Workflowinstanzen dar, die für ein angegebenes Listenelement ausgeführt wurden bzw. aktuell ausgeführt werden. Jedes SPWorkflow-Objekt enthält Eigenschaften, die Informationen zur Workflowinstanz zurückgeben, z. B. den Abschlussstatus, den internen Status und die Verlaufsliste des Workflows. Darüber hinaus enthält jeder Workflow eine Auflistung der Workflowaufgaben (SPWorkflowTaskCollection.)
Verwenden Sie die Workflows-Eigenschaft zum Zurückgeben eines SPWorkflowCollection-Objekts, das die Workflows darstellt, die für das jeweilige Listenelement ausgeführt werden.
Programmgesteuertes Verwalten der Ausführung von Workflowinstanzen
Benutzer interagieren mit den Workflows, die für einzelne Elemente ausgeführt werden, über die SharePoint Foundation-Benutzeroberfläche. Doch SharePoint Foundation bietet über das Objektmodell Funktionalität zum zentralen Steuern der ausgeführten Instanzen von Workflows in der gesamten Websitesammlung. Mithilfe des SPWorkflowManager-Objekts können Sie die ausgeführten Instanzen von Workflows in der gesamten Websitesammlung verwalten. Das SPWorkflowManager-Objekt hat keine Entsprechung auf der Benutzeroberfläche. Verwenden Sie das SPWorkflowManager-Objekt für folgende Zwecke:
Starten, Ausführen und Abbrechen von Workflows
Zurückgeben aller Workflows, die zurzeit für ein bestimmtes Element ausgeführt werden
Durchführen anderer Verwaltungsvorgänge für Workflows
Verwenden Sie zum manuellen Starten eines bestimmten Workflows für ein Element, d. h. einen Workflow, der nicht für einen automatischen Start konfiguriert ist, die Methode StartWorkflow(SPListItem, SPWorkflowAssociation, String) oder StartWorkflow(SPListItem, SPWorkflowAssociation, String, Boolean).