MSBuildProject Class

This is a simple wrapper around an MSBuild project that is used to extract information from it during a help file build.

Definition

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

public class MSBuildProject : IDisposable

Public Class MSBuildProject
	Implements IDisposable

public ref class MSBuildProject : IDisposable

type MSBuildProject = 
    class
        interface IDisposable
    end

Constructor

AssemblyName	This is used to get the assembly name
ProjectFile	This is used to get the underlying MSBuild project file reference
ProjectGuid	This is used to get the project GUID
RequestedTargetFramework	For projects that use multi-targeting, the documentation source can specify which target it wants to use. If not specified, the first target type is used
TargetFramework	This read-only property is used to get the target framework
TargetFrameworkIdentifier	This is used to get the target framework identifier
TargetFrameworks	This read-only property returns an enumerable list of the target frameworks if specified
TargetFrameworkVersion	This is used to get the target framework type and version
XmlCommentsFile	This is used to get the XML comments file name

Dispose	This implements the Dispose() interface to properly dispose of the MSBuild 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)
Finalize	This handles garbage collection to ensure proper disposal of the MSBuild project if not done explicitly with Dispose. (Overrides ObjectFinalize)
GetHashCode	Serves as the default hash function. (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)
SetConfiguration	This is used to set the active configuration and platform used when evaluating the properties.
SetSolutionMacros	This is used to set the Visual Studio solution macros based on the specified project name.
ToString	Returns a string that represents the current object. (Inherited from Object)

SolutionDir	Solution directory global property
SolutionExt	Solution extension global property
SolutionFileName	Solution filename (no path) global property
SolutionName	Solution name (no path or extension) global property
SolutionPath	Solution path (directory and filename) global property