StringTemplate Class

NReco.Data Class Library Documentation

Conditional string template parser.

Inheritance Hierarchy

System Object
NReco.Data StringTemplate

Namespace: NReco.Data
Assembly: NReco.Data (in NReco.Data.dll) Version: 1.0.2

Syntax

C++

Copy to Clipboard Print

public class StringTemplate

public class StringTemplate

Public Class StringTemplate

Public Class StringTemplate

public ref class StringTemplate

public ref class StringTemplate

type StringTemplate =  class end

type StringTemplate =  class end

The StringTemplate type exposes the following members.

Constructors

	Name	Description
	StringTemplate(String)	Initializes a new instance of the StringTemplate class
	StringTemplate(String, Int32)	Initializes a new instance of the StringTemplate class

Top

Methods

	Name	Description
	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.)
	FormatTemplate(IDictionary String, Object )	Replaces the format items in a specified string with the string representations of corresponding objects in a specified dictionary.
	FormatTemplate(Func String, StringTemplate TokenResult )	Replaces the format items in a specified string with the string representations of corresponding objects returned by value handler.
	GetHashCode	Serves as a hash function for a particular type. (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.)
	ReadFormatOptions
	ReadName
	ReplaceTokens
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	ExtraNameChars
	Template

Top

Properties

	Name	Description
	RecursionLevel	Get or set max recursion level of token replacement (for cases when token value contains token definitions).
	ReplaceMissedTokens	Get or set flag that determines replacement behaviour when token is not defined (true by default)

Top

Remarks

StringTemplate replaces all tokens started with '@' (token name should have only aphanumeric or '_-' chars). Token processing can be avoided by specifying @@ before any alphanumeric charachter, for example:

Copy to Clipboard Print

@@Test

@@Test

Copy to Clipboard Print

@Test

@Test

(result: ). Special symbols used for formatting syntax ('@',']',';') can be escaped in the following way: \] or ]] (] symbol)\; or ;; (; symbol)

Examples

Copy to Clipboard Print

var strTpl = new StringTemplate("@Name[Hello, {0}; Hi all]!");
Console.Write( strTpl.FormatTemplate( new Dictionary<string,object>() { {"Name", "John"} } ) );  // Hi, John!
Console.Write( strTpl.FormatTemplate( new Dictionary<string,object>() ) );  // Hi, all!

var strTpl = new StringTemplate("@Name[Hello, {0}; Hi all]!");
Console.Write( strTpl.FormatTemplate( new Dictionary<string,object>() { {"Name", "John"} } ) );  // Hi, John!
Console.Write( strTpl.FormatTemplate( new Dictionary<string,object>() ) );  // Hi, all!