SubstitutionTagReplacement Class

This class handles substitution tag replacement in build template files

Definition

Namespace: SandcastleBuilder.Utils.BuildEngine
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.2.18.0
public class SubstitutionTagReplacement
Inheritance
Object    SubstitutionTagReplacement

Remarks

Replacement tags appear in the form of a tag name prefixed with an '@' and enclosed in curly braces ({@PropertyName}). An optional format specifier is also allowed if needed such as for date formatting ({@BuildDate:MMMM d, yyyy}).

Methods in this class tagged with the SubstitutionTagAttribute attribute represent substitution tags that require additional handling. For simple types that require no special handling and those that require only minor changes, the value returned by ReplacementValueFor(String) is used and there is no corresponding method in this class.

Constructors

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)
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)
ToStringReturns a string that represents the current object.
(Inherited from Object)
TransformTemplate Transform the specified template file by inserting the necessary values into the substitution tags and saving it to the destination folder.
TransformText Transform the specified template text by replacing the substitution tags with the corresponding project property values.

See Also