CustomizeOffice2007Document Class

Defines an MSBuild task that generates a customized document for projects developed for the 2007 Microsoft Office system. This class cannot be inherited.

Inheritance Hierarchy

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

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 CustomizeOffice2007Document _
    Inherits BuildTask
[ComVisibleAttribute(false)]
[PermissionSetAttribute(SecurityAction.Demand, Name = "FullTrust")]
public sealed class CustomizeOffice2007Document : BuildTask

The CustomizeOffice2007Document type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property AssemblyName Gets or sets the name of a customization assembly to attach to a document.
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.)
Public property DeploymentManifestName Gets or sets the relative or fully qualified path of the deployment manifest.
Public property DocumentPath Gets or sets the relative or fully qualified path of the project document.
Public property HostObject Gets or sets the host object associated with the task. (Inherited from Task.)
Public property InstallationPath Sets the relative or fully qualified path of the installation folder.
Public property Local Gets or sets a value that indicates whether to make all the paths in the application manifest relative to the document location.
Public property Log Gets an instance of a TaskLoggingHelper class containing task logging methods. (Inherited from Task.)
Public property SolutionID Sets the GUID of an Office solution.
Public property Unregister Gets or sets a value that indicates whether to remove a customization assembly from a document.

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method Execute Generates a customized document for a project developed for the 2007 Microsoft Office system. (Overrides Task.Execute().)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

Set all of the CustomizeOffice2007Document properties and then call Execute to run this task.

CustomizeOffice2007Document generates a customized document based on a path to a source document, deployment manifest, and customization assembly. To check whether a customized document needs updating, use CheckOffice2007Document.

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