Component UtilitiesCreate Component Container Method
This is used to return a composition container filled with the available build components (SHFB
plug-ins, presentation styles, BuildAssembler components, and syntax generators).
Definition
Namespace: Sandcastle.Core
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2026.1.20.0
The a composition container that contains all of the available components
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2026.1.20.0
C#
public static CompositionContainer CreateComponentContainer(
IEnumerable<string> folders,
ComponentAssemblyResolver resolver,
CancellationToken cancellationToken
)VB
Public Shared Function CreateComponentContainer (
folders As IEnumerable(Of String),
resolver As ComponentAssemblyResolver,
cancellationToken As CancellationToken
) As CompositionContainerC++
public:
static CompositionContainer^ CreateComponentContainer(
IEnumerable<String^>^ folders,
ComponentAssemblyResolver^ resolver,
CancellationToken cancellationToken
)F#
static member CreateComponentContainer :
folders : IEnumerable<string> *
resolver : ComponentAssemblyResolver *
cancellationToken : CancellationToken -> CompositionContainer Parameters
- folders IEnumerableString
- An enumerable list of additional folders to search recursively for components.
- resolver ComponentAssemblyResolver
- A component assembly resolver to use or null to use a temporary one
- cancellationToken CancellationToken
- An optional cancellation token or null if not supported by the caller.
Return Value
CompositionContainerThe a composition container that contains all of the available components
Remarks
The following folders are searched in the following order. If the given folder has not been
specified or does not exist, it is ignored.
- The enumerable list of additional folders - This is typically the current project's NuGet packages (package tool paths from the SHFBComponentPath item in their properties file), the project's ComponentPath folder, and the current project's folder. This allows for project-specific build components. Paths are searched in the order given above if specified.
- Common application data folder - The help file builder's common application data folder where third-party build components are typically installed.
- SHFBROOT core components folder - The core Sandcastle Help File Builder components folder and its subfolders. This allows for XCOPY deployments that keep everything together.