Class WorkflowXamlServices

Namespace

Acuit.Pinpoint.Workflows

Assembly

Acuit.Pinpoint.Workflows.dll

Provides services (static methods) for loading workflows from XAML.

public static class WorkflowXamlServices

Inheritance

object

WorkflowXamlServices

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

Load(Stream, IExpressionEnvironment?)

Loads a workflow from a given XAML stream.

public static IActivity Load(Stream stream, IExpressionEnvironment? expressionEnvironment = null)

Parameters

stream Stream

The XAML stream from which to load the workflow.

expressionEnvironment IExpressionEnvironment

An optional expression environment. If provided, expressions will be compiled as they are encountered during loading. Otherwise, they will be compiled at runtime when first needed.

Returns

IActivity

The root activity of the loaded workflow.

Exceptions

ArgumentNullException

stream is null.

InvalidOperationException

The loaded XAML does not contain a workflow.

Exception

The workflow object graph could not be created. Potential causes include: the file content is not well-formed and valid XML, or the file content is not valid XAML at the language level, or the XAML types that are specified in the source XAML did not resolve to backing types in the relevant XAML namespaces. The specific possible exceptions are not documented, but they include XmlException, various exceptions derived from XamlException, and various exceptions derived from IOException.

Load(TextReader, IExpressionEnvironment?)

Loads a workflow via a given XAML text reader.

public static IActivity Load(TextReader textReader, IExpressionEnvironment? expressionEnvironment = null)

Parameters

textReader TextReader

The XAML text reader to use to load the workflow.

expressionEnvironment IExpressionEnvironment

An optional expression environment. If provided, expressions will be compiled as they are encountered during loading. Otherwise, they will be compiled at runtime when first needed.

Returns

IActivity

The root activity of the loaded workflow.

Exceptions

ArgumentNullException

textReader is null.

InvalidOperationException

The loaded XAML does not contain a workflow.

Exception

The workflow object graph could not be created. Potential causes include: the file content is not well-formed and valid XML, or the file content is not valid XAML at the language level, or the XAML types that are specified in the source XAML did not resolve to backing types in the relevant XAML namespaces. The specific possible exceptions are not documented, but they include XmlException, various exceptions derived from XamlException, and various exceptions derived from IOException.

Load(string, IExpressionEnvironment?)

Loads a workflow from a XAML file.

public static IActivity Load(string fileName, IExpressionEnvironment? expressionEnvironment = null)

Parameters

fileName string

The file name of the XAML file.

expressionEnvironment IExpressionEnvironment

An optional expression environment. If provided, expressions will be compiled as they are encountered during loading. Otherwise, they will be compiled at runtime when first needed.

Returns

IActivity

The root activity of the loaded workflow.

Exceptions

ArgumentNullException

fileName is null.

InvalidOperationException

The loaded XAML does not contain a workflow.

Exception

The workflow object graph could not be created. Potential causes include: the file content is not well-formed and valid XML, or the file content is not valid XAML at the language level, or the XAML types that are specified in the source XAML did not resolve to backing types in the relevant XAML namespaces. The specific possible exceptions are not documented, but they include XmlException, various exceptions derived from XamlException, and various exceptions derived from IOException.

Load(Uri, IExpressionEnvironment?)

Loads a workflow from XAML from a given Uri.

public static IActivity Load(Uri uri, IExpressionEnvironment? expressionEnvironment = null)

Parameters

uri Uri

The Uri from which to load the XAML workflow.

expressionEnvironment IExpressionEnvironment

An optional expression environment. If provided, expressions will be compiled as they are encountered during loading. Otherwise, they will be compiled at runtime when first needed.

Returns

IActivity

The root activity of the loaded workflow.

Remarks

Pack URIs specifying resources are supported as long as they are in an absolute form like: pack://application:,,,/YourAssemblyShortName;component/Subfolder/ResourceFile.xaml

Exceptions

ArgumentNullException

uri is null.

InvalidOperationException

The loaded XAML does not contain a workflow.

Exception

The workflow object graph could not be created. Potential causes include: the file content is not well-formed and valid XML, or the file content is not valid XAML at the language level, or the XAML types that are specified in the source XAML did not resolve to backing types in the relevant XAML namespaces. The specific possible exceptions are not documented, but they include XmlException, various exceptions derived from XamlException, and various exceptions derived from IOException.

Load(XmlReader, IExpressionEnvironment?)

Loads a workflow via a given XML reader.

public static IActivity Load(XmlReader xmlReader, IExpressionEnvironment? expressionEnvironment = null)

Parameters

xmlReader XmlReader

The XML reader to use to load the workflow.

expressionEnvironment IExpressionEnvironment

An optional expression environment. If provided, expressions will be compiled as they are encountered during loading. Otherwise, they will be compiled at runtime when first needed.

Returns

IActivity

The root activity of the loaded workflow.

Exceptions

ArgumentNullException

xmlReader is null.

InvalidOperationException

The loaded XAML does not contain a workflow.

Exception

The workflow object graph could not be created. Potential causes include: the file content is not well-formed and valid XML, or the file content is not valid XAML at the language level, or the XAML types that are specified in the source XAML did not resolve to backing types in the relevant XAML namespaces. The specific possible exceptions are not documented, but they include XmlException, various exceptions derived from XamlException, and various exceptions derived from IOException.

Parse(string, IExpressionEnvironment?)

Parses and loads a workflow from a XAML string.

public static IActivity Parse(string xaml, IExpressionEnvironment? expressionEnvironment = null)

Parameters

xaml string

The XAML string.

expressionEnvironment IExpressionEnvironment

An optional expression environment. If provided, expressions will be compiled as they are encountered during loading. Otherwise, they will be compiled at runtime when first needed.

Returns

IActivity

The root activity of the loaded workflow.

Exceptions

ArgumentNullException

xaml is null.

InvalidOperationException

The loaded XAML does not contain a workflow.

Exception

The workflow object graph could not be created. Potential causes include: the content is not well-formed and valid XML, or the content is not valid XAML at the language level, or the XAML types that are specified in the source XAML did not resolve to backing types in the relevant XAML namespaces. The specific possible exceptions are not documented, but they include XmlException, various exceptions derived from XamlException.