Click or drag to resize
Sandcastle Help File BuilderMSBuildProject Class
This is a simple wrapper around an MSBuild project that is used to extract information from it during a help file build.
Inheritance Hierarchy
SystemObject
  SandcastleBuilder.Utils.MSBuildMSBuildProject

Namespace: SandcastleBuilder.Utils.MSBuild
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0
Syntax
public class MSBuildProject : IDisposable

The MSBuildProject type exposes the following members.

Constructors
  NameDescription
Public methodMSBuildProject
Constructor
Top
Methods
  NameDescription
Public methodDispose
This implements the Dispose() interface to properly dispose of the MSBuild project object.
Protected methodDispose(Boolean)
This can be overridden by derived classes to add their own disposal code if necessary.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
This handles garbage collection to ensure proper disposal of the MSBuild project if not done explicitly with Dispose.
(Overrides ObjectFinalize.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetConfiguration
This is used to set the active configuration and platform used when evaluating the properties.
Public methodSetSolutionMacros
This is used to set the Visual Studio solution macros based on the specified project name.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Properties
  NameDescription
Public propertyAssemblyName
This is used to get the assembly name
Public propertyProjectFile
This is used to get the underlying MSBuild project file reference
Public propertyProjectGuid
This is used to get the project GUID
Public propertyTargetFrameworkIdentifier
This is used to get the target framework identifier
Public propertyTargetFrameworkVersion
This is used to get the target framework type and version
Public propertyXmlCommentsFile
This is used to get the XML comments file name
Top
See Also