ListFormatter
Formats each item individually when the source value is an array (or supports ICollection). Syntax: #1: "format|spacer" #2: "format|spacer|last spacer" #3: "format|spacer|last spacer|two spacer" 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. Example: CustomFormat("{Dates:D|; |; and }", {#1/1/2000#, #12/31/2999#, #9/9/9999#}) = "January 1, 2000; December 31, 2999; and September 9, 9999" In this example, format = "D", spacer = "; ", and last spacer = "; and " Advanced: Composite Formatting is allowed in the format by using nested braces. If a nested item is detected, Composite formatting will be used. Example: CustomFormat("{Sizes:{Width}x{Height}|, }", {new Size(4,3), new Size(16,9)}) = "4x3, 16x9" In this example, format = "{Width}x{Height}". Notice the nested braces.
Read time 1 minuteLast updated 6 days ago
Definition
- Type: Class
- Namespace: Unity.SmartStrings.Extensions
- Assembly: UnityEngine.SmartStringsModule
- Inherits from: FormatterBase
- Implements: IFormatter, ISource, IInitializer, IFormatterLiteralExtractor
public class ListFormatter : FormatterBase, IFormatter, ISource, IInitializer, IFormatterLiteralExtractor
Remarks
The ListFormatter PluralLocalizationExtension and ConditionalExtension
Constructors
Constructor | Description |
|---|---|
| ListFormatter() | Creates a new instance of the formatter. |
Properties
Property | Description |
|---|---|
| SplitChar | The character used to split the option text literals. Valid characters are: | (pipe) , (comma) ~ (tilde) |
Methods
Method | Description |
|---|---|
| TryEvaluateFormat | Writes the given IFormattingInfo to the IOutput if it can be processed by the formatter. |
| TryEvaluateSelector | 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]. |