CheckOffice2007Document Class
Defines an MSBuild task that determines whether a customized document in the 2007 Microsoft Office system should be generated. This class cannot be inherited.
Inheritance Hierarchy
System.Object
Microsoft.Build.Utilities.Task
Microsoft.VisualStudio.Tools.Office.BuildTasks.BuildTask
Microsoft.VisualStudio.Tools.Office.BuildTasks.CheckOffice2007Document
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 CheckOffice2007Document _
Inherits BuildTask
[ComVisibleAttribute(false)]
[PermissionSetAttribute(SecurityAction.Demand, Name = "FullTrust")]
public sealed class CheckOffice2007Document : BuildTask
The CheckOffice2007Document type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
CheckOffice2007Document | Initializes a new instance of the CheckOffice2007Document 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.) |
|
DeploymentManifest | Gets or sets the relative or fully qualified path of the deployment manifest. |
|
DestinationDocument | Gets or sets the relative or fully qualified path of the customized document that is created by calling Execute. |
|
DocumentCustomization | Gets or sets the relative or fully qualified path of the customization assembly. |
|
HostObject | Gets or sets the host object associated with the task. (Inherited from Task.) |
|
Log | Gets an instance of a TaskLoggingHelper class containing task logging methods. (Inherited from Task.) |
|
RecustomizeDocument | Gets a value that indicates whether any Office customization assemblies or documents in a document-level project have changed. |
|
SourceDocument | Gets or sets the relative or fully qualified path of the version of the document that is in the project folder. |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
|
Execute | Determines whether a customized document in the 2007 Microsoft Office system should be generated. (Overrides Task.Execute().) |
|
GetHashCode | Serves as the default hash function. (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
Set all of the CheckOffice2007Document properties, and then call Execute to run this build task.
CheckOffice2007Document checks to see whether a customized document requires updating. To generate a new version of the customized document after you have changed the source document, deployment manifest, or customization assembly, use CustomizeOffice2007Document.
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.