Class TreeGridColumnBuilder

Inheritance

System.Object

TreeGridColumnBuilder

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class TreeGridColumnBuilder

Constructors

TreeGridColumnBuilder(TreeGrid)

Initializes a new instance of the class.

Declaration

public TreeGridColumnBuilder(TreeGrid treeGrid)

Parameters

Type	Name	Description
TreeGrid	treeGrid	The tree grid.

Fields

columnProperty

Declaration

public List<TreeGridColumn> columnProperty

Field Value

Type	Description
System.Collections.Generic.List<TreeGridColumn>

currentColumnProperty

Declaration

public TreeGridColumn currentColumnProperty

Field Value

Type	Description
TreeGridColumn

Methods

Add()

It adds the current column value.

Declaration

public void Add()

AllowCellSelection()

It sets a value to enable or disable cell selection for particular column.

Declaration

public TreeGridColumnBuilder AllowCellSelection()

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

AllowCellSelection(Boolean)

It sets a value to enable or disable cell selection for particular column.

Declaration

public TreeGridColumnBuilder AllowCellSelection(bool allowCellSelection)

Parameters

Type	Name	Description
System.Boolean	allowCellSelection	It accepts the boolean value and enable/disble cell selection for particular column

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

AllowEditing()

It sets a value to enable or disable editing for particular column.

Declaration

public TreeGridColumnBuilder AllowEditing()

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

AllowEditing(Boolean)

It sets a value to enable or disable editing for particular column.

Declaration

public TreeGridColumnBuilder AllowEditing(bool allowEditing)

Parameters

Type	Name	Description
System.Boolean	allowEditing	It accepts the boolean value and enable/disble editing action in particular column

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

AllowFiltering()

It sets the value that indicates whether to enable dynamic filtering behavior for particular column.

Declaration

public TreeGridColumnBuilder AllowFiltering()

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

AllowFiltering(Boolean)

It sets the value that indicates whether to enable dynamic filtering behavior for particular column.

Declaration

public TreeGridColumnBuilder AllowFiltering(bool allowFiltering)

Parameters

Type	Name	Description
System.Boolean	allowFiltering	It accepts the boolean value and enables or disables filtering action

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

AllowFilteringBlankContent()

It sets the value that indicates whether to filter blank content for particular column.

Declaration

public TreeGridColumnBuilder AllowFilteringBlankContent()

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

AllowFilteringBlankContent(Boolean)

It sets the value that indicates whether to filter blank content for particular column.

Declaration

public TreeGridColumnBuilder AllowFilteringBlankContent(bool allowFilteringBlankContent)

Parameters

Type	Name	Description
System.Boolean	allowFilteringBlankContent	It accepts the boolean value and enables or disables blank option in filtering element

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

AllowFreezing()

It sets a value to freeze/unfreeze particular column.

Declaration

public TreeGridColumnBuilder AllowFreezing()

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

AllowFreezing(Boolean)

It sets a value to freeze/unfreeze particular column.

Declaration

public TreeGridColumnBuilder AllowFreezing(bool allowFreezing)

Parameters

Type	Name	Description
System.Boolean	allowFreezing	It accepts the boolean value and freeze/unfreeze particular column

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

AllowSorting()

Gets or sets a value to enable sorting behavior for particular column.

Declaration

public TreeGridColumnBuilder AllowSorting()

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

AllowSorting(Boolean)

It sets a value to enable sorting behavior for particular column.

Declaration

public TreeGridColumnBuilder AllowSorting(bool allowSorting)

Parameters

Type	Name	Description
System.Boolean	allowSorting	It accepts the boolean value and enables or disables sorting

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

CheckboxEditOptions(CheckBoxProperties)

It sets a value that indicates to customize ejCheckbox of an editable column.

Declaration

public TreeGridColumnBuilder CheckboxEditOptions(CheckBoxProperties checkboxEditOptions)

Parameters

Type	Name	Description
CheckBoxProperties	checkboxEditOptions	It displays the customized checkbox

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

ClipMode(TreeGridColumnClipMode)

Sets the clip mode for tree grid cell as ellipsis or clipped content.

Declaration

public TreeGridColumnBuilder ClipMode(TreeGridColumnClipMode Mode)

Parameters

Type	Name	Description
TreeGridColumnClipMode	Mode	It sets the clipmode

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

Commands(Action<TreeGridCommandsBuilder>)

It sets an object that indicates to define a command column in the tree grid.

Declaration

public TreeGridColumnBuilder Commands(Action<TreeGridCommandsBuilder> commands)

Parameters

Type	Name	Description
System.Action<TreeGridCommandsBuilder>	commands	It displays the command column through lambda expression

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

Commands(List<TreeGridCommands>)

It sets an object that indicates to define a command column in the tree grid.

Declaration

public TreeGridColumnBuilder Commands(List<TreeGridCommands> commands)

Parameters

Type	Name	Description
System.Collections.Generic.List<TreeGridCommands>	commands	It displays the list of command columns

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

DateEditOptions(DatePickerProperties)

It sets a value that indicates to customize ejDatePicker of an editable column.

Declaration

public TreeGridColumnBuilder DateEditOptions(DatePickerProperties dateeditparams)

Parameters

Type	Name	Description
DatePickerProperties	dateeditparams	It displays the customized datepicker

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

DateTimeEditOptions(DateTimePickerProperties)

It sets a value that indicates to customize ejDateTimePicker of an editable column.

Declaration

public TreeGridColumnBuilder DateTimeEditOptions(DateTimePickerProperties datetimeeditparams)

Parameters

Type	Name	Description
DateTimePickerProperties	datetimeeditparams	It displays the customized dateTimepicker

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

DisplayAsCheckbox()

It sets a value that indicates to display a column value as checkbox or string.

Declaration

public TreeGridColumnBuilder DisplayAsCheckbox()

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

DisplayAsCheckbox(Boolean)

Gets or sets a value that indicates to display a column value as checkbox or string.

Declaration

public TreeGridColumnBuilder DisplayAsCheckbox(bool displayAsCheckbox)

Parameters

Type	Name	Description
System.Boolean	displayAsCheckbox	It accepts the boolean value and displays the checkbox based on the value

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

DropDownData(IEnumerable)

It sets a data source to dropdown list.

Declaration

public TreeGridColumnBuilder DropDownData(IEnumerable dropDownData)

Parameters

Type	Name	Description
System.Collections.IEnumerable	dropDownData	It displays a dropdown data source

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

DropDownData(Object)

It sets a data source to dropdown list.

Declaration

public TreeGridColumnBuilder DropDownData(object dropDownData)

Parameters

Type	Name	Description
System.Object	dropDownData	It displays a dropdown data source

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

DropDownEditOptions(DropDownListProperties)

It sets a value that indicates to customize ejDropDownList of an editable column.

Declaration

public TreeGridColumnBuilder DropDownEditOptions(DropDownListProperties dropdowneditoptions)

Parameters

Type	Name	Description
DropDownListProperties	dropdowneditoptions	It displays the customized drop down

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

EditTemplate(TreeGridEditTemplate)

Declaration

public TreeGridColumnBuilder EditTemplate(TreeGridEditTemplate editTemplate)

Parameters

Type	Name	Description
TreeGridEditTemplate	editTemplate

Returns

Type	Description
TreeGridColumnBuilder

EditTemplate(Action<TreeGridEditTemplateOptionsBuilder>)

It sets a template that displays a custom editor used to edit column values.

Declaration

public TreeGridColumnBuilder EditTemplate(Action<TreeGridEditTemplateOptionsBuilder> editOption)

Parameters

Type	Name	Description
System.Action<TreeGridEditTemplateOptionsBuilder>	editOption	It displays the Edittemplate column through lambda expression

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

EditType(TreeGridEditingType)

It sets the value that indicates to render the element edit type while editing the tree grid record.

Declaration

public TreeGridColumnBuilder EditType(TreeGridEditingType editType)

Parameters

Type	Name	Description
TreeGridEditingType	editType	It displays the element based on the edit type.

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

Field(String)

It sets the value that indicates to display the columns in the tree grid mapping with column name of the dataSource.

Declaration

public TreeGridColumnBuilder Field(string field)

Parameters

Type	Name	Description
System.String	field	It accepts the string value and display the field for that columns

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

FilterEditType(TreeGridFilterEditType)

It sets the value that indicates to render the filter element edit type while editing the tree grid record.

Declaration

public TreeGridColumnBuilder FilterEditType(TreeGridFilterEditType filterEditType)

Parameters

Type	Name	Description
TreeGridFilterEditType	filterEditType	It displays the element based on the filter edit type.

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

FilterType(TreeGridFilterOption)

It sets the value that specifies the tree grid to indicate the mode of filtering records.

Declaration

public TreeGridColumnBuilder FilterType(TreeGridFilterOption filterType)

Parameters

Type	Name	Description
TreeGridFilterOption	filterType	It displays the type of filter used for filtering

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

Format(String)

It sets a format for the column value.

Declaration

public TreeGridColumnBuilder Format(string format)

Parameters

Type	Name	Description
System.String	format	It accepts the string value and applies the format for that column

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

HeaderTemplateID(String)

It sets a value that indicates to add the template within the header element of the particular column.

Declaration

public TreeGridColumnBuilder HeaderTemplateID(string headerTemplateID)

Parameters

Type	Name	Description
System.String	headerTemplateID	It accepts the string value and displays the headerTemplate for that column

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

HeaderText()

It sets the value that indicates to display the title of that particular column.

Declaration

public TreeGridColumnBuilder HeaderText()

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

HeaderText(String)

It sets the value that indicates to display the header text of that particular column.

Declaration

public TreeGridColumnBuilder HeaderText(string headerText)

Parameters

Type	Name	Description
System.String	headerText	It accepts the string value and displays the title for that column

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

HeaderTextAlign(TextAlign)

It sets a value that indicates to align the text within the column.

Declaration

public TreeGridColumnBuilder HeaderTextAlign(TextAlign textAlign)

Parameters

Type	Name	Description
TextAlign	textAlign

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

HeaderTooltip(String)

Sets the template for Tooltip in tree grid headers.

Declaration

public TreeGridColumnBuilder HeaderTooltip(string headertooltip)

Parameters

Type	Name	Description
System.String	headertooltip	It accepts the string and displays the tooltip

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

IsFrozen()

It sets a value to enable or disable freezing in tree grid column.

Declaration

public TreeGridColumnBuilder IsFrozen()

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

IsFrozen(Boolean)

It sets a value to enable or disable freezing in tree grid column.

Declaration

public TreeGridColumnBuilder IsFrozen(bool isFrozen)

Parameters

Type	Name	Description
System.Boolean	isFrozen	It accepts the boolean value and enable/disable freezing in tree grid column

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

IsTemplateColumn()

It sets the value that indicates whether to enables column template for a particular column.

Declaration

public TreeGridColumnBuilder IsTemplateColumn()

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

IsTemplateColumn(Boolean)

It sets the value that indicates whether to enables column template for a particular column.

Declaration

public TreeGridColumnBuilder IsTemplateColumn(bool isTemplateColumn)

Parameters

Type	Name	Description
System.Boolean	isTemplateColumn	It accepts the string value and enables or disables the template column

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

MappingName(String)

It sets a value that indicates to map for particular column.

Declaration

public TreeGridColumnBuilder MappingName(string mappingName)

Parameters

Type	Name	Description
System.String	mappingName	It accepts the string value and displays the mapping name for that column

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

MaskTextEditOptions(MaskEditProperties)

It sets a value that indicates to customize mask edit of an editable column.

Declaration

public TreeGridColumnBuilder MaskTextEditOptions(MaskEditProperties masktexteditparams)

Parameters

Type	Name	Description
MaskEditProperties	masktexteditparams	It displays the customized mask edit

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

NumericEditOptions(EditorProperties)

It sets a value that indicates to customize numeric edit of an editable column.

Declaration

public TreeGridColumnBuilder NumericEditOptions(EditorProperties numericeditparams)

Parameters

Type	Name	Description
EditorProperties	numericeditparams	It displays the customized numeric edit

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

Priority(Int32)

Priority makes column to be visible or hidden based on the priority value and browser’s width to best accommodate the possible columns.These Priority values are from one to six.

Declaration

public TreeGridColumnBuilder Priority(int priority)

Parameters

Type	Name	Description
System.Int32	priority	It accepts the integer value and display or hide the columns based on priority

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

ShowCheckbox()

It sets a value to enable checkbox in particular column.

Declaration

public TreeGridColumnBuilder ShowCheckbox()

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

ShowCheckbox(Boolean)

It sets a value to enable checkbox in particular column.

Declaration

public TreeGridColumnBuilder ShowCheckbox(bool showCheckbox)

Parameters

Type	Name	Description
System.Boolean	showCheckbox	It accepts the boolean value and enable checkbox in particular column

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

ShowInColumnChooser()

Used to hide the particular column in column chooser by giving value as false.

Declaration

public TreeGridColumnBuilder ShowInColumnChooser()

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

ShowInColumnChooser(Boolean)

Used to hide the particular column in column chooser by giving value as false.

Declaration

public TreeGridColumnBuilder ShowInColumnChooser(bool showInColumnChooser)

Parameters

Type	Name	Description
System.Boolean	showInColumnChooser	It accepts the boolean value and displays or hides the particular column

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

Template(String)

It sets a value that indicates to map for particular column.

Declaration

public TreeGridColumnBuilder Template(string template)

Parameters

Type	Name	Description
System.String	template	It accepts the string value and displays the template for that column

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

TemplateID(String)

It sets a value that indicates to map a template using its ID for particular column.

Declaration

public TreeGridColumnBuilder TemplateID(string templateId)

Parameters

Type	Name	Description
System.String	templateId	It accepts the string value and displays the template for that column

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

TextAlign(TextAlign)

It sets a value that indicates to align the text within the column.

Declaration

public TreeGridColumnBuilder TextAlign(TextAlign textAlign)

Parameters

Type	Name	Description
TextAlign	textAlign	It displays the list of TextAlign values

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

Tooltip(String)

Sets the template for Tooltip in tree grid content.

Declaration

public TreeGridColumnBuilder Tooltip(string tooltip)

Parameters

Type	Name	Description
System.String	tooltip	It accepts the string and displays the tooltip

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

ValidationRules(Action<TreeGridValidationRuleBuilder>)

It sets a value that indicates to define validations for saving data to the database.

Declaration

public TreeGridColumnBuilder ValidationRules(Action<TreeGridValidationRuleBuilder> validationRule)

Parameters

Type	Name	Description
System.Action<TreeGridValidationRuleBuilder>	validationRule	It defines the validations for saving data through lambda expression

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

ValidationRules(Dictionary<String, Object>)

It sets a value that indicates to define validations for saving data to the database.

Declaration

public TreeGridColumnBuilder ValidationRules(Dictionary<string, object> validationRule)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	validationRule	It accepts the string as key and object value passed to define the validations for saving the data

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

Visible()

It sets a value that indicates whether this column is visible in the tree grid.

Declaration

public TreeGridColumnBuilder Visible()

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

Visible(Boolean)

It sets a value that indicates whether this column is visible in the tree grid.

Declaration

public TreeGridColumnBuilder Visible(bool visible)

Parameters

Type	Name	Description
System.Boolean	visible	It accepts the boolean value and show/hide particular column

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder

Width(Int32)

It sets a value that indicates to define the width for a particular column in the tree grid.

Declaration

public TreeGridColumnBuilder Width(int width)

Parameters

Type	Name	Description
System.Int32	width	It displays the column based on the object value passed.

Returns

Type	Description
TreeGridColumnBuilder	TreeGridColumnBuilder