docs.unity3d.com
    Show / Hide Table of Contents

    Class TimeFormatter

    Provides the ability to format a DateTime or TimeSpan object.

    Inheritance
    Object
    FormatterBase
    TimeFormatter
    Inherited Members
    FormatterBase.Names
    Namespace: UnityEngine.Localization.SmartFormat.Extensions
    Syntax
    [Serializable]
    public class TimeFormatter : FormatterBase, IFormatter, ISerializationCallbackReceiver

    Constructors

    TimeFormatter()

    Creates a new instance of the formatter.

    Declaration
    public TimeFormatter()

    Properties

    DefaultFormatOptions

    Determines the options for time formatting.

    Declaration
    public TimeSpanFormatOptions DefaultFormatOptions { get; set; }
    Property Value
    Type Description
    UnityEngine.Localization.SmartFormat.Utilities.TimeSpanFormatOptions

    DefaultNames

    Default names to use when Names is null.

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

    DefaultTwoLetterISOLanguageName

    The ISO language name, which will be used for getting the UnityEngine.Localization.SmartFormat.Utilities.TimeTextInfo.

    Declaration
    public string DefaultTwoLetterISOLanguageName { get; set; }
    Property Value
    Type Description
    String

    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
    FormatterBase.TryEvaluateFormat(IFormattingInfo)

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

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    In This Article
    • Constructors
      • TimeFormatter()
    • Properties
      • DefaultFormatOptions
      • DefaultNames
      • DefaultTwoLetterISOLanguageName
    • Methods
      • TryEvaluateFormat(IFormattingInfo)
    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