Skip to content

Commit 295ca3c

Browse files
authored
docs(Grid): Add programmatic export limitations
1 parent 3117b82 commit 295ca3c

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

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+
* Always set the `Columns` and `Data` properties of `GridExcelExportOptions`.
141+
* Multi-column headers are not supported.
137142

138143
>caption Invoke the export function from code
139144

0 commit comments

Comments
 (0)