ConvertToMSBuildFormat Class

This class is an abstract base class used to convert a project in another format to the new MSBuild format project files used by SHFB 1.8.0.0 and later.

Inheritance Hierarchy

SystemObject
  SandcastleBuilder.Utils.ConversionConvertToMSBuildFormat
    SandcastleBuilder.Utils.ConversionConvertFromDocProject
    SandcastleBuilder.Utils.ConversionConvertFromMSExampleGui
    SandcastleBuilder.Utils.ConversionConvertFromNDoc
    SandcastleBuilder.Utils.ConversionConvertFromSandcastleGui
    SandcastleBuilder.Utils.ConversionConvertFromShfbFile

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

Syntax

C++

Copy

public abstract class ConvertToMSBuildFormat : IDisposable

Public MustInherit Class ConvertToMSBuildFormat
	Implements IDisposable

public ref class ConvertToMSBuildFormat abstract : IDisposable

[<AbstractClassAttribute>]
type ConvertToMSBuildFormat =  
    class
        interface IDisposable
    end

The ConvertToMSBuildFormat type exposes the following members.

Constructors

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

Top

Methods

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

Top

Properties

	Name	Description
	OldFolder	Get the old project folder
	OldProjectFile	Get the old project filename
	Project	Get the new project
	ProjectFolder	Get the new project folder
	Reader	Get the XML text reader used for the conversion

Top

Reference

SandcastleBuilder.Utils.Conversion Namespace