BuildProcess Class |
Namespace: SandcastleBuilder.Utils.BuildEngine
The BuildProcess type exposes the following members.
Name | Description | |
---|---|---|
BuildProcess(SandcastleProject) |
Constructor
| |
BuildProcess(SandcastleProject, PartialBuildType) |
Constructor
|
Name | Description | |
---|---|---|
ApplyManualApiFilter |
This is used to manually apply the specified API filter to the specified reflection information file
| |
ApplyVisibilityProperties |
Apply the project's Visibility category properties to the given reflection information file
| |
Build |
Call this method to perform the build on the project.
| |
EnsureOutputFoldersExist |
This is used to ensure that all output folders exist based on the selected help file format(s)
| |
Equals | (Inherited from Object.) | |
ExecuteAfterStepPlugIns |
This can be used by plug-ins using the
InsteadOf execution behavior to execute plug-ins that want to run
after the plug-in has executed its main processing.
| |
ExecuteBeforeStepPlugIns |
This can be used by plug-ins using the
InsteadOf execution behavior to execute plug-ins that want to run
before the plug-in executes its main processing.
| |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
FindOnFixedDrives |
Find a folder by searching the Program Files folders on all fixed drives.
| |
FindSdkExecutable |
This is used to find the named executable in one of the Visual Studio SDK installation folders.
| |
FindTools |
Find the Sandcastle tools and the HTML help compiler
| |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetReferencedNamespaces |
This is used to get an enumerable list of unique namespaces from the given reflection data file
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnBuildProgress |
This raises the BuildProgress event.
| |
OnBuildStepChanged |
This raises the BuildStepChanged event.
| |
ReadWithEncoding |
This is used to read in a file using an appropriate encoding method
| |
ReportProgress(String, Object) |
This is used to report progress during the build process within the current step
| |
ReportProgress(BuildStep, String, Object) |
This is used to report progress during the build process and possibly update the current step
| |
ReportWarning |
This is used to report a warning that may need attention
| |
RunProcess |
This is used to run a step in the build process
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
TransformTemplate |
Transform the specified template by inserting the necessary values into the place holders and saving
it to the working folder.
| |
TransformText |
Transform the specified template text by inserting the necessary
values into the place holders tags.
| |
VerifySafePath |
Make sure the path isn't one the user would regret having nuked without warning
|
Name | Description | |
---|---|---|
ApiTocOrder |
This is used to get or set the sort order for API content so that it appears within its parent in the
correct position.
| |
ApiTocParentId |
This is used to get or set the table of contents parent for the API content
| |
BuildApiFilter |
This read-only property returns the API filter that is used at build-time to filter the API elements
| |
BuildCanceled |
This is used to get the cancellation state of the build
| |
CommentsFiles |
This read-only property returns the XML comments files collection
| |
ConceptualContent |
This is used to get the conceptual content settings in effect for the build
| |
CurrentFormat |
This returns the current help file format being generated
| |
CurrentProject |
This returns the current project being used for the build
| |
DefaultTopicFile |
This returns the filename of the default topic as determined by the build engine
| |
FrameworkSettings |
This read-only property returns the framework settings used by the build
| |
Help1CompilerFolder |
This returns the name of the HTML Help 1 compiler folder determined by the build process
| |
Help1Files |
This returns a list of the HTML Help 1 (CHM) files that were built
| |
Help2CompilerFolder |
This returns the name of the MS Help 2 compiler folder determined by the build process
| |
Help2Files |
This returns a list of the MS Help 2 (HxS) files that were built
| |
HelpFormatOutputFolders |
This read-only property returns a collection of the output folders specific to each help file format
produced by the build.
| |
HelpViewerFiles |
This returns a list of the MS Help Viewer (MSHC) files that were built
| |
LoadedPlugIns |
This returns a DictionaryTKey, TValue containing the currently loaded plug-ins.
| |
LogFilename |
This returns the name of the log file used for saving the build progress messages
| |
MSBuildExePath |
This returns the path to MSBuild.exe
| |
OpenXmlFiles |
This returns a list of the Open XML files that were built
| |
OutputFolder |
This returns the output folder where the log file and help file can be found after the build process
has finished.
| |
PartialBuildType |
This read-only property is used to get the partial build type
| |
PresentationStyle |
This returns the presentation instance being used by the build process
| |
PresentationStyleFolder |
This returns the name of the main Sandcastle presentation style folder determined by the build
process.
| |
PresentationStyleResourceItemsFolder |
This returns the name of the presentation style resource items folder determined by the build
process.
| |
ProjectFilename |
This returns the project filename without the folder
| |
ProjectFolder |
This returns the project folder name
| |
ReferencedNamespaces |
This read-only property returns a hash set used to contain a list of namespaces referenced by the
project reflection data files, project XML comments files, and base framework XML comments files.
| |
ReflectionInfoFilename |
This returns the name of the reflection information file
| |
ResolvedHelpTitle |
This returns the HelpTitle project property value with all
substitution tags it contains, if any, resolved to actual values.
| |
ResolvedHtmlHelpName |
This returns the HtmlHelpName project property value with all
substitution tags it contains, if any, resolved to actual values.
| |
RootContentContainerId |
This is used to get or set the topic ID to use for the root content container node
| |
SuppressApiFilter |
This controls whether or not the API filter is suppressed
| |
TemplateFolder |
This returns the location of the help file builder template folder
| |
WebsiteFiles |
This returns a list of the website files that were built
| |
WorkingFolder |
This returns the name of the working files folder
|
Name | Description | |
---|---|---|
BuildProgress |
This event is raised to report progress information throughout
each build step.
| |
BuildStepChanged |
This event is raised to report a change in the build step
|