Class TreeGridEditSettingsBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
TreeGridEditSettingsBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class TreeGridEditSettingsBuilder : ControlBuilder
Constructors
TreeGridEditSettingsBuilder()
Declaration
public TreeGridEditSettingsBuilder()
TreeGridEditSettingsBuilder(TreeGridEditSettings)
Declaration
public TreeGridEditSettingsBuilder(TreeGridEditSettings model)
Parameters
Methods
AllowAdding(Boolean)
Enables the ability to add new records to the TreeGrid when set to true.
This allows users to insert new rows into the data set.
Declaration
public TreeGridEditSettingsBuilder AllowAdding(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
AllowDeleting(Boolean)
Allows removal of records from the TreeGrid when set to true.
Users can delete rows from the data set, reflecting changes immediately.
Declaration
public TreeGridEditSettingsBuilder AllowDeleting(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
AllowEditing(Boolean)
Permits updating values in existing records if set to true.
This setting allows inline modification of data cells within the TreeGrid.
Declaration
public TreeGridEditSettingsBuilder AllowEditing(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
AllowEditOnDblClick(Boolean)
If set to false, prevents editing on a row double-click, allowing edits through other triggers only.
Declaration
public TreeGridEditSettingsBuilder AllowEditOnDblClick(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
AllowNextRowEdit(Boolean)
Enables continued editing in subsequent rows when navigating with keyboard shortcuts if set to true.
Declaration
public TreeGridEditSettingsBuilder AllowNextRowEdit(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Dialog(Object)
Specifies the parameters for customizing the edit dialog, allowing the configuration of elements and behavior.
Declaration
public TreeGridEditSettingsBuilder Dialog(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
Mode(EditMode)
Specifies the editing mode for the TreeGrid. Available modes include:
Cell: Enables individual cell editing.
Row: Allows entire row editing at once.
Dialog: Opens a dialog for row editing.
Batch: Supports batch editing of cells across multiple rows. Changes are not immediately saved but can be committed all at once, enhancing efficiency in bulk data edits.
Declaration
public TreeGridEditSettingsBuilder Mode(EditMode value)
Parameters
Returns
NewRowPosition(RowPosition)
Determines the position where new rows are added within the TreeGrid. Options are:
Top: Adds new rows at the top of the grid.
Bottom: Adds new rows at the bottom of the grid.
Above: Inserts a new row above the selected row.
Below: Adds a new row below the selected row.
Child: Inserts a new row as a child of the currently selected row.
Declaration
public TreeGridEditSettingsBuilder NewRowPosition(RowPosition value)
Parameters
Returns
ShowConfirmDialog(Boolean)
Controls the display of a confirmation dialog when batch changes are either applied or discarded.
Set to false to suppress the display of this confirmation prompt.
Declaration
public TreeGridEditSettingsBuilder ShowConfirmDialog(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
ShowDeleteConfirmDialog(Boolean)
If set to true, a confirmation dialog appears before record deletion, allowing users to confirm or cancel the operation.
Declaration
public TreeGridEditSettingsBuilder ShowDeleteConfirmDialog(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Template(String)
Provides a template for custom editing elements within the dialog, supporting both HTML strings and functions.
Declaration
public TreeGridEditSettingsBuilder Template(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
