SPWorkflowAssociation members

Represents the association of a workflow template with a specific list or content type, and contains members that return custom information about that workflow's association with the specific list or content type.

The SPWorkflowAssociation type exposes the following members.

  Name Description
Public property AllowAsyncManualStart Gets or sets a value that enables Microsoft SharePoint Foundation to start the workflow asynchronously, even if the workflow was manually initiated.
Public property AllowManual Gets or sets whether workflow instances based on this workflow association can be started manually.
Public property AssociationData Gets or sets the association data for workflow instances based on this workflow association.
Public property Author Returns the user ID of the author of the workflow association.
Public property AutoCleanupDays Gets or sets the number of days before instance data for the association is deleted. The default value is 60 days.
Public property AutoStartChange True to have workflow instances based on this workflow associate start automatically when an item is changed.
Public property AutoStartCreate True to have workflow instances based on this workflow associate start automatically when an item is created.
Public property BaseId Gets the ID of the workflow template on which this workflow association is based.
Public property BaseTemplate Gets the workflow template on which this workflow association is based.
Public property CompressInstanceData Gets or sets a value that specifies whether the instance data for the association is compressed when it is stored in the database.
Public property ContentTypePushDown Gets or sets a value that indicates whether the association should be pushed down to child content types.
Public property Created Returns the date and time at which the workflow association was created.
Public property Description Gets and sets the description for the workflow association.
Public property Enabled Gets or sets a value that indicates whether the workflow association is enabled.
Public property GloballyEnabled Gets a value that determines whether the workflow association can be run.
Public property HistoryListId Gets the list ID of the list to which to log workflow history events for this workflow association.
Public property HistoryListTitle Gets or sets the title of the list to which to log workflow history events for this workflow association.
Public property Id Returns the ID of the workflow association.
Public property InstantiationUrl Returns the URL of the workflow initiation form for the workflow association.
Public property InternalName Gets the internal name of the workflow association.
Public property IsDeclarative Returns True if the workflow association is a declarative, files-based workflow, False if the workflow association is a compiled workflow assembly.
Public property Item Gets the specified property from the BaseTemplate of the association.
Public property LockItem Gets or sets a value that makes an association read-only.
Public property MarkedForDelete Gets or sets a value that marks the association for deletion. This prevents the association from being accessed before it is actually deleted.
Public property ModificationUrl Gets the URL of the workflow modification form.
Public property Modified Gets the date and time when the workflow association was last modified.
Public property Name Gets or sets the name of the workflow association.
Public property ParentAssociationId Gets the unique ID of the parent association in the parent content type of the content type of this association.
Public property ParentContentType Gets the parent content type on which the workflow association resides.
Public property ParentList Returns the list on which the workflow association resides.
Public property ParentSite Returns the site collection on which the workflow association resides.
Public property ParentWeb Returns the site on which the workflow association resides.
Public property PermissionsManual Gets or sets the permissions that are required for manually starting workflows that are based on this association.
Public property RunningInstances Returns the number of in-progress workflow instances based on the workflow association.
Public property SiteId Returns the site ID of the site collection on which the workflow association resides.
Public property SiteOverQuota Gets a value that indicates whether the SPSite on which the workflow association resides is over quota.
Public property SiteWriteLocked Gets a value that indicates whether the SPSite on which the workflow association resides does not allow updates.
Public property SoapXml Returns a string that represents the workflow association definition in XML format.
Public property StatusColumn True to display a status column for this workflow association in the user interface.
Public property StatusUrl Specifies the URL of a custom workflow status page for the workflow.
Public property TaskListContentTypeId Returns the content type ID of the content type assigned to the workflow task list.
Public property TaskListId Gets the list ID of the workflow task list.
Public property TaskListTitle Gets or sets the title of the list on which to create workflow tasks for the workflow association.
Public property WebId Gets the ID of the site on which the workflow association resides.
Top

  Name Description
Public method Static member CreateListAssociation Creates a workflow association that can then be added to a list.
Public method Static member CreateListContentTypeAssociation Creates a workflow association that can then be added to a list content type.
Public method Static member CreateSiteContentTypeAssociation Obsolete. Creates a workflow association that can then be added to a site content type.
Public method Static member CreateWebAssociation Creates a workflow association that can then be added to an SPWeb object.
Public method Static member CreateWebContentTypeAssociation Creates a workflow association that can then be added to a content type that is scoped at the website level.
Public method Equals (Inherited from Object.)
Public method ExportToXml Gets a string that contains the state of all members of the class in XML format.
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method Static member ImportFromXml Creates an SPWorkflowAssociation object from an XML formatted string.
Protected method MemberwiseClone (Inherited from Object.)
Public method SetHistoryList Specifies the list to which to log workflow history events for this workflow association.
Public method SetTaskList Specifies the task list on which to create workflow tasks for this workflow association.
Public method ToString (Inherited from Object.)
Top

  Name Description
Explicit interface implemetation Private method IComparer.Compare Compares two objects and returns a value that indicates whether the first object is alphabetically less than, equal to, or greater than the second object.
Top
Show: