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

    Class LocaleColumns

    Represents the localized value and Comment metadata from a StringTable.

    Inheritance
    Object
    CsvColumns
    LocaleColumns
    Inherited Members
    CsvColumns.WriteEnd(StringTableCollection)
    Namespace: UnityEditor.Localization.Plugins.CSV.Columns
    Syntax
    [Serializable]
    public class LocaleColumns : CsvColumns, ISerializationCallbackReceiver

    Properties

    CommentFieldName

    The comments field name when exporting and importing. When importing this name will be checked against the headers to determine if the field is present in the CSV data.

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

    FieldName

    The value field name when exporting and importing. When importing this name will be checked against the headers to determine if the field is present in the CSV data.

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

    IncludeComments

    Should the Comment metadata be exported as a separate column?

    Declaration
    public bool IncludeComments { get; set; }
    Property Value
    Type Description
    Boolean

    LocaleIdentifier

    Used to extract the StringTable from the StringTableCollection when importing and exporting.

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

    Methods

    OnAfterDeserialize()

    Declaration
    public void OnAfterDeserialize()
    Implements
    ISerializationCallbackReceiver.OnAfterDeserialize()

    OnBeforeSerialize()

    Declaration
    public void OnBeforeSerialize()
    Implements
    ISerializationCallbackReceiver.OnBeforeSerialize()

    ReadBegin(StringTableCollection, CsvReader)

    Declaration
    public override void ReadBegin(StringTableCollection collection, CsvReader csvReader)
    Parameters
    Type Name Description
    StringTableCollection collection
    CsvReader csvReader
    Overrides
    CsvColumns.ReadBegin(StringTableCollection, CsvReader)

    ReadEnd(StringTableCollection)

    Declaration
    public override void ReadEnd(StringTableCollection collection)
    Parameters
    Type Name Description
    StringTableCollection collection
    Overrides
    CsvColumns.ReadEnd(StringTableCollection)

    ReadRow(SharedTableData.SharedTableEntry, CsvReader)

    Declaration
    public override void ReadRow(SharedTableData.SharedTableEntry keyEntry, CsvReader reader)
    Parameters
    Type Name Description
    SharedTableData.SharedTableEntry keyEntry
    CsvReader reader
    Overrides
    CsvColumns.ReadRow(SharedTableData.SharedTableEntry, CsvReader)

    SetDefaultFieldNames()

    Declaration
    public void SetDefaultFieldNames()

    WriteBegin(StringTableCollection, CsvWriter)

    Declaration
    public override void WriteBegin(StringTableCollection collection, CsvWriter csvWriter)
    Parameters
    Type Name Description
    StringTableCollection collection
    CsvWriter csvWriter
    Overrides
    CsvColumns.WriteBegin(StringTableCollection, CsvWriter)

    WriteRow(SharedTableData.SharedTableEntry, IList<StringTableEntry>, CsvWriter)

    Declaration
    public override void WriteRow(SharedTableData.SharedTableEntry keyEntry, IList<StringTableEntry> tableEntries, CsvWriter writer)
    Parameters
    Type Name Description
    SharedTableData.SharedTableEntry keyEntry
    IList<StringTableEntry> tableEntries
    CsvWriter writer
    Overrides
    CsvColumns.WriteRow(SharedTableData.SharedTableEntry, IList<StringTableEntry>, CsvWriter)
    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