Share via


WorkflowAssociation members

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

The WorkflowAssociation type exposes the following members.

Constructors

  Name Description
Public method WorkflowAssociation

Top

Properties

  Name Description
Public property AllowManual Gets or sets a value that specifies whether workflow instances based on this workflow association can be started manually.
Public property AssociationData Gets or sets a value that specifies the workflow association data for workflow instances created from this workflow association.
Public property AutoStartChange Gets or sets a value that specifies whether workflow instances will be created from this workflow association and started automatically when a list item is changed.
Public property AutoStartCreate Gets or sets a value that specifies whether workflow instances will be created from this workflow association and started automatically when a list item is changed.
Public property BaseId Gets a value that specifies the identifier of the workflow template on which this workflow association is based.
Public property Context Returns the context that is associated with the client object. (Inherited from ClientObject.)
Public property Created Gets a value that specifies the date and time at which this workflow association was created.
Public property Description Gets or sets a value that specifies the description for this workflow association.
Public property Enabled Gets or sets a value that specifies whether new workflow instances will be allowed for this workflow association
Public property HistoryListTitle Gets or sets a value that specifies the title of the list to which to log workflow history events for this workflow association.
Public property Id Gets a value that specifies the identifier of the workflow association.
Public property InstantiationUrl Gets a value that specifies the URL of the workflow initiation form for this workflow association.
Public property InternalName Gets a value that specifies the internal name of this workflow association, as determined by the WorkflowAssociation implementation.
Public property IsDeclarative Gets a value that specifies whether the workflow association represents a declarative workflow.
Public property ListId Gets a value that specifies the identifier of the list on which this workflow association resides.
Public property Modified Gets a value that specifies the data and time at which this workflow association was last modified.
Public property Name Gets or sets a value that specifies the name of this workflow association.
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 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 TaskListTitle Gets or sets a value that specifies the title of the list within which workflow tasks will be created for this workflow association.
Public property TypedObject Gets the object with the correct type information returned from the server. (Inherited from ClientObject.)
Public property WebId Gets a value that specifies the identifier of the site on which the workflow association resides.

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 DeleteObject Removes this workflow association from its parent WorkflowAssociations collection.
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.)
Public method Update Informs this workflow association’s parent WorkflowAssociation collection that changes have been made to this workflow association.
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

WorkflowAssociation class

Microsoft.SharePoint.Client.Workflow namespace