SandcastleProject(String, Boolean, Boolean) Constructor

Load a Sandcastle Builder project from the given filename

Definition

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.2.18.0
public SandcastleProject(
	string filename,
	bool mustExist,
	bool useFinalValues
)

Parameters

filename  String
The filename to load
mustExist  Boolean
Specify true if the file must exist or false if a new project should be created if the file does not exist.
useFinalValues  Boolean
True to use final evaluated property values, or false to use the unevaluated property values. For builds, this should always be true. If loading the project for editing, it should always be false.

Exceptions

ArgumentExceptionThis is thrown if a filename is not specified or if it does not exist and mustExist is true.

See Also