Skip to content

Docs: export customizations #623

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Dec 7, 2021
Merged

Docs: export customizations #623

merged 14 commits into from
Dec 7, 2021

Conversation

svdimitr
Copy link
Contributor

@svdimitr svdimitr commented Dec 5, 2021

No description provided.

@svdimitr svdimitr requested a review from a team December 5, 2021 10:34
@svdimitr svdimitr self-assigned this Dec 5, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Dec 5, 2021

Hello @svdimitr,

Check the below option if you would like to automatically generate PR to production. The automation uses the branch for the cherry-pick, and then will delete the branch. Please, do not delete it manually.

  • create pr to production


You can programmatically invoke the export feature of the Grid, by using the following methods exposed on the `@ref` of the Grid:

* `SaveAsExcelFileAsync` - `ValueTask` - sends the exported excel file to the browser for download
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if it's clear that the second word is the return type.

svdimitr and others added 2 commits December 6, 2021 17:13
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>

* `Data` - `IEnumerable<object>` - you can assign a custom collection of data to be exported to excel/csv such as the selected items in the Grid.

* `isCancelled` - `bool` - you can cancel the OnBeforeExcel event by setting the `isCancelled` field to `true`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `isCancelled` - `bool` - you can cancel the OnBeforeExcel event by setting the `isCancelled` field to `true`.
* `isCancelled` - `bool` - cancel the OnBeforeExcel event by setting the `isCancelled` property to `true`.

Copy link
Contributor

@dimodi dimodi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use consistent grammar and structure in list items. For example, no need to use "you can" in some items, and skip it elsewhere. It's best to skip it everywhere, because it does not add value and make the item longer.

@marin-bratanov
Copy link
Contributor

Add mentions of the export-related events into a dedicated section in the common Grid Events article, with just a link to the dedicated article, like we have for the CRUD events, OnRead, Column events.

svdimitr and others added 5 commits December 7, 2021 08:39
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
svdimitr and others added 5 commits December 7, 2021 08:40
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
@svdimitr svdimitr merged commit abb1555 into master Dec 7, 2021
@github-actions github-actions bot deleted the docs-export-customizations branch December 7, 2021 06:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants