Reference Link Settings Class
This represents reference link settings for the AdditionalReferenceLinksPlugIn
Definition
Namespace: SandcastleBuilder.PlugIns
Assembly: SandcastleBuilder.PlugIns (in SandcastleBuilder.PlugIns.dll) Version: 2026.3.29.0
Assembly: SandcastleBuilder.PlugIns (in SandcastleBuilder.PlugIns.dll) Version: 2026.3.29.0
C#
public class ReferenceLinkSettings : INotifyPropertyChangedVB
Public Class ReferenceLinkSettings
Implements INotifyPropertyChangedC++
public ref class ReferenceLinkSettings : INotifyPropertyChangedF#
type ReferenceLinkSettings =
class
interface INotifyPropertyChanged
end- Inheritance
- Object ReferenceLinkSettings
- Implements
- INotifyPropertyChanged
Constructors
| ReferenceLinkSettings | Constructor |
Properties
| ErrorMessage | This read-only property returns an error message describing any issues with the settings |
| HelpFileProject | This is used to get or set the path to the help file builder project used to generate reference link information. |
| HtmlSdkLinkType | This is used to get or set the HTML Help 1 SDK link type for the target |
| MSHelpViewerSdkLinkType | This is used to get or set the MS Help Viewer SDK link type for the target |
| ReferenceLinkDescription | This read-only property returns a description of the settings |
| WebsiteSdkLinkType | This is used to get or set the website SDK link type for the target |
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) |
| FromXml | Create a reference link settings instance from an XML element containing the settings |
| 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) |
| OnPropertyChanged | This raises the PropertyChanged event |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| ToXml | Store the reference link settings as an XML element |
Events
| PropertyChanged | The property changed event |