HtmlDxDataGridOption Class

Summary

Options for the HtmlDxDataGrid template.
graph BT Type-->Base0["Enum"] Type["HtmlDxDataGridOption"] class Type type-node

Syntax

public sealed class HtmlDxDataGridOption : Enum

Fields

Name Constant Value Summary
AdditionalColumns 34
List of HtmlDxDataGridColumnDescription for additional columsn which should be added to the grid. Default value is an empty list.
static
DevExtremeLocation 38
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 39
Version of the DevExtreme libraries which should be used. If setting this the matching JQueryVersion needs to also be set. Default value is 19.2.3.
static
EnableExporting 41
Flag if exporting to Microsoft Excel 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
ExportFileName 42
Default name of Microsoft Excel file without file name extension. Default value is issue-report.
static
FileDirectorySortOrder 21
Sort order of the FileDirectory column if it is part of SortedColumns. See ColumnSortOrder for possible values. Default value is Ascending.
static
FileDirectoryVisible 20
Flag if the FileDirectory column should be visible or not. Either true or false. Default value is true.
static
FileLinkSettings 35
Settings for having issues linked to files. Value needs to be an instance of FileLinkSettings. Default value is null.
static
FileNameSortOrder 23
Sort order of the FileName column if it is part of SortedColumns. See ColumnSortOrder for possible values. Default value is Ascending.
static
FileNameVisible 22
Flag if the FileName column should be visible or not. Either true or false. Default value is true.
static
FilePathSortOrder 19
Sort order of the FilePath column if it is part of SortedColumns. See ColumnSortOrder for possible values. Default value is Ascending.
static
FilePathVisible 18
Flag if the FilePath column should be visible or not. Either true or false. Default value is false.
static
GroupedColumns 32
List of ReportColumn which should be grouped. Grouped columns are always visible. Default value is ProviderName.
static
IdeIntegrationSettings 40
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 36
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 37
Version of jQuery which should be used. This version needs to match the version required by the selected DevExtremeVersion. Default value is 3.1.0.
static
JSZipLocation 43
Location where JSZip can be found. The following files need to be available:
  • {JSZipLocation}/jszip.min.js
Default value is https://cdnjs.cloudflare.com/ajax/libs/jszip/3.1.5/.
static
LineSortOrder 25
Sort order of the Line column if it is part of SortedColumns. See ColumnSortOrder for possible values. Default value is Ascending.
static
LineVisible 24
Flag if the Line column should be visible or not. Either true or false. Default value is true.
static
MessageSortOrder 31
Sort order of the Message column if it is part of SortedColumns. See ColumnSortOrder for possible values. Default value is Ascending.
static
MessageVisible 30
Flag if the Message column should be visible or not. Either true or false. Default value is true.
static
PriorityNameSortOrder 13
Sort order of the PriorityName column if it is part of SortedColumns. See ColumnSortOrder for possible values. Default value is Descending.
static
PriorityNameVisible 12
Flag if the PriorityName column should be visible or not. Either true or false. Default value is true.
static
PrioritySortOrder 11
Sort order of the Priority column if it is part of SortedColumns. See ColumnSortOrder for possible values. Default value is Descending.
static
PriorityVisible 10
Flag if the Priority column should be visible or not. Either true or false. Default value is false.
static
ProjectNameSortOrder 17
Sort order of the ProjectName column if it is part of SortedColumns. See ColumnSortOrder for possible values. Default value is Ascending.
static
ProjectNameVisible 16
Flag if the ProjectName column should be visible or not. Either true or false. Default value is true.
static
ProjectPathSortOrder 15
Sort order of the ProjectPath column if it is part of SortedColumns. See ColumnSortOrder for possible values. Default value is Ascending.
static
ProjectPathVisible 14
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
RuleSortOrder 27
Sort order of the Rule column if it is part of SortedColumns. See ColumnSortOrder for possible values. Default value is Ascending.
static
RuleUrlSortOrder 29
Sort order of the RuleUrl column if it is part of SortedColumns. See ColumnSortOrder for possible values. Default value is Ascending.
static
RuleUrlVisible 28
Flag if the RuleUrl column should be visible or not. Either true or false. Default value is false.
static
RuleVisible 26
Flag if the Rule column should be visible 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 33
List of ReportColumn which should be sorted. Default value is PriorityName, ProjectName, FileDirectory, FileName, Line.
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
NotNull<HtmlDxDataGridOption>(string) void
Throws an exception if the specified parameter's value is null.
GitHub