docs.unity3d.com
    Show / Hide Table of Contents

    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"

    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.

    Inheritance
    Object
    FormatterBase
    ListFormatter
    Inherited Members
    FormatterBase.Names
    FormatterBase.OnAfterDeserialize()
    FormatterBase.OnBeforeSerialize()
    Namespace: UnityEngine.Localization.SmartFormat.Extensions
    Syntax
    public class ListFormatter : FormatterBase, IFormatter, ISerializationCallbackReceiver, ISource

    Constructors

    ListFormatter(SmartFormatter)

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

    Properties

    DefaultNames

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

    Methods

    TryEvaluateAllLiterals(IFormattingInfo)

    Declaration
    public override bool TryEvaluateAllLiterals(IFormattingInfo formattingInfo)
    Parameters
    Type Name Description
    IFormattingInfo formattingInfo
    Returns
    Type Description
    Boolean
    Overrides
    FormatterBase.TryEvaluateAllLiterals(IFormattingInfo)

    TryEvaluateFormat(IFormattingInfo)

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

    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
    ISource.TryEvaluateSelector(ISelectorInfo)

    Extension Methods

    TupleExtensions.IsValueTuple(Object)
    TupleExtensions.GetValueTupleItemObjects(Object)
    TupleExtensions.GetValueTupleItemObjectsFlattened(Object)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023