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
Implements
Inherited Members
Namespace: UnityEngine.Localization.SmartFormat.Extensions
Assembly: Unity.Localization.dll
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

Name Description
ListFormatter(SmartFormatter)

Creates a new instance of the formatter.

Properties

Name Description
DefaultNames

Default names to use when Names is null.

Methods

Name Description
TryEvaluateFormat(IFormattingInfo)

Writes the current value to the output, using the specified format. IF this extension cannot write the value, returns false, otherwise true.
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].
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.