TfsBuild Class

Article
07/02/2014

Represents the activity for the Team Foundation Server build process.

Inheritance Hierarchy

System.Object
System.Activities.Activity
Microsoft.TeamFoundation.Build.Workflow.Activities.TfsBuild

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

Syntax

'Declaration
<BuildCategoryAttribute> _
<ActivityTrackingAttribute(ActivityTrackingOption.ActivityOnly)> _
<ToolboxBitmapAttribute(GetType(TeamBuildBaseActivityDesigner), "DefaultBuildIcon.png")> _
Public NotInheritable Class TfsBuild _
    Inherits Activity

[BuildCategoryAttribute]
[ActivityTrackingAttribute(ActivityTrackingOption.ActivityOnly)]
[ToolboxBitmapAttribute(typeof(TeamBuildBaseActivityDesigner), "DefaultBuildIcon.png")]
public sealed class TfsBuild : Activity

[BuildCategoryAttribute]
[ActivityTrackingAttribute(ActivityTrackingOption::ActivityOnly)]
[ToolboxBitmapAttribute(typeof(TeamBuildBaseActivityDesigner), L"DefaultBuildIcon.png")]
public ref class TfsBuild sealed : public Activity

[<Sealed>]
[<BuildCategoryAttribute>]
[<ActivityTrackingAttribute(ActivityTrackingOption.ActivityOnly)>]
[<ToolboxBitmapAttribute(typeof(TeamBuildBaseActivityDesigner), "DefaultBuildIcon.png")>]
type TfsBuild =  
    class 
        inherit Activity 
    end

public final class TfsBuild extends Activity

The TfsBuild type exposes the following members.

Constructors

	Name	Description
	TfsBuild	Initializes a new instance of the TfsBuild class.

Top

Properties

	Name	Description
	BinariesSubdirectory	Gets or sets the name of the subdirectory to drop the binaries.
	BuildDirectory	Gets or sets the root directory of the build.
	CacheId	Gets the identifier of the cache that is unique within the scope of the workflow definition. (Inherited from Activity.)
	CommandLineArguments	Gets or sets the command line arguments for the TfsBuild process.
	ConfigurationFolderPath	Gets or sets the path to the configuration folder.
	DisplayName	Gets or sets an optional friendly name that is used for debugging, validation, exception handling, and tracking. (Inherited from Activity.)
	DoNotDownloadBuildType	Gets or sets a flag indication whether to download the build type.
	Id	Gets an identifier that is unique in the scope of the workflow definition. (Inherited from Activity.)
	LogFilePerProject	Gets or sets a flag indicating whether to write a separate log file per project.
	MaxProcesses	Gets or sets the maximum number of concurrent build processes to execute.
	NodeReuse
	RecursionType	Gets or sets the recursion type.
	SourcesSubdirectory	Gets or sets the subdirectory for source files.
	TargetsNotLogged
	TestResultsSubdirectory	Gets or sets the subdirectory to drop test results.
	ToolPath	Gets or sets the tool path.
	ToolPlatform	Gets or sets the tool platform.
	Verbosity	Gets or sets the verbosity of the build.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ShouldSerializeDisplayName	Indicates whether the DisplayName property should be serialized. (Inherited from Activity.)
	ToString	Returns a String that contains the Id and DisplayName of the Activity. (Inherited from Activity.)

Top

Extension Methods

	Name	Description
	GetAssemblyMetadataCollection	(Defined by WorkflowHelpers.)

Top

Remarks

This is not meant to be used in custom builds.

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.