Class TreeGrid

Inheritance
System.Object
CommonDataBoundControl
TreeGrid
Implements
System.Web.UI.INamingContainer
System.Web.UI.IPostBackEventHandler
System.Web.UI.IPostBackDataHandler
System.Web.UI.IUrlResolutionService
Inherited Members
Namespace: Syncfusion.JavaScript.Web
Assembly: Syncfusion.EJ.Web.dll
Syntax
public class TreeGrid : CommonDataBoundControl, INamingContainer, IPostBackEventHandler, IPostBackDataHandler, IUrlResolutionService

Constructors

TreeGrid()

Declaration
public TreeGrid()

Properties

ActionBegin

Triggered before every success event of Treegrid action.

Declaration
public string ActionBegin { get; set; }
Property Value
Type Description
System.String

ActionComplete

Triggered for every Treegrid action success event.

Declaration
public string ActionComplete { get; set; }
Property Value
Type Description
System.String

ActionFailure

Triggered for every TreeGrid server action failure.

Declaration
public string ActionFailure { get; set; }
Property Value
Type Description
System.String

AllowColumnReordering

Enables or disables the ability to reorder the column position interactively.

Declaration
public bool AllowColumnReordering { get; set; }
Property Value
Type Description
System.Boolean

AllowColumnResize

Enables or disables the ability to resize the column width interactively.

Declaration
public bool AllowColumnResize { get; set; }
Property Value
Type Description
System.Boolean

AllowDragAndDrop

Enables or disables the ability to drag and drop the row interactively to reorder the rows.

Declaration
public bool AllowDragAndDrop { get; set; }
Property Value
Type Description
System.Boolean

AllowFiltering

Enables or disables the ability to filter the data on all the columns. Enabling this property will display a row with editor controls corresponding to each column. You can restrict filtering on particular column by disabling this property directly on that column instance itself.

Declaration
public bool AllowFiltering { get; set; }
Property Value
Type Description
System.Boolean

AllowKeyboardNavigation

Enables or disables keyboard navigation.

Declaration
public bool AllowKeyboardNavigation { get; set; }
Property Value
Type Description
System.Boolean

AllowMultiSorting

Enables or disables the ability to sort the rows based on multiple columns/fields by clicking on each column header. Rows will be sorted recursively on clicking the column headers.

Declaration
public bool AllowMultiSorting { get; set; }
Property Value
Type Description
System.Boolean

AllowPaging

Enables/disables pagination of rows in TreeGrid

Declaration
public bool AllowPaging { get; set; }
Property Value
Type Description
System.Boolean

AllowSearching

Gets or sets a value that indicates whether to enable dynamic searching behavior in treegrid.

Declaration
public bool AllowSearching { get; set; }
Property Value
Type Description
System.Boolean

AllowSelection

Enables or disables the ability to select a row interactively.

Declaration
public bool AllowSelection { get; set; }
Property Value
Type Description
System.Boolean

AllowSorting

Enables or disables the ability to sort the rows based on a single field/column by clicking on that column header. When enabled, rows can be sorted only by single field/column.

Declaration
public bool AllowSorting { get; set; }
Property Value
Type Description
System.Boolean

AllowTextWrap

Gets or sets a value that indicates whether the Content will wrap to the next line if the content exceeds the boundary of the Column Cells

Declaration
public bool AllowTextWrap { get; set; }
Property Value
Type Description
System.Boolean

AltRowTemplateId

Specifies the id of the template that has to be applied for alternate rows.

Declaration
public string AltRowTemplateId { get; set; }
Property Value
Type Description
System.String

BeforePrint

Triggered before printing get initiated

Declaration
public string BeforePrint { get; set; }
Property Value
Type Description
System.String

BeginEdit

Triggered while enter the edit mode in the treegrid cell

Declaration
public string BeginEdit { get; set; }
Property Value
Type Description
System.String

CellSelected

Triggered after the cell is selected.

Declaration
public string CellSelected { get; set; }
Property Value
Type Description
System.String

CellSelecting

Triggered before the cell is going to be selected.

Declaration
public string CellSelecting { get; set; }
Property Value
Type Description
System.String

CellTooltipTemplate

Gets or ses th tool tip template fo cell Tooltip

Declaration
public string CellTooltipTemplate { get; set; }
Property Value
Type Description
System.String

ChildMapping

Specifies the mapping property path for sub tasks in datasource

Declaration
[JsonProperty("childMapping")]
public string ChildMapping { get; set; }
Property Value
Type Description
System.String

Collapsed

Triggered after collapsed the TreeGrid record

Declaration
public string Collapsed { get; set; }
Property Value
Type Description
System.String

CollapsibleTotalSummary

Specifies the visibility of expander icon in total summary row.

Declaration
public bool CollapsibleTotalSummary { get; set; }
Property Value
Type Description
System.Boolean

Collapsing

Triggered while collapsing the TreeGrid record

Declaration
public string Collapsing { get; set; }
Property Value
Type Description
System.String

ColumnDialogFields

Include or exclude column dialog fields

Declaration
public List<string> ColumnDialogFields { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

ColumnDrag

Triggered while dragging a column

Declaration
public string ColumnDrag { get; set; }
Property Value
Type Description
System.String

ColumnDragStart

Triggered when you start to drag a column

Declaration
public string ColumnDragStart { get; set; }
Property Value
Type Description
System.String

ColumnDrop

Triggered when a column is dropped

Declaration
public string ColumnDrop { get; set; }
Property Value
Type Description
System.String

ColumnResized

Triggered after column resized.

Declaration
public string ColumnResized { get; set; }
Property Value
Type Description
System.String

ColumnResizeEnd

Triggered once we mouse up in the column resize action

Declaration
public string ColumnResizeEnd { get; set; }
Property Value
Type Description
System.String

ColumnResizeSettings

Specifies column resize modes in TreeGrid

Declaration
public TreeGridColumnResizeSettings ColumnResizeSettings { get; set; }
Property Value
Type Description
TreeGridColumnResizeSettings

ColumnResizeStart

Triggered when we start to resize the column

Declaration
public string ColumnResizeStart { get; set; }
Property Value
Type Description
System.String

Columns

Option for adding columns; each column has the option to bind to a field in the dataSource.

Declaration
public List<TreeGridColumn> Columns { get; }
Property Value
Type Description
System.Collections.Generic.List<TreeGridColumn>

CommonWidth

Specifies common width of the TreeGrid.

Declaration
public int CommonWidth { get; set; }
Property Value
Type Description
System.Int32

ContextMenuOpen

Triggered while Context Menu is rendered in TreeGrid control

Declaration
public string ContextMenuOpen { get; set; }
Property Value
Type Description
System.String

ContextMenuSettings

Options for displaying and customizing context menu items.

Declaration
public TreeGridContextMenuOptions ContextMenuSettings { get; set; }
Property Value
Type Description
TreeGridContextMenuOptions

Create

Triggered after complete the tree grid rendering.

Declaration
public string Create { get; set; }
Property Value
Type Description
System.String

CssClass

Specify the CSS class for treegrid to achieve custom theme.

Declaration
public override string CssClass { get; set; }
Property Value
Type Description
System.String

DataManager

Declaration
public DataSource DataManager { get; set; }
Property Value
Type Description
DataSource

DataSourceCachingMode

Gets or sets the caching mode of data source

Declaration
public DataSourceCachingMode DataSourceCachingMode { get; set; }
Property Value
Type Description
DataSourceCachingMode

DateFormat

Specifies the dateFormat for treegrid , given format is displayed in tooltip , grid .

Declaration
public string DateFormat { get; set; }
Property Value
Type Description
System.String

DetailsDataBound

Triggered while rendering details template in TreeGrid

Declaration
public string DetailsDataBound { get; set; }
Property Value
Type Description
System.String

DetailsHidden

Triggered when details template pop-up is hidden.

Declaration
public string DetailsHidden { get; set; }
Property Value
Type Description
System.String

DetailsRowHeight

Gets or sets a details row height in tree grid

Declaration
[JsonProperty("detailsRowHeight")]
public int DetailsRowHeight { get; set; }
Property Value
Type Description
System.Int32

DetailsShown

Triggered when details template pop-up is shown.

Declaration
public string DetailsShown { get; set; }
Property Value
Type Description
System.String

DetailsTemplate

Gets or sets a template for details row

Declaration
[JsonProperty("detailsTemplate")]
public string DetailsTemplate { get; set; }
Property Value
Type Description
System.String

DragTooltip

Options for displaying and customizing the tooltip. This tooltip will show the preview of the row that is being dragged.

Declaration
public TreeGridDragTooltip DragTooltip { get; set; }
Property Value
Type Description
TreeGridDragTooltip

EditSettings

Options for enabling and configuring the editing related operations.

Declaration
public TreeGridEditOptions EditSettings { get; set; }
Property Value
Type Description
TreeGridEditOptions

EnableAltRow

Specifies whether to render alternate rows in different background colors.

Declaration
public bool EnableAltRow { get; set; }
Property Value
Type Description
System.Boolean

EnableCollapseAll

Specifies whether to load all the rows in collapsed state when the TreeGrid is rendered for the first time.

Declaration
[JsonProperty("enableCollapseAll")]
public bool EnableCollapseAll { get; set; }
Property Value
Type Description
System.Boolean

EnableLoadOnDemand

Specifies whether to load remote data on demand basis.

Declaration
[JsonProperty("enableLoadOnDemand")]
public bool EnableLoadOnDemand { get; set; }
Property Value
Type Description
System.Boolean

EnableResize

Specifies whether to resize TreeGrid whenever window size changes.

Declaration
[JsonProperty("enableResize")]
public bool EnableResize { get; set; }
Property Value
Type Description
System.Boolean

EnableVirtualization

Specifies whether to render only the visual elements that are visible in the UI. When you enable this property, it will reduce the loading time for loading large number of records.

Declaration
public bool EnableVirtualization { get; set; }
Property Value
Type Description
System.Boolean

EndEdit

Triggered after saved the modified cellValue in treegrid

Declaration
public string EndEdit { get; set; }
Property Value
Type Description
System.String

Expanded

Triggered after expand the record

Declaration
public string Expanded { get; set; }
Property Value
Type Description
System.String

Expanding

Triggered while expanding the TreeGrid record

Declaration
public string Expanding { get; set; }
Property Value
Type Description
System.String

ExpandStateMapping

Specifies the name of the field in the dataSource, which contains the expand state of the parent row

Declaration
[JsonProperty("expandStateMapping")]
public string ExpandStateMapping { get; set; }
Property Value
Type Description
System.String

FilterSettings

Gets or sets a filter option for tree grid

Declaration
public TreeGridFilterSettings FilterSettings { get; set; }
Property Value
Type Description
TreeGridFilterSettings

HasChildMapping

Specifies the name of the boolean field in the remote dataSource, which defines wherther a task is parent or not.

Declaration
[JsonProperty("hasChildMapping")]
public string HasChildMapping { get; set; }
Property Value
Type Description
System.String

HeaderTextOverflow

Specifies the type of selection whether to select single row or multiple rows

Declaration
public TreeGridHeaderTextOverflow HeaderTextOverflow { get; set; }
Property Value
Type Description
TreeGridHeaderTextOverflow

IdMapping

Specifies the name of the field in the dataSource, which contains the id of that row

Declaration
[JsonProperty("idMapping")]
public string IdMapping { get; set; }
Property Value
Type Description
System.String

IsResponsive

Specifies whether to resize TreeGrid whenever window size changes.

Declaration
[JsonProperty("isResponsive")]
public bool IsResponsive { get; set; }
Property Value
Type Description
System.Boolean

Load

Triggered while Treegrid is loaded

Declaration
public string Load { get; set; }
Property Value
Type Description
System.String

Locale

Specify the locale for treegrid

Declaration
public string Locale { get; set; }
Property Value
Type Description
System.String

Model

Declaration
public TreeGridProperties Model { get; set; }
Property Value
Type Description
TreeGridProperties

PageSettings

Gets or sets a paging customization option when enable the paging.

Declaration
public TreeGridPageSettings PageSettings { get; set; }
Property Value
Type Description
TreeGridPageSettings

ParentIdMapping

Specifies the name of the field in the dataSource, which contains the parent’s id. This is necessary to form a parent-child hierarchy, if the dataSource contains self-referential data.

Declaration
[JsonProperty("parentIdMapping")]
public string ParentIdMapping { get; set; }
Property Value
Type Description
System.String

ParseRowTemplate

Specifies row templates need to be parsed or not.

Declaration
public bool ParseRowTemplate { get; set; }
Property Value
Type Description
System.Boolean

Query

Specifies ej.Query to select data from the dataSource. This property is applicable only when the dataSource is ej.DataManager.

Declaration
public string Query { get; set; }
Property Value
Type Description
System.String

QueryCellInfo

Triggered while rendering each cell in the treegrid

Declaration
public string QueryCellInfo { get; set; }
Property Value
Type Description
System.String

RecordClick

Client side event for record click action

Declaration
public string RecordClick { get; set; }
Property Value
Type Description
System.String

RecordDoubleClick

Client side event for record double click action

Declaration
public string RecordDoubleClick { get; set; }
Property Value
Type Description
System.String

RowDataBound

Triggered while rendering each row

Declaration
public string RowDataBound { get; set; }
Property Value
Type Description
System.String

RowDrag

Triggered while dragging a row in TreeGrid control

Declaration
public string RowDrag { get; set; }
Property Value
Type Description
System.String

RowDragStart

Triggered while start to drag row in TreeGrid control

Declaration
public string RowDragStart { get; set; }
Property Value
Type Description
System.String

RowDragStop

Triggered while drop a row in TreeGrid control

Declaration
public string RowDragStop { get; set; }
Property Value
Type Description
System.String

RowDropActionBegin

Triggered before drop action begins in TreeGrid

Declaration
public string RowDropActionBegin { get; set; }
Property Value
Type Description
System.String

RowHeight

Specifies the height of a single row in tree grid. Also, we need to set same height in the CSS style with class name e-rowcell.

Declaration
public int RowHeight { get; set; }
Property Value
Type Description
System.Int32

RowSelected

Triggered after the row is selected.

Declaration
public string RowSelected { get; set; }
Property Value
Type Description
System.String

RowSelecting

Triggered before the row is going to be selected.

Declaration
public string RowSelecting { get; set; }
Property Value
Type Description
System.String

RowTemplateId

Specifies the id of the template to be applied for all the rows.

Declaration
public string RowTemplateId { get; set; }
Property Value
Type Description
System.String

SearchSettings

Gets or sets an object that indicates whether to customize the searching behavior of the treegrid.

Declaration
public TreeGridSearchSettings SearchSettings { get; set; }
Property Value
Type Description
TreeGridSearchSettings

SelectedCellIndexes

Indexes of cells which are highlighted while loading.

Declaration
public List<TreeGridSelectedCellIndex> SelectedCellIndexes { get; }
Property Value
Type Description
System.Collections.Generic.List<TreeGridSelectedCellIndex>

SelectedRowIndex

Specifies the index of the selected row.

Declaration
public int SelectedRowIndex { get; set; }
Property Value
Type Description
System.Int32

SelectionMode

Specifies the type of selection Mode whether it is Row or Cell

Declaration
public TreeGridSelectionMode SelectionMode { get; set; }
Property Value
Type Description
TreeGridSelectionMode

SelectionSettings

Gets or sets a selection option customization when enable the selection.

Declaration
public TreeGridSelectionSettings SelectionSettings { get; set; }
Property Value
Type Description
TreeGridSelectionSettings

SelectionType

Specifies the type of selection whether to select single row or multiple rows

Declaration
public TreeGridSelectionType SelectionType { get; set; }
Property Value
Type Description
TreeGridSelectionType

ShowColumnChooser

Controls the visibility of the menu button, which is displayed on the column header. Clicking on this button will show a popup menu. When you choose “Columns” item from this popup, a list box with column names will be shown, from which you can select/deselect a column name to control the visibility of the respective columns.

Declaration
public bool ShowColumnChooser { get; set; }
Property Value
Type Description
System.Boolean

ShowColumnOptions

Enable or disable the column options in column menu

Declaration
public bool ShowColumnOptions { get; set; }
Property Value
Type Description
System.Boolean

ShowDetailsRow

Gets or sets a visibility of details row.

Declaration
[JsonProperty("showDetailsRow")]
public bool ShowDetailsRow { get; set; }
Property Value
Type Description
System.Boolean

ShowDetailsRowInfoColumn

Gets or sets a visibility of details row information column.

Declaration
[JsonProperty("showDetailsRowInfoColumn")]
public bool ShowDetailsRowInfoColumn { get; set; }
Property Value
Type Description
System.Boolean

ShowGridCellTooltip

Specifies whether to show tooltip when mouse is hovered on the cell.

Declaration
public bool ShowGridCellTooltip { get; set; }
Property Value
Type Description
System.Boolean

ShowGridExpandCellTooltip

Specifies whether to show tooltip for the cells, which has expander button.

Declaration
public bool ShowGridExpandCellTooltip { get; set; }
Property Value
Type Description
System.Boolean

ShowStackedHeader

Declaration
public bool ShowStackedHeader { get; set; }
Property Value
Type Description
System.Boolean

ShowSummaryRow

Gets or sets a visibility of summary row

Declaration
public bool ShowSummaryRow { get; set; }
Property Value
Type Description
System.Boolean

ShowTotalSummary

Gets or sets a visibility of total summary row

Declaration
public bool ShowTotalSummary { get; set; }
Property Value
Type Description
System.Boolean

SizeSettings

Options for setting width and height for TreeGrid.

Declaration
public TreeGridSizeSettings SizeSettings { get; set; }
Property Value
Type Description
TreeGridSizeSettings

SortedColumns

Options for sorting the rows.

Declaration
public List<TreeGridSortedColumn> SortedColumns { get; }
Property Value
Type Description
System.Collections.Generic.List<TreeGridSortedColumn>

StackedHeaderRows

Declaration
public List<TreeGridStackedHeaderRow> StackedHeaderRows { get; }
Property Value
Type Description
System.Collections.Generic.List<TreeGridStackedHeaderRow>

SummaryRows

Gets or sets a summary row collection object to be displayed

Declaration
public List<TreeGridSummaryRow> SummaryRows { get; }
Property Value
Type Description
System.Collections.Generic.List<TreeGridSummaryRow>

ToolbarClick

Triggered when toolbar item is clicked in TreeGrid

Declaration
public string ToolbarClick { get; set; }
Property Value
Type Description
System.String

ToolbarSettings

Options for displaying and customizing the toolbar items.

Declaration
public TreeGridToolBarOptions ToolbarSettings { get; set; }
Property Value
Type Description
TreeGridToolBarOptions

TotalSummaryHeight

Specifies custom total summary height of TreeGrid

Declaration
public int TotalSummaryHeight { get; set; }
Property Value
Type Description
System.Int32

TreeColumnIndex

Specifies the index of the column that needs to have the expander button. By default, cells in the first column contain the expander button.

Declaration
public int TreeColumnIndex { get; set; }
Property Value
Type Description
System.Int32

Methods

DependentScripts()

Declaration
public List<string> DependentScripts()
Returns
Type Description
System.Collections.Generic.List<System.String>

FetchData(IEnumerable)

Declaration
public override void FetchData(IEnumerable data)
Parameters
Type Name Description
System.Collections.IEnumerable data
Overrides

GetCollection<T>(Object)

Declaration
protected List<T> GetCollection<T>(object collection)
Parameters
Type Name Description
System.Object collection
Returns
Type Description
System.Collections.Generic.List<T>
Type Parameters
Name Description
T

GetDependentFiles()

Declaration
public override List<string> GetDependentFiles()
Returns
Type Description
System.Collections.Generic.List<System.String>
Overrides

GetList<T>(Object)

Declaration
protected List<T> GetList<T>(object arrayCollection)
Parameters
Type Name Description
System.Object arrayCollection
Returns
Type Description
System.Collections.Generic.List<T>
Type Parameters
Name Description
T

LoadViewState(Object)

Declaration
protected override void LoadViewState(object state)
Parameters
Type Name Description
System.Object state
Overrides

PostBackEventHandler(String, Dictionary<String, Object>)

Declaration
public override void PostBackEventHandler(string EventName, Dictionary<string, object> args)
Parameters
Type Name Description
System.String EventName
System.Collections.Generic.Dictionary<System.String, System.Object> args
Overrides

Render()

Declaration
public string Render()
Returns
Type Description
System.String

Render(HtmlTextWriter)

Declaration
protected override void Render(HtmlTextWriter writer)
Parameters
Type Name Description
System.Web.UI.HtmlTextWriter writer
Overrides

SaveViewState()

Declaration
protected override object SaveViewState()
Returns
Type Description
System.Object

UpdateServerModel(Dictionary<String, Object>)

Declaration
public override void UpdateServerModel(Dictionary<string, object> ClientModel)
Parameters
Type Name Description
System.Collections.Generic.Dictionary<System.String, System.Object> ClientModel
Overrides

Events

ServerExcelExporting

Declaration
public event TreeGrid.TreeGridEventHandler ServerExcelExporting
Event Type
Type Description
TreeGrid.TreeGridEventHandler

ServerExcelQueryCellInfo

Declaration
public event TreeGridProperties.TreeGridEJExportEventHandler ServerExcelQueryCellInfo
Event Type
Type Description
TreeGridProperties.TreeGridEJExportEventHandler

ServerExcelRowInfo

Declaration
public event TreeGridProperties.TreeGridEJExportEventHandler ServerExcelRowInfo
Event Type
Type Description
TreeGridProperties.TreeGridEJExportEventHandler

ServerPdfExporting

Declaration
public event TreeGrid.TreeGridEventHandler ServerPdfExporting
Event Type
Type Description
TreeGrid.TreeGridEventHandler

ServerPdfQueryCellInfo

Declaration
public event TreeGridProperties.TreeGridEJExportEventHandler ServerPdfQueryCellInfo
Event Type
Type Description
TreeGridProperties.TreeGridEJExportEventHandler

ServerPdfRowInfo

Declaration
public event TreeGridProperties.TreeGridEJExportEventHandler ServerPdfRowInfo
Event Type
Type Description
TreeGridProperties.TreeGridEJExportEventHandler

ServerRowSelected

Declaration
public event TreeGrid.TreeGridEventHandler ServerRowSelected
Event Type
Type Description
TreeGrid.TreeGridEventHandler

Implements

System.Web.UI.INamingContainer
System.Web.UI.IPostBackEventHandler
System.Web.UI.IPostBackDataHandler
System.Web.UI.IUrlResolutionService