Interface IWorkflowStartParameterHandler
Interface that usercontrols that are registered through use of attribute WorkflowPlugIn should implement. These controls are used to set StartParameters for a workflow definition that will be passed to instance when it is created.
Namespace: EPiServer.WorkflowFoundation.UI
Assembly: EPiServer.WorkflowFoundation.dll
Version: 8.11.0Syntax
public interface IWorkflowStartParameterHandlerExamples
Shows a sample implementation of interface
Methods
LoadStartParameters(Guid, PageReference, Boolean, IDictionary<String, Object>)
Will be called at startup to set previous saved values.
Declaration
void LoadStartParameters(Guid definitionId, PageReference pageLink, bool definitionMode, IDictionary<string, object> parameters)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | definitionId | The definition id of the selected definition |
| PageReference | pageLink | The current page displayed, will be PageReferece.Empty in admin mode, that is when definitionMode is true |
| System.Boolean | definitionMode | set to true if control is loaded to predefine params, that is in admin mode. else if control is loaded when a user is about to create a workflow instance value is false |
| System.Collections.Generic.IDictionary<System.String, System.Object> | parameters | StartParameters |
SaveStartParameters()
Will be called after user clicked Save/Start to get the values from the loaded control.
Declaration
IDictionary<string, object> SaveStartParameters()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IDictionary<System.String, System.Object> | StartParameters |
Remarks
Before SaveStartParameters are called Page.IsValid() is called so any custom validators will have chance to validate input
If PageArgs (of type WorkflowPageEventArgs) are not set but exposed by workflow runtime will set it automatically
