Click or drag to resize
Sandcastle Help File Builder

BuildProcess Class

This class is used to handle all aspects of the build process in a separate thread
Inheritance Hierarchy
SystemObject
  SandcastleBuilder.Utils.BuildEngineBuildProcess

Namespace:  SandcastleBuilder.Utils.BuildEngine
Assembly:  SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2019.11.17.0
Syntax
public class BuildProcess
Request Example View Source

The BuildProcess type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyApiTocOrder
This is used to get or set the sort order for API content so that it appears within its parent in the correct position.
Public propertyApiTocParentId
This is used to get or set the table of contents parent for the API content
Public propertyBuildStart
This read-only property returns the build start time
Public propertyCancellationToken
This is used to get or set the cancellation token for the build if running as a task
Public propertyCommentsFiles
This read-only property returns the XML comments files collection
Public propertyConceptualContent
This is used to get the conceptual content settings in effect for the build
Public propertyCurrentBuildStep
This read-only property is used to get the current build step
Public propertyCurrentFormat
This returns the current help file format being generated
Public propertyCurrentProject
This returns the current project being used for the build
Public propertyDefaultTopicFile
This returns the filename of the default topic as determined by the build engine
Public propertyFrameworkReflectionData
This read-only property returns the framework reflection data settings used by the build
Public propertyFrameworkReflectionDataFolder
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.).
Public propertyHelp1CompilerFolder
This returns the name of the HTML Help 1 compiler folder determined by the build process
Public propertyHelp1Files
This returns a list of the HTML Help 1 (CHM) files that were built
Public propertyHelpFormatOutputFolders
This read-only property returns a collection of the output folders specific to each help file format produced by the build.
Public propertyHelpViewerFiles
This returns a list of the MS Help Viewer (MSHC) files that were built
Public propertyLanguage
This read-only property returns the language used for resource items, etc.
Public propertyLanguageFolder
This read-only property returns the resource item file language folder name
Public propertyLoadedPlugIns
Public propertyLogFilename
This returns the name of the log file used for saving the build progress messages
Public propertyMarkdownFiles
This returns a list of the Markdown files that were built
Public propertyMSBuildExePath
This returns the path to MSBuild.exe
Public propertyOpenXmlFiles
This returns a list of the Open XML files that were built
Public propertyOutputFolder
This returns the output folder where the log file and help file can be found after the build process has finished.
Public propertyPartialBuildType
This read-only property is used to get the partial build type
Public propertyPresentationStyle
This returns the presentation instance being used by the build process
Public propertyPresentationStyleFolder
This returns the name of the main Sandcastle presentation style folder determined by the build process.
Public propertyPresentationStyleResourceItemsFolder
This returns the name of the presentation style resource items folder determined by the build process.
Public propertyProgressReportProvider
This is used to get or set the progress report provider
Public propertyProjectFilename
This returns the project filename without the folder
Public propertyProjectFolder
This returns the project folder name
Public propertyReferencedNamespaces
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.
Public propertyReflectionDataSetDictionary
This read-only property returns the framework reflection data dictionary used by the build
Public propertyReflectionInfoFilename
This returns the name of the reflection information file
Public propertyResolvedHelpTitle
This returns the HelpTitle project property value with all substitution tags it contains, if any, resolved to actual values.
Public propertyResolvedHtmlHelpName
This returns the HtmlHelpName project property value with all substitution tags it contains, if any, resolved to actual values.
Public propertyRootContentContainerId
This is used to get or set the topic ID to use for the root content container node
Public propertySubstitutionTags
This returns the substitution tag replacement handler instance
Public propertySuppressApiFilter
This controls whether or not the API filter is suppressed
Public propertyTaskRunner
This returns the task runner instance
Public propertyTemplateFolder
This returns the location of the help file builder template folder
Public propertyWebsiteFiles
This returns a list of the website files that were built
Public propertyWorkingFolder
This returns the name of the working files folder
Top
Methods
  NameDescription
Public methodBuild
Call this method to perform the build on the project.
Public methodEnsureOutputFoldersExist
This is used to ensure that all output folders exist based on the selected help file format(s)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExecuteAfterStepPlugIns
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.
Public methodExecuteBeforeStepPlugIns
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.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodStatic memberFindOnFixedDrives
Find a folder by searching the Program Files folders on all fixed drives.
Protected methodStatic memberFindSdkExecutable
This is used to find the named executable in one of the Visual Studio SDK installation folders.
Protected methodFindTools
Find the Sandcastle tools and the HTML help compiler
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodStatic memberGetReferencedNamespaces
This is used to get an enumerable list of unique namespaces from the given reflection data file
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodReportProgress(String, Object)
This is used to report progress during the build process within the current step
Protected methodReportProgress(BuildStep, String, Object)
This is used to report progress during the build process and possibly update the current step
Public methodReportWarning
This is used to report a warning that may need attention
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodStatic memberVerifySafePath
Make sure the path isn't one the user would regret having nuked without warning
Top
See Also