ASP.NET MVC - EJ2

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class Grid - ASP.NETMVC-EJ2 API Reference | Syncfusion

    Show / Hide Table of Contents

    Class Grid

    Inheritance
    System.Object
    TagHelper
    EJTagHelper
    Grid
    Inherited Members
    EJTagHelper.GetList()
    EJTagHelper.GetSerializedProperties()
    EJTagHelper.GetScriptString()
    EJTagHelper.GetHtmlAttrString(IDictionary<String, Object>)
    EJTagHelper.Id
    EJTagHelper.IsChild
    EJTagHelper.IsComplex
    EJTagHelper.IsCollection
    EJTagHelper.ParentPropertyName
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    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
    [HtmlAttributeName("actionBegin")]
    public string ActionBegin { get; set; }
    Property Value
    Type Description
    System.String

    ActionComplete

    Triggers when Grid actions such as sorting, filtering, paging, grouping etc. are completed.

    Declaration
    [HtmlAttributeName("actionComplete")]
    public string ActionComplete { get; set; }
    Property Value
    Type Description
    System.String

    ActionFailure

    Triggers when any Grid action failed to achieve the desired results.

    Declaration
    [HtmlAttributeName("actionFailure")]
    public string ActionFailure { get; set; }
    Property Value
    Type Description
    System.String

    Aggregates

    Configures the Grid aggregate rows.

    Check the Aggregates for its configuration.

    Declaration
    [HtmlAttributeName("aggregates")]
    public List<GridAggregate> Aggregates { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<GridAggregate>

    AllowExcelExport

    If allowExcelExport set to true, then it will allow the user to export grid to Excel file.

    Declaration
    [HtmlAttributeName("allowExcelExport")]
    public bool AllowExcelExport { get; set; }
    Property Value
    Type Description
    System.Boolean

    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
    [HtmlAttributeName("allowFiltering")]
    public bool AllowFiltering { get; set; }
    Property Value
    Type Description
    System.Boolean

    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
    [HtmlAttributeName("allowGrouping")]
    public bool AllowGrouping { get; set; }
    Property Value
    Type Description
    System.Boolean

    AllowMultiSorting

    If allowMultiSorting set to true, then it will allow the user to sort multiple column in the grid.

    allowSorting should be true.

    Declaration
    [HtmlAttributeName("allowMultiSorting")]
    public bool AllowMultiSorting { get; set; }
    Property Value
    Type Description
    System.Boolean

    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
    [HtmlAttributeName("allowPaging")]
    public bool AllowPaging { get; set; }
    Property Value
    Type Description
    System.Boolean

    AllowPdfExport

    If allowPdfExport set to true, then it will allow the user to export grid to Pdf file.

    Declaration
    [HtmlAttributeName("allowPdfExport")]
    public bool AllowPdfExport { get; set; }
    Property Value
    Type Description
    System.Boolean

    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
    [HtmlAttributeName("allowReordering")]
    public bool AllowReordering { get; set; }
    Property Value
    Type Description
    System.Boolean

    AllowResizing

    If allowResizing is set to true, Grid columns can be resized.

    Declaration
    [HtmlAttributeName("allowResizing")]
    public bool AllowResizing { get; set; }
    Property Value
    Type Description
    System.Boolean

    AllowRowDragAndDrop

    If allowRowDragAndDrop is set to true, you can drag and drop grid rows at another grid.

    Declaration
    [HtmlAttributeName("allowRowDragAndDrop")]
    public bool AllowRowDragAndDrop { get; set; }
    Property Value
    Type Description
    System.Boolean

    AllowSelection

    If allowSelection is set to true, it allows selection of (highlight row) Grid records by clicking it.

    Declaration
    [HtmlAttributeName("allowSelection")]
    public bool AllowSelection { get; set; }
    Property Value
    Type Description
    System.Boolean

    AllowSorting

    If allowSorting is set to true, it allows sorting of grid records when column header is clicked.

    Declaration
    [HtmlAttributeName("allowSorting")]
    public bool AllowSorting { get; set; }
    Property Value
    Type Description
    System.Boolean

    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
    [HtmlAttributeName("allowTextWrap")]
    public bool AllowTextWrap { get; set; }
    Property Value
    Type Description
    System.Boolean

    BatchAdd

    Triggers when records are added in batch mode.

    Declaration
    [HtmlAttributeName("batchAdd")]
    public string BatchAdd { get; set; }
    Property Value
    Type Description
    System.String

    BatchCancel

    Triggers when cancel the batch edit changes batch mode.

    Declaration
    [HtmlAttributeName("batchCancel")]
    public string BatchCancel { get; set; }
    Property Value
    Type Description
    System.String

    BatchDelete

    Triggers when records are deleted in batch mode.

    Declaration
    [HtmlAttributeName("batchDelete")]
    public string BatchDelete { get; set; }
    Property Value
    Type Description
    System.String

    BeforeBatchAdd

    Triggers before records are added in batch mode.

    Declaration
    [HtmlAttributeName("beforeBatchAdd")]
    public string BeforeBatchAdd { get; set; }
    Property Value
    Type Description
    System.String

    BeforeBatchDelete

    Triggers before records are deleted in batch mode.

    Declaration
    [HtmlAttributeName("beforeBatchDelete")]
    public string BeforeBatchDelete { get; set; }
    Property Value
    Type Description
    System.String

    BeforeBatchSave

    Triggers before records are saved in batch mode.

    Declaration
    [HtmlAttributeName("beforeBatchSave")]
    public string BeforeBatchSave { get; set; }
    Property Value
    Type Description
    System.String

    BeforeCopy

    Triggers before Grid copy action.

    Declaration
    [HtmlAttributeName("beforeCopy")]
    public string BeforeCopy { get; set; }
    Property Value
    Type Description
    System.String

    BeforeDataBound

    Triggers before data is bound to Grid.

    Declaration
    [HtmlAttributeName("beforeDataBound")]
    public string BeforeDataBound { get; set; }
    Property Value
    Type Description
    System.String

    BeforeExcelExport

    Triggers before Grid data is exported to Excel file.

    Declaration
    [HtmlAttributeName("beforeExcelExport")]
    public string BeforeExcelExport { get; set; }
    Property Value
    Type Description
    System.String

    BeforeOpenAdaptiveDialog

    Triggers before adaptive filter and sort dialogs open.

    Declaration
    [HtmlAttributeName("beforeOpenAdaptiveDialog")]
    public string BeforeOpenAdaptiveDialog { get; set; }
    Property Value
    Type Description
    System.String

    BeforeOpenColumnChooser

    Triggers before the columnChooser open.

    Declaration
    [HtmlAttributeName("beforeOpenColumnChooser")]
    public string BeforeOpenColumnChooser { get; set; }
    Property Value
    Type Description
    System.String

    BeforePaste

    Triggers before Grid paste action.

    Declaration
    [HtmlAttributeName("beforePaste")]
    public string BeforePaste { get; set; }
    Property Value
    Type Description
    System.String

    BeforePdfExport

    Triggers before Grid data is exported to PDF document.

    Declaration
    [HtmlAttributeName("beforePdfExport")]
    public string BeforePdfExport { get; set; }
    Property Value
    Type Description
    System.String

    BeforePrint

    Triggers before the print action starts.

    Declaration
    [HtmlAttributeName("beforePrint")]
    public string BeforePrint { get; set; }
    Property Value
    Type Description
    System.String

    BeginEdit

    Triggers before the record is to be edit.

    Declaration
    [HtmlAttributeName("beginEdit")]
    public string BeginEdit { get; set; }
    Property Value
    Type Description
    System.String

    CellDeselected

    Triggers when a particular selected cell is deselected.

    Declaration
    [HtmlAttributeName("cellDeselected")]
    public string CellDeselected { get; set; }
    Property Value
    Type Description
    System.String

    CellDeselecting

    Triggers before the selected cell is deselecting.

    Declaration
    [HtmlAttributeName("cellDeselecting")]
    public string CellDeselecting { get; set; }
    Property Value
    Type Description
    System.String

    CellEdit

    Triggers when the cell is being edited.

    Declaration
    [HtmlAttributeName("cellEdit")]
    public string CellEdit { get; set; }
    Property Value
    Type Description
    System.String

    CellSave

    Triggers when cell is saved.

    Declaration
    [HtmlAttributeName("cellSave")]
    public string CellSave { get; set; }
    Property Value
    Type Description
    System.String

    CellSaved

    Triggers when cell is saved.

    Declaration
    [HtmlAttributeName("cellSaved")]
    public string CellSaved { get; set; }
    Property Value
    Type Description
    System.String

    CellSelected

    Triggers after a cell is selected.

    Declaration
    [HtmlAttributeName("cellSelected")]
    public string CellSelected { get; set; }
    Property Value
    Type Description
    System.String

    CellSelecting

    Triggers before any cell selection occurs.

    Declaration
    [HtmlAttributeName("cellSelecting")]
    public string CellSelecting { get; set; }
    Property Value
    Type Description
    System.String

    CheckBoxChange

    Triggers when the check box state change in checkbox column.

    Declaration
    [HtmlAttributeName("checkBoxChange")]
    public string CheckBoxChange { get; set; }
    Property Value
    Type Description
    System.String

    ChildGrid

    Defines Grid options to render child Grid. It requires the queryString for parent and child relationship.

    Declaration
    [HtmlAttributeName("childGrid")]
    public object ChildGrid { get; set; }
    Property Value
    Type Description
    System.Object

    ClassName

    Declaration
    protected override string ClassName { get; }
    Property Value
    Type Description
    System.String
    Overrides
    EJTagHelper.ClassName

    ColumnDeselected

    Triggers when a selected column is deselected.

    Declaration
    [HtmlAttributeName("columnDeselected")]
    public string ColumnDeselected { get; set; }
    Property Value
    Type Description
    System.String

    ColumnDeselecting

    Triggers before deselecting the selected column.

    Declaration
    [HtmlAttributeName("columnDeselecting")]
    public string ColumnDeselecting { get; set; }
    Property Value
    Type Description
    System.String

    ColumnDrag

    Triggers when column header element is dragged (moved) continuously.

    Declaration
    [HtmlAttributeName("columnDrag")]
    public string ColumnDrag { get; set; }
    Property Value
    Type Description
    System.String

    ColumnDragStart

    Triggers when column header element drag (move) starts.

    Declaration
    [HtmlAttributeName("columnDragStart")]
    public string ColumnDragStart { get; set; }
    Property Value
    Type Description
    System.String

    ColumnDrop

    Triggers when a column header element is dropped on the target column.

    Declaration
    [HtmlAttributeName("columnDrop")]
    public string ColumnDrop { get; set; }
    Property Value
    Type Description
    System.String

    ColumnMenuClick

    Triggers when click on column menu.

    Declaration
    [HtmlAttributeName("columnMenuClick")]
    public string ColumnMenuClick { get; set; }
    Property Value
    Type Description
    System.String

    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
    [HtmlAttributeName("columnMenuItems")]
    public object ColumnMenuItems { get; set; }
    Property Value
    Type Description
    System.Object

    ColumnMenuOpen

    Triggers before column menu opens.

    Declaration
    [HtmlAttributeName("columnMenuOpen")]
    public string ColumnMenuOpen { get; set; }
    Property Value
    Type Description
    System.String

    ColumnQueryMode

    columnQueryModeprovides 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
    [HtmlAttributeName("columnQueryMode")]
    public ColumnQueryModeType ColumnQueryMode { get; set; }
    Property Value
    Type Description
    ColumnQueryModeType

    Columns

    Defines the schema of dataSource. If the columns declaration is empty or undefined then the columns are automatically generated from data source.

    Declaration
    [HtmlAttributeName("columns")]
    public object Columns { get; set; }
    Property Value
    Type Description
    System.Object

    ColumnSelected

    Triggers after a column is selected.

    Declaration
    [HtmlAttributeName("columnSelected")]
    public string ColumnSelected { get; set; }
    Property Value
    Type Description
    System.String

    ColumnSelecting

    Triggers before column selection occurs.

    Declaration
    [HtmlAttributeName("columnSelecting")]
    public string ColumnSelecting { get; set; }
    Property Value
    Type Description
    System.String

    CommandClick

    Triggers when command button is clicked.

    Declaration
    [HtmlAttributeName("commandClick")]
    public string CommandClick { get; set; }
    Property Value
    Type Description
    System.String

    ContextMenuClick

    Triggers when click on context menu.

    Declaration
    [HtmlAttributeName("contextMenuClick")]
    public string ContextMenuClick { get; set; }
    Property Value
    Type Description
    System.String

    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
    [HtmlAttributeName("contextMenuItems")]
    public object ContextMenuItems { get; set; }
    Property Value
    Type Description
    System.Object

    ContextMenuOpen

    Triggers before context menu opens.

    Declaration
    [HtmlAttributeName("contextMenuOpen")]
    public string ContextMenuOpen { get; set; }
    Property Value
    Type Description
    System.String

    Created

    Triggers when the component is created.

    Declaration
    [HtmlAttributeName("created")]
    public string Created { get; set; }
    Property Value
    Type Description
    System.String

    CssClass

    Defines the own class for the grid element.

    Declaration
    [HtmlAttributeName("cssClass")]
    public string CssClass { get; set; }
    Property Value
    Type Description
    System.String

    DataBound

    Triggers when data source is populated in the Grid.

    Declaration
    [HtmlAttributeName("dataBound")]
    public string DataBound { get; set; }
    Property Value
    Type Description
    System.String

    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
    [HtmlAttributeName("dataSource")]
    public object DataSource { get; set; }
    Property Value
    Type Description
    System.Object

    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
    [HtmlAttributeName("dataSourceChanged")]
    public string DataSourceChanged { get; set; }
    Property Value
    Type Description
    System.String

    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
    [HtmlAttributeName("dataStateChange")]
    public string DataStateChange { get; set; }
    Property Value
    Type Description
    System.String

    Destroyed

    Triggers when the component is destroyed.

    Declaration
    [HtmlAttributeName("destroyed")]
    public string Destroyed { get; set; }
    Property Value
    Type Description
    System.String

    DetailDataBound

    Triggers after detail row expands.

    This event triggers at initial expand.

    Declaration
    [HtmlAttributeName("detailDataBound")]
    public string DetailDataBound { get; set; }
    Property Value
    Type Description
    System.String

    DetailTemplate

    The detail template allows you to show or hide additional information about a particular row.

    Declaration
    [HtmlAttributeName("detailTemplate")]
    public string DetailTemplate { get; set; }
    Property Value
    Type Description
    System.String

    EditSettings

    Configures the edit settings.

    Declaration
    [HtmlAttributeName("editSettings")]
    public GridEditSettings EditSettings { get; set; }
    Property Value
    Type Description
    GridEditSettings

    Ej2StatePersistenceVersion

    Defines the version for Grid persistence.

    Declaration
    [HtmlAttributeName("ej2StatePersistenceVersion")]
    public string Ej2StatePersistenceVersion { get; set; }
    Property Value
    Type Description
    System.String

    EnableAdaptiveUI

    If enableAdaptiveUI set to true the grid dialogs will be displayed at fullscreen.

    Declaration
    [HtmlAttributeName("enableAdaptiveUI")]
    public bool EnableAdaptiveUI { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnableAltRow

    If enableAltRow is set to true, the grid will render with e-altrow CSS class to the alternative tr elements.

    Check the AltRow to customize the styles of alternative rows.

    Declaration
    [HtmlAttributeName("enableAltRow")]
    public bool EnableAltRow { get; set; }
    Property Value
    Type Description
    System.Boolean

    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
    [HtmlAttributeName("enableAutoFill")]
    public bool EnableAutoFill { get; set; }
    Property Value
    Type Description
    System.Boolean

    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
    [HtmlAttributeName("enableColumnVirtualization")]
    public bool EnableColumnVirtualization { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnableHeaderFocus

    If EnableHeaderFocus set to true, then header element will be focused when focus moves to grid.

    Declaration
    [HtmlAttributeName("enableHeaderFocus")]
    public bool EnableHeaderFocus { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnableHover

    If enableHover is set to true, the row hover is enabled in the Grid.

    Declaration
    [HtmlAttributeName("enableHover")]
    public bool EnableHover { get; set; }
    Property Value
    Type Description
    System.Boolean

    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
    [HtmlAttributeName("enableImmutableMode")]
    public bool EnableImmutableMode { get; set; }
    Property Value
    Type Description
    System.Boolean

    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
    [HtmlAttributeName("enableInfiniteScrolling")]
    public bool EnableInfiniteScrolling { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnablePersistence

    Enable or disable persisting component's state between page reloads.

    Declaration
    [HtmlAttributeName("enablePersistence")]
    public bool EnablePersistence { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnableRtl

    Enable or disable rendering component in right to left direction.

    Declaration
    [HtmlAttributeName("enableRtl")]
    public bool EnableRtl { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnableStickyHeader

    If 'EnableStickyHeader' is set to true, then the user can able to make the Grid column headers visible when the document is scrolled.

    Declaration
    [HtmlAttributeName("enableStickyHeader")]
    public bool EnableStickyHeader { get; set; }
    Property Value
    Type Description
    System.Boolean

    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
    [HtmlAttributeName("enableVirtualization")]
    public bool EnableVirtualization { get; set; }
    Property Value
    Type Description
    System.Boolean

    ExcelExportComplete

    Triggers after Grid data is exported to Excel file.

    Declaration
    [HtmlAttributeName("excelExportComplete")]
    public string ExcelExportComplete { get; set; }
    Property Value
    Type Description
    System.String

    ExcelHeaderQueryCellInfo

    Triggers before exporting each header cell to Excel file. You can also customize the Excel cells.

    Declaration
    [HtmlAttributeName("excelHeaderQueryCellInfo")]
    public string ExcelHeaderQueryCellInfo { get; set; }
    Property Value
    Type Description
    System.String

    ExcelQueryCellInfo

    Triggers before exporting each cell to Excel file. You can also customize the Excel cells.

    Declaration
    [HtmlAttributeName("excelQueryCellInfo")]
    public string ExcelQueryCellInfo { get; set; }
    Property Value
    Type Description
    System.String

    ExportDetailDataBound

    Triggers before exporting each detail Grid to PDF document.

    Declaration
    [HtmlAttributeName("exportDetailDataBound")]
    public string ExportDetailDataBound { get; set; }
    Property Value
    Type Description
    System.String

    ExportGroupCaption

    Triggers before exporting each caption row to PDF document. You can also customize the export caption row values.

    Declaration
    [HtmlAttributeName("exportGroupCaption")]
    public string ExportGroupCaption { get; set; }
    Property Value
    Type Description
    System.String

    FilterSettings

    Configures the filter settings of the Grid.

    Declaration
    [HtmlAttributeName("filterSettings")]
    public GridFilterSettings FilterSettings { get; set; }
    Property Value
    Type Description
    GridFilterSettings

    FrozenColumns

    Gets or sets the number of frozen columns.

    Declaration
    [HtmlAttributeName("frozenColumns")]
    public double FrozenColumns { get; set; }
    Property Value
    Type Description
    System.Double

    FrozenRows

    Gets or sets the number of frozen rows.

    Declaration
    [HtmlAttributeName("frozenRows")]
    public double FrozenRows { get; set; }
    Property Value
    Type Description
    System.Double

    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
    [HtmlAttributeName("gridLines")]
    public GridLine GridLines { get; set; }
    Property Value
    Type Description
    GridLine

    GroupSettings

    Configures the group settings.

    Declaration
    [HtmlAttributeName("groupSettings")]
    public GridGroupSettings GroupSettings { get; set; }
    Property Value
    Type Description
    GridGroupSettings

    HeaderCellInfo

    Triggered for stacked header.

    Declaration
    [HtmlAttributeName("headerCellInfo")]
    public string HeaderCellInfo { get; set; }
    Property Value
    Type Description
    System.String

    Height

    Defines the scrollable height of the grid content.

    Declaration
    [HtmlAttributeName("height")]
    public string Height { get; set; }
    Property Value
    Type Description
    System.String

    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
    [HtmlAttributeName("hierarchyPrintMode")]
    public HierarchyGridPrintMode HierarchyPrintMode { get; set; }
    Property Value
    Type Description
    HierarchyGridPrintMode

    HtmlAttributes

    Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

    Declaration
    [HtmlAttributeName("htmlAttributes")]
    public object HtmlAttributes { get; set; }
    Property Value
    Type Description
    System.Object

    InfiniteScrollSettings

    Configures the infinite scroll settings.

    Declaration
    [HtmlAttributeName("infiniteScrollSettings")]
    public GridInfiniteScrollSettings InfiniteScrollSettings { get; set; }
    Property Value
    Type Description
    GridInfiniteScrollSettings

    IsFor

    Declaration
    protected override bool IsFor { get; }
    Property Value
    Type Description
    System.Boolean
    Overrides
    EJTagHelper.IsFor

    KeyPressed

    Triggers when any keyboard keys are pressed inside the grid.

    Declaration
    [HtmlAttributeName("keyPressed")]
    public string KeyPressed { get; set; }
    Property Value
    Type Description
    System.String

    LazyLoadGroupCollapse

    Triggers when any Grid group caption row get collapse in lazy load feature.

    Declaration
    [HtmlAttributeName("lazyLoadGroupCollapse")]
    public string LazyLoadGroupCollapse { get; set; }
    Property Value
    Type Description
    System.String

    LazyLoadGroupExpand

    Triggers when any Grid group caption row get expand in lazy load feature.

    Declaration
    [HtmlAttributeName("lazyLoadGroupExpand")]
    public string LazyLoadGroupExpand { get; set; }
    Property Value
    Type Description
    System.String

    Load

    This event allows customization of Grid properties before rendering.

    Declaration
    [HtmlAttributeName("load")]
    public string Load { get; set; }
    Property Value
    Type Description
    System.String

    Locale

    Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

    Declaration
    [HtmlAttributeName("locale")]
    public string Locale { get; set; }
    Property Value
    Type Description
    System.String

    NameSpace

    Declaration
    protected override string NameSpace { get; }
    Property Value
    Type Description
    System.String
    Overrides
    EJTagHelper.NameSpace

    PagerTemplate

    It used to render pager template

    Declaration
    [HtmlAttributeName("pagerTemplate")]
    public string PagerTemplate { get; set; }
    Property Value
    Type Description
    System.String

    PageSettings

    Configures the pager in the Grid.

    Declaration
    [HtmlAttributeName("pageSettings")]
    public GridPageSettings PageSettings { get; set; }
    Property Value
    Type Description
    GridPageSettings

    PdfExportComplete

    Triggers after Grid data is exported to PDF document.

    Declaration
    [HtmlAttributeName("pdfExportComplete")]
    public string PdfExportComplete { get; set; }
    Property Value
    Type Description
    System.String

    PdfHeaderQueryCellInfo

    Triggers before exporting each header cell to PDF document. You can also customize the PDF cells.

    Declaration
    [HtmlAttributeName("pdfHeaderQueryCellInfo")]
    public string PdfHeaderQueryCellInfo { get; set; }
    Property Value
    Type Description
    System.String

    PdfQueryCellInfo

    Triggers before exporting each cell to PDF document. You can also customize the PDF cells.

    Declaration
    [HtmlAttributeName("pdfQueryCellInfo")]
    public string PdfQueryCellInfo { get; set; }
    Property Value
    Type Description
    System.String

    PrintComplete

    Triggers after print action is completed.

    Declaration
    [HtmlAttributeName("printComplete")]
    public string PrintComplete { get; set; }
    Property Value
    Type Description
    System.String

    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
    [HtmlAttributeName("printMode")]
    public PrintMode PrintMode { get; set; }
    Property Value
    Type Description
    PrintMode

    Query

    Defines the external Query that will be executed along with data processing.

    Declaration
    [HtmlAttributeName("query")]
    public string Query { get; set; }
    Property Value
    Type Description
    System.String

    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
    [HtmlAttributeName("queryCellInfo")]
    public string QueryCellInfo { get; set; }
    Property Value
    Type Description
    System.String

    QueryString

    Defines the relationship between parent and child datasource. It acts as the foreign key for parent datasource.

    Declaration
    [HtmlAttributeName("queryString")]
    public string QueryString { get; set; }
    Property Value
    Type Description
    System.String

    RecordClick

    Triggers when record is clicked.

    Declaration
    [HtmlAttributeName("recordClick")]
    public string RecordClick { get; set; }
    Property Value
    Type Description
    System.String

    RecordDoubleClick

    Triggers when record is double clicked.

    Declaration
    [HtmlAttributeName("recordDoubleClick")]
    public string RecordDoubleClick { get; set; }
    Property Value
    Type Description
    System.String

    ResizeSettings

    Configures the resize settings in the Grid.

    Declaration
    [HtmlAttributeName("resizeSettings")]
    public GridResizeSettings ResizeSettings { get; set; }
    Property Value
    Type Description
    GridResizeSettings

    ResizeStart

    Triggers when column resize starts.

    Declaration
    [HtmlAttributeName("resizeStart")]
    public string ResizeStart { get; set; }
    Property Value
    Type Description
    System.String

    ResizeStop

    Triggers when column resize ends.

    Declaration
    [HtmlAttributeName("resizeStop")]
    public string ResizeStop { get; set; }
    Property Value
    Type Description
    System.String

    Resizing

    Triggers on column resizing.

    Declaration
    [HtmlAttributeName("resizing")]
    public string Resizing { get; set; }
    Property Value
    Type Description
    System.String

    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
    [HtmlAttributeName("rowDataBound")]
    public string RowDataBound { get; set; }
    Property Value
    Type Description
    System.String

    RowDeselected

    Triggers when a selected row is deselected.

    Declaration
    [HtmlAttributeName("rowDeselected")]
    public string RowDeselected { get; set; }
    Property Value
    Type Description
    System.String

    RowDeselecting

    Triggers before deselecting the selected row.

    Declaration
    [HtmlAttributeName("rowDeselecting")]
    public string RowDeselecting { get; set; }
    Property Value
    Type Description
    System.String

    RowDrag

    Triggers when row elements are dragged (moved) continuously.

    Declaration
    [HtmlAttributeName("rowDrag")]
    public string RowDrag { get; set; }
    Property Value
    Type Description
    System.String

    RowDragStart

    Triggers when row element's drag(move) starts.

    Declaration
    [HtmlAttributeName("rowDragStart")]
    public string RowDragStart { get; set; }
    Property Value
    Type Description
    System.String

    RowDragStartHelper

    Triggers when row element's before drag(move).

    Declaration
    [HtmlAttributeName("rowDragStartHelper")]
    public string RowDragStartHelper { get; set; }
    Property Value
    Type Description
    System.String

    RowDrop

    Triggers when row elements are dropped on the target row.

    Declaration
    [HtmlAttributeName("rowDrop")]
    public string RowDrop { get; set; }
    Property Value
    Type Description
    System.String

    RowDropSettings

    Configures the row drop settings.

    Declaration
    [HtmlAttributeName("rowDropSettings")]
    public GridRowDropSettings RowDropSettings { get; set; }
    Property Value
    Type Description
    GridRowDropSettings

    RowHeight

    Defines the height of Grid rows.

    Declaration
    [HtmlAttributeName("rowHeight")]
    public double RowHeight { get; set; }
    Property Value
    Type Description
    System.Double

    RowRenderingMode

    Defines the grid rows displaying direction. The available modes are, Horizontal: Displays the rows horizontally. Vertical: Displays the rows Vertically.

    Declaration
    [HtmlAttributeName("rowRenderingMode")]
    public RowRenderingDirection RowRenderingMode { get; set; }
    Property Value
    Type Description
    RowRenderingDirection

    RowSelected

    Triggers after a row is selected.

    Declaration
    [HtmlAttributeName("rowSelected")]
    public string RowSelected { get; set; }
    Property Value
    Type Description
    System.String

    RowSelecting

    Triggers before row selection occurs.

    Declaration
    [HtmlAttributeName("rowSelecting")]
    public string RowSelecting { get; set; }
    Property Value
    Type Description
    System.String

    RowTemplate

    The row template that renders customized rows from the given template. By default, Grid 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
    [HtmlAttributeName("rowTemplate")]
    public string RowTemplate { get; set; }
    Property Value
    Type Description
    System.String

    SearchSettings

    Configures the search behavior in the Grid.

    Declaration
    [HtmlAttributeName("searchSettings")]
    public GridSearchSettings SearchSettings { get; set; }
    Property Value
    Type Description
    GridSearchSettings

    SelectedRowIndex

    The selectedRowIndex allows you to select a row at initial rendering. You can also get the currently selected row index.

    Declaration
    [HtmlAttributeName("selectedRowIndex")]
    public double SelectedRowIndex { get; set; }
    Property Value
    Type Description
    System.Double

    SelectionSettings

    Configures the selection settings.

    Declaration
    [HtmlAttributeName("selectionSettings")]
    public GridSelectionSettings SelectionSettings { get; set; }
    Property Value
    Type Description
    GridSelectionSettings

    ServerExcelAggregateQueryCellInfo

    Triggers for each aggregate cell while exporting to Excel document in server. You can also customize the Excel cells.

    Declaration
    [HtmlAttributeName("serverExcelAggregateQueryCellInfo")]
    public Action<object> ServerExcelAggregateQueryCellInfo { get; set; }
    Property Value
    Type Description
    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
    [HtmlAttributeName("serverExcelHeaderQueryCellInfo")]
    public Action<object> ServerExcelHeaderQueryCellInfo { get; set; }
    Property Value
    Type Description
    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
    [HtmlAttributeName("serverExcelQueryCellInfo")]
    public Action<object> ServerExcelQueryCellInfo { get; set; }
    Property Value
    Type Description
    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
    [HtmlAttributeName("serverPdfAggregateQueryCellInfo")]
    public Action<object> ServerPdfAggregateQueryCellInfo { get; set; }
    Property Value
    Type Description
    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
    [HtmlAttributeName("serverPdfHeaderQueryCellInfo")]
    public Action<object> ServerPdfHeaderQueryCellInfo { get; set; }
    Property Value
    Type Description
    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
    [HtmlAttributeName("serverPdfQueryCellInfo")]
    public Action<object> ServerPdfQueryCellInfo { get; set; }
    Property Value
    Type Description
    System.Action<System.Object>

    ShowColumnChooser

    If showColumnChooser is set to true, it allows you to dynamically show or hide columns.

    Declaration
    [HtmlAttributeName("showColumnChooser")]
    public bool ShowColumnChooser { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowColumnMenu

    If showColumnMenu set to true, then it will enable the column menu options in each columns.

    Declaration
    [HtmlAttributeName("showColumnMenu")]
    public bool ShowColumnMenu { get; set; }
    Property Value
    Type Description
    System.Boolean

    SortSettings

    Configures the sort settings.

    Declaration
    [HtmlAttributeName("sortSettings")]
    public GridSortSettings SortSettings { get; set; }
    Property Value
    Type Description
    GridSortSettings

    TagName

    Declaration
    protected override string TagName { get; }
    Property Value
    Type Description
    System.String
    Overrides
    EJTagHelper.TagName

    TextWrapSettings

    Configures the text wrap in the Grid.

    Declaration
    [HtmlAttributeName("textWrapSettings")]
    public GridTextWrapSettings TextWrapSettings { get; set; }
    Property Value
    Type Description
    GridTextWrapSettings

    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
    [HtmlAttributeName("toolbar")]
    public object Toolbar { get; set; }
    Property Value
    Type Description
    System.Object

    ToolbarClick

    Triggers when toolbar item is clicked.

    Declaration
    [HtmlAttributeName("toolbarClick")]
    public string ToolbarClick { get; set; }
    Property Value
    Type Description
    System.String

    ToolbarTemplate

    It used to render toolbar template

    Declaration
    [HtmlAttributeName("toolbarTemplate")]
    public string ToolbarTemplate { get; set; }
    Property Value
    Type Description
    System.String

    TValue

    The data source value can be of any type

    Declaration
    [HtmlAttributeName("tvalue")]
    public Type TValue { get; set; }
    Property Value
    Type Description
    System.Type

    Width

    Defines the Grid width.

    Declaration
    [HtmlAttributeName("width")]
    public string Width { get; set; }
    Property Value
    Type Description
    System.String
    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved