WorkflowHelpers Class

Contains static methods to help in validating and processing workflow operations.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.Build.Workflow.WorkflowHelpers

Namespace:  Microsoft.TeamFoundation.Build.Workflow
Assembly:  Microsoft.TeamFoundation.Build.Workflow (in Microsoft.TeamFoundation.Build.Workflow.dll)

Syntax

'Declaration
<ExtensionAttribute> _
Public NotInheritable Class WorkflowHelpers

public static class WorkflowHelpers

[ExtensionAttribute]
public ref class WorkflowHelpers abstract sealed

[<AbstractClass>]
[<Sealed>]
type WorkflowHelpers =  class end

public final class WorkflowHelpers

The WorkflowHelpers type exposes the following members.

Methods

	Name	Description
	CombineMetadata	Gets a ProcessParameterMetadataCollection that contains the specified baseMetadata parameters combined with the overriding overridingMetadata parameters. Values from overridingMetadata are kept if there is a conflict between the two data.
	DeserializeProcessParameters(String)	Creates and returns an Activity object by deserializing the data in the specified XAML string.
	DeserializeProcessParameters(String, IList<ProcessParameterError>%)	Deserializes the parameter values from a XAML serialized dictionary. Parameters of unknown types and non-existent members are ignored when you load the dictionary and specific errors are populated into the errors collection.
	DeserializeWorkflow(String)	Gets the Activity object described by the specified XAML markup.
	DeserializeWorkflow(String, Boolean, List<ProcessParameterError>%)	This method is still used by build computer (returning assembly mismatches instead of throwing an exception at first error)
	FindResource	Gets a localized string that describes the resource at the specified ID.
	GetAssemblyMetadataCollection
	GetCombinedMetadata	Gets the metadata associated with the process parameters defined in the specified Activity.
	GetDefaultMetadata	Gets a collection of metadata that supports the built-in process templates (default and upgrade).
	GetMetadata	Gets the value of the metadata property of the specified activity.
	GetProcessParameters	Gets the process parameter information from the specified activity and returns it as a dictionary.
	GetProcessParametersAndMetadata(IProcessTemplate, ProcessParameterMetadataCollection%)	Gets the process parameters and metadata from the specified process.
	GetProcessParametersAndMetadata(IProcessTemplate, ProcessParameterMetadataCollection%, List<ProcessParameterError>%)	Returns the root Activity from the process template. If the root is a DynamicActivity then the Properties collection is included.
	GetProcessParametersAndMetadata(IProcessTemplate, ProcessParameterMetadataCollection%, List<ProcessParameterError>%, List<ProcessParameterError>%)	Returns the root Activity from the process template. If the root is a DynamicActivity then the Properties collection is included. Also returns all the parsing errors.
	GetProcessParameterValue<T>	Gets the value of the specified process parameter. If the process parameter does not exist the default value is returned.
	GetValueAsString
	IsValueSet
	SerializeProcessParameters(IDictionary<String, Object>)	Serializes the specified process parameter and values into a XAML string.
	SerializeProcessParameters(IDictionary<String, Object>, IEnumerable<String>)	Serializes the parameter values dictionary into XAML (adding raw xml for incorrect parameters to preserve their values)
	TryDeserializeWorkflow	This method is used by client (returning all the errors instead of throwing at first one)
	ValidateWorkflow(Activity)	Validates the specified activity tree.
	ValidateWorkflow(Activity, ValidationSettings)	Validates the specified activity tree using optional settings provided by the caller.

Top

Fields

	Name	Description
	AssemblyMetadataName
	MetadataPropertyName	Metadata.
	SupportedReasonsPropertyName	SupportedReasons.
	VerbosityPropertyName	Verbosity.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.TeamFoundation.Build.Workflow Namespace