GenerateOfficeDocumentInstallationPath Class
Defines an MSBuild task that returns a path to the installation folder to be written into a customized document. This class cannot be inherited.
Inheritance Hierarchy
System.Object
Microsoft.Build.Utilities.Task
Microsoft.VisualStudio.Tools.Office.BuildTasks.BuildTask
Microsoft.VisualStudio.Tools.Office.BuildTasks.GenerateOfficeDocumentInstallationPath
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 NotInheritable Class GenerateOfficeDocumentInstallationPath _
Inherits BuildTask
[ComVisibleAttribute(false)]
[PermissionSetAttribute(SecurityAction.Demand, Name = "FullTrust")]
public sealed class GenerateOfficeDocumentInstallationPath : BuildTask
The GenerateOfficeDocumentInstallationPath type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
GenerateOfficeDocumentInstallationPath | Initializes a new instance of the GenerateOfficeDocumentInstallationPath class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
BuildEngine | Gets or sets the instance of the IBuildEngine object used by the task. (Inherited from Task.) |
|
BuildEngine2 | Gets the instance of the IBuildEngine2 object used by the task. (Inherited from Task.) |
|
BuildEngine3 | Gets the instance of the IBuildEngine3 object used by the task. (Inherited from Task.) |
|
BuildEngine4 | Gets the instance of the IBuildEngine4 object used by the task. (Inherited from Task.) |
|
HostObject | Gets or sets the host object associated with the task. (Inherited from Task.) |
|
InstallationPath | Gets the relative or fully qualified path of the installation folder to be written into a customized document. |
|
InstallUrl | Sets the installation path where the customized document is copied for installation. |
|
Log | Gets an instance of a TaskLoggingHelper class containing task logging methods. (Inherited from Task.) |
|
PublishUrl | Sets the publish path where the customized document is copied for publishing. |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
|
Execute | Creates the output folder and, if applicable, the installation folder, where the customized document is published. (Overrides Task.Execute().) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Remarks
The document must be part of an Office development project for a 2007 Microsoft Office system application.
Set all of the GenerateOfficeDocumentInstallationPath properties, and then call Execute to run this task.
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.