SPWorkflowTemplate Members
Include Protected Members
Include Inherited Members
Represents a workflow template currently deployed on the SharePoint site, and contains members that you can use to get or set information about the template, such as default instantiation data for creating a workflow association from the template.
The SPWorkflowTemplate type exposes the following members.
Properties
Name | Description | |
---|---|---|
AllowAsyncManualStart | True to allow for Windows SharePoint Services to start the workflow asynchronously, even if the workflow was manually initiated. | |
AllowDefaultContentApproval | Gets or sets a value that indicates whether the workflow instances based on this template can start automatically when the user attempts to approve publishing a major version of an item. | |
AllowManual | Gets and sets whether workflow instances based on this workflow template can be started manually. True to be able to start workflow instances manually. | |
AssociationData | Gets or sets the association data for workflow associations based on this workflow template. | |
AssociationUrl | Gets the URL of the workflow association form to use with the workflow template. | |
AutoCleanupDays | Gets or sets the number of days before instance data for the association is deleted. | |
AutoStartChange | True to have workflow instances based on this workflow template start automatically when an item is changed. | |
AutoStartCreate | True to have workflow instances based on this workflow template start automatically when an item is created. | |
BaseId | Gets the workflow template ID. | |
CompressInstanceData | Gets or sets a value that indicates whether the instance data for the template is compressed when it is stored in the database. | |
Description | Gets and sets the description for the workflow template. This description is displayed in the Windows SharePoint Services user interface. | |
Id | Gets the workflow template ID, which uniquely identifies workflow associations that are based on this template. | |
InstantiationUrl | Returns the URL of the workflow initiation form for the workflow template. | |
IsDeclarative | Returns True if the workflow template is a declarative, files-based workflow, False if the workflow template is a compiled workflow assembly. | |
Item | Gets or sets an object that represents the metadata properties. | |
ModificationUrl | Gets the URL of the workflow modification form. | |
Name | Gets the name of the workflow template. | |
PermissionsManual | Gets or sets the permission level that is required for manually starting workflows that are based on this template. | |
StatusColumn | True to display a status column for workflow instances based on this workflow template 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. | |
UpgradedPersistedProperties | (Inherited from SPAutoSerializingObject.) | |
Xml | Returns a value that represents the workflow template definition in XML format. |
Top
Methods
Name | Description | |
---|---|---|
Clone | Creates a copy of the workflow template. | |
Equals | (Inherited from Object.) | |
Finalize | (Inherited from Object.) | |
GetHashCode | (Inherited from Object.) | |
GetObjectData | (Inherited from SPAutoSerializingObject.) | |
GetStatusChoices | Returns a string collection of the possible status choices for this workflow template. | |
GetType | (Inherited from Object.) | |
IsCategoryApplicable | Returns a value that is true if the categories string contains any of the requested categories; otherwise, false. | |
MemberwiseClone | (Inherited from Object.) | |
OnDeserialization | (Inherited from SPAutoSerializingObject.) | |
ToString | (Inherited from Object.) | |
UpdateParent | (Inherited from SPAutoSerializingObject.) |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
IComparer.Compare | Compares two specified SPWorkflowTemplate objects and returns a value that indicates whether one object is less than, equal to, or greater than the other. |
Top