ASP.NET Core - EJ2

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridBuilder<T> - ASP.NETCore-EJ2 API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridBuilder<T>

    Inheritance
    System.Object
    ControlBuilder
    GridBuilder<T>
    Inherited Members
    ControlBuilder.Context
    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 GridBuilder<T> : ControlBuilder where T : class
    Type Parameters
    Name Description
    T

    Constructors

    GridBuilder()

    Declaration
    public GridBuilder()

    GridBuilder(Grid)

    Declaration
    public GridBuilder(Grid model)
    Parameters
    Type Name Description
    Grid model

    Fields

    model

    Declaration
    public Grid model
    Field Value
    Type Description
    Grid

    Properties

    HtmlAttr

    Declaration
    public IDictionary<string, object> HtmlAttr { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.IDictionary<System.String, System.Object>

    ID

    Declaration
    public string ID { get; set; }
    Property Value
    Type Description
    System.String

    Output

    Declaration
    public override TextWriter Output { get; set; }
    Property Value
    Type Description
    System.IO.TextWriter
    Overrides
    ControlBuilder.Output

    Methods

    ActionBegin(String)

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

    Declaration
    public GridBuilder<T> ActionBegin(string actionBegin)
    Parameters
    Type Name Description
    System.String actionBegin
    Returns
    Type Description
    GridBuilder<T>

    ActionComplete(String)

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

    Declaration
    public GridBuilder<T> ActionComplete(string actionComplete)
    Parameters
    Type Name Description
    System.String actionComplete
    Returns
    Type Description
    GridBuilder<T>

    ActionFailure(String)

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

    Declaration
    public GridBuilder<T> ActionFailure(string actionFailure)
    Parameters
    Type Name Description
    System.String actionFailure
    Returns
    Type Description
    GridBuilder<T>

    Aggregates(Action<GridAggregateBuilder>)

    Declaration
    public GridBuilder<T> Aggregates(Action<GridAggregateBuilder> aggregates)
    Parameters
    Type Name Description
    System.Action<GridAggregateBuilder> aggregates
    Returns
    Type Description
    GridBuilder<T>

    Aggregates(List<GridAggregate>)

    Configures the Grid aggregate rows.

    Check the Aggregates for its configuration.

    Declaration
    public GridBuilder<T> Aggregates(List<GridAggregate> aggregates)
    Parameters
    Type Name Description
    System.Collections.Generic.List<GridAggregate> aggregates
    Returns
    Type Description
    GridBuilder<T>

    AllowExcelExport(Boolean)

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

    Declaration
    public GridBuilder<T> AllowExcelExport(bool allowExcelExport = true)
    Parameters
    Type Name Description
    System.Boolean allowExcelExport
    Returns
    Type Description
    GridBuilder<T>

    AllowFiltering(Boolean)

    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 GridBuilder<T> AllowFiltering(bool allowFiltering = true)
    Parameters
    Type Name Description
    System.Boolean allowFiltering
    Returns
    Type Description
    GridBuilder<T>

    AllowGrouping(Boolean)

    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 GridBuilder<T> AllowGrouping(bool allowGrouping = true)
    Parameters
    Type Name Description
    System.Boolean allowGrouping
    Returns
    Type Description
    GridBuilder<T>

    AllowMultiSorting(Boolean)

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

    allowSorting should be true.

    Declaration
    public GridBuilder<T> AllowMultiSorting(bool allowMultiSorting = true)
    Parameters
    Type Name Description
    System.Boolean allowMultiSorting
    Returns
    Type Description
    GridBuilder<T>

    AllowPaging(Boolean)

    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 GridBuilder<T> AllowPaging(bool allowPaging = true)
    Parameters
    Type Name Description
    System.Boolean allowPaging
    Returns
    Type Description
    GridBuilder<T>

    AllowPdfExport(Boolean)

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

    Declaration
    public GridBuilder<T> AllowPdfExport(bool allowPdfExport = true)
    Parameters
    Type Name Description
    System.Boolean allowPdfExport
    Returns
    Type Description
    GridBuilder<T>

    AllowReordering(Boolean)

    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 GridBuilder<T> AllowReordering(bool allowReordering = true)
    Parameters
    Type Name Description
    System.Boolean allowReordering
    Returns
    Type Description
    GridBuilder<T>

    AllowResizing(Boolean)

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

    Declaration
    public GridBuilder<T> AllowResizing(bool allowResizing = true)
    Parameters
    Type Name Description
    System.Boolean allowResizing
    Returns
    Type Description
    GridBuilder<T>

    AllowRowDragAndDrop(Boolean)

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

    Declaration
    public GridBuilder<T> AllowRowDragAndDrop(bool allowRowDragAndDrop = true)
    Parameters
    Type Name Description
    System.Boolean allowRowDragAndDrop
    Returns
    Type Description
    GridBuilder<T>

    AllowSelection(Boolean)

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

    Declaration
    public GridBuilder<T> AllowSelection(bool allowSelection = true)
    Parameters
    Type Name Description
    System.Boolean allowSelection
    Returns
    Type Description
    GridBuilder<T>

    AllowSorting(Boolean)

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

    Declaration
    public GridBuilder<T> AllowSorting(bool allowSorting = true)
    Parameters
    Type Name Description
    System.Boolean allowSorting
    Returns
    Type Description
    GridBuilder<T>

    AllowTextWrap(Boolean)

    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 GridBuilder<T> AllowTextWrap(bool allowTextWrap = true)
    Parameters
    Type Name Description
    System.Boolean allowTextWrap
    Returns
    Type Description
    GridBuilder<T>

    BatchAdd(String)

    Triggers when records are added in batch mode.

    Declaration
    public GridBuilder<T> BatchAdd(string batchAdd)
    Parameters
    Type Name Description
    System.String batchAdd
    Returns
    Type Description
    GridBuilder<T>

    BatchCancel(String)

    Triggers when cancel the batch edit changes batch mode.

    Declaration
    public GridBuilder<T> BatchCancel(string batchCancel)
    Parameters
    Type Name Description
    System.String batchCancel
    Returns
    Type Description
    GridBuilder<T>

    BatchDelete(String)

    Triggers when records are deleted in batch mode.

    Declaration
    public GridBuilder<T> BatchDelete(string batchDelete)
    Parameters
    Type Name Description
    System.String batchDelete
    Returns
    Type Description
    GridBuilder<T>

    BeforeBatchAdd(String)

    Triggers before records are added in batch mode.

    Declaration
    public GridBuilder<T> BeforeBatchAdd(string beforeBatchAdd)
    Parameters
    Type Name Description
    System.String beforeBatchAdd
    Returns
    Type Description
    GridBuilder<T>

    BeforeBatchDelete(String)

    Triggers before records are deleted in batch mode.

    Declaration
    public GridBuilder<T> BeforeBatchDelete(string beforeBatchDelete)
    Parameters
    Type Name Description
    System.String beforeBatchDelete
    Returns
    Type Description
    GridBuilder<T>

    BeforeBatchSave(String)

    Triggers before records are saved in batch mode.

    Declaration
    public GridBuilder<T> BeforeBatchSave(string beforeBatchSave)
    Parameters
    Type Name Description
    System.String beforeBatchSave
    Returns
    Type Description
    GridBuilder<T>

    BeforeCopy(String)

    Triggers before Grid copy action.

    Declaration
    public GridBuilder<T> BeforeCopy(string beforeCopy)
    Parameters
    Type Name Description
    System.String beforeCopy
    Returns
    Type Description
    GridBuilder<T>

    BeforeDataBound(String)

    Triggers before data is bound to Grid.

    Declaration
    public GridBuilder<T> BeforeDataBound(string beforeDataBound)
    Parameters
    Type Name Description
    System.String beforeDataBound
    Returns
    Type Description
    GridBuilder<T>

    BeforeExcelExport(String)

    Triggers before Grid data is exported to Excel file.

    Declaration
    public GridBuilder<T> BeforeExcelExport(string beforeExcelExport)
    Parameters
    Type Name Description
    System.String beforeExcelExport
    Returns
    Type Description
    GridBuilder<T>

    BeforeOpenColumnChooser(String)

    Triggers before the columnChooser open.

    Declaration
    public GridBuilder<T> BeforeOpenColumnChooser(string beforeOpenColumnChooser)
    Parameters
    Type Name Description
    System.String beforeOpenColumnChooser
    Returns
    Type Description
    GridBuilder<T>

    BeforePaste(String)

    Triggers before Grid paste action.

    Declaration
    public GridBuilder<T> BeforePaste(string beforePaste)
    Parameters
    Type Name Description
    System.String beforePaste
    Returns
    Type Description
    GridBuilder<T>

    BeforePdfExport(String)

    Triggers before Grid data is exported to PDF document.

    Declaration
    public GridBuilder<T> BeforePdfExport(string beforePdfExport)
    Parameters
    Type Name Description
    System.String beforePdfExport
    Returns
    Type Description
    GridBuilder<T>

    BeforePrint(String)

    Triggers before the print action starts.

    Declaration
    public GridBuilder<T> BeforePrint(string beforePrint)
    Parameters
    Type Name Description
    System.String beforePrint
    Returns
    Type Description
    GridBuilder<T>

    BeginEdit(String)

    Triggers before the record is to be edit.

    Declaration
    public GridBuilder<T> BeginEdit(string beginEdit)
    Parameters
    Type Name Description
    System.String beginEdit
    Returns
    Type Description
    GridBuilder<T>

    CellDeselected(String)

    Triggers when a particular selected cell is deselected.

    Declaration
    public GridBuilder<T> CellDeselected(string cellDeselected)
    Parameters
    Type Name Description
    System.String cellDeselected
    Returns
    Type Description
    GridBuilder<T>

    CellDeselecting(String)

    Triggers before the selected cell is deselecting.

    Declaration
    public GridBuilder<T> CellDeselecting(string cellDeselecting)
    Parameters
    Type Name Description
    System.String cellDeselecting
    Returns
    Type Description
    GridBuilder<T>

    CellEdit(String)

    Triggers when the cell is being edited.

    Declaration
    public GridBuilder<T> CellEdit(string cellEdit)
    Parameters
    Type Name Description
    System.String cellEdit
    Returns
    Type Description
    GridBuilder<T>

    CellSave(String)

    Triggers when cell is saved.

    Declaration
    public GridBuilder<T> CellSave(string cellSave)
    Parameters
    Type Name Description
    System.String cellSave
    Returns
    Type Description
    GridBuilder<T>

    CellSaved(String)

    Triggers when cell is saved.

    Declaration
    public GridBuilder<T> CellSaved(string cellSaved)
    Parameters
    Type Name Description
    System.String cellSaved
    Returns
    Type Description
    GridBuilder<T>

    CellSelected(String)

    Triggers after a cell is selected.

    Declaration
    public GridBuilder<T> CellSelected(string cellSelected)
    Parameters
    Type Name Description
    System.String cellSelected
    Returns
    Type Description
    GridBuilder<T>

    CellSelecting(String)

    Triggers before any cell selection occurs.

    Declaration
    public GridBuilder<T> CellSelecting(string cellSelecting)
    Parameters
    Type Name Description
    System.String cellSelecting
    Returns
    Type Description
    GridBuilder<T>

    CheckBoxChange(String)

    Triggers when the check box state change in checkbox column.

    Declaration
    public GridBuilder<T> CheckBoxChange(string checkBoxChange)
    Parameters
    Type Name Description
    System.String checkBoxChange
    Returns
    Type Description
    GridBuilder<T>

    ChildGrid(Object)

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

    Declaration
    public GridBuilder<T> ChildGrid(object childGrid)
    Parameters
    Type Name Description
    System.Object childGrid
    Returns
    Type Description
    GridBuilder<T>

    ColumnDeselected(String)

    Triggers when a selected column is deselected.

    Declaration
    public GridBuilder<T> ColumnDeselected(string columnDeselected)
    Parameters
    Type Name Description
    System.String columnDeselected
    Returns
    Type Description
    GridBuilder<T>

    ColumnDeselecting(String)

    Triggers before deselecting the selected column.

    Declaration
    public GridBuilder<T> ColumnDeselecting(string columnDeselecting)
    Parameters
    Type Name Description
    System.String columnDeselecting
    Returns
    Type Description
    GridBuilder<T>

    ColumnDrag(String)

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

    Declaration
    public GridBuilder<T> ColumnDrag(string columnDrag)
    Parameters
    Type Name Description
    System.String columnDrag
    Returns
    Type Description
    GridBuilder<T>

    ColumnDragStart(String)

    Triggers when column header element drag (move) starts.

    Declaration
    public GridBuilder<T> ColumnDragStart(string columnDragStart)
    Parameters
    Type Name Description
    System.String columnDragStart
    Returns
    Type Description
    GridBuilder<T>

    ColumnDrop(String)

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

    Declaration
    public GridBuilder<T> ColumnDrop(string columnDrop)
    Parameters
    Type Name Description
    System.String columnDrop
    Returns
    Type Description
    GridBuilder<T>

    ColumnMenuClick(String)

    Triggers when click on column menu.

    Declaration
    public GridBuilder<T> ColumnMenuClick(string columnMenuClick)
    Parameters
    Type Name Description
    System.String columnMenuClick
    Returns
    Type Description
    GridBuilder<T>

    ColumnMenuItems(Object)

    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 GridBuilder<T> ColumnMenuItems(object columnMenuItems)
    Parameters
    Type Name Description
    System.Object columnMenuItems
    Returns
    Type Description
    GridBuilder<T>

    ColumnMenuOpen(String)

    Triggers before column menu opens.

    Declaration
    public GridBuilder<T> ColumnMenuOpen(string columnMenuOpen)
    Parameters
    Type Name Description
    System.String columnMenuOpen
    Returns
    Type Description
    GridBuilder<T>

    ColumnQueryMode(ColumnQueryModeType)

    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
    public GridBuilder<T> ColumnQueryMode(ColumnQueryModeType columnQueryMode)
    Parameters
    Type Name Description
    ColumnQueryModeType columnQueryMode
    Returns
    Type Description
    GridBuilder<T>

    Columns(Action<GridColumnBuilder<T>>)

    Declaration
    public GridBuilder<T> Columns(Action<GridColumnBuilder<T>> columns)
    Parameters
    Type Name Description
    System.Action<GridColumnBuilder<T>> columns
    Returns
    Type Description
    GridBuilder<T>

    Columns(List<GridColumn>)

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

    Declaration
    public GridBuilder<T> Columns(List<GridColumn> columns)
    Parameters
    Type Name Description
    System.Collections.Generic.List<GridColumn> columns
    Returns
    Type Description
    GridBuilder<T>

    Columns(Object)

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

    Declaration
    public GridBuilder<T> Columns(object columns)
    Parameters
    Type Name Description
    System.Object columns
    Returns
    Type Description
    GridBuilder<T>

    Columns(String[])

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

    Declaration
    public GridBuilder<T> Columns(string[] columns)
    Parameters
    Type Name Description
    System.String[] columns
    Returns
    Type Description
    GridBuilder<T>

    ColumnSelected(String)

    Triggers after a column is selected.

    Declaration
    public GridBuilder<T> ColumnSelected(string columnSelected)
    Parameters
    Type Name Description
    System.String columnSelected
    Returns
    Type Description
    GridBuilder<T>

    ColumnSelecting(String)

    Triggers before column selection occurs.

    Declaration
    public GridBuilder<T> ColumnSelecting(string columnSelecting)
    Parameters
    Type Name Description
    System.String columnSelecting
    Returns
    Type Description
    GridBuilder<T>

    CommandClick(String)

    Triggers when command button is clicked.

    Declaration
    public GridBuilder<T> CommandClick(string commandClick)
    Parameters
    Type Name Description
    System.String commandClick
    Returns
    Type Description
    GridBuilder<T>

    ContextMenuClick(String)

    Triggers when click on context menu.

    Declaration
    public GridBuilder<T> ContextMenuClick(string contextMenuClick)
    Parameters
    Type Name Description
    System.String contextMenuClick
    Returns
    Type Description
    GridBuilder<T>

    ContextMenuItems(Object)

    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 GridBuilder<T> ContextMenuItems(object contextMenuItems)
    Parameters
    Type Name Description
    System.Object contextMenuItems
    Returns
    Type Description
    GridBuilder<T>

    ContextMenuOpen(String)

    Triggers before context menu opens.

    Declaration
    public GridBuilder<T> ContextMenuOpen(string contextMenuOpen)
    Parameters
    Type Name Description
    System.String contextMenuOpen
    Returns
    Type Description
    GridBuilder<T>

    Created(String)

    Triggers when the component is created.

    Declaration
    public GridBuilder<T> Created(string created)
    Parameters
    Type Name Description
    System.String created
    Returns
    Type Description
    GridBuilder<T>

    DataBound(String)

    Triggers when data source is populated in the Grid.

    Declaration
    public GridBuilder<T> DataBound(string dataBound)
    Parameters
    Type Name Description
    System.String dataBound
    Returns
    Type Description
    GridBuilder<T>

    DataSource(Action<DataManagerBuilder>)

    Declaration
    public GridBuilder<T> DataSource(Action<DataManagerBuilder> dataSource)
    Parameters
    Type Name Description
    System.Action<DataManagerBuilder> dataSource
    Returns
    Type Description
    GridBuilder<T>

    DataSource(Object)

    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 GridBuilder<T> DataSource(object dataSource)
    Parameters
    Type Name Description
    System.Object dataSource
    Returns
    Type Description
    GridBuilder<T>

    DataSourceChanged(String)

    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 GridBuilder<T> DataSourceChanged(string dataSourceChanged)
    Parameters
    Type Name Description
    System.String dataSourceChanged
    Returns
    Type Description
    GridBuilder<T>

    DataStateChange(String)

    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 GridBuilder<T> DataStateChange(string dataStateChange)
    Parameters
    Type Name Description
    System.String dataStateChange
    Returns
    Type Description
    GridBuilder<T>

    Destroyed(String)

    Triggers when the component is destroyed.

    Declaration
    public GridBuilder<T> Destroyed(string destroyed)
    Parameters
    Type Name Description
    System.String destroyed
    Returns
    Type Description
    GridBuilder<T>

    DetailDataBound(String)

    Triggers after detail row expands.

    This event triggers at initial expand.

    Declaration
    public GridBuilder<T> DetailDataBound(string detailDataBound)
    Parameters
    Type Name Description
    System.String detailDataBound
    Returns
    Type Description
    GridBuilder<T>

    DetailTemplate(String)

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

    Declaration
    public GridBuilder<T> DetailTemplate(string detailTemplate)
    Parameters
    Type Name Description
    System.String detailTemplate
    Returns
    Type Description
    GridBuilder<T>

    EditSettings(GridEditSettings)

    Configures the edit settings.

    Declaration
    public GridBuilder<T> EditSettings(GridEditSettings editSettings)
    Parameters
    Type Name Description
    GridEditSettings editSettings
    Returns
    Type Description
    GridBuilder<T>

    EditSettings(Action<GridEditSettingsBuilder>)

    Declaration
    public GridBuilder<T> EditSettings(Action<GridEditSettingsBuilder> editSettings)
    Parameters
    Type Name Description
    System.Action<GridEditSettingsBuilder> editSettings
    Returns
    Type Description
    GridBuilder<T>

    EnableAltRow(Boolean)

    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
    public GridBuilder<T> EnableAltRow(bool enableAltRow = true)
    Parameters
    Type Name Description
    System.Boolean enableAltRow
    Returns
    Type Description
    GridBuilder<T>

    EnableAutoFill(Boolean)

    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 GridBuilder<T> EnableAutoFill(bool enableAutoFill = true)
    Parameters
    Type Name Description
    System.Boolean enableAutoFill
    Returns
    Type Description
    GridBuilder<T>

    EnableColumnVirtualization(Boolean)

    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 GridBuilder<T> EnableColumnVirtualization(bool enableColumnVirtualization = true)
    Parameters
    Type Name Description
    System.Boolean enableColumnVirtualization
    Returns
    Type Description
    GridBuilder<T>

    EnableHover(Boolean)

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

    Declaration
    public GridBuilder<T> EnableHover(bool enableHover = true)
    Parameters
    Type Name Description
    System.Boolean enableHover
    Returns
    Type Description
    GridBuilder<T>

    EnableImmutableMode(Boolean)

    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 GridBuilder<T> EnableImmutableMode(bool enableImmutableMode = true)
    Parameters
    Type Name Description
    System.Boolean enableImmutableMode
    Returns
    Type Description
    GridBuilder<T>

    EnableInfiniteScrolling(Boolean)

    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 GridBuilder<T> EnableInfiniteScrolling(bool enableInfiniteScrolling = true)
    Parameters
    Type Name Description
    System.Boolean enableInfiniteScrolling
    Returns
    Type Description
    GridBuilder<T>

    EnablePersistence(Boolean)

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

    Declaration
    public GridBuilder<T> EnablePersistence(bool enablePersistence = true)
    Parameters
    Type Name Description
    System.Boolean enablePersistence
    Returns
    Type Description
    GridBuilder<T>

    EnableRtl(Boolean)

    Enable or disable rendering component in right to left direction.

    Declaration
    public GridBuilder<T> EnableRtl(bool enableRtl = true)
    Parameters
    Type Name Description
    System.Boolean enableRtl
    Returns
    Type Description
    GridBuilder<T>

    EnableVirtualization(Boolean)

    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 GridBuilder<T> EnableVirtualization(bool enableVirtualization = true)
    Parameters
    Type Name Description
    System.Boolean enableVirtualization
    Returns
    Type Description
    GridBuilder<T>

    ExcelExportComplete(String)

    Triggers after Grid data is exported to Excel file.

    Declaration
    public GridBuilder<T> ExcelExportComplete(string excelExportComplete)
    Parameters
    Type Name Description
    System.String excelExportComplete
    Returns
    Type Description
    GridBuilder<T>

    ExcelHeaderQueryCellInfo(String)

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

    Declaration
    public GridBuilder<T> ExcelHeaderQueryCellInfo(string excelHeaderQueryCellInfo)
    Parameters
    Type Name Description
    System.String excelHeaderQueryCellInfo
    Returns
    Type Description
    GridBuilder<T>

    ExcelQueryCellInfo(String)

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

    Declaration
    public GridBuilder<T> ExcelQueryCellInfo(string excelQueryCellInfo)
    Parameters
    Type Name Description
    System.String excelQueryCellInfo
    Returns
    Type Description
    GridBuilder<T>

    ExportDetailDataBound(String)

    Triggers before exporting each detail Grid to PDF document.

    Declaration
    public GridBuilder<T> ExportDetailDataBound(string exportDetailDataBound)
    Parameters
    Type Name Description
    System.String exportDetailDataBound
    Returns
    Type Description
    GridBuilder<T>

    ExportGroupCaption(String)

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

    Declaration
    public GridBuilder<T> ExportGroupCaption(string exportGroupCaption)
    Parameters
    Type Name Description
    System.String exportGroupCaption
    Returns
    Type Description
    GridBuilder<T>

    FilterSettings(GridFilterSettings)

    Configures the filter settings of the Grid.

    Declaration
    public GridBuilder<T> FilterSettings(GridFilterSettings filterSettings)
    Parameters
    Type Name Description
    GridFilterSettings filterSettings
    Returns
    Type Description
    GridBuilder<T>

    FilterSettings(Action<GridFilterSettingsBuilder>)

    Declaration
    public GridBuilder<T> FilterSettings(Action<GridFilterSettingsBuilder> filterSettings)
    Parameters
    Type Name Description
    System.Action<GridFilterSettingsBuilder> filterSettings
    Returns
    Type Description
    GridBuilder<T>

    FrozenColumns(Double)

    Gets or sets the number of frozen columns.

    Declaration
    public GridBuilder<T> FrozenColumns(double frozenColumns)
    Parameters
    Type Name Description
    System.Double frozenColumns
    Returns
    Type Description
    GridBuilder<T>

    FrozenRows(Double)

    Gets or sets the number of frozen rows.

    Declaration
    public GridBuilder<T> FrozenRows(double frozenRows)
    Parameters
    Type Name Description
    System.Double frozenRows
    Returns
    Type Description
    GridBuilder<T>

    GridLines(GridLine)

    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 GridBuilder<T> GridLines(GridLine gridLines)
    Parameters
    Type Name Description
    GridLine gridLines
    Returns
    Type Description
    GridBuilder<T>

    GroupSettings(GridGroupSettings)

    Configures the group settings.

    Declaration
    public GridBuilder<T> GroupSettings(GridGroupSettings groupSettings)
    Parameters
    Type Name Description
    GridGroupSettings groupSettings
    Returns
    Type Description
    GridBuilder<T>

    GroupSettings(Action<GridGroupSettingsBuilder>)

    Declaration
    public GridBuilder<T> GroupSettings(Action<GridGroupSettingsBuilder> groupSettings)
    Parameters
    Type Name Description
    System.Action<GridGroupSettingsBuilder> groupSettings
    Returns
    Type Description
    GridBuilder<T>

    HeaderCellInfo(String)

    Triggered for stacked header.

    Declaration
    public GridBuilder<T> HeaderCellInfo(string headerCellInfo)
    Parameters
    Type Name Description
    System.String headerCellInfo
    Returns
    Type Description
    GridBuilder<T>

    Height(Double)

    Defines the scrollable height of the grid content.

    Declaration
    public GridBuilder<T> Height(double height)
    Parameters
    Type Name Description
    System.Double height
    Returns
    Type Description
    GridBuilder<T>

    Height(String)

    Defines the scrollable height of the grid content.

    Declaration
    public GridBuilder<T> Height(string height)
    Parameters
    Type Name Description
    System.String height
    Returns
    Type Description
    GridBuilder<T>

    HierarchyPrintMode(HierarchyGridPrintMode)

    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 GridBuilder<T> HierarchyPrintMode(HierarchyGridPrintMode hierarchyPrintMode)
    Parameters
    Type Name Description
    HierarchyGridPrintMode hierarchyPrintMode
    Returns
    Type Description
    GridBuilder<T>

    HtmlAttributes(Object)

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

    Declaration
    public GridBuilder<T> HtmlAttributes(object htmlAttributes)
    Parameters
    Type Name Description
    System.Object htmlAttributes
    Returns
    Type Description
    GridBuilder<T>

    InfiniteScrollSettings(GridInfiniteScrollSettings)

    Configures the infinite scroll settings of the Grid.

    Declaration
    public GridBuilder<T> InfiniteScrollSettings(GridInfiniteScrollSettings infiniteScrollSettings)
    Parameters
    Type Name Description
    GridInfiniteScrollSettings infiniteScrollSettings
    Returns
    Type Description
    GridBuilder<T>

    InfiniteScrollSettings(Action<GridInfiniteScrollSettingsBuilder>)

    Declaration
    public GridBuilder<T> InfiniteScrollSettings(Action<GridInfiniteScrollSettingsBuilder> infiniteScrollSettings)
    Parameters
    Type Name Description
    System.Action<GridInfiniteScrollSettingsBuilder> infiniteScrollSettings
    Returns
    Type Description
    GridBuilder<T>

    KeyPressed(String)

    Triggers when any keyboard keys are pressed inside the grid.

    Declaration
    public GridBuilder<T> KeyPressed(string keyPressed)
    Parameters
    Type Name Description
    System.String keyPressed
    Returns
    Type Description
    GridBuilder<T>

    LazyLoadGroupCollapse(String)

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

    Declaration
    public GridBuilder<T> LazyLoadGroupCollapse(string lazyLoadGroupCollapse)
    Parameters
    Type Name Description
    System.String lazyLoadGroupCollapse
    Returns
    Type Description
    GridBuilder<T>

    LazyLoadGroupExpand(String)

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

    Declaration
    public GridBuilder<T> LazyLoadGroupExpand(string lazyLoadGroupExpand)
    Parameters
    Type Name Description
    System.String lazyLoadGroupExpand
    Returns
    Type Description
    GridBuilder<T>

    Load(String)

    This event allows customization of Grid properties before rendering.

    Declaration
    public GridBuilder<T> Load(string load)
    Parameters
    Type Name Description
    System.String load
    Returns
    Type Description
    GridBuilder<T>

    Locale(String)

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

    Declaration
    public GridBuilder<T> Locale(string locale)
    Parameters
    Type Name Description
    System.String locale
    Returns
    Type Description
    GridBuilder<T>

    PagerTemplate(String)

    It used to render pager template

    Declaration
    public GridBuilder<T> PagerTemplate(string pagerTemplate)
    Parameters
    Type Name Description
    System.String pagerTemplate
    Returns
    Type Description
    GridBuilder<T>

    PageSettings(GridPageSettings)

    Configures the pager in the Grid.

    Declaration
    public GridBuilder<T> PageSettings(GridPageSettings pageSettings)
    Parameters
    Type Name Description
    GridPageSettings pageSettings
    Returns
    Type Description
    GridBuilder<T>

    PageSettings(Action<GridPageSettingsBuilder>)

    Declaration
    public GridBuilder<T> PageSettings(Action<GridPageSettingsBuilder> pageSettings)
    Parameters
    Type Name Description
    System.Action<GridPageSettingsBuilder> pageSettings
    Returns
    Type Description
    GridBuilder<T>

    PdfExportComplete(String)

    Triggers after Grid data is exported to PDF document.

    Declaration
    public GridBuilder<T> PdfExportComplete(string pdfExportComplete)
    Parameters
    Type Name Description
    System.String pdfExportComplete
    Returns
    Type Description
    GridBuilder<T>

    PdfHeaderQueryCellInfo(String)

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

    Declaration
    public GridBuilder<T> PdfHeaderQueryCellInfo(string pdfHeaderQueryCellInfo)
    Parameters
    Type Name Description
    System.String pdfHeaderQueryCellInfo
    Returns
    Type Description
    GridBuilder<T>

    PdfQueryCellInfo(String)

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

    Declaration
    public GridBuilder<T> PdfQueryCellInfo(string pdfQueryCellInfo)
    Parameters
    Type Name Description
    System.String pdfQueryCellInfo
    Returns
    Type Description
    GridBuilder<T>

    PrintComplete(String)

    Triggers after print action is completed.

    Declaration
    public GridBuilder<T> PrintComplete(string printComplete)
    Parameters
    Type Name Description
    System.String printComplete
    Returns
    Type Description
    GridBuilder<T>

    PrintMode(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 GridBuilder<T> PrintMode(PrintMode printMode)
    Parameters
    Type Name Description
    PrintMode printMode
    Returns
    Type Description
    GridBuilder<T>

    Query(String)

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

    Declaration
    public GridBuilder<T> Query(string query)
    Parameters
    Type Name Description
    System.String query
    Returns
    Type Description
    GridBuilder<T>

    QueryCellInfo(String)

    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 GridBuilder<T> QueryCellInfo(string queryCellInfo)
    Parameters
    Type Name Description
    System.String queryCellInfo
    Returns
    Type Description
    GridBuilder<T>

    QueryString(String)

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

    Declaration
    public GridBuilder<T> QueryString(string queryString)
    Parameters
    Type Name Description
    System.String queryString
    Returns
    Type Description
    GridBuilder<T>

    RecordClick(String)

    Triggers when record is clicked.

    Declaration
    public GridBuilder<T> RecordClick(string recordClick)
    Parameters
    Type Name Description
    System.String recordClick
    Returns
    Type Description
    GridBuilder<T>

    RecordDoubleClick(String)

    Triggers when record is double clicked.

    Declaration
    public GridBuilder<T> RecordDoubleClick(string recordDoubleClick)
    Parameters
    Type Name Description
    System.String recordDoubleClick
    Returns
    Type Description
    GridBuilder<T>

    Render()

    Declaration
    public HtmlString Render()
    Returns
    Type Description
    Microsoft.AspNetCore.Html.HtmlString

    ResizeSettings(GridResizeSettings)

    Configures the resize settings in the Grid.

    Declaration
    public GridBuilder<T> ResizeSettings(GridResizeSettings resizeSettings)
    Parameters
    Type Name Description
    GridResizeSettings resizeSettings
    Returns
    Type Description
    GridBuilder<T>

    ResizeSettings(Action<GridResizeSettingsBuilder>)

    Declaration
    public GridBuilder<T> ResizeSettings(Action<GridResizeSettingsBuilder> resizeSettings)
    Parameters
    Type Name Description
    System.Action<GridResizeSettingsBuilder> resizeSettings
    Returns
    Type Description
    GridBuilder<T>

    ResizeStart(String)

    Triggers when column resize starts.

    Declaration
    public GridBuilder<T> ResizeStart(string resizeStart)
    Parameters
    Type Name Description
    System.String resizeStart
    Returns
    Type Description
    GridBuilder<T>

    ResizeStop(String)

    Triggers when column resize ends.

    Declaration
    public GridBuilder<T> ResizeStop(string resizeStop)
    Parameters
    Type Name Description
    System.String resizeStop
    Returns
    Type Description
    GridBuilder<T>

    Resizing(String)

    Triggers on column resizing.

    Declaration
    public GridBuilder<T> Resizing(string resizing)
    Parameters
    Type Name Description
    System.String resizing
    Returns
    Type Description
    GridBuilder<T>

    RowDataBound(String)

    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 GridBuilder<T> RowDataBound(string rowDataBound)
    Parameters
    Type Name Description
    System.String rowDataBound
    Returns
    Type Description
    GridBuilder<T>

    RowDeselected(String)

    Triggers when a selected row is deselected.

    Declaration
    public GridBuilder<T> RowDeselected(string rowDeselected)
    Parameters
    Type Name Description
    System.String rowDeselected
    Returns
    Type Description
    GridBuilder<T>

    RowDeselecting(String)

    Triggers before deselecting the selected row.

    Declaration
    public GridBuilder<T> RowDeselecting(string rowDeselecting)
    Parameters
    Type Name Description
    System.String rowDeselecting
    Returns
    Type Description
    GridBuilder<T>

    RowDrag(String)

    Triggers when row elements are dragged (moved) continuously.

    Declaration
    public GridBuilder<T> RowDrag(string rowDrag)
    Parameters
    Type Name Description
    System.String rowDrag
    Returns
    Type Description
    GridBuilder<T>

    RowDragStart(String)

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

    Declaration
    public GridBuilder<T> RowDragStart(string rowDragStart)
    Parameters
    Type Name Description
    System.String rowDragStart
    Returns
    Type Description
    GridBuilder<T>

    RowDragStartHelper(String)

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

    Declaration
    public GridBuilder<T> RowDragStartHelper(string rowDragStartHelper)
    Parameters
    Type Name Description
    System.String rowDragStartHelper
    Returns
    Type Description
    GridBuilder<T>

    RowDrop(String)

    Triggers when row elements are dropped on the target row.

    Declaration
    public GridBuilder<T> RowDrop(string rowDrop)
    Parameters
    Type Name Description
    System.String rowDrop
    Returns
    Type Description
    GridBuilder<T>

    RowDropSettings(GridRowDropSettings)

    Configures the row drop settings.

    Declaration
    public GridBuilder<T> RowDropSettings(GridRowDropSettings rowDropSettings)
    Parameters
    Type Name Description
    GridRowDropSettings rowDropSettings
    Returns
    Type Description
    GridBuilder<T>

    RowDropSettings(Action<GridRowDropSettingsBuilder>)

    Declaration
    public GridBuilder<T> RowDropSettings(Action<GridRowDropSettingsBuilder> rowDropSettings)
    Parameters
    Type Name Description
    System.Action<GridRowDropSettingsBuilder> rowDropSettings
    Returns
    Type Description
    GridBuilder<T>

    RowHeight(Double)

    Defines the height of Grid rows.

    Declaration
    public GridBuilder<T> RowHeight(double rowHeight)
    Parameters
    Type Name Description
    System.Double rowHeight
    Returns
    Type Description
    GridBuilder<T>

    RowSelected(String)

    Triggers after a row is selected.

    Declaration
    public GridBuilder<T> RowSelected(string rowSelected)
    Parameters
    Type Name Description
    System.String rowSelected
    Returns
    Type Description
    GridBuilder<T>

    RowSelecting(String)

    Triggers before row selection occurs.

    Declaration
    public GridBuilder<T> RowSelecting(string rowSelecting)
    Parameters
    Type Name Description
    System.String rowSelecting
    Returns
    Type Description
    GridBuilder<T>

    RowTemplate(String)

    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
    public GridBuilder<T> RowTemplate(string rowTemplate)
    Parameters
    Type Name Description
    System.String rowTemplate
    Returns
    Type Description
    GridBuilder<T>

    SearchSettings(GridSearchSettings)

    Configures the search behavior in the Grid.

    Declaration
    public GridBuilder<T> SearchSettings(GridSearchSettings searchSettings)
    Parameters
    Type Name Description
    GridSearchSettings searchSettings
    Returns
    Type Description
    GridBuilder<T>

    SearchSettings(Action<GridSearchSettingsBuilder>)

    Declaration
    public GridBuilder<T> SearchSettings(Action<GridSearchSettingsBuilder> searchSettings)
    Parameters
    Type Name Description
    System.Action<GridSearchSettingsBuilder> searchSettings
    Returns
    Type Description
    GridBuilder<T>

    SelectedRowIndex(Double)

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

    Declaration
    public GridBuilder<T> SelectedRowIndex(double selectedRowIndex)
    Parameters
    Type Name Description
    System.Double selectedRowIndex
    Returns
    Type Description
    GridBuilder<T>

    SelectionSettings(GridSelectionSettings)

    Configures the selection settings.

    Declaration
    public GridBuilder<T> SelectionSettings(GridSelectionSettings selectionSettings)
    Parameters
    Type Name Description
    GridSelectionSettings selectionSettings
    Returns
    Type Description
    GridBuilder<T>

    SelectionSettings(Action<GridSelectionSettingsBuilder>)

    Declaration
    public GridBuilder<T> SelectionSettings(Action<GridSelectionSettingsBuilder> selectionSettings)
    Parameters
    Type Name Description
    System.Action<GridSelectionSettingsBuilder> selectionSettings
    Returns
    Type Description
    GridBuilder<T>

    ShowColumnChooser(Boolean)

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

    Declaration
    public GridBuilder<T> ShowColumnChooser(bool showColumnChooser = true)
    Parameters
    Type Name Description
    System.Boolean showColumnChooser
    Returns
    Type Description
    GridBuilder<T>

    ShowColumnMenu(Boolean)

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

    Declaration
    public GridBuilder<T> ShowColumnMenu(bool showColumnMenu = true)
    Parameters
    Type Name Description
    System.Boolean showColumnMenu
    Returns
    Type Description
    GridBuilder<T>

    SortSettings(GridSortSettings)

    Configures the sort settings.

    Declaration
    public GridBuilder<T> SortSettings(GridSortSettings sortSettings)
    Parameters
    Type Name Description
    GridSortSettings sortSettings
    Returns
    Type Description
    GridBuilder<T>

    SortSettings(Action<GridSortSettingsBuilder>)

    Declaration
    public GridBuilder<T> SortSettings(Action<GridSortSettingsBuilder> sortSettings)
    Parameters
    Type Name Description
    System.Action<GridSortSettingsBuilder> sortSettings
    Returns
    Type Description
    GridBuilder<T>

    TextWrapSettings(GridTextWrapSettings)

    Configures the text wrap in the Grid.

    Declaration
    public GridBuilder<T> TextWrapSettings(GridTextWrapSettings textWrapSettings)
    Parameters
    Type Name Description
    GridTextWrapSettings textWrapSettings
    Returns
    Type Description
    GridBuilder<T>

    TextWrapSettings(Action<GridTextWrapSettingsBuilder>)

    Declaration
    public GridBuilder<T> TextWrapSettings(Action<GridTextWrapSettingsBuilder> textWrapSettings)
    Parameters
    Type Name Description
    System.Action<GridTextWrapSettingsBuilder> textWrapSettings
    Returns
    Type Description
    GridBuilder<T>

    Toolbar(Object)

    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 GridBuilder<T> Toolbar(object toolbar)
    Parameters
    Type Name Description
    System.Object toolbar
    Returns
    Type Description
    GridBuilder<T>

    ToolbarClick(String)

    Triggers when toolbar item is clicked.

    Declaration
    public GridBuilder<T> ToolbarClick(string toolbarClick)
    Parameters
    Type Name Description
    System.String toolbarClick
    Returns
    Type Description
    GridBuilder<T>

    ToolbarTemplate(String)

    It used to render toolbar template

    Declaration
    public GridBuilder<T> ToolbarTemplate(string toolbarTemplate)
    Parameters
    Type Name Description
    System.String toolbarTemplate
    Returns
    Type Description
    GridBuilder<T>

    Width(Double)

    Defines the Grid width.

    Declaration
    public GridBuilder<T> Width(double width)
    Parameters
    Type Name Description
    System.Double width
    Returns
    Type Description
    GridBuilder<T>

    Width(String)

    Defines the Grid width.

    Declaration
    public GridBuilder<T> Width(string width)
    Parameters
    Type Name Description
    System.String width
    Returns
    Type Description
    GridBuilder<T>
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved