Sandcastle Help File Builder Documentation
Copy
This build component copies elements from an indexed set of XML files into the target document based on
one or more copy commands that define the elements to copy and where to put them.
Definition
Namespace: Sandcastle.Tools.BuildComponents
Assembly: Sandcastle.Tools.BuildComponents (in Sandcastle.Tools.BuildComponents.dll) Version: 2024.9.12.0
Assembly: Sandcastle.Tools.BuildComponents (in Sandcastle.Tools.BuildComponents.dll) Version: 2024.9.12.0
C#
public class CopyFromIndexComponent : BuildComponentCoreVB
Public Class CopyFromIndexComponent
Inherits BuildComponentCoreC++
public ref class CopyFromIndexComponent : public BuildComponentCoreF#
type CopyFromIndexComponent =
class
inherit BuildComponentCore
end- Inheritance
- Object BuildComponentCore CopyFromIndexComponent
Constructors
| CopyFromIndexComponent | Constructor |
Properties
| BuildAssembler |
This read-only property returns a reference to the build assembler instance using the component
(Inherited from BuildComponentCore) |
| Context | This read-only property returns the context to use for the index when evaluating XPath expressions |
| 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)) |
| CreateIndex | This is used to create the index cache |
| 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.
(Overrides BuildComponentCoreDispose(Boolean)) |
| 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) |