BuildHelp.ProjectFile Property

BuildHelpProjectFile Property

This is used to pass in the project filename

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

Syntax

C++

Copy

public string ProjectFile { get; set; }

Public Property ProjectFile As String
	Get
	Set

public:
property String^ ProjectFile {
	String^ get ();
	void set (String^ value);
}

member ProjectFile : string with get, set

Property Value

Type: String

Remarks

Since SandcastleProject already wraps the MSBuild project, it seemed redundant to define each and every property on this task and map them to the project properties. As such, this task will attempt to use the executing project to create the Sandcastle project instance. If that fails or AlwaysLoadProject is true, this file will be loaded instead. The downside is that property overrides on the command line will be ignored.

Reference

BuildHelp Class

SandcastleBuilder.Utils.MSBuild Namespace