Using CsvFormatProvider

CsvFormatProvider makes it easy to import and export CSV files. Note that CSV is a plain text format,meaning that it keeps only the contents of the worksheet without its formatting. Exporting a file to CSV strips all styling and saves only cell's result value with the respective format applied. Moreover, it exports only the contents of the active worksheet – no support for exporting multiple worksheets into a csv at once is available.

To import and export csv files, you need to use the CsvFormatProvider class that appears in the Telerik.Windows.Documents.Spreadsheet.FormatProviders.TextBased.Csv namespace. The CsvFormatProvider implements the IWorkbookFormatProvider interface which in turn is contained in the Telerik.Windows.Documents.Spreadsheet.FormatProviders namespace.

For more examples and application scenarios of Importing and Exporting a Workbook to various formats using a FormatProvider check out the Import/Load and Export/Save RadSpreadProcessing Workbook knowledge base article.

Import

Example 1 shows how to import a CSV file using a FileStream. The code assures that a file with the specified name exists. Further, the sample instantiates a CsvFormatProvider and passes a FileStream to its Import() method.

Example 1: Import CSV file

• C#

string fileName = "FileName.csv"; 
if (!File.Exists(fileName)) 
{ 
    throw new FileNotFoundException(String.Format("File {0} was not found!", fileName)); 
} 
 
Workbook workbook; 
CsvFormatProvider formatProvider = new CsvFormatProvider(); 
 
using (Stream input = new FileStream(fileName, FileMode.Open)) 
{ 
    //workbook = formatProvider.Import(input); //This method is obsolete since Q4 2024. 
 
    workbook = formatProvider.Import(input, TimeSpan.FromSeconds(10)); 
} 

Export

Example 2 demonstrates how to export an existing Workbook to a CSV file. The snippet creates a new workbook with a single worksheet. Further, it creates a CsvFormatProvider and invokes its Export() method:

Example 2: Export CSV file

• C#

Workbook workbook = new Workbook(); 
workbook.Worksheets.Add(); 
 
string fileName = "SampleFile.csv"; 
CsvFormatProvider formatProvider = new CsvFormatProvider(); 
 
using (Stream output = new FileStream(fileName, FileMode.Create)) 
{ 
    //formatProvider.Export(workbook, output); //This method is obsolete since Q4 2024. 
 
    formatProvider.Export(workbook, output, TimeSpan.FromSeconds(10)); 
}