The requested page is not available for the requested platform. You are viewing the content for Default platform.

TreeListColumnBuilder<T> Members

Constructors

Name Description
TreeListColumnBuilder(OptionsOwnerContext)

Methods

Name Description
Alignment(HorizontalAlignment)

Aligns the content of the column.

AllowEditing(Boolean)

Specifies whether a user can edit values in the column at runtime. By default, inherits the value of the editing.allowUpdating option.

AllowEditing(JS)

Specifies whether a user can edit values in the column at runtime. By default, inherits the value of the editing.allowUpdating option.

AllowFiltering(Boolean)

Specifies whether data can be filtered by this column. Applies only if filterRow.visible is true.

AllowFiltering(JS)

Specifies whether data can be filtered by this column. Applies only if filterRow.visible is true.

AllowFixing(Boolean)

Specifies whether a user can fix the column at runtime. Applies only if columnFixing.enabled is true.

AllowFixing(JS)

Specifies whether a user can fix the column at runtime. Applies only if columnFixing.enabled is true.

AllowHeaderFiltering(Boolean)

Specifies whether the header filter can be used to filter data by this column. Applies only if headerFilter.visible is true. By default, inherits the value of the allowFiltering option.

AllowHeaderFiltering(JS)

Specifies whether the header filter can be used to filter data by this column. Applies only if headerFilter.visible is true. By default, inherits the value of the allowFiltering option.

AllowHiding(Boolean)

Specifies whether a user can hide the column using the column chooser at runtime. Applies only if columnChooser.enabled is true.

AllowHiding(JS)

Specifies whether a user can hide the column using the column chooser at runtime. Applies only if columnChooser.enabled is true.

AllowReordering(Boolean)

Specifies whether this column can be used in column reordering at runtime. Applies only if allowColumnReordering is true.

AllowReordering(JS)

Specifies whether this column can be used in column reordering at runtime. Applies only if allowColumnReordering is true.

AllowResizing(Boolean)

Specifies whether a user can resize the column at runtime. Applies only if allowColumnResizing is true.

AllowResizing(JS)

Specifies whether a user can resize the column at runtime. Applies only if allowColumnResizing is true.

AllowSearch(Boolean)

Specifies whether this column can be searched. Applies only if searchPanel.visible is true. Inherits the value of the allowFiltering option by default.

AllowSearch(JS)

Specifies whether this column can be searched. Applies only if searchPanel.visible is true. Inherits the value of the allowFiltering option by default.

AllowSorting(Boolean)

Specifies whether a user can sort rows by this column at runtime. Applies only if sorting.mode differs from "none".

AllowSorting(JS)

Specifies whether a user can sort rows by this column at runtime. Applies only if sorting.mode differs from "none".

Buttons(Action<CollectionFactory<TreeListColumnButtonBuilder>>)

Allows you to customize buttons in the editing column or create a custom command column. Applies only if the column's type is "buttons".

Buttons(IEnumerable<TreeListColumnButtonName>)

Allows you to customize buttons in the editing column or create a custom command column. Applies only if the column's type is "buttons".

CalculateCellValue(RazorBlock)

Calculates custom values for column cells.

CalculateCellValue(String)

Calculates custom values for column cells.

CalculateDisplayValue(JS)

Calculates custom display values for column cells. Requires specifying the dataField or calculateCellValue option. Used in lookup optimization.

CalculateDisplayValue(String)

Calculates custom display values for column cells. Requires specifying the dataField or calculateCellValue option. Used in lookup optimization.

CalculateFilterExpression(RazorBlock)

Specifies the column's custom filtering rules.

CalculateFilterExpression(String)

Specifies the column's custom filtering rules.

CalculateSortValue(JS)

Calculates custom values to be used in sorting.

CalculateSortValue(String)

Calculates custom values to be used in sorting.

Caption(JS)

Specifies a caption for the column.

Caption(String)

Specifies a caption for the column.

CellTemplate(JS)

Specifies a custom template for column cells.

CellTemplate(RazorBlock)

Specifies a custom template for column cells.

CellTemplate(String)

Specifies a custom template for column cells.

CellTemplate(TemplateName)

Specifies a custom template for column cells.

Columns(Action<CollectionFactory<TreeListColumnBuilder<T>>>)

Configures columns.

Columns(IEnumerable<String>)

Configures columns.

Columns(JS)

Configures columns.

CssClass(JS)

Specifies a CSS class to be applied to the column.

CssClass(String)

Specifies a CSS class to be applied to the column.

CustomizeText(RazorBlock)

Customizes the text displayed in column cells.

CustomizeText(String)

Customizes the text displayed in column cells.

DataField(JS)

Binds the column to a field of the dataSource.

DataField(String)

Binds the column to a field of the dataSource.

DataType(GridColumnDataType)

Casts column values to a specific data type.

EditCellTemplate(JS)

Specifies a custom template for column cells in the editing state.

EditCellTemplate(RazorBlock)

Specifies a custom template for column cells in the editing state.

EditCellTemplate(String)

Specifies a custom template for column cells in the editing state.

EditCellTemplate(TemplateName)

Specifies a custom template for column cells in the editing state.

EditorOptions(Object)

Specifies options for the underlain editor.

EncodeHtml(Boolean)

Specifies whether HTML tags are displayed as plain text or applied to the values of the column.

EncodeHtml(JS)

Specifies whether HTML tags are displayed as plain text or applied to the values of the column.

Equals(Object) Determines whether the specified object is equal to the current object.
(Inherited from Object)
Equals(Object, Object) Determines whether the specified object instances are considered equal.
(Inherited from Object)
FalseText(JS)

In a boolean column, replaces all false items with a specified text. Applies only if showEditorAlways option is false.

FalseText(String)

In a boolean column, replaces all false items with a specified text. Applies only if showEditorAlways option is false.

FilterOperations(IEnumerable<FilterOperations>)

Specifies a set of available filter operations. Applies only if filterRow.visible and allowFiltering are true.

FilterType(FilterType)

Specifies whether a user changes the current filter by including (selecting) or excluding (clearing the selection of) values. Applies only if headerFilter.visible and allowHeaderFiltering are true.

FilterValue(Object)

Specifies the column's filter value displayed in the filter row.

FilterValues(IEnumerable)

Specifies values selected in the column's header filter.

FilterValues(JS)

Specifies values selected in the column's header filter.

Fixed(Boolean)

Fixes the column.

Fixed(JS)

Fixes the column.

FixedPosition(HorizontalEdge)

Specifies the widget's edge to which the column is fixed. Applies only if columns].[fixed is true.

FormItem(Action<FormSimpleItemBuilder>)

Configures the form item that the column produces in the editing state. Applies only if editing.mode is "form" or "popup".

Format(Action<FormatBuilder>)

Formats a value before it is displayed in a column cell.

Format(Format)

Formats a value before it is displayed in a column cell.

Format(JS)

Formats a value before it is displayed in a column cell.

Format(String)

Formats a value before it is displayed in a column cell.

GetHashCode() Serves as the default hash function.
(Inherited from Object)
GetType() Gets the Type of the current instance.
(Inherited from Object)
HeaderCellTemplate(JS)

Specifies a custom template for column headers.

HeaderCellTemplate(RazorBlock)

Specifies a custom template for column headers.

HeaderCellTemplate(String)

Specifies a custom template for column headers.

HeaderCellTemplate(TemplateName)

Specifies a custom template for column headers.

HeaderFilter(Action<TreeListColumnHeaderFilterBuilder>)

Specifies data settings for the header filter.

HidingPriority(Int32)

Specifies the order in which columns are hidden when the widget adapts to the screen or container size. Ignored if allowColumnResizing is true and columnResizingMode is "widget".

HidingPriority(JS)

Specifies the order in which columns are hidden when the widget adapts to the screen or container size. Ignored if allowColumnResizing is true and columnResizingMode is "widget".

IsBand(Boolean)

Specifies whether the column bands other columns or not.

IsBand(JS)

Specifies whether the column bands other columns or not.

Lookup(Action<TreeListColumnLookupBuilder>)

Specifies options of a lookup column.

MemberwiseClone() Creates a shallow copy of the current Object.
(Inherited from Object)
MinWidth(Double)

Specifies the minimum width of the column.

MinWidth(JS)

Specifies the minimum width of the column.

Name(JS)

Specifies the identifier of the column.

Name(String)

Specifies the identifier of the column.

Option(String, Object)

Allows to specify an arbitrary option by its name.

OwnerBand(Double)

Specifies the band column that owns the current column. Accepts the index of the band column in the columns array.

OwnerBand(JS)

Specifies the band column that owns the current column. Accepts the index of the band column in the columns array.

ReferenceEquals(Object, Object) Determines whether the specified Object instances are the same instance.
(Inherited from Object)
RenderAsync(Boolean)

Specifies whether to render the column after other columns and elements. Use if column cells have a complex template. Requires the width option specified.

RenderAsync(JS)

Specifies whether to render the column after other columns and elements. Use if column cells have a complex template. Requires the width option specified.

SelectedFilterOperation(FilterOperations)

Specifies the column's filter operation displayed in the filter row.

SetCellValue(RazorBlock)

Specifies a function to be invoked after the user has edited a cell value, but before it will be saved in the data source.

SetCellValue(String)

Specifies a function to be invoked after the user has edited a cell value, but before it will be saved in the data source.

ShowEditorAlways(Boolean)

Specifies whether the column displays its values using editors.

ShowEditorAlways(JS)

Specifies whether the column displays its values using editors.

ShowInColumnChooser(Boolean)

Specifies whether the column chooser can contain the column header.

ShowInColumnChooser(JS)

Specifies whether the column chooser can contain the column header.

SortIndex(Int32)

Specifies the index according to which columns participate in sorting.

SortIndex(JS)

Specifies the index according to which columns participate in sorting.

SortOrder(SortOrder)

Specifies the sort order of column values.

SortingMethod(RazorBlock)

Specifies a custom comparison function for sorting. Applies only when sorting is performed on the client.

SortingMethod(String)

Specifies a custom comparison function for sorting. Applies only when sorting is performed on the client.

ToString() Returns a string that represents the current object.
(Inherited from Object)
TrueText(JS)

In a boolean column, replaces all true items with a specified text. Applies only if showEditorAlways option is false.

TrueText(String)

In a boolean column, replaces all true items with a specified text. Applies only if showEditorAlways option is false.

Type(TreeListCommandColumnType)

Specifies the command column that this object customizes.

ValidationRules(Action<ValidationRulesFactory>)

Specifies validation rules to be checked on updating cell values.

Visible(Boolean)

Specifies whether the column is visible, that is, occupies space in the table.

Visible(JS)

Specifies whether the column is visible, that is, occupies space in the table.

VisibleIndex(Int32)

Specifies the position of the column regarding other columns in the resulting widget.

VisibleIndex(JS)

Specifies the position of the column regarding other columns in the resulting widget.

Width(Double)

Specifies the column's width in pixels or as a percentage. Ignored if it is less than minWidth.

Width(JS)

Specifies the column's width in pixels or as a percentage. Ignored if it is less than minWidth.

Width(String)

Specifies the column's width in pixels or as a percentage. Ignored if it is less than minWidth.

See Also