diff options
Diffstat (limited to 'ThirdParty/CsvHelper-master/src/CsvHelper.Website/input/examples/writing')
5 files changed, 191 insertions, 0 deletions
diff --git a/ThirdParty/CsvHelper-master/src/CsvHelper.Website/input/examples/writing/appending-to-an-existing-file/index.md b/ThirdParty/CsvHelper-master/src/CsvHelper.Website/input/examples/writing/appending-to-an-existing-file/index.md new file mode 100644 index 0000000..c709017 --- /dev/null +++ b/ThirdParty/CsvHelper-master/src/CsvHelper.Website/input/examples/writing/appending-to-an-existing-file/index.md @@ -0,0 +1,52 @@ +# Appending to an Existing CSV File + +###### Example + +```cs +void Main() +{ + var records = new List<Foo> + { + new Foo { Id = 1, Name = "one" }, + }; + + // Write to a file. + using (var writer = new StreamWriter("path\\to\\file.csv")) + using (var csv = new CsvWriter(writer, CultureInfo.InvariantCulture)) + { + csv.WriteRecords(records); + } + + records = new List<Foo> + { + new Foo { Id = 2, Name = "two" }, + }; + + // Append to the file. + var config = new CsvConfiguration(CultureInfo.InvariantCulture) + { + // Don't write the header again. + HasHeaderRecord = false, + }; + using (var stream = File.Open("path\\to\\file.csv", FileMode.Append)) + using (var writer = new StreamWriter(stream)) + using (var csv = new CsvWriter(writer, config)) + { + csv.WriteRecords(records); + } +} + +public class Foo +{ + public int Id { get; set; } + public string Name { get; set; } +} +``` + +###### Output + +``` +Id,Name +1,one +2,two +``` diff --git a/ThirdParty/CsvHelper-master/src/CsvHelper.Website/input/examples/writing/index.md b/ThirdParty/CsvHelper-master/src/CsvHelper.Website/input/examples/writing/index.md new file mode 100644 index 0000000..d019dd6 --- /dev/null +++ b/ThirdParty/CsvHelper-master/src/CsvHelper.Website/input/examples/writing/index.md @@ -0,0 +1,51 @@ +# Writing + +<h2 class="title is-2 has-text-danger">Injection Warning</h2> + +When opening a CSV in an external program, a formula in a field could be ran that contains a vulnerability. +Read more here: [CSV Injection](https://owasp.org/www-community/attacks/CSV_Injection). +Due to this issue, there is a setting `InjectionOptions` that can be configured. + +The list of injection characters to detect are configurable in `CsvConfiguration.InjectionCharacters` +and default to `=`, `@`, `+`, `-`, `\t`, `\r`. An injection character can be the first character of a field +or quoted field. i.e. `=foo` or `"=foo"` + +The `InjectionOptions` values are `None` (default), `Escape`, `Strip`, and `Exception`. + +###### None + +No injection protection is taken. + +###### Exception + +If an injection character is detected, a `CsvWriterException` is thrown. + +###### Strip + +All injection characters at the start of a field will be removed. `===foo` will be stripped to `foo`. + +###### Escape + +If an injection character is detected, the field will be prepended with the `InjectionEscapeCharacter` +that defaults to `'`. The field will be quoted if it is not already. + +`=one` -> `"'=one"` + +`"=one"` -> `"'=one"` + +`=one"two` -> `"'=one""two"` + +This option is disabled by default because the primary goal if this library is to read and write CSV +files. If you are storing user entered data that you haven't sanitized yourself and you're letting +it be accessed by people that may open in Excel/Sheets/etc, you might consider enabling this feature. +The `InjectionEscapeCharacter` is not removed when reading. + +When writing, you can throw an enumerable of class objects, dynamic objects, anonymous type objects, or pretty much +anything else, and it will get written. + +Topics | +- | - +[Write Class Objects](~/examples/writing/write-class-objects) | +[Write Dynamic Objects](~/examples/writing/write-dynamic-objects) | +[Write Anonymous Type Objects](~/examples/writing/write-anonymous-type-objects) | +[Appending to an Existing File](~/examples/writing/appending-to-an-existing-file) | diff --git a/ThirdParty/CsvHelper-master/src/CsvHelper.Website/input/examples/writing/write-anonymous-type-objects/index.md b/ThirdParty/CsvHelper-master/src/CsvHelper.Website/input/examples/writing/write-anonymous-type-objects/index.md new file mode 100644 index 0000000..3beedd5 --- /dev/null +++ b/ThirdParty/CsvHelper-master/src/CsvHelper.Website/input/examples/writing/write-anonymous-type-objects/index.md @@ -0,0 +1,26 @@ +# Write Anonymous Type Objects + +###### Example + +```cs +void Main() +{ + var records = new List<object> + { + new { Id = 1, Name = "one" }, + }; + + using (var writer = new StreamWriter("path\\to\\file.csv")) + using (var csv = new CsvWriter(writer, CultureInfo.InvariantCulture)) + { + csv.WriteRecords(records); + } +} +``` + +###### Output + +``` +Id,Name +1,one +``` diff --git a/ThirdParty/CsvHelper-master/src/CsvHelper.Website/input/examples/writing/write-class-objects/index.md b/ThirdParty/CsvHelper-master/src/CsvHelper.Website/input/examples/writing/write-class-objects/index.md new file mode 100644 index 0000000..4327224 --- /dev/null +++ b/ThirdParty/CsvHelper-master/src/CsvHelper.Website/input/examples/writing/write-class-objects/index.md @@ -0,0 +1,32 @@ +# Write Class Objects + +###### Example + +```cs +void Main() +{ + var records = new List<Foo> + { + new Foo { Id = 1, Name = "one" }, + }; + + using (var writer = new StreamWriter("path\\to\\file.csv")) + using (var csv = new CsvWriter(writer, CultureInfo.InvariantCulture)) + { + csv.WriteRecords(records); + } +} + +public class Foo +{ + public int Id { get; set; } + public string Name { get; set; } +} +``` + +###### Output + +``` +Id,Name +1,one +``` diff --git a/ThirdParty/CsvHelper-master/src/CsvHelper.Website/input/examples/writing/write-dynamic-objects/index.md b/ThirdParty/CsvHelper-master/src/CsvHelper.Website/input/examples/writing/write-dynamic-objects/index.md new file mode 100644 index 0000000..8f025bb --- /dev/null +++ b/ThirdParty/CsvHelper-master/src/CsvHelper.Website/input/examples/writing/write-dynamic-objects/index.md @@ -0,0 +1,30 @@ +# Write Dynamic Objects + +###### Example + +```cs +void Main() +{ + var records = new List<dynamic>(); + + dynamic record = new ExpandoObject(); + record.Id = 1; + record.Name = "one"; + records.Add(record); + + using (var writer = new StringWriter()) + using (var csv = new CsvWriter(writer, CultureInfo.InvariantCulture)) + { + csv.WriteRecords(records); + + writer.ToString().Dump(); + } +} +``` + +###### Output + +``` +Id,Name +1,one +``` |