Sandcastle Help File Builder Documentation
IBuild
This read-only property is used to get the current help file format being generated
Definition
Namespace: Sandcastle.Core.BuildEngine
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2025.9.30.0
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2025.9.30.0
C#
HelpFileFormats CurrentFormat { get; }VB
ReadOnly Property CurrentFormat As HelpFileFormats
GetC++
property HelpFileFormats CurrentFormat {
HelpFileFormats get ();
}F#
abstract CurrentFormat : HelpFileFormats with getProperty Value
HelpFileFormatsRemarks
The 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.