BuildOpenXmlFile Class

This task is used to finish up creation of the Open XML file parts and compress the help content into an Open XML document (a ZIP file with a .docx extension).

Inheritance Hierarchy

SystemObject
Microsoft.Build.UtilitiesTask
SandcastleBuilder.Utils.MSBuildBuildOpenXmlFile

Namespace: SandcastleBuilder.Utils.MSBuild
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public class BuildOpenXmlFile : Task

Public Class BuildOpenXmlFile
	Inherits Task

public ref class BuildOpenXmlFile : public Task

type BuildOpenXmlFile =  
    class
        inherit Task
    end

The BuildOpenXmlFile type exposes the following members.

Constructors

	Name	Description
	BuildOpenXmlFile	Initializes a new instance of the BuildOpenXmlFile class

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute	This is used to execute the task and perform the build (Overrides TaskExecute.)
	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 a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	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

Properties

	Name	Description
	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.)
	HelpFilename	This is used to pass in the name of the help file document (no path or extension)
	HelpKeywordPrefix	Gets or sets the prefix used to compose Help keywords from resource names. (Inherited from Task.)
	HostObject	Gets or sets the host object associated with the task. (Inherited from Task.)
	IndentXml	This is used for debugging. Set it to true to indent the XML, false to not indent it
	Log	Gets an instance of a TaskLoggingHelper class containing task logging methods. (Inherited from Task.)
	OutputFolder	This is used to pass in the output folder where the compressed output file is stored
	TaskResources	Gets or sets the culture-specific resources associated with the task. (Inherited from Task.)
	WorkingFolder	This is used to pass in the working folder where the files to compress are located

Top

Reference

SandcastleBuilder.Utils.MSBuild Namespace