Class Grid
Inheritance
Namespace: Syncfusion.EJ2.Grids
Assembly: Syncfusion.EJ2.dll
Syntax
public class Grid : EJTagHelper
Constructors
Grid()
Declaration
public Grid()
Properties
ActionBegin
Triggers when Grid actions such as sorting, filtering, paging, grouping etc., starts.
Declaration
public string ActionBegin { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ActionComplete
Triggers when Grid actions such as sorting, filtering, paging, grouping etc. are completed.
Declaration
public string ActionComplete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ActionFailure
Triggers when any Grid action failed to achieve the desired results.
Declaration
public string ActionFailure { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
AdaptiveUIMode
One of the adaptiveUIMode enumeration that specifies the Adaptive Mode. The default value is Both.
Declaration
public AdaptiveMode AdaptiveUIMode { get; set; }
Property Value
Type | Description |
---|---|
AdaptiveMode | The default value is AdaptiveMode.Both |
Aggregates
Declaration
public List<GridAggregate> Aggregates { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<Syncfusion.EJ2.Grids.GridAggregate> | The default value is null |
AllowExcelExport
If allowExcelExport
set to true, then it will allow the user to export grid to Excel file.
Declaration
public bool AllowExcelExport { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
AllowFiltering
If allowFiltering
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 grid records with required criteria.
Declaration
public bool AllowFiltering { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
AllowGrouping
If allowGrouping
set to true, then it will allow the user to dynamically group or ungroup columns.
Grouping can be done by drag and drop columns from column header to group drop area.
Declaration
public bool AllowGrouping { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
AllowKeyboard
Enables or disables the key board interaction of Grid.
Declaration
public bool AllowKeyboard { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowMultiSorting
If allowMultiSorting
set to true, then it will allow the user to sort multiple column in the grid.
allowSorting
should be true.
Declaration
public bool AllowMultiSorting { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
AllowPaging
If allowPaging
is set to true, the pager renders at the footer of the Grid. It is used to handle page navigation in the Grid.
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 grid 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, Grid columns can be reordered.
Reordering can be done by drag and drop of a particular column from one index to another index.
If Grid 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, Grid 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 grid rows at another grid.
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) Grid 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 grid 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 |
AutoFit
If autoFit
set to true, then it will auto fit the columns based on given width.
Declaration
public bool AutoFit { 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 when cancel the batch edit changes 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 |
BeforeAutoFill
Triggers before Grid autoFill action.
Declaration
public string BeforeAutoFill { 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 Grid 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 Grid.
Declaration
public string BeforeDataBound { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeExcelExport
Triggers before Grid data is exported to Excel file.
Declaration
public string BeforeExcelExport { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeOpenAdaptiveDialog
Triggers before adaptive filter and sort dialogs open.
Declaration
public string BeforeOpenAdaptiveDialog { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeOpenColumnChooser
Triggers before the columnChooser open.
Declaration
public string BeforeOpenColumnChooser { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforePaste
Triggers before Grid paste action.
Declaration
public string BeforePaste { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforePdfExport
Triggers before Grid 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 the cell is being saved.
Declaration
public string CellSave { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CellSaved
Triggers after the 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 |
ChildGrid
Defines Grid options to render child Grid.
It requires the queryString
for parent
and child relationship.
Declaration
public object ChildGrid { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
ClipMode
Defines the mode of clip. The available modes are,
Clip
: Truncates the cell content when it overflows its area.
Ellipsis
: Displays ellipsis when the cell content overflows its area.
EllipsisWithTooltip
: Displays ellipsis when the cell content overflows its area,
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 ClipMode.Ellipsis |
ColumnChooserSettings
Configures the column chooser in the Grid.
Declaration
public GridColumnChooserSettings ColumnChooserSettings { get; set; }
Property Value
Type | Description |
---|---|
GridColumnChooserSettings | The default value is null |
ColumnDataStateChange
Triggers when the grid actions such as Sorting, Paging, Grouping etc., are done to get column dataSource
.
In this event,the current view column data and total record count should be assigned to the column dataSource
based
on the action performed.
Declaration
public string ColumnDataStateChange { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ColumnDeselected
Triggers when a selected column is deselected.
Declaration
public string ColumnDeselected { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ColumnDeselecting
Triggers before deselecting the selected column.
Declaration
public string ColumnDeselecting { 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.
Group
- Group by current column.
Ungroup
- Ungroup by 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 checkbox filter, excel filter, 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 retrive data from the datasource.Their types are
All
: It Retrives whole datasource.
Schema
: Retrives data for all the defined columns in grid from the datasource.
ExcludeHidden
: Retrives data only for visible columns of grid from the dataSource.
Declaration
public ColumnQueryModeType ColumnQueryMode { get; set; }
Property Value
Type | Description |
---|---|
ColumnQueryModeType | The default value is ColumnQueryModeType.All |
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 |
ColumnSelected
Triggers after a column is selected.
Declaration
public string ColumnSelected { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ColumnSelecting
Triggers before column selection occurs.
Declaration
public string ColumnSelecting { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CommandClick
Triggers when command button is clicked.
Declaration
public string CommandClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | 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.
Group
- Group by current column.
Ungroup
- Ungroup by current column.
Edit
- Edit the current record.
Delete
- Delete the current record.
Save
- Save the edited record.
Cancel
- Cancel the edited state.
Copy
- Copy the selected records.
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 |
Created
Triggers when the component is created.
Declaration
public string Created { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CssClass
Defines the own class for the grid element.
Declaration
public string CssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
CurrentAction
Gets or sets the current action details.
Declaration
public object CurrentAction { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
CurrentViewData
Gets the currently visible records of the Grid.
Declaration
public object CurrentViewData { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
DataBound
Triggers when data source is populated in the Grid.
Declaration
public string DataBound { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
DataSource
It is used to render grid table rows.
If the dataSource
is an array of JavaScript objects,
then Grid will create instance of DataManager
from this dataSource
.
If the dataSource
is an existing DataManager
,
the Grid will not initialize a new one.
Declaration
public object DataSource { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
DataSourceChanged
Triggers when the grid 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 grid actions such as Sorting, Paging, Grouping 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 |
Destroyed
Triggers when the component is destroyed.
Declaration
public string Destroyed { 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 GridEditSettings EditSettings { get; set; }
Property Value
Type | Description |
---|---|
GridEditSettings | The default value is null |
Ej2StatePersistenceVersion
Defines the version for Grid persistence.
Declaration
public string Ej2StatePersistenceVersion { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
EmptyRecordTemplate
Declaration
public string EmptyRecordTemplate { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
EnableAdaptiveUI
If enableAdaptiveUI
set to true the grid filter, sort, and edit dialogs render adaptively.
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 |
EnableColumnVirtualization
If enableColumnVirtualization
set to true, then the 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 Grid.
Declaration
public bool EnableColumnVirtualization { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableHeaderFocus
If enableHeaderFocus
set to true, then header element will be focused when focus moves to grid.
Declaration
public bool EnableHeaderFocus { 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 Grid.
Declaration
public bool EnableHover { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
EnableHtmlSanitizer
Specifies whether to display or remove the untrusted HTML values in the Grid component. If 'enableHtmlSanitizer' set to true, the component 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 grid will reuse old rows if it exists in the new result instead of
full refresh while performing the grid 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 Grid when the scrollbar reaches the end.
This helps to load large dataset in Grid.
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 |
EnableStickyHeader
If 'enableStickyHeader' set to true, then the user can able to make the column headers visible when the document is scrolled.
Declaration
public bool EnableStickyHeader { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableVirtualization
If enableVirtualization
set to true, then the Grid will render only the rows visible within the view-port
and load subsequent rows on vertical scrolling. This helps to load large dataset in Grid.
Declaration
public bool EnableVirtualization { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableVirtualMaskRow
Specifies the shimmer effect for Grid virtual and infinite scrolling.
Declaration
public bool EnableVirtualMaskRow { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
ExcelAggregateQueryCellInfo
Triggers before exporting aggregate cell to Excel document. You can also customize the PDF cells.
Declaration
public string ExcelAggregateQueryCellInfo { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ExcelExportComplete
Triggers after Grid data is exported to Excel file.
Declaration
public string ExcelExportComplete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
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 |
ExportDetailDataBound
Triggers before exporting each detail Grid to PDF document.
Declaration
public string ExportDetailDataBound { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ExportDetailTemplate
Triggers before exporting each detail template.
Declaration
public string ExportDetailTemplate { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ExportGrids
Defines the id of the grids that needs to be exported
Declaration
public string[] ExportGrids { get; set; }
Property Value
Type | Description |
---|---|
System.String[] | The default value is null |
ExportGroupCaption
Triggers before exporting each caption row to PDF/Excel/CSV document. You can also customize the export caption row values.
Declaration
public string ExportGroupCaption { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
FilterSettings
Configures the filter settings of the Grid.
Declaration
public GridFilterSettings FilterSettings { get; set; }
Property Value
Type | Description |
---|---|
GridFilterSettings | 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 grid lines. The available modes are,
Both
: Displays both horizontal and vertical grid lines.
None
: No grid lines are displayed.
Horizontal
: Displays the horizontal grid lines only.
Vertical
: Displays the vertical grid lines only.
Default
: Displays grid lines based on the theme.
Declaration
public GridLine GridLines { get; set; }
Property Value
Type | Description |
---|---|
GridLine | The default value is GridLine.Default |
GroupSettings
Configures the group settings.
Declaration
public GridGroupSettings GroupSettings { get; set; }
Property Value
Type | Description |
---|---|
GridGroupSettings | 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 grid content.
Declaration
public string Height { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "auto" |
HierarchyPrintMode
Defines the hierarchy grid print modes. The available modes are
Expanded
- Prints the master grid with expanded child grids.
All
- Prints the master grid with all the child grids.
None
- Prints the master grid alone.
Declaration
public HierarchyGridPrintMode HierarchyPrintMode { get; set; }
Property Value
Type | Description |
---|---|
HierarchyGridPrintMode | The default value is HierarchyGridPrintMode.Expanded |
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 |
InfiniteScrollSettings
Configures the infinite scroll settings.
Declaration
public GridInfiniteScrollSettings InfiniteScrollSettings { get; set; }
Property Value
Type | Description |
---|---|
GridInfiniteScrollSettings | The default value is null |
KeyPressed
Triggers when any keyboard keys are pressed inside the grid.
Declaration
public string KeyPressed { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
LazyLoadGroupCollapse
Triggers when collapse the caption row in lazy load grouping.
Declaration
public string LazyLoadGroupCollapse { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
LazyLoadGroupExpand
Triggers when expand the caption row in lazy load grouping.
Declaration
public string LazyLoadGroupExpand { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Load
This event allows customization of Grid properties before rendering.
Declaration
public string Load { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
LoadingIndicator
Configures the Loading Indicator of the Grid.
Declaration
public GridLoadingIndicator LoadingIndicator { get; set; }
Property Value
Type | Description |
---|---|
GridLoadingIndicator | 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 "" |
PagerTemplate
It used to render pager template
Declaration
public string PagerTemplate { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
PageSettings
Configures the pager in the Grid.
Declaration
public GridPageSettings PageSettings { get; set; }
Property Value
Type | Description |
---|---|
GridPageSettings | The default value is null |
ParentDetails
Gets the parent Grid details.
Declaration
public object ParentDetails { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
PdfAggregateQueryCellInfo
Triggers before exporting aggregate cell to PDF document. You can also customize the PDF cells.
Declaration
public string PdfAggregateQueryCellInfo { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
PdfExportComplete
Triggers after Grid data is exported to PDF document.
Declaration
public string PdfExportComplete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
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
AllPages
: Prints all pages of the Grid.
CurrentPage
: Prints the current page of the Grid.
Declaration
public PrintMode PrintMode { get; set; }
Property Value
Type | Description |
---|---|
PrintMode | The default value is 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 Grid element.
Declaration
public string QueryCellInfo { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
QueryString
Defines the relationship between parent and child datasource. It acts as the foreign key for parent datasource.
Declaration
public string QueryString { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
RecordClick
Triggers when record is clicked.
Declaration
public string RecordClick { 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 |
ResizeSettings
Defines the resizing behavior of the Grid.
Declaration
public GridResizeSettings ResizeSettings { get; set; }
Property Value
Type | Description |
---|---|
GridResizeSettings | 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 Grid 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.
Declaration
public GridRowDropSettings RowDropSettings { get; set; }
Property Value
Type | Description |
---|---|
GridRowDropSettings | The default value is null |
RowHeight
Defines the height of Grid rows.
Declaration
public double RowHeight { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is Double.NaN |
RowRenderingMode
Defines the grid row elements rendering direction. The available directions are,
Horizontal
: Renders the grid row elements in the horizontal direction
Vertical
: Renders the grid row elements in the vertical direction
Declaration
public RowRenderingDirection RowRenderingMode { get; set; }
Property Value
Type | Description |
---|---|
RowRenderingDirection | The default value is RowRenderingDirection.Horizontal |
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
Declaration
public string RowTemplate { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
SearchSettings
Configures the search behavior in the Grid.
Declaration
public GridSearchSettings SearchSettings { get; set; }
Property Value
Type | Description |
---|---|
GridSearchSettings | 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 GridSelectionSettings SelectionSettings { get; set; }
Property Value
Type | Description |
---|---|
GridSelectionSettings | The default value is null |
ServerExcelAggregateQueryCellInfo
Triggers for each aggregate cell while exporting to Excel document in server. You can also customize the Excel cells.
Declaration
public Action<object> ServerExcelAggregateQueryCellInfo { get; set; }
Property Value
Type |
---|
System.Action<System.Object> |
ServerExcelHeaderQueryCellInfo
Triggers for each header cell while exporting to Excel file in server. You can also customize the Excel cells.
Declaration
public Action<object> ServerExcelHeaderQueryCellInfo { get; set; }
Property Value
Type |
---|
System.Action<System.Object> |
ServerExcelQueryCellInfo
Triggers for each cell while exporting while exporting to Excel file in server. You can also customize the Excel cells.
Declaration
public Action<object> ServerExcelQueryCellInfo { get; set; }
Property Value
Type |
---|
System.Action<System.Object> |
ServerPdfAggregateQueryCellInfo
Triggers for each aggregate cell while exporting to Pdf document in server. You can also customize the Pdf Aggregate cells.
Declaration
public Action<object> ServerPdfAggregateQueryCellInfo { get; set; }
Property Value
Type |
---|
System.Action<System.Object> |
ServerPdfHeaderQueryCellInfo
Triggers for each header cell while exporting to Pdf file in server. You can also customize the Pdf header cells.
Declaration
public Action<object> ServerPdfHeaderQueryCellInfo { get; set; }
Property Value
Type |
---|
System.Action<System.Object> |
ServerPdfQueryCellInfo
Triggers for each cell while exporting while exporting to Pdf file in server. You can also customize the Pdf cells.
Declaration
public Action<object> ServerPdfQueryCellInfo { get; set; }
Property Value
Type |
---|
System.Action<System.Object> |
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 |
ShowHider
The showHider
is used to manipulate column's show/hide operation in the Grid.
Declaration
public object ShowHider { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
SortSettings
Configures the sort settings.
Declaration
public GridSortSettings SortSettings { get; set; }
Property Value
Type | Description |
---|---|
GridSortSettings | The default value is null |
TextWrapSettings
Configures the text wrap in the Grid.
Declaration
public GridTextWrapSettings TextWrapSettings { get; set; }
Property Value
Type | Description |
---|---|
GridTextWrapSettings | The default value is null |
Toolbar
toolbar
defines the ToolBar items of the Grid.
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 Grid ToolBar.
If an array value is assigned, it is considered as the list of built-in and custom toolbar items in the Grid'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 |
ToolbarTemplate
It used to render toolbar template
Declaration
public string ToolbarTemplate { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
TValue
The data source value can be of any type
Declaration
public Type TValue { get; set; }
Property Value
Type |
---|
System.Type |
Width
Defines the Grid width.
Declaration
public string Width { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "auto" |