ComponentUtilities Class
Definition
- Namespace
- Sandcastle.Core
- Assembly
- Sandcastle.Core.dll
This class contains properties and methods used to locate and work with build components, plug-ins, syntax generators, and presentation styles.
public static class ComponentUtilities- Inheritance
-
ComponentUtilities
Properties
| 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 |
Methods
| AssemblyFolder(Assembly) |
This is used to get the physical location of the specified assembly |
| CorrectFilePathSeparators(string) |
This is used to ensure that DirectorySeparatorChar is used to separate the parts of a file path. |
| CreateComponentContainer(IEnumerable<string>, ComponentAssemblyResolver, CancellationToken) |
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(string) |
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. |
| GetReferencedNamespaces(string, IEnumerable<string>) |
This is used to get an enumerable list of unique namespaces from the given reflection data file |
| ReadWithEncoding(string, ref Encoding) |
This is used to read in a file using an appropriate encoding method |
| SyntaxFilterGeneratorsFrom(IEnumerable<ISyntaxGeneratorMetadata>, string) |
This returns the syntax generator XML elements to insert into a BuildAssembler configuration file for the comma-separated list of syntax filter IDs. |
| SyntaxFilterLanguagesFrom(IEnumerable<ISyntaxGeneratorMetadata>, string) |
This returns the language filter items to used in the presentation style transformation |
| SyntaxFiltersFrom(IEnumerable<ISyntaxGeneratorMetadata>, string) |
This is used to return a collection of syntax filters based on the comma-separated list of IDs passed to the method. |
| SyntaxGeneratorResourceItemFiles(CompositionContainer, CultureInfo) |
This returns an enumerable list of resource item files for all defined syntax filters |
| ToRecognizedSyntaxFilterIds(IEnumerable<ISyntaxGeneratorMetadata>, string) |
This is used to convert the given set of comma-separated syntax filter IDs to a set of recognized filter IDs. |
| ToWebsiteOrZipFilePath(string) |
This is used to ensure that a forward slash is used to separate the parts of a website or zip file item path. |
| XmlStreamAxis(string, IEnumerable<string>) |
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 |