Label Class

Article
2014-07-02

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.Build.Tasks.Task
    Microsoft.TeamFoundation.Build.Tasks.WorkflowTask
      Microsoft.TeamFoundation.Build.Tasks.Label

Namespace: Microsoft.TeamFoundation.Build.Tasks
Assembly: Microsoft.TeamFoundation.Build.ProcessComponents (in Microsoft.TeamFoundation.Build.ProcessComponents.dll)

Syntax

'Declaration
Public Class Label _
    Inherits WorkflowTask

public class Label : WorkflowTask

public ref class Label : public WorkflowTask

type Label =  
    class 
        inherit WorkflowTask 
    end

public class Label extends WorkflowTask

The Label type exposes the following members.

Constructors

	Name	Description
	Label

Top

Properties

	Name	Description
	BuildAgentUri	Property that gives the Uri of the Build Agent (Inherited from WorkflowTask.)
	BuildEngine	ITask implementation—BuildEngine property. (Inherited from Task.)
	BuildUri	Property that gives the URI of the build for which this task is executing. Derived classes can override this property to make it required. (Inherited from Task.)
	Child	How you want to handle labels underneath the current labels scope with the same name.Set this property to whatever string argument you would use in the label command line.
	Comments	This is the comment applied to the label.
	Extensions	(Inherited from WorkflowTask.)
	Files	This is the set of Folders/Files to put into the label. This property is set through the MSBuild task configuration.
	HostObject	ITask implementation—HostObject property. (Inherited from Task.)
	Name	The name of the label being created.
	Recursive	Retrieves Filespec recursively.
	Scope	The scope of the label being created.
	TeamFoundationServerUrl	Property that gives the URL of the Team Foundation Server. (Inherited from Task.)
	Tfs	Lazy [init] property that gives access to the Team Foundation Server. (Inherited from Task.)
	Version	This is the version string to apply to the items being added to the label.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Execute	ITask implementation - Execute method. (Inherited from Task.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetParameterLog	(Inherited from Task.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	LogCustomEvent	Helper to log a custom event if the task is running within MSBuild. (Inherited from Task.)
	LogError	Helper to log an error string if the task is running within MSBuild. (Inherited from Task.)
	LogErrorEvent	Helper to log an error event if the task is running within MSBuild. (Inherited from Task.)
	LogMessage(String)	Helper to log a message string if the task is running within MSBuild. (Inherited from Task.)
	LogMessage(String, MessageImportance)	Helper to log a message string if the task is running within MSBuild. (Inherited from Task.)
	LogMessageEvent	Helper to log a message event if the task is running within MSBuild. (Inherited from Task.)
	LogWarning	Helper to log a warning string if the task is running within MSBuild. (Inherited from Task.)
	LogWarningEvent	Helper to log a warning event if the task is running within MSBuild. (Inherited from Task.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

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.

Share via