Click or drag to resize
Sandcastle Help File BuilderBuildProcess Methods

The BuildProcess type exposes the following members.

Methods
  NameDescription
Public methodApplyManualApiFilter
This is used to manually apply the specified API filter to the specified reflection information file
Public methodApplyVisibilityProperties
Apply the project's Visibility category properties to the given reflection information file
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 a hash function for a particular type.
(Inherited from Object.)
Public methodGetReferencedNamespaces
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.)
Protected methodOnBuildProgress
This raises the BuildProgress event.
Protected methodOnBuildStepChanged
This raises the BuildStepChanged event.
Public methodStatic memberReadWithEncoding
This is used to read in a file using an appropriate encoding method
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 methodRunProcess
This is used to run a step in the build process
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTransformTemplate
Transform the specified template by inserting the necessary values into the place holders and saving it to the working folder.
Public methodTransformText
Transform the specified template text by inserting the necessary values into the place holders tags.
Public methodStatic memberVerifySafePath
Make sure the path isn't one the user would regret having nuked without warning
Top
See Also