BuildProcessCurrentFormat Property

This returns the current help file format being generated

Definition

Namespace: SandcastleBuilder.Utils.BuildEngine
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0

C#View Source Request Example

public HelpFileFormats CurrentFormat { get; }

VBView Source Request Example

Public ReadOnly Property CurrentFormat As HelpFileFormats
	Get

C++View Source Request Example

public:
property HelpFileFormats CurrentFormat {
	HelpFileFormats get ();
}

F#View Source Request Example

member CurrentFormat : HelpFileFormats with get

Property Value

HelpFileFormats

Remarks

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.

BuildProcessCurrentFormat Property

Definition

Property Value

Remarks

See Also

Reference