Class TreeGridStackedColumnBuilder

Inheritance

System.Object

Syncfusion.EJ2.ControlBuilder

TreeGridStackedColumnBuilder

Namespace: Syncfusion.EJ2.TreeGrid

Assembly: Syncfusion.EJ2.dll

Syntax

public class TreeGridStackedColumnBuilder : ControlBuilder

Constructors

TreeGridStackedColumnBuilder()

Declaration

public TreeGridStackedColumnBuilder()

TreeGridStackedColumnBuilder(List<TreeGridStackedColumn>)

Declaration

public TreeGridStackedColumnBuilder(List<TreeGridStackedColumn> collection)

Parameters

Type	Name	Description
System.Collections.Generic.List<TreeGridStackedColumn>	collection

Methods

Add()

Declaration

public void Add()

AllowEditing(Boolean)

If allowEditing set to false, then it disables editing of a particular column. By default all columns are editable.

Declaration

public TreeGridStackedColumnBuilder AllowEditing(bool allowEditing)

Parameters

Type	Name	Description
System.Boolean	allowEditing

Returns

Type
TreeGridStackedColumnBuilder

AllowFiltering(Boolean)

If allowFiltering set to false, then it disables filtering option and filter bar element of a particular column. By default all columns are filterable.

Declaration

public TreeGridStackedColumnBuilder AllowFiltering(bool allowFiltering)

Parameters

Type	Name	Description
System.Boolean	allowFiltering

Returns

Type
TreeGridStackedColumnBuilder

AllowReordering(Boolean)

If allowReordering set to false, then it disables reorder of a particular column. By default all columns can be reorder.

Declaration

public TreeGridStackedColumnBuilder AllowReordering(bool allowReordering)

Parameters

Type	Name	Description
System.Boolean	allowReordering

Returns

Type
TreeGridStackedColumnBuilder

AllowResizing(Boolean)

If allowResizing set to false, it disables resize option of a particular column.

Declaration

public TreeGridStackedColumnBuilder AllowResizing(bool allowResizing)

Parameters

Type	Name	Description
System.Boolean	allowResizing

Returns

Type
TreeGridStackedColumnBuilder

AllowSorting(Boolean)

If allowSorting set to false, then it disables sorting option of a particular column. By default all columns are sortable.

Declaration

public TreeGridStackedColumnBuilder AllowSorting(bool allowSorting)

Parameters

Type	Name	Description
System.Boolean	allowSorting

Returns

Type
TreeGridStackedColumnBuilder

ClipMode(ClipMode)

Defines the cell content's overflow mode. The available modes are

also it will display tooltip while hover on ellipsis applied cell.

Declaration

public TreeGridStackedColumnBuilder ClipMode(ClipMode clipMode)

Parameters

Type	Name	Description
ClipMode	clipMode

Returns

Type
TreeGridStackedColumnBuilder

Columns(Object)

Defines stacked columns

Declaration

public TreeGridStackedColumnBuilder Columns(object columns)

Parameters

Type	Name	Description
System.Object	columns

Returns

Type
TreeGridStackedColumnBuilder

Columns(String[])

Defines stacked columns

Declaration

public TreeGridStackedColumnBuilder Columns(string[] columns)

Parameters

Type	Name	Description
System.String[]	columns

Returns

Type
TreeGridStackedColumnBuilder

Commands(Object)

commands provides an option to display command buttons in every cell. The available built-in command buttons are Edit - Edit the record. Delete - Delete the record. Save - Save the record. Cancel - Cancel the edit state.

Declaration

public TreeGridStackedColumnBuilder Commands(object commands)

Parameters

Type	Name	Description
System.Object	commands

Returns

Type
TreeGridStackedColumnBuilder

CustomAttributes(Object)

The CSS styles and attributes of the content cells of a particular column can be customized.

Declaration

public TreeGridStackedColumnBuilder CustomAttributes(object customAttributes)

Parameters

Type	Name	Description
System.Object	customAttributes

Returns

Type
TreeGridStackedColumnBuilder

DefaultValue(String)

Defines default values for the component when adding a new record to the TreeGrid.

Declaration

public TreeGridStackedColumnBuilder DefaultValue(string defaultValue)

Parameters

Type	Name	Description
System.String	defaultValue

Returns

Type
TreeGridStackedColumnBuilder

DisableHtmlEncode(Boolean)

If disableHtmlEncode is set to true, it encodes the HTML of the header and content cells.

Declaration

public TreeGridStackedColumnBuilder DisableHtmlEncode(bool disableHtmlEncode)

Parameters

Type	Name	Description
System.Boolean	disableHtmlEncode

Returns

Type
TreeGridStackedColumnBuilder

DisplayAsCheckBox(Boolean)

If displayAsCheckBox is set to true, it displays the column value as a check box instead of Boolean value.

Declaration

public TreeGridStackedColumnBuilder DisplayAsCheckBox(bool displayAsCheckBox)

Parameters

Type	Name	Description
System.Boolean	displayAsCheckBox

Returns

Type
TreeGridStackedColumnBuilder

Edit(Object)

Defines the IEditCell object to customize default edit cell.

Declaration

public TreeGridStackedColumnBuilder Edit(object edit)

Parameters

Type	Name	Description
System.Object	edit

Returns

Type
TreeGridStackedColumnBuilder

EditType(String)

Defines the type of component for editing.

Declaration

public TreeGridStackedColumnBuilder EditType(string editType)

Parameters

Type	Name	Description
System.String	editType

Returns

Type
TreeGridStackedColumnBuilder

Field(String)

Defines the field name of column which is mapped with mapping name of DataSource. The bounded columns can be sort, filter etc., The field name must be a valid JavaScript identifier, the first character must be an alphabet and should not contain spaces and special characters.

Declaration

public TreeGridStackedColumnBuilder Field(string field)

Parameters

Type	Name	Description
System.String	field

Returns

Type
TreeGridStackedColumnBuilder

Filter(Object)

Defines the filter options to customize filtering for the particular column.

Declaration

public TreeGridStackedColumnBuilder Filter(object filter)

Parameters

Type	Name	Description
System.Object	filter

Returns

Type
TreeGridStackedColumnBuilder

FilterBarTemplate(Object)

The filterBarTemplate is used to add a custom component instead of default input component for filter bar. It have create and read functions. create: It is used for creating custom components. read: It is used to perform custom filter action.

Declaration

public TreeGridStackedColumnBuilder FilterBarTemplate(object filterBarTemplate)

Parameters

Type	Name	Description
System.Object	filterBarTemplate

Returns

Type
TreeGridStackedColumnBuilder

Format(String)

It is used to change display value with the given format and does not affect the original data. Gets the format from the user which can be standard or custom number and date formats.

Declaration

public TreeGridStackedColumnBuilder Format(string format)

Parameters

Type	Name	Description
System.String	format

Returns

Type
TreeGridStackedColumnBuilder

Formatter(Object)

Defines the method which is used to achieve custom formatting from an external function. This function triggers before rendering of each cell.

Declaration

public TreeGridStackedColumnBuilder Formatter(object formatter)

Parameters

Type	Name	Description
System.Object	formatter

Returns

Type
TreeGridStackedColumnBuilder

Freeze(FreezeDirection)

Defines which side the column need to freeze

Declaration

public TreeGridStackedColumnBuilder Freeze(FreezeDirection freeze)

Parameters

Type	Name	Description
FreezeDirection	freeze

Returns

Type
TreeGridStackedColumnBuilder

HeaderTemplate(String)

Defines the header template as string or HTML element ID which is used to add customized element in the column header.

Declaration

public TreeGridStackedColumnBuilder HeaderTemplate(string headerTemplate)

Parameters

Type	Name	Description
System.String	headerTemplate

Returns

Type
TreeGridStackedColumnBuilder

HeaderText(String)

Defines the header text of column which is used to display in column header. If headerText is not defined, then field name value will be assigned to header text.

Declaration

public TreeGridStackedColumnBuilder HeaderText(string headerText)

Parameters

Type	Name	Description
System.String	headerText

Returns

Type
TreeGridStackedColumnBuilder

HeaderTextAlign(TextAlign)

Define the alignment of column header which is used to align the text of column header.

Declaration

public TreeGridStackedColumnBuilder HeaderTextAlign(TextAlign headerTextAlign)

Parameters

Type	Name	Description
TextAlign	headerTextAlign

Returns

Type
TreeGridStackedColumnBuilder

HideAtMedia(String)

Column visibility can change based on Media Queries. hideAtMedia accepts only valid Media Queries.

Declaration

public TreeGridStackedColumnBuilder HideAtMedia(string hideAtMedia)

Parameters

Type	Name	Description
System.String	hideAtMedia

Returns

Type
TreeGridStackedColumnBuilder

IsFrozen(Boolean)

You can use this property to freeze selected columns in grid.

Declaration

public TreeGridStackedColumnBuilder IsFrozen(bool isFrozen)

Parameters

Type	Name	Description
System.Boolean	isFrozen

Returns

Type
TreeGridStackedColumnBuilder

IsIdentity(Boolean)

If isIdentity is set to true, then this column is considered as identity column.

Declaration

public TreeGridStackedColumnBuilder IsIdentity(bool isIdentity)

Parameters

Type	Name	Description
System.Boolean	isIdentity

Returns

Type
TreeGridStackedColumnBuilder

IsPrimaryKey(Boolean)

If isPrimaryKey is set to true, considers this column as the primary key constraint.

Declaration

public TreeGridStackedColumnBuilder IsPrimaryKey(bool isPrimaryKey)

Parameters

Type	Name	Description
System.Boolean	isPrimaryKey

Returns

Type
TreeGridStackedColumnBuilder

LockColumn(Boolean)

If lockColumn set to true, then it disables Reordering of a particular column. The locked column will be moved to first position.

Declaration

public TreeGridStackedColumnBuilder LockColumn(bool lockColumn)

Parameters

Type	Name	Description
System.Boolean	lockColumn

Returns

Type
TreeGridStackedColumnBuilder

MaxWidth(Double)

Defines the maximum width of the column in pixels or percentage, which will restrict resizing beyond this pixels or percentage.

Declaration

public TreeGridStackedColumnBuilder MaxWidth(double maxWidth)

Parameters

Type	Name	Description
System.Double	maxWidth

Returns

Type
TreeGridStackedColumnBuilder

MaxWidth(String)

Defines the maximum width of the column in pixels or percentage, which will restrict resizing beyond this pixels or percentage.

Declaration

public TreeGridStackedColumnBuilder MaxWidth(string maxWidth)

Parameters

Type	Name	Description
System.String	maxWidth

Returns

Type
TreeGridStackedColumnBuilder

MinWidth(Double)

Defines the minimum width of the column in pixels or percentage.

Declaration

public TreeGridStackedColumnBuilder MinWidth(double minWidth)

Parameters

Type	Name	Description
System.Double	minWidth

Returns

Type
TreeGridStackedColumnBuilder

MinWidth(String)

Defines the minimum width of the column in pixels or percentage.

Declaration

public TreeGridStackedColumnBuilder MinWidth(string minWidth)

Parameters

Type	Name	Description
System.String	minWidth

Returns

Type
TreeGridStackedColumnBuilder

ShowCheckbox(Boolean)

If showCheckbox set to true, then the checkboxes will be displayed in particular column.

Declaration

public TreeGridStackedColumnBuilder ShowCheckbox(bool showCheckbox)

Parameters

Type	Name	Description
System.Boolean	showCheckbox

Returns

Type
TreeGridStackedColumnBuilder

ShowColumnMenu(Boolean)

If showColumnMenu set to false, then it disable the column menu of a particular column. By default column menu will show for all columns

Declaration

public TreeGridStackedColumnBuilder ShowColumnMenu(bool showColumnMenu)

Parameters

Type	Name	Description
System.Boolean	showColumnMenu

Returns

Type
TreeGridStackedColumnBuilder

ShowInColumnChooser(Boolean)

If showInColumnChooser set to false, then hide the particular column in column chooser. By default all columns are displayed in column Chooser.

Declaration

public TreeGridStackedColumnBuilder ShowInColumnChooser(bool showInColumnChooser)

Parameters

Type	Name	Description
System.Boolean	showInColumnChooser

Returns

Type
TreeGridStackedColumnBuilder

SortComparer(Object)

Defines the sort comparer property.

Declaration

public TreeGridStackedColumnBuilder SortComparer(object sortComparer)

Parameters

Type	Name	Description
System.Object	sortComparer

Returns

Type
TreeGridStackedColumnBuilder

SortComparer(String)

Defines the sort comparer property.

Declaration

public TreeGridStackedColumnBuilder SortComparer(string sortComparer)

Parameters

Type	Name	Description
System.String	sortComparer

Returns

Type
TreeGridStackedColumnBuilder

Template(String)

Defines the column template that renders customized element in each cell of the column. It accepts either template string or HTML element ID.

Declaration

public TreeGridStackedColumnBuilder Template(string template)

Parameters

Type	Name	Description
System.String	template

Returns

Type
TreeGridStackedColumnBuilder

TextAlign(TextAlign)

Defines the alignment of the column in both header and content cells.

Declaration

public TreeGridStackedColumnBuilder TextAlign(TextAlign textAlign)

Parameters

Type	Name	Description
TextAlign	textAlign

Returns

Type
TreeGridStackedColumnBuilder

Type(String)

Defines the data type of the column.

Declaration

public TreeGridStackedColumnBuilder Type(string type)

Parameters

Type	Name	Description
System.String	type

Returns

Type
TreeGridStackedColumnBuilder

Uid(String)

Gets the unique identifier value of the column. It is used to get the object.

Declaration

public TreeGridStackedColumnBuilder Uid(string uid)

Parameters

Type	Name	Description
System.String	uid

Returns

Type
TreeGridStackedColumnBuilder

ValidationRules(Object)

Defines rules to validate data before creating and updating.

Declaration

public TreeGridStackedColumnBuilder ValidationRules(object validationRules)

Parameters

Type	Name	Description
System.Object	validationRules

Returns

Type
TreeGridStackedColumnBuilder

ValueAccessor(Object)

Defines the method used to apply custom cell values from external function and display this on each cell rendered.

Declaration

public TreeGridStackedColumnBuilder ValueAccessor(object valueAccessor)

Parameters

Type	Name	Description
System.Object	valueAccessor

Returns

Type
TreeGridStackedColumnBuilder

ValueAccessor(String)

Defines the method used to apply custom cell values from external function and display this on each cell rendered.

Declaration

public TreeGridStackedColumnBuilder ValueAccessor(string valueAccessor)

Parameters

Type	Name	Description
System.String	valueAccessor

Returns

Type
TreeGridStackedColumnBuilder

Visible(Boolean)

If visible is set to false, hides the particular column. By default, columns are displayed.

Declaration

public TreeGridStackedColumnBuilder Visible(bool visible)

Parameters

Type	Name	Description
System.Boolean	visible

Returns

Type
TreeGridStackedColumnBuilder

Width(Double)

Defines the width of the column in pixels or percentage.

Declaration

public TreeGridStackedColumnBuilder Width(double width)

Parameters

Type	Name	Description
System.Double	width

Returns

Type
TreeGridStackedColumnBuilder

Width(String)

Defines the width of the column in pixels or percentage.

Declaration

public TreeGridStackedColumnBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width

Returns

Type
TreeGridStackedColumnBuilder