TopicTransformationCoreLoadTemplateFile Method

Load a template file and perform any necessary substitution tag replacements

Definition

Namespace: Sandcastle.Core.PresentationStyle.Transformation
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.12.21.0

C#View Source Request Example

public static XDocument LoadTemplateFile(
	string templateFilePath,
	IEnumerable<(string Key, string Value)> replacementTags
)

VBView Source Request Example

Public Shared Function LoadTemplateFile ( 
	templateFilePath As String,
	replacementTags As IEnumerable(Of (Key As String, Value As String))
) As XDocument

C++View Source Request Example

public:
static XDocument^ LoadTemplateFile(
	String^ templateFilePath, 
	IEnumerable<ValueTuple<String^, String^>>^ replacementTags
)

F#View Source Request Example

static member LoadTemplateFile : 
        templateFilePath : string * 
        replacementTags : IEnumerable<ValueTuple<string, string>> -> XDocument

Parameters

templateFilePath String: The template file to load
replacementTags IEnumerableValueTupleString, String: An optional enumerable list of tuples containing the substitution tag names and replacement values.

Return Value

XDocument
A copy of the template XML document with the substitution tags replaced with the given text

TopicTransformationCoreLoadTemplateFile Method

Definition

Parameters

Return Value

See Also

Reference