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.
Syntax
[Serializable]
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
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
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
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
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
Methods
ReadBegin(StringTableCollection, CsvReader)
Declaration
public override void ReadBegin(StringTableCollection collection, CsvReader csvReader)
Parameters
Overrides
ReadEnd(StringTableCollection)
Declaration
public override void ReadEnd(StringTableCollection collection)
Parameters
Overrides
ReadKey(CsvReader)
Declaration
public SharedTableData.SharedTableEntry ReadKey(CsvReader reader)
Parameters
| Type |
Name |
Description |
| CsvReader |
reader |
|
Returns
Implements
ReadRow(SharedTableData.SharedTableEntry, CsvReader)
Declaration
public override void ReadRow(SharedTableData.SharedTableEntry keyEntry, CsvReader reader)
Parameters
Overrides
WriteBegin(StringTableCollection, CsvWriter)
Declaration
public override void WriteBegin(StringTableCollection collection, CsvWriter csvWriter)
Parameters
Overrides
WriteRow(SharedTableData.SharedTableEntry, IList<StringTableEntry>, CsvWriter)
Declaration
public override void WriteRow(SharedTableData.SharedTableEntry keyEntry, IList<StringTableEntry> tableEntries, CsvWriter writer)
Parameters
Overrides