Share via


BuildTask Class

Provides the base class for MSBuild tasks that are used by the Office development tools in Visual Studio to build projects.

Inheritance Hierarchy

System.Object
  Microsoft.Build.Utilities.Task
    Microsoft.VisualStudio.Tools.Office.BuildTasks.BuildTask
      More...

Namespace:  Microsoft.VisualStudio.Tools.Office.BuildTasks
Assembly:  Microsoft.VisualStudio.Tools.Office.BuildTasks (in Microsoft.VisualStudio.Tools.Office.BuildTasks.dll)

Syntax

'Declaration
<ComVisibleAttribute(False)> _
<PermissionSetAttribute(SecurityAction.Demand, Name := "FullTrust")> _
Public MustInherit Class BuildTask _
    Inherits Task
[ComVisibleAttribute(false)]
[PermissionSetAttribute(SecurityAction.Demand, Name = "FullTrust")]
public abstract class BuildTask : Task

The BuildTask type exposes the following members.

Constructors

  Name Description
Public method BuildTask Initializes a new instance of the BuildTask class.

Top

Properties

  Name Description
Public property BuildEngine Gets or sets the instance of the IBuildEngine object used by the task. (Inherited from Task.)
Public property BuildEngine2 Gets the instance of the IBuildEngine2 object used by the task. (Inherited from Task.)
Public property BuildEngine3 Gets the instance of the IBuildEngine3 object used by the task. (Inherited from Task.)
Public property BuildEngine4 Gets the instance of the IBuildEngine4 object used by the task. (Inherited from Task.)
Protected property HelpKeywordPrefix Gets or sets the prefix used to compose Help keywords from resource names. (Inherited from Task.)
Public property HostObject Gets or sets the host object associated with the task. (Inherited from Task.)
Public property Log Gets an instance of a TaskLoggingHelper class containing task logging methods. (Inherited from Task.)
Protected property TaskResources Gets or sets the culture-specific resources associated with the task. (Inherited from Task.)

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method Execute When overridden in a derived class, executes the task. (Inherited from Task.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

These build tasks are for the 2007 Microsoft Office system.

The Microsoft Build Engine uses Microsoft.VisualStudio.Tools.Office.BuildTasks to build and deploy Office solutions. However, you can create your own build system by using these classes and the MSBuild XML-based project files. For more information, see MSBuild Reference.

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.VisualStudio.Tools.Office.BuildTasks Namespace

Inheritance Hierarchy

System.Object
  Microsoft.Build.Utilities.Task
    Microsoft.VisualStudio.Tools.Office.BuildTasks.BuildTask
      Microsoft.VisualStudio.Tools.Office.BuildTasks.CheckOffice2007Document
      Microsoft.VisualStudio.Tools.Office.BuildTasks.CustomizeOffice2007Document
      Microsoft.VisualStudio.Tools.Office.BuildTasks.EmbedTypeLibrary
      Microsoft.VisualStudio.Tools.Office.BuildTasks.GenerateOfficeAddInManifest
      Microsoft.VisualStudio.Tools.Office.BuildTasks.GenerateOfficeDocumentInstallationPath
      Microsoft.VisualStudio.Tools.Office.BuildTasks.GenerateOfficeDocumentManifest
      Microsoft.VisualStudio.Tools.Office.BuildTasks.InitializeDefaultProperties
      Microsoft.VisualStudio.Tools.Office.BuildTasks.RegisterFormRegions
      Microsoft.VisualStudio.Tools.Office.BuildTasks.SetInclusionListEntry