PDF

Class CsvOptions

Provides properties to manage CSV export behaviors.

Inheritance
System.Object
CsvOptions
Implements
System.IDisposable
Namespace: BoldReports.Writer
Assembly: BoldReports.Web.dll
Syntax
public class CsvOptions : Object, IReportDispose, IDisposable

Constructors

CsvOptions()

Declaration
public CsvOptions()

Properties

EliminateHeader

Gets or sets a value indicating whether to eliminate the header row in the output.

Declaration
public bool EliminateHeader { get; set; }
Property Value
Type Description
System.Boolean

true if the header row should be eliminated; otherwise, false.

Encoding

Gets or sets the encoding of the output file.

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

The default value is UTF-8.

FieldDelimiter

Gets or sets the field delimiter string to separate field in the result.

Declaration
public string FieldDelimiter { get; set; }
Property Value
Type Description
System.String

A string containing the delimiter, the default value is a comma (,).

FileExtension

Gets or sets the extension of the result file. FileExtension are specified then FileExtension will take precedence.

Declaration
public string FileExtension { get; set; }
Property Value
Type Description
System.String

A string containing the file extension.

Qualifier

Gets or sets the qualifier string which is put around the output result if contain the field delimiter or record delimiter.

Declaration
public string Qualifier { get; set; }
Property Value
Type Description
System.String

A string containing the qualifier, the default value is a quotation mark (").

RecordDelimiter

Gets or sets the record delimiter which is put at the end of each record.

Declaration
public string RecordDelimiter { get; set; }
Property Value
Type Description
System.String

A string containing the delimiter, the default value is "\r\n".

SuppressLineBreaks

Gets or sets a boolean value that indicates whether the line breaks are removed from the data included in the output or not.

Declaration
public bool SuppressLineBreaks { get; set; }
Property Value
Type Description
System.Boolean

The default value is false.

UseFormattedValues

Gets or sets a boolean value indicating whether the report formatted text needs to be included in the CSV file.

Declaration
public bool UseFormattedValues { get; set; }
Property Value
Type Description
System.Boolean

The default value is true.

Methods

Dispose()

Provides a mechanism for releasing unmanaged resources.

Declaration
public void Dispose()
Remarks

It close or release unmanaged resources such as files, streams, and handles held by an instance of the class that implements this interface.

Implements

System.IDisposable