Document PDF export #2706

ntacheva · 2025-01-14T16:15:52Z

Closes https://github.com/telerik/blazor/issues/10641

ikoevska

Great work. Pay attention to some capitalization inconsistencies, the proper use of a and an with abbreviations, and the use of the serial comma and the M-dash.

ikoevska · 2025-01-17T08:49:03Z

components/grid/export/csv.md

@@ -32,11 +32,14 @@ To enable the grid CSV Export, add a [command button](slug://components/grid/col
 </GridToolBarTemplate>
 ````

-Optionally, you can also set the `GridCsvExport` tag settings under the `GridExport` tag to choose:
+Optionally, you can also set the `GridCsvExport` tag settings under the `GridExport` tag to subscribe to the [Grid export events](slug:grid-export-events) that allow further customization of the exported columns/data or configure the CSV export options:


This fragment has become somewhat confusing and hard to read. I recommend some form of rework. For example:

Suggested change

Optionally, you can also set the `GridCsvExport` tag settings under the `GridExport` tag to subscribe to the [Grid export events](slug:grid-export-events) that allow further customization of the exported columns/data or configure the CSV export options:

Optionally, you can also set the `GridCsvExport` tag settings under the `GridExport` tag to subscribe to the [Grid export events](slug:grid-export-events) that allow further customization of the exported columns/data. Alternatively, you can configure the CSV export options:

ikoevska · 2025-01-17T08:49:40Z

components/grid/export/csv.md

-* `ExportToCsvAsync` - `Task<MemoryStream>` - returns the exported data as a `MemoryStream`. The stream itself is finalized, so that the resource does not leak. To read and work with the stream, clone its available binary data to a new `MemoryStream` instance.
+| Method | Type | Description |
+| --- | --- | --- |
+| `SaveAsCsvFileAsync` | `ValueTask` | sends the exported CSV file to the browser for download. |


ikoevska · 2025-01-17T08:56:51Z

components/grid/export/csv.md

+| Method | Type | Description |
+| --- | --- | --- |
+| `SaveAsCsvFileAsync` | `ValueTask` | sends the exported CSV file to the browser for download. |
+| `ExportToCsvAsync` | `Task<MemoryStream>` | returns the exported data as a `MemoryStream`. The stream itself is finalized, so that the resource does not leak. To read and work with the stream, clone its available binary data to a new `MemoryStream` instance. |


Suggested change

| `ExportToCsvAsync` | `Task<MemoryStream>` | returns the exported data as a `MemoryStream`. The stream itself is finalized, so that the resource does not leak. To read and work with the stream, clone its available binary data to a new `MemoryStream` instance. |

| `ExportToCsvAsync` | `Task<MemoryStream>` | Returns the exported data as a `MemoryStream`. The stream itself is finalized, so that the resource does not leak. To read and work with the stream, clone its available binary data to a new `MemoryStream` instance. |

ikoevska · 2025-01-17T09:02:34Z

components/grid/export/events.md

+
+    * `Width` - define the width of the column **in pixels**.
+    * `Title` - define the column title to be shown in the PDF file header. 
+    * `NumberFormat` - provide an PDF-compatible number/date format


In the case of abbreviations, choosing between a/an depends on the pronunciation of the abbreviations. In this case, it would be a pi-di-ef. But with svgs, for examples, it would be an es-vi-dʒi

Suggested change

* `NumberFormat` - provide an PDF-compatible number/date format

* `NumberFormat` - provide a PDF-compatible number/date format.

ikoevska · 2025-01-17T09:03:00Z

components/grid/export/events.md

+    * `Field` - set the data bound field of the column.
+
+To export a hidden Grid column that has its `Visible` parameter set to `false`, you can manually define an instance of the `GridPdfExportColumn` in the handler for the `OnBeforeExport` event and add that column to the `args.Columns` collection.
+


Maybe clean up the empty line.

ikoevska · 2025-01-17T09:13:42Z

components/grid/export/pdf.md

+
+The component allows you to control the data set that will be exported. It also provides built-in customization options for the columns such as `Width`, `Title` and more.
+
+For more advanced customization the Grid lets you get the `MemoryStream` of the file. Thus, you can customize it using the [`PdfProcessing`](https://docs.telerik.com/devtools/document-processing/libraries/radpdfprocessing/overview) library that is available with your license.


Double-check if this is still the case after the new subscription model.

ikoevska · 2025-01-17T09:14:26Z

components/grid/export/pdf.md

+
+The PDF export has the following specifics:
+
+* When exporting Grid columns, the developer must provide column widths that are appropriate for exporting the data. While an Excel file allows resizing its columns, the PDF file format does not allow resizing the columns. You can change the width of the column from the [`OnBeforeExportEventArgs.Columns[0].Width property`](slug://grid-export-events#for-pdf-export), so you have full control over this value (note that it can be different from the one defined in the corresponding Grid column, thus ensuring flexibility to render the Grid columns with one width and export them in other).


Suggested change

* When exporting Grid columns, the developer must provide column widths that are appropriate for exporting the data. While an Excel file allows resizing its columns, the PDF file format does not allow resizing the columns. You can change the width of the column from the [`OnBeforeExportEventArgs.Columns[0].Width property`](slug://grid-export-events#for-pdf-export), so you have full control over this value (note that it can be different from the one defined in the corresponding Grid column, thus ensuring flexibility to render the Grid columns with one width and export them in other).

* When exporting Grid columns, the developer must provide column widths that are appropriate for exporting the data. While an Excel file allows resizing its columns, the PDF file format does not allow resizing the columns. You can change the width of the column from the [`OnBeforeExportEventArgs.Columns[0].Width property`](slug://grid-export-events#for-pdf-export), so you have full control over this value (note that it can be different from the one defined in the corresponding Grid column, thus ensuring flexibility to render the Grid columns with one width and export them with another).

ikoevska · 2025-01-17T09:15:37Z

components/grid/export/pdf.md

+The PDF export has the following specifics:
+
+* When exporting Grid columns, the developer must provide column widths that are appropriate for exporting the data. While an Excel file allows resizing its columns, the PDF file format does not allow resizing the columns. You can change the width of the column from the [`OnBeforeExportEventArgs.Columns[0].Width property`](slug://grid-export-events#for-pdf-export), so you have full control over this value (note that it can be different from the one defined in the corresponding Grid column, thus ensuring flexibility to render the Grid columns with one width and export them in other).
+* We do not recommend exporting columns without widths - while Excel has a default width for a column,  PDF requires fixed dimensions. We recommend setting specific widths to all columns  when exporting (note that this is unrelated to the width of the column as the export width can be configured through the [`OnBeforeExport` event](slug://grid-export-events#for-pdf-export).


How are the first two bullet points in that list different? They seem to say the same thing?

Suggested change

* We do not recommend exporting columns without widths - while Excel has a default width for a column, PDF requires fixed dimensions. We recommend setting specific widths to all columns when exporting (note that this is unrelated to the width of the column as the export width can be configured through the [`OnBeforeExport` event](slug://grid-export-events#for-pdf-export).

* Avoid exporting columns without widths—while Excel has a default width for a column, PDF requires fixed dimensions. Set specific widths to all columns when exporting (note that this is unrelated to the width of the column as the export width can be configured through the [`OnBeforeExport` event](slug://grid-export-events#for-pdf-export).

ikoevska · 2025-01-17T09:16:31Z

components/grid/export/pdf.md

+* When exporting Grid columns, the developer must provide column widths that are appropriate for exporting the data. While an Excel file allows resizing its columns, the PDF file format does not allow resizing the columns. You can change the width of the column from the [`OnBeforeExportEventArgs.Columns[0].Width property`](slug://grid-export-events#for-pdf-export), so you have full control over this value (note that it can be different from the one defined in the corresponding Grid column, thus ensuring flexibility to render the Grid columns with one width and export them in other).
+* We do not recommend exporting columns without widths - while Excel has a default width for a column,  PDF requires fixed dimensions. We recommend setting specific widths to all columns  when exporting (note that this is unrelated to the width of the column as the export width can be configured through the [`OnBeforeExport` event](slug://grid-export-events#for-pdf-export).
+* PDF does not understand units different than `px` for the column `Width`, and if you use them (such as `rem` or `%`), it will fail to parse them and will render a collapsed (hidden) column with zero width.
+* When exporting Grid columns, you must provide appropriate `PaperSize` and `PageOrientation` properties. For example, if you want to render 20 columns (100px each) in a A4 sheet, then this will yield unexpected results. The column dimensions in a PDF file are fixed, thus they cannot be resized as in Excel, which requires the developer to ensure proper export dimensions.


Pay attention to choosing between a and an.

Suggested change

* When exporting Grid columns, you must provide appropriate `PaperSize` and `PageOrientation` properties. For example, if you want to render 20 columns (100px each) in a A4 sheet, then this will yield unexpected results. The column dimensions in a PDF file are fixed, thus they cannot be resized as in Excel, which requires the developer to ensure proper export dimensions.

* When exporting Grid columns, you must provide appropriate `PaperSize` and `PageOrientation` properties. For example, if you want to render 20 columns (100px each) in an A4 sheet, then this will yield unexpected results. The column dimensions in a PDF file are fixed, thus they cannot be resized as in Excel, which requires the developer to ensure proper export dimensions.

ikoevska · 2025-01-17T09:17:18Z

components/grid/export/pdf.md

+* We do not recommend exporting columns without widths - while Excel has a default width for a column,  PDF requires fixed dimensions. We recommend setting specific widths to all columns  when exporting (note that this is unrelated to the width of the column as the export width can be configured through the [`OnBeforeExport` event](slug://grid-export-events#for-pdf-export).
+* PDF does not understand units different than `px` for the column `Width`, and if you use them (such as `rem` or `%`), it will fail to parse them and will render a collapsed (hidden) column with zero width.
+* When exporting Grid columns, you must provide appropriate `PaperSize` and `PageOrientation` properties. For example, if you want to render 20 columns (100px each) in a A4 sheet, then this will yield unexpected results. The column dimensions in a PDF file are fixed, thus they cannot be resized as in Excel, which requires the developer to ensure proper export dimensions.
+* Exporting to PDF in UI for Blazor is different from exporting in Kendo jQuery, where the full HTML is exported. The Blazor export to PDF will export the Grid to a table, similar to an Excel table. If you want [to export to PDF as HTML, you can use a custom approach](#custom-export).


It's usually differs from or different than. Either will work in this case.

ntacheva added 4 commits January 7, 2025 19:06

docs(grid): document pdf export

2b4708b

chore(grid): updated export articles

1f63941

chore(Grid): update pdf export article and examples

8bff13d

chore(grid): update export events

c4e5888

ntacheva self-assigned this Jan 14, 2025

ntacheva requested review from a team as code owners January 14, 2025 16:15

ntacheva and others added 3 commits January 14, 2025 18:34

chore(grid): final updates

0693df0

Merge branch 'master' into document-pdf-export

8c2a1bb

chore(grid): final

4dcc00d

ikoevska approved these changes Jan 17, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document PDF export #2706

Document PDF export #2706

ntacheva commented Jan 14, 2025

ikoevska left a comment

ikoevska Jan 17, 2025

ikoevska Jan 17, 2025

ikoevska Jan 17, 2025

ikoevska Jan 17, 2025

ikoevska Jan 17, 2025

ikoevska Jan 17, 2025

ikoevska Jan 17, 2025

ikoevska Jan 17, 2025

ikoevska Jan 17, 2025

ikoevska Jan 17, 2025

	Optionally, you can also set the `GridCsvExport` tag settings under the `GridExport` tag to subscribe to the [Grid export events](slug:grid-export-events) that allow further customization of the exported columns/data or configure the CSV export options:
	Optionally, you can also set the `GridCsvExport` tag settings under the `GridExport` tag to subscribe to the [Grid export events](slug:grid-export-events) that allow further customization of the exported columns/data. Alternatively, you can configure the CSV export options:

	\| `SaveAsCsvFileAsync` \| `ValueTask` \| sends the exported CSV file to the browser for download. \|
	\| `SaveAsCsvFileAsync` \| `ValueTask` \| Sends the exported CSV file to the browser for download. \|

	\| `ExportToCsvAsync` \| `Task<MemoryStream>` \| returns the exported data as a `MemoryStream`. The stream itself is finalized, so that the resource does not leak. To read and work with the stream, clone its available binary data to a new `MemoryStream` instance. \|
	\| `ExportToCsvAsync` \| `Task<MemoryStream>` \| Returns the exported data as a `MemoryStream`. The stream itself is finalized, so that the resource does not leak. To read and work with the stream, clone its available binary data to a new `MemoryStream` instance. \|

	* `NumberFormat` - provide an PDF-compatible number/date format
	* `NumberFormat` - provide a PDF-compatible number/date format.

		* `Field` - set the data bound field of the column.

		To export a hidden Grid column that has its `Visible` parameter set to `false`, you can manually define an instance of the `GridPdfExportColumn` in the handler for the `OnBeforeExport` event and add that column to the `args.Columns` collection.


		The component allows you to control the data set that will be exported. It also provides built-in customization options for the columns such as `Width`, `Title` and more.

		For more advanced customization the Grid lets you get the `MemoryStream` of the file. Thus, you can customize it using the [`PdfProcessing`](https://docs.telerik.com/devtools/document-processing/libraries/radpdfprocessing/overview) library that is available with your license.


		The PDF export has the following specifics:

		* When exporting Grid columns, the developer must provide column widths that are appropriate for exporting the data. While an Excel file allows resizing its columns, the PDF file format does not allow resizing the columns. You can change the width of the column from the [`OnBeforeExportEventArgs.Columns[0].Width property`](slug://grid-export-events#for-pdf-export), so you have full control over this value (note that it can be different from the one defined in the corresponding Grid column, thus ensuring flexibility to render the Grid columns with one width and export them in other).

	* We do not recommend exporting columns without widths - while Excel has a default width for a column, PDF requires fixed dimensions. We recommend setting specific widths to all columns when exporting (note that this is unrelated to the width of the column as the export width can be configured through the [`OnBeforeExport` event](slug://grid-export-events#for-pdf-export).
	* Avoid exporting columns without widths—while Excel has a default width for a column, PDF requires fixed dimensions. Set specific widths to all columns when exporting (note that this is unrelated to the width of the column as the export width can be configured through the [`OnBeforeExport` event](slug://grid-export-events#for-pdf-export).

	* When exporting Grid columns, you must provide appropriate `PaperSize` and `PageOrientation` properties. For example, if you want to render 20 columns (100px each) in a A4 sheet, then this will yield unexpected results. The column dimensions in a PDF file are fixed, thus they cannot be resized as in Excel, which requires the developer to ensure proper export dimensions.
	* When exporting Grid columns, you must provide appropriate `PaperSize` and `PageOrientation` properties. For example, if you want to render 20 columns (100px each) in an A4 sheet, then this will yield unexpected results. The column dimensions in a PDF file are fixed, thus they cannot be resized as in Excel, which requires the developer to ensure proper export dimensions.

Document PDF export #2706

Are you sure you want to change the base?

Document PDF export #2706

Conversation

ntacheva commented Jan 14, 2025

ikoevska left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment