IBuild
This defines the interface used to interact with a help file builder build process
Definition
Namespace: Sandcastle.Core.BuildEngine
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2026.1.20.0
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2026.1.20.0
C#
public interface IBuildProcessVB
Public Interface IBuildProcessC++
public interface class IBuildProcessF#
type IBuildProcess = interface endProperties
| BuildAssemblerConfigurationFile | This read-only property is used to get the name of the BuildAssembler configuration file |
| BuildAssemblerManifestFile | This read-only property is used to get the name of the BuildAssembler topic manifest file |
| CancellationToken | This is used to get or set the cancellation token for the build if running as a task |
| CommentsFiles | This read-only property is used to get the XML comments files collection |
| ConceptualContent | This read-only property 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 read-only property is used to get the current help file format being generated |
| CurrentProject | This read-only property is used to get the current project being used for the build |
| DefaultTopicFile | This read-only property is used to get the filename of the default topic as determined by the build engine. |
| FrameworkReflectionDataFolder | This read-only property is used to get the name of the folder that contains the reflection data for the selected framework platform and version (.NETFramework 4., .NETCore 4.5, Silverlight 5.0, etc.). |
| Help1CompilerFolder | This read-only property is used to get the name of the HTML Help 1 compiler folder determined by the build process. |
| Help1Files | This read-only property is used to get 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 read-only property is used to get a list of the MS Help Viewer (MSHC) files that were built |
| HtmlExtractHelp1Folder | This read-only property is used to get the Help 1 folder for the title and keyword HTML extract tool during the ExtractingHtmlInfo build step. |
| HtmlExtractLocalizedFolder | This property is used to get or set the localized folder for the title and keyword HTML extract tool during the ExtractingHtmlInfo build step. |
| InheritedDocsReflectionFiles | This read-only property provides access to the generate inherited documentation tool's reflection data files during the GenerateInheritedDocumentation build step. |
| Language | This read-only property returns the language used for resource items, etc. |
| LogFilename | This read-only property is used to get the name of the log file used for saving the build progress messages. |
| MarkdownFiles | This read-only property is used to get a list of the Markdown files that were built |
| OpenXmlFiles | This read-only property is used to get a list of the Open XML files that were built |
| OutputFolder | This read-only property is used to get the output folder where the log file and help file can be found after the build process has finished. |
| PresentationStyle | This read-only property is used to get the presentation instance being used by the build process |
| ProgressReportProvider | This is used to get or set the progress report provider |
| ProjectFilename | This read-only property is used to get the project filename without the folder |
| ProjectFolder | This read-only property returns the project folder name |
| ReferencedNamespaces | This read-only property is used to get 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 read-only property is used to get the name of the reflection information file |
| ResolvedHelpTitle | This read-only property is used to get the HelpTitle project property value with all substitution tags it contains, if any, resolved to actual values. |
| SubstitutionTags | This read-only property is used to get the substitution tag handler |
| SuppressApiFilter | This controls whether or not the API filter is suppressed |
| WebsiteFiles | This read-only property is used to get a list of the website files that were built |
| WorkingFolder | This read-only property is used to get the name of the working files folder |
Methods
| Build | Call this method to perform the build on the project. |
| 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. |
| Load | Load a help file builder project from the given filename unrelated to the current build process |
| ReportError | This is used to report an error that will abort the build |
| ReportProgress | This is used to report progress during the build process within the current step |
| ReportWarning | This is used to report a warning that may need attention |
| Run | Run the specified process with the given arguments |
| Run32BitProject | Run the specified MSBuild project using the 32-bit version of MSBuild |
| RunProject | Run the specified MSBuild project using MSBuild.exe or dotnet.exe |