AdditionalHeaderResourcesComponent Class

This component is used add additional metadata, style sheet, and script file resources to the header of the transformed topics.

Definition

Namespace: Sandcastle.Tools.BuildComponents
Assembly: Sandcastle.Tools.BuildComponents (in Sandcastle.Tools.BuildComponents.dll) Version: 2024.2.18.0

C#View Source Request Example

public class AdditionalHeaderResourcesComponent : BuildComponentCore

VBView Source Request Example

Public Class AdditionalHeaderResourcesComponent
	Inherits BuildComponentCore

C++View Source Request Example

public ref class AdditionalHeaderResourcesComponent : public BuildComponentCore

F#View Source Request Example

type AdditionalHeaderResourcesComponent = 
    class
        inherit BuildComponentCore
    end

Inheritance: Object BuildComponentCore AdditionalHeaderResourcesComponent

Remarks

The configuration consists of a set of script and stylesheet elements with a name attribute that specifies the file to add. The appropriate script and link elements will be appended to the end of the head element. In addition, meta elements can be added. The metadata will be added to the start of the head element verbatim.

Constructors

AdditionalHeaderResourcesComponent

Constructor

Properties

BuildAssembler	This read-only property returns a reference to the build assembler instance using the component (Inherited from BuildComponentCore)
GroupId	This is used to set an optional group ID for use with component events (Inherited from BuildComponentCore)

Methods

Apply	This abstract method must be overridden to apply the build component's changes to the specified document. (Overrides BuildComponentCoreApply(XmlDocument, String))
Dispose	This implements the Dispose() interface to properly dispose of the build component. (Inherited from BuildComponentCore)
Dispose(Boolean)	This can be overridden by derived classes to add their own disposal code if necessary. (Inherited from BuildComponentCore)
Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
Finalize	This handles garbage collection to ensure proper disposal of the build component if not done explicitly with Dispose. (Inherited from BuildComponentCore)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
Initialize	This abstract method must be overridden to initialize the component (Overrides BuildComponentCoreInitialize(XPathNavigator))
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
OnComponentEvent	This can be used to raise the ComponentEvent event with the specified event arguments. (Inherited from BuildComponentCore)
ToString	Returns a string that represents the current object. (Inherited from Object)
WriteMessage(MessageLevel, String, Object)	This can be used to report a message (Inherited from BuildComponentCore)
WriteMessage(String, MessageLevel, String, Object)	This can be used to report a message for a specific topic ID (Inherited from BuildComponentCore)