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

    Class Csv

    Comma Separated Values (CSV) support. Used to transfer localized data and carry it from one step of the localization process to the other, while allowing interoperability between and among tools.

    Inheritance
    Object
    Csv
    Namespace: UnityEditor.Localization.Plugins.CSV
    Syntax
    public static class Csv

    Methods

    Export(TextWriter, StringTableCollection, IList<CsvColumns>, ITaskReporter)

    Exports a StringTableCollection using columnMappings to control the contents of each exported column. CreateDefaultMapping(Boolean).

    Declaration
    public static void Export(TextWriter writer, StringTableCollection collection, IList<CsvColumns> columnMappings, ITaskReporter reporter = null)
    Parameters
    Type Name Description
    TextWriter writer

    The target that will be populated with CSV data.

    StringTableCollection collection

    The collection to export to CSV.

    IList<CsvColumns> columnMappings
    ITaskReporter reporter

    An optional reporter that can be used to provide feedback during export.

    See Also
    CreateDefaultMapping(Boolean)

    Export(TextWriter, StringTableCollection, ITaskReporter)

    Exports all StringTable in collection using default column mappings generated through CreateDefaultMapping(Boolean).

    Declaration
    public static void Export(TextWriter writer, StringTableCollection collection, ITaskReporter reporter = null)
    Parameters
    Type Name Description
    TextWriter writer

    The target that will be populated with CSV data.

    StringTableCollection collection

    The collection to export to CSV.

    ITaskReporter reporter

    An optional reporter that can be used to provide feedback during export.

    Examples

    This example shows how to export a StringTableCollection to a csv file.

    using (var stream = new StreamWriter("my CSV file.csv", false, Encoding.UTF8))
    {
        var stringTableCollection = LocalizationEditorSettings.GetStringTableCollection("My Strings");
        Export(stream, stringTableCollection);
    }

    ImportInto(TextReader, StringTableCollection, Boolean, ITaskReporter)

    Import the CSV data into collection using columnMappings to control what data will be imported. See KeyIdColumns and LocaleColumns for further details.

    Declaration
    public static void ImportInto(TextReader reader, StringTableCollection collection, bool createUndo = false, ITaskReporter reporter = null)
    Parameters
    Type Name Description
    TextReader reader

    The source of the CSV data.

    StringTableCollection collection

    The target collection to be updated using the CSV data.

    Boolean createUndo

    Should an Undo operation be created so the changes can be undone?

    ITaskReporter reporter

    An optional reporter that can be used to provide feedback during import.

    ImportInto(TextReader, StringTableCollection, IList<CsvColumns>, Boolean, ITaskReporter)

    Import the CSV data into collection using default column mappings generated using CreateDefaultMapping(Boolean).

    Declaration
    public static void ImportInto(TextReader reader, StringTableCollection collection, IList<CsvColumns> columnMappings, bool createUndo = false, ITaskReporter reporter = null)
    Parameters
    Type Name Description
    TextReader reader
    StringTableCollection collection
    IList<CsvColumns> columnMappings
    Boolean createUndo
    ITaskReporter reporter
    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