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
Public methodStatic member 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.
Public methodStatic member DeserializeProcessParameters(String) Creates and returns an Activity object by deserializing the data in the specified XAML string.
Public methodStatic member 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.
Public methodStatic member DeserializeWorkflow(String) Gets the Activity object described by the specified XAML markup.
Public methodStatic member DeserializeWorkflow(String, Boolean, List<ProcessParameterError>%) This method is still used by build computer (returning assembly mismatches instead of throwing an exception at first error)
Public methodStatic member FindResource Gets a localized string that describes the resource at the specified ID.
Public methodStatic member GetAssemblyMetadataCollection
Public methodStatic member GetCombinedMetadata Gets the metadata associated with the process parameters defined in the specified Activity.
Public methodStatic member GetDefaultMetadata Gets a collection of metadata that supports the built-in process templates (default and upgrade).
Public methodStatic member GetMetadata Gets the value of the metadata property of the specified activity.
Public methodStatic member GetProcessParameters Gets the process parameter information from the specified activity and returns it as a dictionary.
Public methodStatic member GetProcessParametersAndMetadata(IProcessTemplate, ProcessParameterMetadataCollection%) Gets the process parameters and metadata from the specified process.
Public methodStatic member 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.
Public methodStatic member 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.
Public methodStatic member GetProcessParameterValue<T> Gets the value of the specified process parameter. If the process parameter does not exist the default value is returned.
Public methodStatic member GetValueAsString
Public methodStatic member IsValueSet
Public methodStatic member SerializeProcessParameters(IDictionary<String, Object>) Serializes the specified process parameter and values into a XAML string.
Public methodStatic member SerializeProcessParameters(IDictionary<String, Object>, IEnumerable<String>) Serializes the parameter values dictionary into XAML (adding raw xml for incorrect parameters to preserve their values)
Public methodStatic member TryDeserializeWorkflow This method is used by client (returning all the errors instead of throwing at first one)
Public methodStatic member ValidateWorkflow(Activity) Validates the specified activity tree.
Public methodStatic member ValidateWorkflow(Activity, ValidationSettings) Validates the specified activity tree using optional settings provided by the caller.

Top

Fields

Name Description
Public fieldStatic member AssemblyMetadataName
Public fieldStatic member MetadataPropertyName Metadata.
Public fieldStatic member SupportedReasonsPropertyName SupportedReasons.
Public fieldStatic member 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