Skip to content

Commit

Permalink
HtmlDxDataGrid: Add instructions how to use with a commercial license (
Browse files Browse the repository at this point in the history
  • Loading branch information
pascalberger authored Jan 19, 2025
1 parent d4cfe67 commit 008ab7e
Showing 1 changed file with 48 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ Template for a HTML report containing a rich data grid with sorting, filtering,
## Requirements

* Cake.Issues.Reporting.Generic 0.3.1 or higher
* The template ships with DevExtreme version `23.1`, which was available under a non-commercial license.
Some features in the template require a never version and a commercial [License]{target="_blank"} to be set.
See [Using commercial version] for examples.

## Usage

Expand Down Expand Up @@ -49,6 +52,49 @@ To create a report using the HTML DevExtreme Data Grid template you can use the
@"c:\report.html");
```

### Using commercial version

The template ships with DevExtreme version `23.1`, which was available under a non-commercial license.
To use a never version a commercial [License]{target="_blank"} is required.

To use the template with a never version and commercial license the following options need to be set:

=== "Cake .NET Tool"

```csharp
CreateIssueReport(
issues,
GenericIssueReportFormatFromEmbeddedTemplate(
GenericIssueReportTemplate.HtmlDxDataGrid,
settings => settings
.WithOption(
HtmlDxDataGridOption.DevExtremeLicenseKey,
"<LICENSE_KEY>")
.WithOption(
HtmlDxDataGridOption.DevExtremeVersion,
"23.2")),
@"c:\repo",
@"c:\report.html");
```

=== "Cake Frosting"

```csharp
context.CreateIssueReport(
issues,
context.GenericIssueReportFormatFromEmbeddedTemplate(
GenericIssueReportTemplate.HtmlDxDataGrid,
settings => settings
.WithOption(
HtmlDxDataGridOption.DevExtremeLicenseKey,
"<LICENSE_KEY>")
.WithOption(
HtmlDxDataGridOption.DevExtremeVersion,
"23.2")),
@"c:\repo",
@"c:\report.html");
```

## Options

See [HtmlDxDataGridOption]{target="_blank"} for a list of possible options.
Expand Down Expand Up @@ -350,6 +396,8 @@ Exporting can be enabled using the [HtmlDxDataGridOption.EnableExporting]{target
Source code is available on [GitHub]{target="_blank"}.

[DevExtreme]: https://js.devexpress.com
[License]: https://js.devexpress.com/jQuery/Documentation/Guide/Common/Licensing/
[Using commercial version]: #using-commercial-version
[GenericIssueReportTemplate.HtmlDxDataGrid]: https://cakebuild.net/api/Cake.Issues.Reporting.Generic/GenericIssueReportTemplate/0E9E9D94
[HtmlDxDataGridOption]: https://cakebuild.net/api/Cake.Issues.Reporting.Generic/HtmlDxDataGridOption/
[DevExtremeTheme]: https://cakebuild.net/api/Cake.Issues.Reporting.Generic/DevExtremeTheme/
Expand Down

0 comments on commit 008ab7e

Please sign in to comment.