Class FormattingInfo | Localization | 0.9.0-preview
docs.unity3d.com
    Show / Hide Table of Contents

    Class FormattingInfo

    Inheritance
    Object
    FormattingInfo
    Namespace: UnityEngine.Localization.SmartFormat.Core.Formatting
    Syntax
    public class FormattingInfo : IFormattingInfo, ISelectorInfo

    Constructors

    FormattingInfo(FormatDetails, Format, Object)

    Declaration
    public FormattingInfo(FormatDetails formatDetails, Format format, object currentValue)
    Parameters
    Type Name Description
    FormatDetails formatDetails
    Format format
    Object currentValue

    FormattingInfo(FormattingInfo, FormatDetails, Format, Object)

    Declaration
    public FormattingInfo(FormattingInfo parent, FormatDetails formatDetails, Format format, object currentValue)
    Parameters
    Type Name Description
    FormattingInfo parent
    FormatDetails formatDetails
    Format format
    Object currentValue

    FormattingInfo(FormattingInfo, FormatDetails, Placeholder, Object)

    Declaration
    public FormattingInfo(FormattingInfo parent, FormatDetails formatDetails, Placeholder placeholder, object currentValue)
    Parameters
    Type Name Description
    FormattingInfo parent
    FormatDetails formatDetails
    Placeholder placeholder
    Object currentValue

    Properties

    Alignment

    Declaration
    public int Alignment { get; }
    Property Value
    Type Description
    Int32
    Implements
    IFormattingInfo.Alignment

    CurrentValue

    Declaration
    public object CurrentValue { get; set; }
    Property Value
    Type Description
    Object
    Implements
    IFormattingInfo.CurrentValue
    ISelectorInfo.CurrentValue

    Format

    Declaration
    public Format Format { get; }
    Property Value
    Type Description
    Format
    Implements
    IFormattingInfo.Format

    FormatDetails

    Declaration
    public FormatDetails FormatDetails { get; }
    Property Value
    Type Description
    FormatDetails
    Implements
    IFormattingInfo.FormatDetails
    ISelectorInfo.FormatDetails

    FormatterOptions

    Declaration
    public string FormatterOptions { get; }
    Property Value
    Type Description
    String
    Implements
    IFormattingInfo.FormatterOptions

    Parent

    Declaration
    public FormattingInfo Parent { get; }
    Property Value
    Type Description
    FormattingInfo

    Placeholder

    Declaration
    public Placeholder Placeholder { get; }
    Property Value
    Type Description
    Placeholder
    Implements
    IFormattingInfo.Placeholder
    ISelectorInfo.Placeholder

    Result

    Declaration
    public object Result { get; set; }
    Property Value
    Type Description
    Object
    Implements
    ISelectorInfo.Result

    Selector

    Declaration
    public Selector Selector { get; set; }
    Property Value
    Type Description
    Selector

    SelectorIndex

    Declaration
    public int SelectorIndex { get; }
    Property Value
    Type Description
    Int32
    Implements
    ISelectorInfo.SelectorIndex

    SelectorOperator

    Declaration
    public string SelectorOperator { get; }
    Property Value
    Type Description
    String
    Implements
    ISelectorInfo.SelectorOperator

    SelectorText

    Declaration
    public string SelectorText { get; }
    Property Value
    Type Description
    String
    Implements
    ISelectorInfo.SelectorText

    Methods

    CreateChild(Placeholder)

    Declaration
    public FormattingInfo CreateChild(Placeholder placeholder)
    Parameters
    Type Name Description
    Placeholder placeholder
    Returns
    Type Description
    FormattingInfo

    FormattingException(String, FormatItem, Int32)

    Declaration
    public FormattingException FormattingException(string issue, FormatItem problemItem = null, int startIndex = -1)
    Parameters
    Type Name Description
    String issue
    FormatItem problemItem
    Int32 startIndex
    Returns
    Type Description
    FormattingException
    Implements
    IFormattingInfo.FormattingException(String, FormatItem, Int32)

    Write(String)

    Declaration
    public void Write(string text)
    Parameters
    Type Name Description
    String text
    Implements
    IFormattingInfo.Write(String)

    Write(String, Int32, Int32)

    Declaration
    public void Write(string text, int startIndex, int length)
    Parameters
    Type Name Description
    String text
    Int32 startIndex
    Int32 length
    Implements
    IFormattingInfo.Write(String, Int32, Int32)

    Write(Format, Object)

    Declaration
    public void Write(Format format, object value)
    Parameters
    Type Name Description
    Format format
    Object value
    Implements
    IFormattingInfo.Write(Format, 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