ComponentUtilities Class

This class contains properties and methods used to locate and work with build components, plug-ins, syntax generators, and presentation styles.

Definition

Namespace: Sandcastle.Core
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.2.18.0

public static class ComponentUtilities

<ExtensionAttribute>
Public NotInheritable Class ComponentUtilities

[ExtensionAttribute]
public ref class ComponentUtilities abstract sealed

[<AbstractClassAttribute>]
[<SealedAttribute>]
[<ExtensionAttribute>]
type ComponentUtilities = class end

CoreComponentsFolder	This read-only property returns the core build components folder
CoreReflectionDataFolder	This read-only property returns the core reflection data file folder
DefaultSyntaxFilter	This read-only property returns the default syntax filter setting
RootFolder	This read-only property returns the path to the Sandcastle Help File Builder root folder
SupportedLanguages	This read-only property returns a list of languages supported by the help file builder presentation styles.
ThirdPartyComponentsFolder	This read-only property returns the common application data build components folder
ToolsFolder	This read-only property returns the path to the Sandcastle Help File Builder tools folder

AssemblyFolder	This is used to get the physical location of the specified assembly
CreateComponentContainer	This is used to return a composition container filled with the available build components (SHFB plug-ins, presentation styles, BuildAssembler components, and syntax generators).
GetHashCodeDeterministic	This returns a deterministic hash code that is the same in the full .NET Framework and in .NET Core in every session given the same string to hash.
SyntaxFilterGeneratorsFrom	This returns the syntax generator XML elements to insert into a BuildAssembler configuration file for the comma-separated list of syntax filter IDs.
SyntaxFilterLanguagesFrom	This returns the language filter items to used in the presentation style transformation
SyntaxFiltersFrom	This is used to return a collection of syntax filters based on the comma-separated list of IDs passed to the method.
SyntaxGeneratorResourceItemFiles	This returns an enumerable list of resource item files for all defined syntax filters
ToRecognizedSyntaxFilterIds	This is used to convert the given set of comma-separated syntax filter IDs to a set of recognized filter IDs.
XmlStreamAxis(String, IEnumerableString)	This provides a fast and efficient way of querying large XML files for specific element types which themselves may contain instances of the given elements.
XmlStreamAxis(String, String)	This provides a fast and efficient way of querying large XML files for a specific element type