This build component is used to obtain version information for each topic so that it can be placed in the footer by the PostTransformComponent.

Namespace: SandcastleBuilder.Components
Assembly: SandcastleBuilder.Components (in SandcastleBuilder.Components.dll) Version: 1.9.3.0

Syntax

C#
public class VersionInfoComponent : BuildComponent
Visual Basic
Public Class VersionInfoComponent _
	Inherits BuildComponent

Remarks

The PostTransformComponent adds the version information to the topic after it has been transformed into HTML. We need to get the version information here though as the reference information is lost once it has been transformed.

Examples

CopyExample configuration
<!-- Version information component configuration.  This must
     appear before the TransformComponent.  See also:
     PostTransformComponent -->
<component type="SandcastleBuilder.Components.VersionInfoComponent"
  assembly="C:\SandcastleBuilder\SandcastleBuilder.Components.dll">
    <!-- Reflection information file for version info (required) -->
    <reflectionFile filename="reflection.xml" />
</component>

Inheritance Hierarchy

System..::..Object
  Microsoft.Ddue.Tools..::..BuildComponent
    SandcastleBuilder.Components..::..VersionInfoComponent

See Also