Sandcastle Help File Builder Documentation
Reference
This class is used to hold reference link information used by the
ResolveReferenceLinksComponent.
Definition
Namespace: Sandcastle.Tools.BuildComponents.Targets
Assembly: Sandcastle.Tools.BuildComponents (in Sandcastle.Tools.BuildComponents.dll) Version: 2025.9.30.0
Assembly: Sandcastle.Tools.BuildComponents (in Sandcastle.Tools.BuildComponents.dll) Version: 2025.9.30.0
C#
public class ReferenceLinkInfoVB
Public Class ReferenceLinkInfoC++
public ref class ReferenceLinkInfoF#
type ReferenceLinkInfo = class end- Inheritance
- Object ReferenceLinkInfo
Constructors
| ReferenceLinkInfo | Constructor |
Properties
| Contents | This read-only property returns the contents of the link |
| DisplayOptions | This read-only property returns the display options for the link |
| DisplayTarget | This read-only property returns the display target of the link |
| PreferOverload | This read-only property indicates whether or not to prefer the overload topic |
| RenderAsLink | This read-only property indicates whether or not to render the element as an actual link |
| Target | This read-only property returns the target of the link |
Methods
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |