Version: Unity 6.7 Alpha (6000.7)
LanguageEnglish
  • C#

ListFormatter

class in Unity.SmartStrings.Extensions

/

Inherits from:Unity.SmartStrings.Core.Extensions.FormatterBase


Implements interfaces:IFormatterLiteralExtractor, IInitializer, ISource

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

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.

The ListFormatter PluralLocalizationExtension and ConditionalExtension

Properties

Property Description
SplitChar The character used to split the option text literals. Valid characters are: | (pipe) , (comma) ~ (tilde)

Constructors

Constructor Description
ListFormatter Creates a new instance of the formatter.

Public 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].

Inherited Members

Properties

PropertyDescription
DefaultName Default name to use when FormatterBase.Name is null.