TemplateWeaver.GetFormattedValue Method

Converts the argument into its string representation.

Namespace: Plexdata.Utilities.Formatting.Helpers
Assembly: Plexdata.Utilities.Templates (in Plexdata.Utilities.Templates.dll) Version: 1.0.0

Syntax

private static string GetFormattedValue(
	this BaseToken token,
	Options options,
	Object argument
)

token: Type: Plexdata.Utilities.Formatting.Entities.BaseToken
The token to be processed.
options: Type: Plexdata.Utilities.Formatting.Options
The options to be used.
argument: Type: System.Object
The argument to be formatted.

Type: String
The argument in its formatted representation.

In Visual Basic and C#, you can call this method as an instance method on any object of type BaseToken. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

This method converts the argument into its string representation by taking their specific format instructions into account.

The argument is stringified if its format instruction starts with '$'.

The argument is serialized if its format instruction starts with '@'.

The argument is formatted if its format instruction does neither start with '$' nor with '@'.

Furthermore, in case of an exception the result contains the exception name and message instead.