ConvertFromDocProject Class

This class is used to convert DocProject project files to the MSBuild format project files used by the help file builder.

Inheritance Hierarchy

SystemObject
SandcastleBuilder.Utils.ConversionConvertToMSBuildFormat
SandcastleBuilder.Utils.ConversionConvertFromDocProject

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

Syntax

public class ConvertFromDocProject : ConvertToMSBuildFormat

Public Class ConvertFromDocProject
	Inherits ConvertToMSBuildFormat

public ref class ConvertFromDocProject : public ConvertToMSBuildFormat

type ConvertFromDocProject =  
    class
        inherit ConvertToMSBuildFormat
    end

The ConvertFromDocProject type exposes the following members.

Constructors

	Name	Description
	ConvertFromDocProject(String, SandcastleProject)	Constructor
	ConvertFromDocProject(String, String)	Constructor

Methods

	Name	Description
	ConvertProject	This is used to perform the actual conversion (Overrides ConvertToMSBuildFormatConvertProject.)
	CreateFolderItems	This can be called after all additional content has been added to create the Folder build items in the project. (Inherited from ConvertToMSBuildFormat.)
	Dispose	This implements the Dispose() interface to properly dispose of the Sandcastle project object. (Inherited from ConvertToMSBuildFormat.)
	Dispose(Boolean)	This can be overridden by derived classes to add their own disposal code if necessary. (Inherited from ConvertToMSBuildFormat.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	This handles garbage collection to ensure proper disposal of the Sandcastle project if not done explicity with Dispose. (Inherited from ConvertToMSBuildFormat.)
	FullPath	This converts a relative path to a full path using the old project's folder. (Inherited from ConvertToMSBuildFormat.)
	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.)
	SetProperty	This is used to set the named property to the specified value using Reflection. (Inherited from ConvertToMSBuildFormat.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Properties

	Name	Description
	OldFolder	Get the old project folder (Inherited from ConvertToMSBuildFormat.)
	OldProjectFile	Get the old project filename (Inherited from ConvertToMSBuildFormat.)
	Project	Get the new project (Inherited from ConvertToMSBuildFormat.)
	ProjectFolder	Get the new project folder (Inherited from ConvertToMSBuildFormat.)
	Reader	An XML reader isn't used by this converter (Overrides ConvertToMSBuildFormatReader.)