BuildProcess Class

This class is used to handle all aspects of the build process in a separate thread

Definition

Namespace: SandcastleBuilder.Utils.BuildEngine
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.2.18.0
public class BuildProcess
Inheritance
Object    BuildProcess

Constructors

Properties

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
BuildAssemblerConfigurationFile This returns the name of the BuildAssembler configuration file
BuildAssemblerManifestFile This returns the name of the BuildAssembler topic manifest file
BuildStart This read-only property returns the build start time
CancellationToken This is used to get or set the cancellation token for the build if running as a task
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
CurrentBuildStep This read-only property is used to get the current build step
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
FrameworkReflectionData This read-only property returns the framework reflection data settings used by the build
FrameworkReflectionDataFolder This returns the name of the folder that contains the reflection data for the selected framework platform and version (.NETFramework 4.5, .NETCore 4.5, Silverlight 5.0, etc.).
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
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
HtmlExtractTool This provides access to the title and keyword HTML extract tool during the ExtractingHtmlInfo build step.
Language This read-only property returns the language used for resource items, etc.
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
MarkdownFiles This returns a list of the Markdown files that were built
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.
ProgressReportProvider This is used to get or set the progress report provider
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.
ReflectionDataSetDictionary This read-only property returns the framework reflection data dictionary used by the build
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
SubstitutionTags This returns the substitution tag replacement handler instance
SuppressApiFilter This controls whether or not the API filter is suppressed
TaskRunner This returns the task runner instance
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

Methods

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)
EqualsDetermines whether the specified object is equal to the current object.
(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.
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
FindHtmlHelpCompiler Find the HTML help compiler
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetReferencedNamespaces This is used to get an enumerable list of unique namespaces from the given reflection data file
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ReportError This is used to report an error that will abort the build
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
ToStringReturns a string that represents the current object.
(Inherited from Object)
VerifySafePath Make sure the path isn't one the user would regret having nuked without warning

See Also