New to Telerik Document ProcessingStart a free 30-day trial

Configures delimiter, quote, encoding, and header options for CSV file import and export operations.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.FormatProviders.TextBased.Core

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

C#
public class CsvSettings

Inheritance: objectCsvSettings

Constructors

Initializes a new instance of the CsvSettings class with default values from the current culture for delimiter, quote, and encoding.

C#
public CsvSettings()

Methods

Determines whether the specified object is a CsvSettings instance with equal delimiter, quote, header row, and encoding values.

C#
public override bool Equals(object obj)
Parameters:objobject

The object to compare with the current object.

Returns:

bool

true if the specified object is equal to the current object; otherwise, false.

Overrides: object.Equals(object)

Computes a hash code by combining the hash codes of delimiter, quote, header row, and encoding properties.

C#
public override int GetHashCode()
Returns:

int

A hash code for the current object.

Overrides: object.GetHashCode()

Operators

Determines whether two CsvSettings instances are not equal by comparing their delimiter, quote, header row, and encoding settings.

C#
public static bool operator !=(CsvSettings first, CsvSettings second)
Parameters:firstCsvSettings

The first value.

secondCsvSettings

The second value.

Returns:

bool

The result of the operator.

Determines whether two CsvSettings instances are equal by comparing their delimiter, quote, header row, and encoding settings.

C#
public static bool operator ==(CsvSettings first, CsvSettings second)
Parameters:firstCsvSettings

The first value.

secondCsvSettings

The second value.

Returns:

bool

The result of the operator.

Properties

Gets or sets the character used to separate values in CSV data, defaulting to the list separator of the current culture.

C#
public char Delimiter { get; set; }
Property Value:

The delimiter symbol.

Gets or sets the text encoding used for reading and writing CSV files, defaulting to UTF-8 with BOM.

C#
public Encoding Encoding { get; set; }
Property Value:

The encoding.

Gets or sets a value indicating whether the first row of CSV data contains column headers rather than data, defaulting to false.

C#
public bool HasHeaderRow { get; set; }
Property Value:

The has header row.

Gets or sets the character used to quote values containing delimiters or line breaks, defaulting to double-quote (").

C#
public char Quote { get; set; }
Property Value:

The quote symbol.

Gets or sets a value indicating whether empty cell values are included in the CSV export, affecting trailing delimiters on rows.

C#
public bool ShouldExportEmptyValues { get; set; }
Property Value:

True if the empty values are exported; otherwise false.