Template.Format Method (Boolean, Options, IArgumentRelations, String, Object[])

Formats the list of arguments into the format string using given options.

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

Syntax

private static string Format(
	bool discard,
	Options options,
	out IArgumentRelations relations,
	string format,
	params Object[] arguments
)

discard: Type: System.Boolean
This parameter is only for internal handling and tells the method to resolve relation assignments or not.
options: Type: Plexdata.Utilities.Formatting.Options
An instance of class Options with detailed formatting instructions.
relations: Type: Plexdata.Utilities.Formatting.Interfaces.IArgumentRelations
When this method returns, this parameter contains a list of Label-Value relations consisting of the labels taken from format and the arguments as their values.
format: Type: System.String
A string containing formatting instructions, either for index-based formatting, like "{0}, {1}, ...", or for template-based formatting, like "{name1}, {name2}, ...").
arguments: Type: System.Object[]
The optional list of arguments to be used.

Type: String
A copy of format with the format elements replaced by the string representation of the corresponding objects in arguments.

This method formats the list of arguments into the format string using given options.