ClassExportToCSV
Definition
Namespace:Telerik.WinControls.UI.Export
Assembly:TelerikData.dll
Syntax:
public class ExportToCSV : IExportGridTo
Inheritance: objectExportToCSV
Implements:
Constructors
ExportToCSV(RadGridView)
Create instance of exporter class with specified RadGridView to export
Declaration
public ExportToCSV(RadGridView radGridView)
Parameters
radGridView
RadGridView to export
Properties
ChildViewExportMode
Gets or sets the child view export mode.
Declaration
public ChildViewExportMode ChildViewExportMode { get; set; }
Property Value
The child view export mode.
ColumnDelimiter
Gets or sets the value that will be used for a column delimiter.
EncloseDataWithQuotes
Gets or sets a value indicating whether values are enclosed in quotes in the exported file.
Encoding
Gets or sets the encoding used for the exported file. Default encoding is UTF8.
ExportHierarchy
Set if child rows should be exported.
FileExtension
Set file extension. Default value is csv.
Declaration
public string FileExtension { get; set; }
Property Value
Implements
HiddenColumnOption
Set if hidden column would be exported. Note that ExportAsHidden is not relevant for CSV export.
Declaration
public HiddenOption HiddenColumnOption { get; set; }
Property Value
Implements
HiddenRowOption
Set if hidden rows would be exported. Note that ExportAsHidden is not relevant for CSV export.
Declaration
public HiddenOption HiddenRowOption { get; set; }
Property Value
Implements
PagingExportOption
Sets a value indicating how the export behavies when paging is enabled.
Declaration
public PagingExportOption PagingExportOption { get; set; }
Property Value
The paging export option.
RadGridViewToExport
Set RadGridView that would be exported.
Declaration
public RadGridView RadGridViewToExport { get; set; }
Property Value
Implements
RowDelimiter
Gets or sets the value that will be used for a row delimiter.
SummariesExportOption
Set how to export summary rows.
Declaration
public SummariesOption SummariesExportOption { get; set; }
Property Value
Implements
Methods
AddCustomCSVRow(TableElement, params string[])
Add custom row in the provided csv table element
Declaration
public void AddCustomCSVRow(TableElement csvTableElement, params string[] cellValues)
Parameters
csvTableElement
CSV table element where the new row will be added
cellValues
string[]
Values for the every csv cell object in the custom row
OnCSVCellFormatting(CSVCellFormattingEventArgs)
Declaration
protected virtual void OnCSVCellFormatting(CSVCellFormattingEventArgs e)
Parameters
e
OnCSVTableCreated(CSVTableCreatedEventArgs)
Declaration
protected virtual void OnCSVTableCreated(CSVTableCreatedEventArgs e)
Parameters
e
OnChildViewExporting(ChildViewExportingEventArgs)
Declaration
protected virtual void OnChildViewExporting(ChildViewExportingEventArgs e)
Parameters
e
RunExport(string)
Creates file in csv format.
Declaration
public void RunExport(string fileName)
Parameters
fileName
Export file name
Implements
Events
CSVCellFormatting
Fires when an csv cell was created and needs to be formatted.
Declaration
public event CSVCellFormattingEventHandler CSVCellFormatting
Event Value
CSVTableCreated
Fires when the csv table element was created.
Declaration
public event CSVTableCreatedEventHandler CSVTableCreated
Event Value
ChildViewExporting
Occurs when a child view will be exported.
Declaration
public event ChildViewExportingEventHandler ChildViewExporting
Event Value