Class CsvSettings

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

Inheritance
System.Object
CsvSettings
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.FormatProviders.TextBased.Core
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class CsvSettings

Constructors

CsvSettings()

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

Declaration
public CsvSettings()

Properties

Delimiter

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

Declaration
public char Delimiter { get; set; }
Property Value
System.Char

The delimiter symbol.

Encoding

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

Declaration
public Encoding Encoding { get; set; }
Property Value
System.Text.Encoding

The encoding.

HasHeaderRow

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

Declaration
public bool HasHeaderRow { get; set; }
Property Value
System.Boolean

The has header row.

Quote

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

Declaration
public char Quote { get; set; }
Property Value
System.Char

The quote symbol.

ShouldExportEmptyValues

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

Declaration
public bool ShouldExportEmptyValues { get; set; }
Property Value
System.Boolean

True if the empty values are exported; otherwise false.

Methods

Equals(Object)

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

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

The object to compare with the current object.
Returns
System.Boolean

true if the specified System.Object is equal to the current System.Object; otherwise, false.
Overrides
System.Object.Equals(System.Object)

GetHashCode()

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

Declaration
public override int GetHashCode()
Returns
System.Int32

A hash code for the current System.Object.
Overrides
System.Object.GetHashCode()

Operators

Equality(CsvSettings, CsvSettings)

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

Declaration
public static bool operator ==(CsvSettings first, CsvSettings second)
Parameters
CsvSettings first

The first value.
CsvSettings second

The second value.
Returns
System.Boolean

The result of the operator.

Inequality(CsvSettings, CsvSettings)

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

Declaration
public static bool operator !=(CsvSettings first, CsvSettings second)
Parameters
CsvSettings first

The first value.
CsvSettings second

The second value.
Returns
System.Boolean

The result of the operator.