Skip to content

Commit a084921

Browse files
dimodiikoevska
andauthored
docs(Grid): Add programmatic export limitations (#3321)
* docs(Grid): Add programmatic export limitations * Update csv.md * Update components/grid/export/excel.md Co-authored-by: Iva Stefanova Koevska-Atanasova <[email protected]> * Apply suggestions --------- Co-authored-by: Iva Stefanova Koevska-Atanasova <[email protected]>
1 parent b2cd95b commit a084921

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

components/grid/export/csv.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,12 @@ You can programmatically invoke the export feature of the Grid, by using the fol
124124
| Method | Type | Description |
125125
| --- | --- | --- |
126126
| `SaveAsCsvFileAsync` | `ValueTask` | Sends the exported CSV file to the browser for download. You can pass [`GridCsvExportOptions`](slug:Telerik.Blazor.Components.TelerikGrid-1) to customize the export. |
127-
| `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. You can pass [`GridCsvExportOptions`](slug:Telerik.Blazor.Components.TelerikGrid-1) to customize the export. |
127+
| `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. You can pass [`GridCsvExportOptions`](slug:Telerik.Blazor.Components.Grid.GridCsvExportOptions) to customize the export. |
128+
129+
When exporting programmatically with a `GridCsvExportOptions` argument:
130+
131+
* The `Columns` and `Data` properties of `GridCsvExportOptions` are required.
132+
* Multi-column headers are not supported.
128133

129134
>caption Invoke the export function from code
130135

components/grid/export/excel.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,13 @@ You can programmatically invoke the export feature of the Grid, by using the fol
132132

133133
| Method | Type | Description |
134134
| --- | --- | --- |
135-
| `SaveAsExcelFileAsync` | `ValueTask` | Sends the exported excel file to the browser for download. You can pass [`GridExcelExportOptions`](slug:Telerik.Blazor.Components.TelerikGrid-1) to customize the export. |
136-
| `ExportToExcelAsync` | `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. You can pass [`GridExcelExportOptions`](slug:Telerik.Blazor.Components.TelerikGrid-1) to customize the export. |
135+
| `SaveAsExcelFileAsync` | `ValueTask` | Sends the exported Excel file to the browser for download. You can pass [`GridExcelExportOptions`](slug:Telerik.Blazor.Components.Grid.GridExcelExportOptions) to customize the export. |
136+
| `ExportToExcelAsync` | `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. You can pass [`GridExcelExportOptions`](slug:Telerik.Blazor.Components.Grid.GridExcelExportOptions) to customize the export. |
137+
138+
When exporting programmatically with a `GridExcelExportOptions` argument:
139+
140+
* The `Columns` and `Data` properties of `GridExcelExportOptions` are required.
141+
* Multi-column headers are not supported.
137142

138143
>caption Invoke the export function from code
139144

0 commit comments

Comments
 (0)