SPWorkflowAssociation Members
Include Protected Members
Include Inherited 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.
Properties
Name | Description | |
---|---|---|
AllowAsyncManualStart | Gets or sets a value that enables Microsoft SharePoint Foundation to start the workflow asynchronously, even if the workflow was manually initiated. | |
AllowManual | Gets or sets whether workflow instances based on this workflow association can be started manually. | |
AssociationData | Gets or sets the association data for workflow instances based on this workflow association. | |
Author | Returns the user ID of the author of the workflow association. | |
AutoCleanupDays | Gets or sets the number of days before instance data for the association is deleted. The default value is 60 days. | |
AutoStartChange | True to have workflow instances based on this workflow associate start automatically when an item is changed. | |
AutoStartCreate | True to have workflow instances based on this workflow associate start automatically when an item is created. | |
BaseId | Gets the ID of the workflow template on which this workflow association is based. | |
BaseTemplate | Gets the workflow template on which this workflow association is based. | |
CompressInstanceData | Gets or sets a value that specifies whether the instance data for the association is compressed when it is stored in the database. | |
ContentTypePushDown | Gets or sets a value that indicates whether the association should be pushed down to child content types. | |
Created | Returns the date and time at which the workflow association was created. | |
Description | Gets and sets the description for the workflow association. | |
Enabled | Gets or sets a value that indicates whether the workflow association is enabled. | |
GloballyEnabled | Gets a value that determines whether the workflow association can be run. | |
HistoryListId | Gets the list ID of the list to which to log workflow history events for this workflow association. | |
HistoryListTitle | Gets or sets the title of the list to which to log workflow history events for this workflow association. | |
Id | Returns the ID of the workflow association. | |
InstantiationUrl | Returns the URL of the workflow initiation form for the workflow association. | |
InternalName | Gets the internal name of the workflow association. | |
IsDeclarative | Returns True if the workflow association is a declarative, files-based workflow, False if the workflow association is a compiled workflow assembly. | |
Item | Gets the specified property from the BaseTemplate of the association. | |
LockItem | Gets or sets a value that makes an association read-only. | |
MarkedForDelete | Gets or sets a value that marks the association for deletion. This prevents the association from being accessed before it is actually deleted. | |
ModificationUrl | Gets the URL of the workflow modification form. | |
Modified | Gets the date and time when the workflow association was last modified. | |
Name | Gets or sets the name of the workflow association. | |
ParentAssociationId | Gets the unique ID of the parent association in the parent content type of the content type of this association. | |
ParentContentType | Gets the parent content type on which the workflow association resides. | |
ParentList | Returns the list on which the workflow association resides. | |
ParentSite | Returns the site collection on which the workflow association resides. | |
ParentWeb | Returns the site on which the workflow association resides. | |
PermissionsManual | Gets or sets the permissions that are required for manually starting workflows that are based on this association. | |
RunningInstances | Returns the number of in-progress workflow instances based on the workflow association. | |
SiteId | Returns the site ID of the site collection on which the workflow association resides. | |
SiteOverQuota | Gets a value that indicates whether the SPSite on which the workflow association resides is over quota. | |
SiteWriteLocked | Gets a value that indicates whether the SPSite on which the workflow association resides does not allow updates. | |
SoapXml | Returns a string that represents the workflow association definition in XML format. | |
StatusColumn | True to display a status column for this workflow association in the user interface. | |
StatusUrl | Specifies the URL of a custom workflow status page for the workflow. | |
TaskListContentTypeId | Returns the content type ID of the content type assigned to the workflow task list. | |
TaskListId | Gets the list ID of the workflow task list. | |
TaskListTitle | Gets or sets the title of the list on which to create workflow tasks for the workflow association. | |
UpgradedPersistedProperties | (Inherited from SPAutoSerializingObject.) | |
WebId | Gets the ID of the site on which the workflow association resides. |
Top
Methods
Name | Description | |
---|---|---|
CreateListAssociation | Creates a workflow association that can then be added to a list. | |
CreateListContentTypeAssociation | Creates a workflow association that can then be added to a list content type. | |
CreateSiteContentTypeAssociation | Obsolete. Creates a workflow association that can then be added to a site content type. | |
CreateWebAssociation | Creates a workflow association that can then be added to an SPWeb object. | |
CreateWebContentTypeAssociation | Creates a workflow association that can then be added to a content type that is scoped at the website level. | |
Equals | (Inherited from Object.) | |
ExportToXml | Gets a string that contains the state of all members of the class in XML format. | |
Finalize | (Inherited from Object.) | |
GetHashCode | (Inherited from Object.) | |
GetObjectData | (Inherited from SPAutoSerializingObject.) | |
GetType | (Inherited from Object.) | |
ImportFromXml | Creates an SPWorkflowAssociation object from an XML formatted string. | |
MemberwiseClone | (Inherited from Object.) | |
OnDeserialization | (Inherited from SPAutoSerializingObject.) | |
SetHistoryList | Specifies the list to which to log workflow history events for this workflow association. | |
SetTaskList | Specifies the task list on which to create workflow tasks for this workflow association. | |
ToString | (Inherited from Object.) | |
UpdateParent | (Inherited from SPAutoSerializingObject.) |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
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