Click or drag to resize
Sandcastle Help File Builder

BuildProcessCurrentFormat Property

This returns the current help file format being generated

Namespace:  SandcastleBuilder.Utils.BuildEngine
Assembly:  SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2019.11.17.0
Syntax
public HelpFileFormats CurrentFormat { get; }
Request Example View Source

Property Value

Type: HelpFileFormats
Remarks
The GenerateHelpFormatTableOfContents, GenerateHelpFileIndex, GenerateHelpProject, and CompilingHelpFile steps will run once for each help file format selected. This property allows a plug-in to determine which files it may need to work with during those steps or to skip processing if it is not relevant.
See Also