Share via


WorkflowTemplate 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 WorkflowTemplate type exposes the following members.

Constructors

  Name Description
Public method WorkflowTemplate

Top

Properties

  Name Description
Public property AllowManual Gets a value that specifies whether workflow associations based on this workflow template can be configured to allow workflow instances to be started manually.
Public property AssociationUrl Gets a value that specifies the site relative URL of the workflow association form to use with the workflow template.
Public property AutoStartChange Gets a value that specifies whether workflow associations based on this workflow template can be configured to start workflow instances automatically when an item is changed.
Public property AutoStartCreate Gets a value that specifies whether workflow associations based on this workflow template can be configured to start workflow instances automatically when an item is created.
Public property Context Returns the context that is associated with the client object. (Inherited from ClientObject.)
Public property Description Gets a value that gives 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 IsDeclarative Gets a value that specifies whether the workflow template represents a declarative workflow.
Public property Name Gets a value that gives the name of the workflow template.
Protected property ObjectData Gets the object data for the current client object. (Inherited from ClientObject.)
Public property ObjectVersion Gets a string that indicates the version of the current client object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public property Path Tracks how a client object is created in the ClientRuntimeContext class so that the object can be recreated on the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public property PermissionsManual Gets a value that specifies the permission level a user must have to manually start workflow instances based on the workflow template.
Public property ServerObjectIsNull Gets the server object and returns null if the server object is null. (Inherited from ClientObject.)
Public property Tag Gets or sets data that is associated with the client object. (Inherited from ClientObject.)
Public property TypedObject Gets the object with the correct type information returned from the server. (Inherited from ClientObject.)

Top

Methods

  Name Description
Protected method CheckUninitializedProperty Checks to determine whether the specified value type property of a ClientObject has been initialized. (Inherited from ClientObject.)
Public method CustomFromJson Returns a Boolean value that indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method FromJson Indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Protected method InitNonPropertyFieldFromJson Initializes a non-property field of the client object based on JavaScript Object Notation (JSON) data from the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Protected method InitOnePropertyFromJson (Overrides ClientObject.InitOnePropertyFromJson(String, JsonReader).)
Public method IsObjectPropertyInstantiated Indicates whether the specified property of the client object is instantiated. (Inherited from ClientObject.)
Public method IsPropertyAvailable Returns a Boolean value that indicates whether the specified scalar property has been retrieved or set. (Inherited from ClientObject.)
Protected method LoadExpandoFields Initializes the extended properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
Public method RefreshLoad Reloads all scalar properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
Protected method RemoveFromParentCollection Removes the current client object from the parent client object collection. (Inherited from ClientObject.)
Public method Retrieve() Retrieves all scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method Retrieve([]) Retrieves the specified scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method ToString (Inherited from Object.)
Protected method UpdateClientObjectPropertyType Updates the client object property's value to have correct type by using the type information returned from the server. (Inherited from ClientObject.)

Top

See also

Reference

WorkflowTemplate class

Microsoft.SharePoint.Client.Workflow namespace