Class ListFormatter

If the source value is an array (or supports ICollection), then each item will be custom formatted. Syntax:

  1. "format|spacer"
  2. "format|spacer|last spacer"
  3. "format|spacer|last spacer|two spacer"

Inheritance
Object
FormatterBase
ListFormatter
Inherited Members
Namespace: UnityEngine.Localization.SmartFormat.Extensions
Syntax
[Serializable]
public class ListFormatter : FormatterBase, IFormatter, ISerializationCallbackReceiver, ISource, IFormatterLiteralExtractor
Examples

The format will be used for each item in the collection, the spacer will be between all items, and the last spacer will replace the spacer for the last item only. In this example, format = "D", spacer = "; ", and last spacer = "; and ".
Format: {Dates:D|; |; and }
Arguments: {#1/1/2000#, #12/31/2999#, #9/9/9999#}
Result: "January 1, 2000; December 31, 2999"

Composite Formatting is allowed in the format by using nested braces. If a nested item is detected, Composite formatting will be used. In this example, format = "{Width}x{Height}". Notice the nested braces.
Format: {Sizes:{Width}x{Height}|, }
Arguments: {new Size(4,3), new Size(16,9)}
Result: "4x3, 16x9"

Constructors

ListFormatter(SmartFormatter)

Creates a new instance of the formatter.

Declaration
public ListFormatter(SmartFormatter formatter)
Parameters
Type Name Description
SmartFormatter formatter

Properties

DefaultNames

Default names to use when Names is null.

Declaration
public override string[] DefaultNames { get; }
Property Value
Type Description
String[]
Overrides

Methods

TryEvaluateFormat(IFormattingInfo)

Writes the current value to the output, using the specified format. IF this extension cannot write the value, returns false, otherwise true.

Declaration
public override bool TryEvaluateFormat(IFormattingInfo formattingInfo)
Parameters
Type Name Description
IFormattingInfo formattingInfo
Returns
Type Description
Boolean
Overrides

TryEvaluateSelector(ISelectorInfo)

This allows an integer to be used as a selector to index an array (or list). This is better described using an example: CustomFormat("{Dates.2.Year}", {#1/1/2000#, #12/31/2999#, #9/9/9999#}) = "9999" The ".2" selector is used to reference Dates[2].

Declaration
public bool TryEvaluateSelector(ISelectorInfo selectorInfo)
Parameters
Type Name Description
ISelectorInfo selectorInfo
Returns
Type Description
Boolean
Implements

WriteAllLiterals(IFormattingInfo)

Ignores the format arguments and writes every possible literal value. This is used to extract all possible values so that we can determine the distinct characters for font generation etc.

Declaration
public void WriteAllLiterals(IFormattingInfo formattingInfo)
Parameters
Type Name Description
IFormattingInfo formattingInfo
Implements

Did you find this page useful? Please give it a rating: