IWorkflow Interface

Article
02/21/2017

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2013, Dynamics CRM 2015, Dynamics CRM 2016

Represents the interface definition for IWorkflow.

Namespace: Microsoft.Uii.Desktop.Core
Assembly: Microsoft.Uii.Desktop.Core (in Microsoft.Uii.Desktop.Core.dll)

Syntax

public interface IWorkflow : IHostedApplication3, IHostedApplication2, 
    IHostedApplication

Public Interface IWorkflow
    Inherits IHostedApplication3, IHostedApplication2, IHostedApplication

Properties

	Name	Description
	AgentID	Gets or sets the agent who is logged in.(Inherited from IHostedApplication3.)
	ApplicationID	Gets the application ID.(Inherited from IHostedApplication.)
	ApplicationName	Gets the application name.(Inherited from IHostedApplication.)
	CanEmbed	Gets a Boolean value that specifies whether the application is an external application.(Inherited from IHostedApplication.)
	CurrentWorkflow	Get the current workflow that is active.
	DisplayGroup	Gets the display group extracted from the initialization string.(Inherited from IHostedApplication.)
	Icon	Gets or sets the icon used to represent the application in the UII UI.(Inherited from IHostedApplication2.)
	ImplementedAsCcf20	Gets a Boolean value that specifies whether the application is allowed to run certain routines as CCF 2.0 or prior.(Inherited from IHostedApplication3.)
	IsControlEnabled	Gets or Set value indicating whether the control can respond to user interaction.
	IsControlVisible	Gets or Sets value indicating whether the control is displayed.
	IsForced	Returns a Boolean value that specifies whether the workflow is forced or not.
	IsGlobal	Gets or sets a Boolean value that specifies whether the hosted application is global.(Inherited from IHostedApplication3.)
	IsListed	Gets a Boolean value that specifies whether the application is allowed to be seen but not listed.(Inherited from IHostedApplication3.)
	IsNavigating	Get a Boolean value that specifies whether the application is currently navigating.(Inherited from IHostedApplication.)
	MinimumSize	Gets a hint for minimum window size.(Inherited from IHostedApplication.)
	OptimumSize	Gets a hint for optimal window size.(Inherited from IHostedApplication.)
	SessionManager	Sets the session manager object.(Inherited from IHostedApplication3.)
	TopLevelWindow	Gets the top level window for the application.(Inherited from IHostedApplication.)
	WorkflowNotStarted	Returns a boolean value that specifies whether the workflow has started or not.

Methods

	Name	Description
	AddAction(Int32, String, String)	Adds an action to the application.(Inherited from IHostedApplication.)
	Clear()	Clears the contents of the workflow.
	Close()	Closes the application.(Inherited from IHostedApplication.)
	DoAction(Int32, String)	Invokes an action on the application(Inherited from IHostedApplication.)
	DoAction(String, String)	Obsolete. Invokes an action on the application(Inherited from IHostedApplication.)
	DoDefaultAction()	Invokes the default action for the application(Inherited from IHostedApplication.)
	FireRequestAction(RequestActionEventArgs)	Sends a request to perform some action to another application. If the RequestActionEventArgs has a target of *, then all applications get the action.(Inherited from IHostedApplication3.)
	GetIconList()	Gets the image list for the application.(Inherited from IHostedApplication.)
	GetStateData()	Requests the hosted application to return its current state.(Inherited from IHostedApplication.)
	Initialize()	Initializes the hosted application.(Inherited from IHostedApplication.)
	IsWorkflowPending(Guid)	Checks whether the workflow XML in the session's workflow string property is a valid pending workflow.
	NotifyContextChange(Context)	Notifies the application that the context has changed.(Inherited from IHostedApplication3.)
	NotifyContextChange(String)	Obsolete. Notifies the application that context has changed.(Inherited from IHostedApplication.)
	SessionChange(Boolean, Guid)	Called whenever the session is changed. Only global applications receive this since 'local' applications don't need to know if their session is shown or not.(Inherited from IHostedApplication.)
	SetContext(Context)	Obsolete. This is used to set the context from ApplicationHost without causing further notifications. It exists so that context can be updated quietly before doing the 'real' context notification because some applications fire actions onto other apps when the context changes and some actions are designed to depend upon context. In other words, a race condition.(Inherited from IHostedApplication3.)
	SetContext(String)	Obsolete. Sets the context from ApplicationHost without causing further notifications. It exists so that context can be updated quietly before doing the 'real' context notification because some applications fire actions onto other apps when the context changes and some actions are designed to depend upon context. In other words, a race condition.(Inherited from IHostedApplication2.)
	SetStateData(String)	Passes the saved state to the hosted application.(Inherited from IHostedApplication.)
	StartWorkflowById(Guid)	Starts workflow from the ID of the workflow passed in.
	StartWorkflowByIndex(Int32)	Starts Workflow from index value of the available workflow asset passed in.
	StartWorkflowByName(String)	Starts Workflow from the name of the workflow passed in.
	WorkflowUpdate(Guid, Guid)	Updates the workflow.

Events

	Name	Description
	ActionCompleted	Event to notify the hosted application that the action has completed.(Inherited from IHostedApplication.)
	ChangeContext	Event to add a name-value pair to the context.(Inherited from IHostedApplication.)
	RequestAction	Event to request an action of another application to be invoked.(Inherited from IHostedApplication.)
	WorkflowStarted	Notifies the desktop that a workflow is started.
	WorkflowStatusChange	Raised when a workflow becomes active and when a workflow is completed/canceled.

Share via

IWorkflow Interface

Syntax

Properties

Methods

Events

See Also

Additional resources