Sandcastle Help File Builder Documentation
Reference
Create a reference link settings instance from an XML element containing the settings
Definition
Namespace: SandcastleBuilder.PlugIns
Assembly: SandcastleBuilder.PlugIns (in SandcastleBuilder.PlugIns.dll) Version: 2024.12.21.0
A ReferenceLinkSettings object containing the settings from the XML element
Assembly: SandcastleBuilder.PlugIns (in SandcastleBuilder.PlugIns.dll) Version: 2024.12.21.0
C#
public static ReferenceLinkSettings FromXml(
IBasePathProvider pathProvider,
XElement configuration
)VB
Public Shared Function FromXml (
pathProvider As IBasePathProvider,
configuration As XElement
) As ReferenceLinkSettingsC++
public:
static ReferenceLinkSettings^ FromXml(
IBasePathProvider^ pathProvider,
XElement^ configuration
)F#
static member FromXml :
pathProvider : IBasePathProvider *
configuration : XElement -> ReferenceLinkSettings Parameters
- pathProvider IBasePathProvider
- The base path provider object
- configuration XElement
- The XML element from which to obtain the settings.
Return Value
ReferenceLinkSettingsA ReferenceLinkSettings object containing the settings from the XML element
Remarks
It should contain an element called target with two attributes (linkType and
helpFileProject).