CsvConverterSaveTSource(IEnumerableTSource, String, CsvMapping, ActionTSource, Object, Char, Encoding, IReadOnlyCollectionString) Method

public static void Save<TSource>(
	IEnumerable<TSource> data,
	string filePath,
	CsvMapping mapping,
	Action<TSource, Object> conversion,
	char delimiter = ',',
	Encoding? textEncoding = null,
	IReadOnlyCollection<string?>? columnNames = null
)

Public Shared Sub Save(Of TSource) ( 
	data As IEnumerable(Of TSource),
	filePath As String,
	mapping As CsvMapping,
	conversion As Action(Of TSource, Object),
	Optional delimiter As Char = ","C,
	Optional textEncoding As Encoding = Nothing,
	Optional columnNames As IReadOnlyCollection(Of String) = Nothing
)

public:
generic<typename TSource>
static void Save(
	IEnumerable<TSource>^ data, 
	String^ filePath, 
	CsvMapping^ mapping, 
	Action<TSource, Object^>^ conversion, 
	wchar_t delimiter = L',', 
	Encoding^ textEncoding = nullptr, 
	IReadOnlyCollection<String^>^ columnNames = nullptr
)

static member Save : 
        data : IEnumerable<'TSource> * 
        filePath : string * 
        mapping : CsvMapping * 
        conversion : Action<'TSource, Object> * 
        ?delimiter : char * 
        ?textEncoding : Encoding * 
        ?columnNames : IReadOnlyCollection<string> 
(* Defaults:
        let _delimiter = defaultArg delimiter ','
        let _textEncoding = defaultArg textEncoding null
        let _columnNames = defaultArg columnNames null
*)
-> unit 

Parameters

data  IEnumerableTSource

The data to save as CSV file. Each item will be represented with a CSV row.

filePath  String

File path of the CSV file.

mapping  CsvMapping

The CsvMapping used to convert a TSource instance to a CSV row.

conversion  ActionTSource, Object

A method that fills the content of a TSource instance into the properties of mapping.

conversion is called with each CSV row to be written and it gets the TSource instance and mapping as arguments. mapping is passed to the method as dynamic argument: Inside the conversion method the registered DynamicProperty instances can be used like regular .NET properties, but without IntelliSense ("late binding").

With each call of conversion all DynamicProperty instances in mapping are reset to their DefaultValue.

delimiter  Char  (Optional)

The field separator character.

textEncoding  Encoding  (Optional)

The text encoding to be used or null for UTF8.

columnNames  IReadOnlyCollectionString  (Optional)

A collection of column names for the header to be written, or null to use the PropertyNames of mapping as column names.

The collection determines the order in which the columns appear in the CSV file.

The collection will be copied. If the collection contains null values, empty strings, or white space, these are replaced by automatically generated column names. Column names cannot appear twice. By default the comparison is case-sensitive but it will be reset to a case-insensitive comparison if the column names are also unique when treated case-insensitive.

Type Parameters

TSource

Generic type parameter for the data type to write as CSV row.

Creates a new CSV file. If the target file already exists, it is truncated and overwritten.

When exchanging CSV data with Excel, the appropriate arguments can be determined with GetExcelArguments.

Reference