HtmlDxDataGridColumnDescription Class

Summary

Description of a column in the HtmlDxDataGrid template.
Assembly
Cake.Issues.Reporting.Generic.dll
Namespace
Cake.Issues.Reporting.Generic
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["HtmlDxDataGridColumnDescription"] class Type type-node

Syntax

public class HtmlDxDataGridColumnDescription

Constructors

Name Summary
HtmlDxDataGridColumnDescription(string, Func<IIssue, object>) Initializes a new instance of the HtmlDxDataGridColumnDescription class.

Properties

Name Value Summary
AllowFiltering bool
Gets or sets a value indicating whether data can be filtered by this column or not. Applies only if EnableFiltering is set. Default value is true.
AllowGrouping bool
Gets or sets a value indicating whether the user can group data by values of this column or not. Applies only if EnableGrouping is set. Default value is true.
AllowSorting bool
Gets or sets a value indicating whether a user can sort rows by this column at runtime or not. Default value is true.
Caption string
Gets or sets the caption of the column.
Id string
Gets the ID of the column.
ValueRetriever Func<IIssue, object>
Gets a function for retrieving the value of the column.
VisibleIndex int
Gets or sets the position of the column regarding other columns. See ReportColumn for values of default columns. Default value is zero, which means that the column will be added before any default columns.

Extension Methods

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