Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

SPWorkflowTemplate Members

SharePoint 2010

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.

  Name Description
Public property AllowAsyncManualStart True to allow for Windows SharePoint Services to start the workflow asynchronously, even if the workflow was manually initiated.
Public property 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.
Public property 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.
Public property AssociationData Gets or sets the association data for workflow associations based on this workflow template.
Public property AssociationUrl Gets the URL of the workflow association form to use with the workflow template.
Public property AutoCleanupDays Gets or sets the number of days before instance data for the association is deleted.
Public property AutoStartChange True to have workflow instances based on this workflow template start automatically when an item is changed.
Public property AutoStartCreate True to have workflow instances based on this workflow template start automatically when an item is created.
Public property BaseId Gets the workflow template ID.
Public property CompressInstanceData Gets or sets a value that indicates whether the instance data for the template is compressed when it is stored in the database.
Public property Description Gets and sets the description for the workflow template. This description is displayed in the Windows SharePoint Services user interface.
Public property Id Gets the workflow template ID, which uniquely identifies workflow associations that are based on this template.
Public property InstantiationUrl Returns the URL of the workflow initiation form for the workflow template.
Public property IsDeclarative Returns True if the workflow template is a declarative, files-based workflow, False if the workflow template is a compiled workflow assembly.
Public property Item Gets or sets an object that represents the metadata properties.
Public property ModificationUrl Gets the URL of the workflow modification form.
Public property Name Gets the name of the workflow template.
Public property PermissionsManual Gets or sets the permission level that is required for manually starting workflows that are based on this template.
Public property StatusColumn True to display a status column for workflow instances based on this workflow template 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 UpgradedPersistedProperties (Inherited from SPAutoSerializingObject.)
Public property Xml Returns a value that represents the workflow template definition in XML format.
Top
  Name Description
Public method Clone Creates a copy of the workflow template.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetObjectData (Inherited from SPAutoSerializingObject.)
Public method GetStatusChoices Returns a string collection of the possible status choices for this workflow template.
Public method GetType (Inherited from Object.)
Public method Static member IsCategoryApplicable Returns a value that is true if the categories string contains any of the requested categories; otherwise, false.
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnDeserialization (Inherited from SPAutoSerializingObject.)
Public method ToString (Inherited from Object.)
Protected method UpdateParent (Inherited from SPAutoSerializingObject.)
Top
  Name Description
Explicit interface implemetation Private method 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
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ