ReferenceLinkSettings Class

This represents reference link settings for the AdditionalReferenceLinksPlugIn

Definition

Namespace: SandcastleBuilder.PlugIns
Assembly: SandcastleBuilder.PlugIns (in SandcastleBuilder.PlugIns.dll) Version: 2024.2.18.0
public class ReferenceLinkSettings : INotifyPropertyChanged
Inheritance
Object    ReferenceLinkSettings
Implements
INotifyPropertyChanged

Constructors

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

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows 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
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
OnPropertyChanged This raises the PropertyChanged event
ToStringReturns 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

See Also