This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Issues.Reporting.Generic.

Summary

Options for the HtmlDxDataGrid template.

Assembly

Cake.Issues.Reporting.Generic.dll

Namespace

Cake.Issues.Reporting.Generic

Base Types

Enum

graph BT Type-->Base0["Enum"] Type["HtmlDxDataGridOption"] class Type type-node

Syntax

public sealed class HtmlDxDataGridOption : Enum

Fields

Name	Constant Value	Summary
AdditionalColumns	46	List of `HtmlDxDataGridColumnDescription` for additional columns which should be added to the grid. Default value is an empty list. static
ColumnSortOrder	31	Sort order of the `Column` column if it is part of `SortedColumns`. See `ColumnSortOrder` for possible values. Default value is `Ascending`. static
ColumnVisible	30	Flag if the `Column` column should be visible or not. Either `true` or `false`. Default value is `false`. static
DevExtremeLicenseKey	51	License key for DevExtreme. Required for version 23.2 and later. Default value is `null`. static
DevExtremeLocation	49	Location where the DevExtreme libraries can be found. Below the location there needs to be a folder matching `DevExtremeVersion` and inside there subfolders `js` and `css`. The following files need to be available: `{DevExtremeLocation}/{DevExtremeVersion}/js/dx.all.js` `{DevExtremeLocation}/{DevExtremeVersion}/css/dx.common.css` `{DevExtremeLocation}/{DevExtremeVersion}/css/{Theme}` Default value is `https://cdn3.devexpress.com/jslib/`. static
DevExtremeVersion	50	Version of the DevExtreme libraries which should be used. If setting this the matching `JQueryVersion` needs to also be set. Default value is `23.1.13`. static
DisplayMode	64	Display mode of the grid. See `HtmlDxDataGridDisplayMode` for possible values. Default value is `Paged`. static
EnableExporting	53	Flag if exporting should be available or not. Either `true` or `false`. Default value is `false`. static
EnableFiltering	5	Flag if filtering should be available or not. Either `true` or `false`. Default value is `true`. static
EnableGrouping	4	Flag if the group panel which allows end-user grouping should be visible or not. Either `true` or `false`. If `false` grouping defined by `GroupedColumns` is still applied. Default value is `true`. static
EnableSearching	3	Flag if the search panel for full text searching should be visible or not. Either `true` or `false`. Default value is `true`. static
EndColumnSortOrder	33	Sort order of the `EndColumn` column if it is part of `SortedColumns`. See `ColumnSortOrder` for possible values. Default value is `Ascending`. static
EndColumnVisible	32	Flag if the `EndColumn` column should be visible or not. Either `true` or `false`. Default value is `false`. static
EndLineSortOrder	29	Sort order of the `EndLine` column if it is part of `SortedColumns`. See `ColumnSortOrder` for possible values. Default value is `Ascending`. static
EndLineVisible	28	Flag if the `EndLine` column should be visible or not. Either `true` or `false`. Default value is `false`. static
ExcelJsLocation	56	Location where ExcelJS can be found. Below the location there needs to be a folder matching `ExcelJsVersion`. The following files need to be available: `{ExcelJsLocation}/{ExcelJsVersion}/exceljs.min.js` Default value is `https://cdnjs.cloudflare.com/ajax/libs/exceljs/`. static
ExcelJsVersion	57	Version of ExcelJS which should be used. This version needs to match the version required by the selected `DevExtremeVersion`. Default value is `4.4.0`. static
ExportFileName	54	Default name of the export file without file name extension. Default value is `issue-report`. static
ExportFormat	55	Export format. See `HtmlDxDataGridExportFormat` for possible values. Default value is `Excel`. static
FileDirectorySortOrder	23	Sort order of the `FileDirectory` column if it is part of `SortedColumns`. See `ColumnSortOrder` for possible values. Default value is `Ascending`. static
FileDirectoryVisible	22	Flag if the `FileDirectory` column should be visible or not. Either `true` or `false`. Default value is `true`. static
FileNameSortOrder	25	Sort order of the `FileName` column if it is part of `SortedColumns`. See `ColumnSortOrder` for possible values. Default value is `Ascending`. static
FileNameVisible	24	Flag if the `FileName` column should be visible or not. Either `true` or `false`. Default value is `true`. static
FilePathSortOrder	21	Sort order of the `FilePath` column if it is part of `SortedColumns`. See `ColumnSortOrder` for possible values. Default value is `Ascending`. static
FilePathVisible	20	Flag if the `FilePath` column should be visible or not. Either `true` or `false`. Default value is `false`. static
FileSaverJsLocation	58	Location where FileSaver.js can be found. Below the location there needs to be a folder matching `FileSaverJsVersion`. The following files need to be available: `{FileSaverLocation}/{FileSaverVersion}/FileSaver.js` Default value is `https://cdnjs.cloudflare.com/ajax/libs/`. static
FileSaverJsVersion	59	Version of FileSaver.js which should be used. This version needs to match the version required by the selected `DevExtremeVersion`. Default value is `2.0.5`. static
GroupedColumns	44	List of `ReportColumn` which should be grouped. Grouped columns are always visible. Default value is `ProviderName` and `Run`. static
IdeIntegrationSettings	52	Settings for having functionality to open files affected by issues in IDEs. Value needs to be an instance of `IdeIntegrationSettings`. Default value is `null`. static
JQueryLocation	47	Location where jQuery can be found. The following files need to be available: `{JQueryLocation}/jquery-{JQueryVersion}.min.js` Default value is `https://ajax.aspnetcdn.com/ajax/jquery/`. static
JQueryVersion	48	Version of jQuery which should be used. This version needs to match the version required by the selected `DevExtremeVersion`. Default value is `3.7.1`. static
JsPdfAutotableLocation	62	Location where jsPDF-AutoTable plugin can be found. Below the location there needs to be a folder matching `JsPdfAutotableVersion`. The following files need to be available: `{JsPdfAutotableLocation}/{JsPdfAutotableVersion}/jspdf.plugin.autotable.min.js` Default value is `https://cdnjs.cloudflare.com/ajax/libs/jspdf-autotable/`. static
JsPdfAutotableVersion	63	Version of jsPDF-AutoTable plugin which should be used. This version needs to match the version required by the selected `DevExtremeVersion`. Default value is `5.0.2`. static
JsPdfLocation	60	Location where jsPDF can be found. Below the location there needs to be a folder matching `JsPdfVersion`. The following files need to be available: `{JsPdfLocation}/{JsPdfVersion}/jspdf.umd.min.js` Default value is `https://cdnjs.cloudflare.com/ajax/libs/jspdf/`. static
JsPdfVersion	61	Version of jsPDF which should be used. This version needs to match the version required by the selected `DevExtremeVersion`. Default value is `3.0.3`. static
LineSortOrder	27	Sort order of the `Line` column if it is part of `SortedColumns`. See `ColumnSortOrder` for possible values. Default value is `Ascending`. static
LineVisible	26	Flag if the `Line` column should be visible or not. Either `true` or `false`. Default value is `false`. static
LocationSortOrder	35	Sort order of the `Location` column if it is part of `SortedColumns`. See `ColumnSortOrder` for possible values. Default value is `Ascending`. static
LocationVisible	34	Flag if the `Location` column should be visible or not. Either `true` or `false`. Default value is `true`. static
MessageSortOrder	43	Sort order of the `Message` column if it is part of `SortedColumns`. See `ColumnSortOrder` for possible values. Default value is `Ascending`. static
MessageVisible	42	Flag if the `Message` column should be visible or not. Either `true` or `false`. Default value is `true`. static
PersistState	66	Flag if customization in the report should be persisted. Either `true` or `false`. Default value is `true`. static
PriorityNameSortOrder	15	Sort order of the `PriorityName` column if it is part of `SortedColumns`. See `ColumnSortOrder` for possible values. Default value is `Descending`. static
PriorityNameVisible	14	Flag if the `PriorityName` column should be visible or not. Either `true` or `false`. Default value is `true`. static
PrioritySortOrder	13	Sort order of the `Priority` column if it is part of `SortedColumns`. See `ColumnSortOrder` for possible values. Default value is `Descending`. static
PriorityVisible	12	Flag if the `Priority` column should be visible or not. Either `true` or `false`. Default value is `false`. static
ProjectNameSortOrder	19	Sort order of the `ProjectName` column if it is part of `SortedColumns`. See `ColumnSortOrder` for possible values. Default value is `Ascending`. static
ProjectNameVisible	18	Flag if the `ProjectName` column should be visible or not. Either `true` or `false`. Default value is `true`. static
ProjectPathSortOrder	17	Sort order of the `ProjectPath` column if it is part of `SortedColumns`. See `ColumnSortOrder` for possible values. Default value is `Ascending`. static
ProjectPathVisible	16	Flag if the `ProjectPath` column should be visible or not. Either `true` or `false`. Default value is `false`. static
ProviderNameSortOrder	9	Sort order of the `ProviderName` column if it is part of `SortedColumns`. See `ColumnSortOrder` for possible values. Default value is `Ascending`. static
ProviderNameVisible	8	Flag if the `ProviderName` column should be visible or not. Either `true` or `false`. Default value is `true`. static
ProviderTypeSortOrder	7	Sort order of the `ProviderType` column if it is part of `SortedColumns`. See `ColumnSortOrder` for possible values. Default value is `Ascending`. static
ProviderTypeVisible	6	Flag if the `ProviderType` column should be visible or not. Either `true` or `false`. Default value is `false`. static
RuleIdSortOrder	37	Sort order of the `RuleId` column if it is part of `SortedColumns`. See `ColumnSortOrder` for possible values. Default value is `Ascending`. static
RuleIdVisible	36	Flag if the `RuleId` column should be visible or not. Either `true` or `false`. Default value is `true`. static
RuleNameSortOrder	39	Sort order of the `RuleName` column if it is part of `SortedColumns`. See `ColumnSortOrder` for possible values. Default value is `Ascending`. static
RuleNameVisible	38	Flag if the `RuleName` column should be visible or not. Either `true` or `false`. Default value is `true`. static
RuleUrlSortOrder	41	Sort order of the `RuleUrl` column if it is part of `SortedColumns`. See `ColumnSortOrder` for possible values. Default value is `Ascending`. static
RuleUrlVisible	40	Flag if the `RuleUrl` column should be visible or not. Either `true` or `false`. Default value is `false`. static
RunSortOrder	11	Sort order of the `Run` column if it is part of `SortedColumns`. See `ColumnSortOrder` for possible values. Default value is `Ascending`. static
RunVisible	10	Flag if the `Run` column should be visible or not. Either `true` or `false`. Default value is `true` if any issue contains run information, otherwise `false`. static
ShowColumnChooser	65	Flag if the column chooser to show and hide columns should be available or not. Either `true` or `false`. Default value is `true`. static
ShowHeader	2	Flag if the title should be shown as header on the top of the page. Either `true` or `false`. Default value is `true`. static
SortedColumns	45	List of `ReportColumn` which should be sorted. Default value is `PriorityName`, `ProjectName`, `FileDirectory`, `FileName`, `Line`. static
StorageKey	67	Key for the state storage. Reports with the same key will share customizations. Default value is `CakeIssuesReportingGeneric`. static
Theme	1	DevExtreme theme to use. See `DevExtremeTheme` for possible values. Default value is `Light`. static
Title	0	Title of the report. Default value is `Issues Report`. static
value__

Extension Methods

Name	Value	Summary
Dump<HtmlDxDataGridOption>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<HtmlDxDataGridOption>(HtmlDxDataGridOption[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<HtmlDxDataGridOption>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<HtmlDxDataGridOption>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<HtmlDxDataGridOption>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<HtmlDxDataGridOption>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin

HtmlDxDataGridOption Class

Summary

Syntax

Fields

Extension Methods