Class TreeGrid
Inheritance
Namespace: Syncfusion.EJ2.TreeGrid
Assembly: Syncfusion.EJ2.dll
Syntax
public class TreeGrid : EJTagHelper
Constructors
TreeGrid()
Declaration
public TreeGrid()
Properties
ActionBegin
Triggers when TreeGrid actions such as sorting, filtering, paging etc., starts.
Declaration
public string ActionBegin { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ActionComplete
Triggers when TreeGrid actions such as sorting, filtering, paging etc. are completed.
Declaration
public string ActionComplete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ActionFailure
Triggers when any TreeGrid action failed to achieve the desired results.
Declaration
public string ActionFailure { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Aggregates
Declaration
public List<TreeGridAggregate> Aggregates { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<Syncfusion.EJ2.TreeGrid.TreeGridAggregate> | The default value is null |
AllowExcelExport
If allowExcelExport
set to true, then it will allow the user to export treegrid to Excel file.
Declaration
public bool AllowExcelExport { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
AllowFiltering
If allowFiltering
is set to true the filter bar will be displayed.
If set to false the filter bar will not be displayed.
Filter bar allows the user to filter tree grid records with required criteria.
Declaration
public bool AllowFiltering { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
AllowMultiSorting
If allowMultiSorting
set to true, then it will allow the user to sort multiple column in the treegrid.
allowSorting
should be true.
Declaration
public bool AllowMultiSorting { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowPaging
If allowPaging
is set to true, pager renders.
Declaration
public bool AllowPaging { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
AllowPdfExport
If allowPdfExport
set to true, then it will allow the user to export treegrid to Pdf file.
Declaration
public bool AllowPdfExport { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
AllowReordering
If allowReordering
is set to true, TreeGrid columns can be reordered.
Reordering can be done by drag and drop of a particular column from one index to another index.
If TreeGrid is rendered with stacked headers, reordering is allowed only at the same level as the column headers.
Declaration
public bool AllowReordering { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
AllowResizing
If allowResizing
is set to true, TreeGrid columns can be resized.
Declaration
public bool AllowResizing { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
AllowRowDragAndDrop
If allowRowDragAndDrop
is set to true, you can drag and drop treegrid rows at another treegrid.
Declaration
public bool AllowRowDragAndDrop { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
AllowSelection
If allowSelection
is set to true, it allows selection of (highlight row) TreeGrid records by clicking it.
Declaration
public bool AllowSelection { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowSorting
If allowSorting
is set to true, it allows sorting of treegrid records when column header is clicked.
Declaration
public bool AllowSorting { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
AllowTextWrap
If allowTextWrap
set to true,
then text content will wrap to the next line when its text content exceeds the width of the Column Cells.
Declaration
public bool AllowTextWrap { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
AutoCheckHierarchy
If autoCheckHierarchy
is set to true, hierarchy checkbox selection is enabled in TreeGrid.
Declaration
public bool AutoCheckHierarchy { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
BatchAdd
Triggers when records are added in batch mode.
Declaration
public string BatchAdd { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BatchCancel
Triggers before records are added in batch mode.
Declaration
public string BatchCancel { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BatchDelete
Triggers when records are deleted in batch mode.
Declaration
public string BatchDelete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeBatchAdd
Triggers before records are added in batch mode.
Declaration
public string BeforeBatchAdd { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeBatchDelete
Triggers before records are deleted in batch mode.
Declaration
public string BeforeBatchDelete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeBatchSave
Triggers before records are saved in batch mode.
Declaration
public string BeforeBatchSave { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeCopy
Triggers before TreeGrid copy action.
Declaration
public string BeforeCopy { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeDataBound
Triggers before data is bound to Tree Grid.
Declaration
public string BeforeDataBound { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeExcelExport
Triggers before TreeGrid data is exported to Excel file.
Declaration
public string BeforeExcelExport { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforePaste
Triggers before TreeGrid paste action.
Declaration
public string BeforePaste { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforePdfExport
Triggers before TreeGrid data is exported to PDF document.
Declaration
public string BeforePdfExport { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforePrint
Triggers before the print action starts.
Declaration
public string BeforePrint { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeginEdit
Triggers before the record is to be edit.
Declaration
public string BeginEdit { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CellDeselected
Triggers when a particular selected cell is deselected.
Declaration
public string CellDeselected { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CellDeselecting
Triggers before the selected cell is deselecting.
Declaration
public string CellDeselecting { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CellEdit
Triggers when the cell is being edited.
Declaration
public string CellEdit { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CellSave
Triggers when cell is saved.
Declaration
public string CellSave { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CellSaved
Triggers when cell is saved.
Declaration
public string CellSaved { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CellSelected
Triggers after a cell is selected.
Declaration
public string CellSelected { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CellSelecting
Triggers before any cell selection occurs.
Declaration
public string CellSelecting { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CheckboxChange
Triggers when the check box state change in checkbox column.
Declaration
public string CheckboxChange { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ChildMapping
Specifies the mapping property path for child records in data source
Declaration
public string ChildMapping { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ClipMode
Defines the mode of clip. The available modes are,
also it will display the tooltip while hover on ellipsis is applied.
Declaration
public ClipMode ClipMode { get; set; }
Property Value
Type | Description |
---|---|
ClipMode | The default value is Syncfusion.EJ2.Grids.ClipMode.Ellipsis |
Collapsed
Triggers after the record is collapsed.
Declaration
public string Collapsed { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Collapsing
Triggers while collapsing the TreeGrid record
Declaration
public string Collapsing { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ColumnDrag
Triggers when column header element is dragged (moved) continuously.
Declaration
public string ColumnDrag { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ColumnDragStart
Triggers when column header element drag (move) starts.
Declaration
public string ColumnDragStart { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ColumnDrop
Triggers when a column header element is dropped on the target column.
Declaration
public string ColumnDrop { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ColumnMenuClick
Triggers when click on column menu.
Declaration
public string ColumnMenuClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ColumnMenuItems
columnMenuItems
defines both built-in and custom column menu items.
The available built-in items are,
AutoFitAll
- Auto fit the size of all columns.
AutoFit
- Auto fit the current column.
SortAscending
- Sort the current column in ascending order.
SortDescending
- Sort the current column in descending order.
Filter
- Filter options will show based on filterSettings property like filterbar, menu filter.
Declaration
public object ColumnMenuItems { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
ColumnMenuOpen
Triggers before column menu opens.
Declaration
public string ColumnMenuOpen { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ColumnQueryMode
columnQueryMode
provides options to retrieves data from the data source.Their types are
All
: It retrieves whole data source.
Schema
: retrieves data for all the defined columns in TreeGrid from the data source.
ExcludeHidden
: retrieves data only for visible columns of TreeGrid from the data Source.
Declaration
public object ColumnQueryMode { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
Columns
Defines the schema of dataSource.
If the columns
declaration is empty or undefined then the columns
are automatically generated from data source.
Declaration
public object Columns { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
ContextMenuClick
Triggers when click on context menu.
Declaration
public string ContextMenuClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ContextMenuItems
contextMenuItems
defines both built-in and custom context menu items.
The available built-in items are,
AutoFitAll
- Auto fit the size of all columns.
AutoFit
- Auto fit the current column.
Edit
- Edit the current record.
Delete
- Delete the current record.
Save
- Save the edited record.
Cancel
- Cancel the edited state.
PdfExport
- Export the grid as Pdf format.
ExcelExport
- Export the grid as Excel format.
CsvExport
- Export the grid as CSV format.
SortAscending
- Sort the current column in ascending order.
SortDescending
- Sort the current column in descending order.
FirstPage
- Go to the first page.
PrevPage
- Go to the previous page.
LastPage
- Go to the last page.
NextPage
- Go to the next page.
Declaration
public object ContextMenuItems { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
ContextMenuOpen
Triggers before context menu opens.
Declaration
public string ContextMenuOpen { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CopyHierarchyMode
copyHierarchyMode
Defines the copy clipboard types.
The available built-in items are,
Parent
- Copy the selected data with parent record.
Child
- Copy the selected data with child record.
Both
- Copy the selected data with both parent and child record.
None
- Copy only the selected record.
Declaration
public CopyHierarchyType CopyHierarchyMode { get; set; }
Property Value
Type | Description |
---|---|
CopyHierarchyType | The default value is CopyHierarchyType.Parent |
Created
Triggers when the component is created.
Declaration
public string Created { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
DataBound
Triggers when data source is populated in the TreeGrid.
Declaration
public string DataBound { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
DataSource
It is used to render TreeGrid table rows.
Declaration
public object DataSource { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
DataSourceChanged
Triggers when the TreeGrid data is added, deleted and updated. Invoke the done method from the argument to start render after edit operation.
Declaration
public string DataSourceChanged { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
DataStateChange
Triggers when the TreeGrid actions such as Sorting, Paging etc., are done.
In this event,the current view data and total record count should be assigned to the dataSource
based on the action performed.
Declaration
public string DataStateChange { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
DetailDataBound
Triggers after detail row expands.
This event triggers at initial expand.
Declaration
public string DetailDataBound { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
DetailTemplate
The detail template allows you to show or hide additional information about a particular row.
Declaration
public string DetailTemplate { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
EditSettings
Configures the edit settings.
Declaration
public TreeGridEditSettings EditSettings { get; set; }
Property Value
Type | Description |
---|---|
TreeGridEditSettings | The default value is null |
EnableAdaptiveUI
If enableAdaptiveUI
is set to true, the pop-up UI will become adaptive to small screens,
and be used for filtering and other features.
Declaration
public bool EnableAdaptiveUI { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableAltRow
Declaration
public bool EnableAltRow { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
EnableAutoFill
If enableAutoFill
is set to true, then the auto fill icon will displayed on cell selection for copy cells.
It requires the selection mode
to be Cell and cellSelectionMode
to be Box
.
Declaration
public bool EnableAutoFill { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableCollapseAll
Specifies whether to load all the rows in collapsed state when the TreeGrid is rendered for the first time.
Declaration
public bool EnableCollapseAll { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableColumnVirtualization
If enableColumnVirtualization
set to true, then the Tree Grid will render only the columns visible within the view-port
and load subsequent columns on horizontal scrolling. This helps to load large dataset of columns in Tree Grid.
Declaration
public bool EnableColumnVirtualization { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableHover
If enableHover
is set to true, the row hover is enabled in the TreeGrid.
Declaration
public bool EnableHover { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableHtmlSanitizer
Specifies whether to display or remove the untrusted HTML values in the TreeGrid component.
If enableHtmlSanitizer
is set to true, then it will sanitize any suspected untrusted strings and scripts before rendering them.
Declaration
public bool EnableHtmlSanitizer { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableImmutableMode
If enableImmutableMode
is set to true, the TreeGrid will reuse old rows if it exists in the new result instead of
full refresh while performing the TreeGrid actions.
Declaration
public bool EnableImmutableMode { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableInfiniteScrolling
If enableInfiniteScrolling
set to true, then the data will be loaded in TreeGrid when the scrollbar reaches the end.
This helps to load large dataset in TreeGrid.
Declaration
public bool EnableInfiniteScrolling { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnablePersistence
Enable or disable persisting component's state between page reloads.
Declaration
public bool EnablePersistence { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableRtl
Enable or disable rendering component in right to left direction.
Declaration
public bool EnableRtl { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableVirtualization
If enableVirtualization
set to true, then the TreeGrid will render only the rows visible within the view-port
and load subsequent rows on vertical scrolling. This helps to load large dataset in TreeGrid.
Declaration
public bool EnableVirtualization { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableVirtualMaskRow
Specifies whether to display shimmer effect during scrolling action in virtual scrolling feature. If disabled, spinner is shown instead of shimmer effect.
Declaration
public bool EnableVirtualMaskRow { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
ExcelAggregateCellRendering
Triggers for each aggregate cell while exporting to Excel document in server. You can also customize the Excel cells.
Declaration
public Action<object> ExcelAggregateCellRendering { get; set; }
Property Value
Type |
---|
System.Action<System.Object> |
ExcelCellRendering
Triggers for each cell while exporting while exporting to Excel file in server. You can also customize the Excel cells.
Declaration
public Action<object> ExcelCellRendering { get; set; }
Property Value
Type |
---|
System.Action<System.Object> |
ExcelExportComplete
Triggers after TreeGrid data is exported to Excel file.
Declaration
public string ExcelExportComplete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ExcelHeaderCellRendering
Triggers for each header cell while exporting to Excel file in server. You can also customize the Excel cells.
Declaration
public Action<object> ExcelHeaderCellRendering { get; set; }
Property Value
Type |
---|
System.Action<System.Object> |
ExcelHeaderQueryCellInfo
Triggers before exporting each header cell to Excel file. You can also customize the Excel cells.
Declaration
public string ExcelHeaderQueryCellInfo { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ExcelQueryCellInfo
Triggers before exporting each cell to Excel file. You can also customize the Excel cells.
Declaration
public string ExcelQueryCellInfo { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Expanded
Triggers after the record is expanded
Declaration
public string Expanded { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Expanding
Triggers while expanding the TreeGrid record
Declaration
public string Expanding { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ExpandStateMapping
Specifies the mapping property path for the expand status of a record in data source.
Declaration
public string ExpandStateMapping { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
FilterSettings
Configures the filter settings of the TreeGrid.
Declaration
public TreeGridFilterSettings FilterSettings { get; set; }
Property Value
Type | Description |
---|---|
TreeGridFilterSettings | The default value is null |
FrozenColumns
Gets or sets the number of frozen columns.
Declaration
public double FrozenColumns { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 0 |
FrozenRows
Gets or sets the number of frozen rows.
Declaration
public double FrozenRows { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 0 |
GridLines
Defines the mode of TreeGrid lines. The available modes are,
Declaration
public GridLine GridLines { get; set; }
Property Value
Type | Description |
---|---|
GridLine | The default value is Syncfusion.EJ2.Grids.GridLine.Default |
HasChildMapping
Specifies whether record is parent or not for the remote data binding
Declaration
public string HasChildMapping { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
HeaderCellInfo
Triggered for stacked header.
Declaration
public string HeaderCellInfo { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Height
Defines the scrollable height of the TreeGrid content.
Declaration
public string Height { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "auto" |
HtmlAttributes
Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.
Declaration
public object HtmlAttributes { get; set; }
Property Value
Type |
---|
System.Object |
IdMapping
Specifies the name of the field in the dataSource, which contains the id of that row.
Declaration
public string IdMapping { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
InfiniteScrollSettings
Configures the infinite scroll settings.
Declaration
public TreeGridInfiniteScrollSettings InfiniteScrollSettings { get; set; }
Property Value
Type | Description |
---|---|
TreeGridInfiniteScrollSettings | The default value is null |
Load
This event allows customization of TreeGrid properties before rendering.
Declaration
public string Load { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
LoadChildOnDemand
When enabled, only parent records would be rendered during the initial render and child records will be loaded only when expanding a parent record. This property is only applicable for remote data binding. Loading child records on demand can improve the performance of data-bound controls with a large number of records. Child records are only loaded when they are requested, rather than loading all child records at once.
Declaration
public bool LoadChildOnDemand { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
LoadingIndicator
Configures the loading indicator of the Tree Grid. Specifies whether to display spinner or shimmer effect during the waiting time on any actions (paging, sorting, filtering, CRUD operations) performed in Tree Grid.
Declaration
public TreeGridLoadingIndicator LoadingIndicator { get; set; }
Property Value
Type | Description |
---|---|
TreeGridLoadingIndicator | The default value is null |
Locale
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
public string Locale { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
PageSettings
Configures the pager in the TreeGrid.
Declaration
public TreeGridPageSettings PageSettings { get; set; }
Property Value
Type | Description |
---|---|
TreeGridPageSettings | The default value is null |
ParentIdMapping
Specifies the name of the field in the dataSource, which contains the parent’s id
Declaration
public string ParentIdMapping { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
PdfAggregateCellRendering
Triggers for each aggregate cell while exporting to Pdf document in server. You can also customize the Pdf Aggregate cells.
Declaration
public Action<object> PdfAggregateCellRendering { get; set; }
Property Value
Type |
---|
System.Action<System.Object> |
PdfCellRendering
Triggers for each cell while exporting while exporting to Pdf file in server. You can also customize the Pdf cells.
Declaration
public Action<object> PdfCellRendering { get; set; }
Property Value
Type |
---|
System.Action<System.Object> |
PdfExportComplete
Triggers after TreeGrid data is exported to PDF document.
Declaration
public string PdfExportComplete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
PdfHeaderCellRendering
Triggers for each header cell while exporting to Pdf file in server. You can also customize the Pdf header cells.
Declaration
public Action<object> PdfHeaderCellRendering { get; set; }
Property Value
Type |
---|
System.Action<System.Object> |
PdfHeaderQueryCellInfo
Triggers before exporting each header cell to PDF document. You can also customize the PDF cells.
Declaration
public string PdfHeaderQueryCellInfo { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
PdfQueryCellInfo
Triggers before exporting each cell to PDF document. You can also customize the PDF cells.
Declaration
public string PdfQueryCellInfo { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
PrintComplete
Triggers after print action is completed.
Declaration
public string PrintComplete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
PrintMode
Defines the print modes. The available print modes are
Declaration
public PrintMode PrintMode { get; set; }
Property Value
Type | Description |
---|---|
PrintMode | The default value is Syncfusion.EJ2.Grids.PrintMode.AllPages |
Query
Defines the external Query
that will be executed along with data processing.
Declaration
public string Query { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
QueryCellInfo
Triggered every time a request is made to access cell information, element, or data. This will be triggered before the cell element is appended to the TreeGrid element.
Declaration
public string QueryCellInfo { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
RecordDoubleClick
Triggers when record is double clicked.
Declaration
public string RecordDoubleClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ResizeStart
Triggers when column resize starts.
Declaration
public string ResizeStart { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ResizeStop
Triggers when column resize ends.
Declaration
public string ResizeStop { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Resizing
Triggers on column resizing.
Declaration
public string Resizing { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
RowDataBound
Triggered every time a request is made to access row information, element, or data. This will be triggered before the row element is appended to the TreeGrid element.
Declaration
public string RowDataBound { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
RowDeselected
Triggers when a selected row is deselected.
Declaration
public string RowDeselected { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
RowDeselecting
Triggers before deselecting the selected row.
Declaration
public string RowDeselecting { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
RowDrag
Triggers when row elements are dragged (moved) continuously.
Declaration
public string RowDrag { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
RowDragStart
Triggers when row element’s drag(move) starts.
Declaration
public string RowDragStart { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
RowDragStartHelper
Triggers when row element’s before drag(move).
Declaration
public string RowDragStartHelper { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
RowDrop
Triggers when row elements are dropped on the target row.
Declaration
public string RowDrop { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
RowDropSettings
Configures the row drop settings of the TreeGrid.
Declaration
public TreeGridRowDropSettings RowDropSettings { get; set; }
Property Value
Type | Description |
---|---|
TreeGridRowDropSettings | The default value is null |
RowHeight
Defines the height of TreeGrid rows.
Declaration
public double RowHeight { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is Double.NaN |
RowSelected
Triggers after a row is selected.
Declaration
public string RowSelected { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
RowSelecting
Triggers before row selection occurs.
Declaration
public string RowSelecting { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
RowTemplate
The row template that renders customized rows from the given template. By default, TreeGrid renders a table row for every data source item.
It accepts either template string or HTML element ID. The row template must be a table row.
Declaration
public string RowTemplate { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
SearchSettings
Configures the search settings of the TreeGrid.
Declaration
public TreeGridSearchSettings SearchSettings { get; set; }
Property Value
Type | Description |
---|---|
TreeGridSearchSettings | The default value is null |
SelectedRowIndex
The selectedRowIndex
allows you to select a row at initial rendering.
You can also get the currently selected row index.
Declaration
public double SelectedRowIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is -1 |
SelectionSettings
Configures the selection settings.
Declaration
public TreeGridSelectionSettings SelectionSettings { get; set; }
Property Value
Type | Description |
---|---|
TreeGridSelectionSettings | The default value is null |
ShowColumnChooser
If showColumnChooser
is set to true, it allows you to dynamically show or hide columns.
Declaration
public bool ShowColumnChooser { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
ShowColumnMenu
If showColumnMenu
set to true, then it will enable the column menu options in each columns.
Declaration
public bool ShowColumnMenu { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
SortSettings
Configures the sort settings of the TreeGrid.
Declaration
public TreeGridSortSettings SortSettings { get; set; }
Property Value
Type | Description |
---|---|
TreeGridSortSettings | The default value is null |
TextWrapSettings
Configures the text wrap in the TreeGrid.
Declaration
public TreeGridTextWrapSettings TextWrapSettings { get; set; }
Property Value
Type | Description |
---|---|
TreeGridTextWrapSettings | The default value is null |
Toolbar
toolbar
defines the ToolBar items of the TreeGrid.
It contains built-in and custom toolbar items.
If a string value is assigned to the toolbar
option, it is considered as the template for the whole TreeGrid ToolBar.
If an array value is assigned, it is considered as the list of built-in and custom toolbar items in the TreeGrid's Toolbar.
The following code example implements the custom toolbar items.
Declaration
public object Toolbar { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
ToolbarClick
Triggers when toolbar item is clicked.
Declaration
public string ToolbarClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
TreeColumnIndex
Specifies the index of the column that needs to have the expander button.
Declaration
public double TreeColumnIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 0 |
Width
Defines the TreeGrid width.
Declaration
public string Width { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "auto" |