Class KeyIdColumns

Represents 3 possible columns in CSV data:

When importing from CSV all columns are treated as optional however there must be at least 1 Key or Id field. When adding new values to be imported from the CSV the Id field can be left blank or given the value 0, a new Id will be assigned during import.

Inheritance
Object
CsvColumns
KeyIdColumns
Inherited Members
Namespace: UnityEditor.Localization.Plugins.CSV.Columns
Syntax
public class KeyIdColumns : CsvColumns, IKeyColumn

Properties

IdFieldName

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

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

IncludeId

Should the Id field be included as a field when exporting? When importing IdFieldName will be used to determine if the field is present.

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

IncludeSharedComments

Should the shared Comment be included as a field when exporting? When importing SharedCommentFieldName will be used to determine if the field is present.

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

KeyFieldName

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

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

SharedCommentFieldName

The name of the Shared Comments field when importing and exporting. When importing this name will be checked against the headers to determine if a Shared Comment column is present in the CSV data.

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

Methods

ReadBegin(StringTableCollection, CsvReader)

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

ReadEnd(StringTableCollection)

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

ReadKey(CsvReader)

Declaration
public SharedTableData.SharedTableEntry ReadKey(CsvReader reader)
Parameters
Type Name Description
CsvReader reader
Returns
Type Description
SharedTableData.SharedTableEntry
Implements

ReadRow(SharedTableData.SharedTableEntry, CsvReader)

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

WriteBegin(StringTableCollection, CsvWriter)

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

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

Extension Methods

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