TreeListEventBuilder

Methods

BeforeEdit(System.String)

Fires when the user tries to edit or creates a data item before the editor is created. Can be used for preventing the editing depending on custom logic. The event handler function context (available through the this keyword) will be set to the widget instance. The event will be fired only when the TreeList is editable.

For more information see BeforeEdit event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the beforeEdit event.

BeforeEdit(System.Func)

Fires when the user tries to edit or creates a data item before the editor is created. Can be used for preventing the editing depending on custom logic. The event handler function context (available through the this keyword) will be set to the widget instance. The event will be fired only when the TreeList is editable.

For more information see BeforeEdit event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

Cancel(System.String)

Fires when the user clicks the Cancel button (in inline or popup edit mode) or closes the popup window. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see Cancel event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the cancel event.

Cancel(System.Func)

Fires when the user clicks the Cancel button (in inline or popup edit mode) or closes the popup window. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see Cancel event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

CellClose(System.String)

Fires when the incell edit mode is used and the cell will be closed. The event is triggered after saving or canceling the changes but before the cell is closed. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see CellClose event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the cellClose event.

CellClose(System.Func)

Fires when the incell edit mode is used and the cell will be closed. The event is triggered after saving or canceling the changes but before the cell is closed. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see CellClose event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

Change(System.String)

Fires when the user selects a table row or cell in the TreeList. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see Change event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the change event.

Change(System.Func)

Fires when the user selects a table row or cell in the TreeList. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see Change event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

Collapse(System.String)

Fires when an item is about to be collapsed. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see Collapse event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the collapse event.

Collapse(System.Func)

Fires when an item is about to be collapsed. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see Collapse event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

DataBinding(System.String)

Fires before the widget binds to its data source. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see DataBinding event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the dataBinding event.

DataBinding(System.Func)

Fires before the widget binds to its data source. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see DataBinding event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

DataBound(System.String)

Fires when the widget is bound to data from its data source. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see DataBound event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the dataBound event.

DataBound(System.Func)

Fires when the widget is bound to data from its data source. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see DataBound event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

DragStart(System.String)

(Available as of the 2015.3.1014 release) Fires when the user attempts to drag an item. If prevented, the item is not allowed to move. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see DragStart event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the dragstart event.

DragStart(System.Func)

(Available as of the 2015.3.1014 release) Fires when the user attempts to drag an item. If prevented, the item is not allowed to move. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see DragStart event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

Drag(System.String)

(Available as of the 2015.3.1014 release) Fires while the user is dragging and item. This event is triggered on every mouse move. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see Drag event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the drag event.

Drag(System.Func)

(Available as of the 2015.3.1014 release) Fires while the user is dragging and item. This event is triggered on every mouse move. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see Drag event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

DragEnd(System.String)

(Available as of the 2015.3.1014 release) Fires when the user finishes dragging an item and the model was updated. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see DragEnd event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the dragend event.

DragEnd(System.Func)

(Available as of the 2015.3.1014 release) Fires when the user finishes dragging an item and the model was updated. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see DragEnd event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

Drop(System.String)

(Available as of the 2015.3.1014 release) Fires when the user drops an item. If prevented, the source row will not be moved. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see Drop event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the drop event.

Drop(System.Func)

(Available as of the 2015.3.1014 release) Fires when the user drops an item. If prevented, the source row will not be moved. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see Drop event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

Edit(System.String)

Fires when the user edits or creates a data item. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see Edit event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the edit event.

Edit(System.Func)

Fires when the user edits or creates a data item. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see Edit event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

ExcelExport(System.String)

Fires when the user clicks the Export to Excel toolbar button.

For more information see ExcelExport event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the excelExport event.

ExcelExport(System.Func)

Fires when the user clicks the Export to Excel toolbar button.

For more information see ExcelExport event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

Expand(System.String)

Fires when an item is about to be expanded. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see Expand event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the expand event.

Expand(System.Func)

Fires when an item is about to be expanded. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see Expand event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

FilterMenuInit(System.String)

Fires when the TreeList filter menu is initialized. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see FilterMenuInit event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the filterMenuInit event.

FilterMenuInit(System.Func)

Fires when the TreeList filter menu is initialized. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see FilterMenuInit event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

FilterMenuOpen(System.String)

Fires when the TreeList filter menu is opened. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see FilterMenuOpen event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the filterMenuOpen event.

FilterMenuOpen(System.Func)

Fires when the TreeList filter menu is opened. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see FilterMenuOpen event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

PdfExport(System.String)

Fires when the user clicks the Export to PDF toolbar button.

For more information see PdfExport event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the pdfExport event.

PdfExport(System.Func)

Fires when the user clicks the Export to PDF toolbar button.

For more information see PdfExport event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

Remove(System.String)

Fires when the user clicks the Destroy command button. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see Remove event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the remove event.

Remove(System.Func)

Fires when the user clicks the Destroy command button. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see Remove event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

Save(System.String)

Fires when a data item is saved. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see Save event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the save event.

Save(System.Func)

Fires when a data item is saved. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see Save event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

SaveChanges(System.String)

Fires when the user clicks the Save command button. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see SaveChanges event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the saveChanges event.

SaveChanges(System.Func)

Fires when the user clicks the Save command button. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see SaveChanges event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

ColumnShow(System.String)

Fires when the user shows a column. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see ColumnShow event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the columnShow event.

ColumnShow(System.Func)

Fires when the user shows a column. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see ColumnShow event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

ColumnHide(System.String)

Fires when the user hides a column. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see ColumnHide event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the columnHide event.

ColumnHide(System.Func)

Fires when the user hides a column. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see ColumnHide event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

ColumnReorder(System.String)

Fires when the user changes the order of a column. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see ColumnReorder event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the columnReorder event.

ColumnReorder(System.Func)

Fires when the user changes the order of a column. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see ColumnReorder event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

ColumnResize(System.String)

Fires when the user resizes a column. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see ColumnResize event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the columnResize event.

ColumnResize(System.Func)

Fires when the user resizes a column. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see ColumnResize event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

ColumnMenuInit(System.String)

Fires when the column menu is initialized. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see ColumnMenuInit event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the columnMenuInit event.

ColumnMenuInit(System.Func)

Fires when the column menu is initialized. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see ColumnMenuInit event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

ColumnMenuOpen(System.String)

Fires when the column menu is opened. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see ColumnMenuOpen event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the columnMenuOpen event.

ColumnMenuOpen(System.Func)

Fires when the column menu is opened. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see ColumnMenuOpen event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

ColumnLock(System.String)

Fires when the user lock a column. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see ColumnLock event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the columnLock event.

ColumnLock(System.Func)

Fires when the user lock a column. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see ColumnLock event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

ColumnUnlock(System.String)

Fires when the user unlock a column. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see ColumnUnlock event.

Parameters

handler - System.String

The name of the JavaScript function that will handle the columnUnlock event.

ColumnUnlock(System.Func)

Fires when the user unlock a column. The event handler function context (available through the this keyword) will be set to the widget instance.

For more information see ColumnUnlock event.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.