This is a derived CopyFromIndexComponent class that loads the index document cache from a serialized binary file rather than loading it from the XML reflection data files. This can significantly decrease the amount of time needed to instantiate the component.

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

Syntax

C#
public class CachedCopyFromIndexComponent : CopyFromIndexComponent
Visual Basic
Public Class CachedCopyFromIndexComponent _
	Inherits CopyFromIndexComponent

Examples

CopyCached Reflection Index Data Example
<!-- Cached Reflection Index Data component.  This should replace
     the first instance of the CopyFromIndexComponent. -->
<component id="Cached Reflection Index Data"
  type="SandcastleBuilder.Components.CachedCopyFromIndexComponent"
  assembly="C:\SandcastleBuilder\SandcastleBuilder.Components.dll">
    <index name="reflection" value="/reflection/apis/api"
       key="@id" cache="10">
        <cache base="C:\Program Files\Sandcastle\Data\Reflection"
            recurse="true" files="*.xml"
            cacheFile="C:\SandcastleBuilder\Cache\Reflection.cache"/>
        <data files="reflection.xml" />
    </index>
    <copy name="reflection" source="*" target="/document/reference" />
</component>
CopyCached Framework Comments Index Data Example
<!-- Cached Framework Comments Index Data component.  This should
     replace the third instance of the CopyFromIndexComponent. -->
<component id="Cached Framework Comments Index Data"
  type="SandcastleBuilder.Components.CachedCopyFromIndexComponent"
  assembly="C:\SandcastleBuilder\SandcastleBuilder.Components.dll">
    <index name="comments" value="/doc/members/member"
      key="@name" cache="100">
      <cache files="%SystemRoot%\Microsoft.NET\Framework\v2.0.50727\en\*.xml"
        cacheFile="C:\SandcastleBuilder\Cache\en_2.0.50727.cache" />
      <data files="ExtraComments.xml" />
      <data files="TestDoc.xml" />
      <data files="_InheritedDocs_.xml" />
    </index>
    <copy name="comments" source="*" target="/document/comments" />
</component>

Inheritance Hierarchy

System..::..Object
  Microsoft.Ddue.Tools..::..BuildComponent
    Microsoft.Ddue.Tools..::..CopyFromIndexComponent
      SandcastleBuilder.Components..::..CachedCopyFromIndexComponent

See Also