public class BuildProcess
Public Class BuildProcess
public ref class BuildProcess
type BuildProcess = class end
Thetype exposes the following members.
This is used to get or set the sort order for API content so that it appears within its parent in the correct position.
This is used to get or set the table of contents parent for the API content
This read-only property returns the build start time
This is used to get or set the cancellation token for the build if running as a task
This read-only property returns the XML comments files collection
This is used to get the conceptual content settings in effect for the build
This read-only property is used to get the current build step
This returns the current help file format being generated
This returns the current project being used for the build
This returns the filename of the default topic as determined by the build engine
This read-only property returns the framework reflection data settings used by the build
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.).
This returns the name of the HTML Help 1 compiler folder determined by the build process
This returns a list of the HTML Help 1 (CHM) files that were built
This read-only property returns a collection of the output folders specific to each help file format produced by the build.
This returns a list of the MS Help Viewer (MSHC) files that were built
This read-only property returns the language used for resource items, etc.
This read-only property returns the resource item file language folder name
This returns a DictionaryTKey, TValue containing the currently loaded plug-ins
This returns the name of the log file used for saving the build progress messages
This returns a list of the Markdown files that were built
This returns the path to MSBuild.exe
This returns a list of the Open XML files that were built
This returns the output folder where the log file and help file can be found after the build process has finished.
This read-only property is used to get the partial build type
This returns the presentation instance being used by the build process
This returns the name of the main Sandcastle presentation style folder determined by the build process.
This returns the name of the presentation style resource items folder determined by the build process.
This is used to get or set the progress report provider
This returns the project filename without the folder
This returns the project folder name
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.
This read-only property returns the framework reflection data dictionary used by the build
This returns the name of the reflection information file
This returns the HelpTitle project property value with all substitution tags it contains, if any, resolved to actual values.
This returns the HtmlHelpName project property value with all substitution tags it contains, if any, resolved to actual values.
This is used to get or set the topic ID to use for the root content container node
This returns the substitution tag replacement handler instance
This controls whether or not the API filter is suppressed
This returns the task runner instance
This returns the location of the help file builder template folder
This returns a list of the website files that were built
This returns the name of the working files folder
Call this method to perform the build on the project.
This is used to ensure that all output folders exist based on the selected help file format(s)
Determines whether the specified object is equal to the current object.(Inherited from Object.)
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.
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.
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
Find a folder by searching the Program Files folders on all fixed drives.
This is used to find the named executable in one of the Visual Studio SDK installation folders.
Find the Sandcastle tools and the HTML help compiler
Serves as the default hash function.(Inherited from Object.)
This is used to get an enumerable list of unique namespaces from the given reflection data file
Gets the Type of the current instance.(Inherited from Object.)
Creates a shallow copy of the current Object.(Inherited from 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
This is used to report a warning that may need attention
Returns a string that represents the current object.(Inherited from Object.)
Make sure the path isn't one the user would regret having nuked without warning