ASP.NET Core

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

    Show / Hide Table of Contents

    Class GridPropertiesBuilder<T>

    Inheritance
    System.Object
    GridPropertiesBuilder<T>
    Implements
    IPropertiesBuilder
    System.Web.IHtmlString
    Inherited Members
    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.JavaScript
    Assembly: Syncfusion.EJ.dll
    Syntax
    public class GridPropertiesBuilder<T> : IPropertiesBuilder, IHtmlString where T : class
    Type Parameters
    Name Description
    T

    Constructors

    GridPropertiesBuilder()

    Initializes a new instance of the GridPropertiesBuilder<T> class.

    Declaration
    public GridPropertiesBuilder()

    GridPropertiesBuilder(Grid<T>)

    Initializes a new instance of the GridPropertiesBuilder<T> class.

    Declaration
    public GridPropertiesBuilder(Grid<T> grid)
    Parameters
    Type Name Description
    Grid<T> grid

    Grid

    Fields

    grid

    Declaration
    public Grid<T> grid
    Field Value
    Type Description
    Grid<T>

    Methods

    AllowCellMerging()

    It sets a value that indicates whether to customizing cell based on our needs.

    Declaration
    public GridPropertiesBuilder<T> AllowCellMerging()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowCellMerging(Boolean)

    It sets a value that indicates whether to customizing cell based on our needs.

    Declaration
    public GridPropertiesBuilder<T> AllowCellMerging(bool allowCellMerging)
    Parameters
    Type Name Description
    System.Boolean allowCellMerging

    It accepts the boolean value and enables or disables the cell to customize

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowFiltering()

    It sets a value that indicates whether to enable dynamic filtering behavior on grid. Filtering can be used to limit the records displayed using required criteria and this can be further customized through “filterSettings” property

    Declaration
    public GridPropertiesBuilder<T> AllowFiltering()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowFiltering(Boolean)

    It sets a value that indicates whether to enable dynamic filtering behavior on grid. Filtering can be used to limit the records displayed using required criteria and this can be further customized through “filterSettings” property

    Declaration
    public GridPropertiesBuilder<T> AllowFiltering(bool allowFiltering)
    Parameters
    Type Name Description
    System.Boolean allowFiltering

    It accepts the boolean value and enables or disables filtering based on the value

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowGrouping()

    It sets a value that indicates whether to enable dynamic grouping behavior. Grouping can be done by drag on drop desired columns to grid’s GroupDropArea. This can be further customized through “groupSettings” property.

    Declaration
    public GridPropertiesBuilder<T> AllowGrouping()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowGrouping(Boolean)

    It sets a value that indicates whether to enable dynamic grouping behavior for particular column.

    Declaration
    public GridPropertiesBuilder<T> AllowGrouping(bool allowGrouping)
    Parameters
    Type Name Description
    System.Boolean allowGrouping

    It accepts the boolean value and enables or disables dynamic grouping based on the value

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowKeyboardNavigation()

    It sets a value that indicates whether to enable keyboard support for performing grid actions. selectionType – It sets a value that indicates whether to enable single row or multiple rows selection behavior in grid. Multiple selection can be done through by holding CTRL and clicking the grid rows

    Declaration
    public GridPropertiesBuilder<T> AllowKeyboardNavigation()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowKeyboardNavigation(Boolean)

    It sets a value that indicates whether to enable keyboard support for performing grid actions. selectionType – It sets a value that indicates whether to enable single row or multiple rows selection behavior in grid. Multiple selection can be done through by holding CTRL and clicking the grid rows

    Declaration
    public GridPropertiesBuilder<T> AllowKeyboardNavigation(bool allowKeyboardNavigation)
    Parameters
    Type Name Description
    System.Boolean allowKeyboardNavigation

    It accepts the boolean value and enables or disables the keyboard support

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowMultipleExporting()

    It sets a value that indicates whether to enable the multiple exporting behavior on grid data.

    Declaration
    public GridPropertiesBuilder<T> AllowMultipleExporting()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowMultiSorting()

    It sets a value that indicates whether to enable multi columns sorting behavior in grid. Sort multiple columns by holding CTRL and click on the corresponding column header.

    Declaration
    public GridPropertiesBuilder<T> AllowMultiSorting()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowMultiSorting(Boolean)

    It sets a value that indicates whether to enable multi columns sorting behavior in grid. Sort multiple columns by holding CTRL and click on the corresponding column header.

    Declaration
    public GridPropertiesBuilder<T> AllowMultiSorting(bool allowMultiSorting)
    Parameters
    Type Name Description
    System.Boolean allowMultiSorting

    It accepts the boolean value and enables or disables the multi column sorting

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowPaging()

    This specifies the grid to show the paginated data. Also enables pager control at the bottom of grid for dynamic navigation through data source. Paging can be further customized through “pageSettings” property.

    Declaration
    public GridPropertiesBuilder<T> AllowPaging()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowPaging(Boolean)

    This specifies the grid to show the paginated data. Also enables pager control at the bottom of grid for dynamic navigation through data source. Paging can be further customized through “pageSettings” property.

    Declaration
    public GridPropertiesBuilder<T> AllowPaging(bool allowPaging)
    Parameters
    Type Name Description
    System.Boolean allowPaging

    It accepts the boolean value and enables or disables the paging

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowReordering()

    It sets a value that indicates whether to enable the columns reordering behavior in the grid. Reordering can be done through by drag and drop the particular column from one index to another index within the grid.

    Declaration
    public GridPropertiesBuilder<T> AllowReordering()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowReordering(Boolean)

    It sets a value that indicates whether to enable the columns reordering behavior in the grid. Reordering can be done through by drag and drop the particular column from one index to another index within the grid.

    Declaration
    public GridPropertiesBuilder<T> AllowReordering(bool allowReordering)
    Parameters
    Type Name Description
    System.Boolean allowReordering

    It accepts the boolean value and enables or disables the reordering for that column

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowResizeToFit()

    It sets a value that indicates whether the column is non resizable. Column width is set automatically based on the content or header text which is large.

    Declaration
    public GridPropertiesBuilder<T> AllowResizeToFit()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowResizeToFit(Boolean)

    It sets a value that indicates whether the column is non resizable. Column width is set automatically based on the content or header text which is large.

    Declaration
    public GridPropertiesBuilder<T> AllowResizeToFit(bool allowResizeToFit)
    Parameters
    Type Name Description
    System.Boolean allowResizeToFit

    It accepts the boolean value and enables or disables the resizing

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowResizing()

    It sets a value that indicates whether to enable dynamic resizable of columns. Resize the width of the columns by simply click and move the particular column header line

    Declaration
    public GridPropertiesBuilder<T> AllowResizing()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowResizing(Boolean)

    It sets a value that indicates whether to enable dynamic resizable of columns. Resize the width of the columns by simply click and move the particular column header line

    Declaration
    public GridPropertiesBuilder<T> AllowResizing(bool allowResizing)
    Parameters
    Type Name Description
    System.Boolean allowResizing

    It accepts the boolean value and enables or disables the dynamic resizing of columns

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowRowDragAndDrop()

    Declaration
    public GridPropertiesBuilder<T> AllowRowDragAndDrop()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    AllowRowDragAndDrop(Boolean)

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

    AllowScrolling()

    It sets a value that indicates whether to enable the scrollbar in the grid and view the records by scroll through the grid manually

    Declaration
    public GridPropertiesBuilder<T> AllowScrolling()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    AllowScrolling(Boolean)

    It sets a value that indicates whether to enable the scrollbar in the grid and view the records by scroll through the grid manually

    Declaration
    public GridPropertiesBuilder<T> AllowScrolling(bool allowScrolling)
    Parameters
    Type Name Description
    System.Boolean allowScrolling

    It accepts the boolean value and enables or disables the scrollbar in the grid

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowSearching()

    It sets a value that indicates whether to enable dynamic searching behavior in grid. Currently search box can be enabled through “toolbarSettings”

    Declaration
    public GridPropertiesBuilder<T> AllowSearching()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowSearching(Boolean)

    It sets a value that indicates whether to enable dynamic searching behavior in grid. Currently search box can be enabled through “toolbarSettings”

    Declaration
    public GridPropertiesBuilder<T> AllowSearching(bool allowSearching)
    Parameters
    Type Name Description
    System.Boolean allowSearching

    It accept the boolean value and enables or disables dynamic searching

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowSelection()

    It sets a value that indicates whether user can select rows on grid. On enabling feature, selected row will be highlighted.

    Declaration
    public GridPropertiesBuilder<T> AllowSelection()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowSelection(Boolean)

    It sets a value that indicates whether user can select rows on grid. On enabling feature, selected row will be highlighted.

    Declaration
    public GridPropertiesBuilder<T> AllowSelection(bool allowSelection)
    Parameters
    Type Name Description
    System.Boolean allowSelection

    It accepts the boolean value and enables or disables the selection for that rows

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowSorting()

    It sets a value that indicates whether to enable the dynamic sorting behavior on grid data. Sorting can be done through clicking on particular column header.

    Declaration
    public GridPropertiesBuilder<T> AllowSorting()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowSorting(Boolean)

    It sets a value that indicates whether to enable the dynamic sorting behavior on grid data. Sorting can be done through clicking on particular column header.

    Declaration
    public GridPropertiesBuilder<T> AllowSorting(bool allowSorting)
    Parameters
    Type Name Description
    System.Boolean allowSorting

    It accepts the boolean value and enables or disables the dynamic sorting

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowTextWrap()

    It sets a value that indicates whether the Content will wrap to the next line if the content exceeds the boundary of the Column Cells.

    Declaration
    public GridPropertiesBuilder<T> AllowTextWrap()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    AllowTextWrap(Boolean)

    It sets a value that indicates whether the Content will wrap to the next line if the content exceeds the boundary of the Column Cells.

    Declaration
    public GridPropertiesBuilder<T> AllowTextWrap(bool allowTextWrap)
    Parameters
    Type Name Description
    System.Boolean allowTextWrap

    It accepts the boolean value and enables or disables the content to wrap into nextline

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    ChildGrid(GridProperties)

    This specifies the grid to add the grid control inside the grid row of the parent with expand/collapse options

    Declaration
    public GridPropertiesBuilder<T> ChildGrid(GridProperties childOption)
    Parameters
    Type Name Description
    GridProperties childOption

    It displays the child Grid inside the gridrow

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    ChildGrid(Action<GridPropertiesBuilder<T>>)

    This specifies the grid to add the grid control inside the grid row of the parent with expand/collapse options

    Declaration
    public GridPropertiesBuilder<T> ChildGrid(Action<GridPropertiesBuilder<T>> childOption)
    Parameters
    Type Name Description
    System.Action<GridPropertiesBuilder<T>> childOption

    It displays the child Grid inside the gridrow through lambda expression

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    ChildGrid<D>(Action<GridPropertiesBuilder<D>>)

    Declaration
    public GridPropertiesBuilder<T> ChildGrid<D>(Action<GridPropertiesBuilder<D>> childOption)
        where D : class
    Parameters
    Type Name Description
    System.Action<GridPropertiesBuilder<D>> childOption
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    Type Parameters
    Name Description
    D

    ClientSideEvents(Action<ClientSideEventsBuilder<T>>)

    It sets the list of Events to perform some grid functionalities.

    Declaration
    public GridPropertiesBuilder<T> ClientSideEvents(Action<ClientSideEventsBuilder<T>> clientSideEvents)
    Parameters
    Type Name Description
    System.Action<ClientSideEventsBuilder<T>> clientSideEvents

    It accepts the list of events through lambda expression.

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    ColumnLayout(ColumnLayout)

    Used to enable or disable static width settings for column. If the columnLayout is set as fixed, then column width will be static.

    Declaration
    public GridPropertiesBuilder<T> ColumnLayout(ColumnLayout columnLayout)
    Parameters
    Type Name Description
    ColumnLayout columnLayout

    It displays the list of ColumnLayout options

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    Columns(Action<ColumnBuilder<T>>)

    It sets an object that indicates to render the grid with specified columns

    Declaration
    public GridPropertiesBuilder<T> Columns(Action<ColumnBuilder<T>> column)
    Parameters
    Type Name Description
    System.Action<ColumnBuilder<T>> column

    It displays the list of columns through lambda expression

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    Columns(List<Column>)

    It sets an object that indicates to render the grid with specified columns

    Declaration
    public GridPropertiesBuilder<T> Columns(List<Column> column)
    Parameters
    Type Name Description
    System.Collections.Generic.List<Column> column

    It displays the list of columns

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    CommonWidth(Int32)

    It sets a value that indicates to define common width for all the columns in the grid.

    Declaration
    public GridPropertiesBuilder<T> CommonWidth(int width)
    Parameters
    Type Name Description
    System.Int32 width

    It accepts the integer value and sets the column width for all columns

    Returns
    Type Description
    GridPropertiesBuilder<T>

    ContextMenuSettings(ContextSettings)

    It sets an object that indicates whether to customize the context menu behavior of the grid.

    Declaration
    public GridPropertiesBuilder<T> ContextMenuSettings(ContextSettings ContextMenu)
    Parameters
    Type Name Description
    ContextSettings ContextMenu

    It displays the list of contextMenu settings option

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    ContextMenuSettings(Action<ContextMenuBuilder<T>>)

    It sets an object that indicates whether to customize the context menu behavior of the grid.

    Declaration
    public GridPropertiesBuilder<T> ContextMenuSettings(Action<ContextMenuBuilder<T>> ContextMenuOption)
    Parameters
    Type Name Description
    System.Action<ContextMenuBuilder<T>> ContextMenuOption

    It displays the list of contextMenu settings option through lambda expression

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    CssClass(String)

    It sets a value that indicates to provide custom CSS for an individual column.

    Declaration
    public GridPropertiesBuilder<T> CssClass(string cssclass)
    Parameters
    Type Name Description
    System.String cssclass

    It accepts the string value and displays the custom css for that column

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    CurrentIndex(Int32)

    Declaration
    public GridPropertiesBuilder<T> CurrentIndex(int currentIndex)
    Parameters
    Type Name Description
    System.Int32 currentIndex
    Returns
    Type Description
    GridPropertiesBuilder<T>

    DataManagerID(String)

    Communicates with data source and returns the desired result based on the Query provided.

    Declaration
    public GridPropertiesBuilder<T> DataManagerID(string id)
    Parameters
    Type Name Description
    System.String id

    It accepts the string value and accepts the datasource

    Returns
    Type Description
    GridPropertiesBuilder<T>

    Datasource(DataSource)

    It sets the data to render the grid with records

    Declaration
    public GridPropertiesBuilder<T> Datasource(DataSource dataSource)
    Parameters
    Type Name Description
    DataSource dataSource

    It displays the list of records

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    Datasource(Action<DataSourceBuilder>)

    It sets the data to render the grid with records

    Declaration
    public GridPropertiesBuilder<T> Datasource(Action<DataSourceBuilder> dataSource)
    Parameters
    Type Name Description
    System.Action<DataSourceBuilder> dataSource

    It displays the list of records through lambda expression

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    Datasource(IEnumerable<T>)

    It sets the data to render the grid with records.

    Declaration
    public GridPropertiesBuilder<T> Datasource(IEnumerable<T> dataSource)
    Parameters
    Type Name Description
    System.Collections.Generic.IEnumerable<T> dataSource

    It display the list of records of type IEnumerable

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    Datasource(IEnumerable)

    It sets the data to render the grid with records.

    Declaration
    public GridPropertiesBuilder<T> Datasource(IEnumerable dataSource)
    Parameters
    Type Name Description
    System.Collections.IEnumerable dataSource

    It display the list of records of type IEnumerable

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    Datasource(DataTable)

    It sets the data to render the grid with records

    Declaration
    public GridPropertiesBuilder<T> Datasource(DataTable dataSource)
    Parameters
    Type Name Description
    System.Data.DataTable dataSource

    It displays the list of records

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    Datasource(String)

    Communicates with data source and returns the desired result based on the url provided.

    Declaration
    public GridPropertiesBuilder<T> Datasource(string dataUrl)
    Parameters
    Type Name Description
    System.String dataUrl

    It accepts the string value and provides the datasource

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    DetailsTemplate(String)

    This specifies the grid to add the details row for the corresponding master row

    Declaration
    public GridPropertiesBuilder<T> DetailsTemplate(string detailsTemplate)
    Parameters
    Type Name Description
    System.String detailsTemplate

    It accepts the string value and displays the detail row for the masterrow

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    EditSettings(EditSettings)

    It sets a value that indicates whether to enable editing behavior for particular column.

    Declaration
    public GridPropertiesBuilder<T> EditSettings(EditSettings editOption)
    Parameters
    Type Name Description
    EditSettings editOption

    It displays the list of ejEditSettings options

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    EditSettings(Action<EditOptionsBuilder<T>>)

    It sets a value that indicates whether to enable editing behavior for particular column.

    Declaration
    public GridPropertiesBuilder<T> EditSettings(Action<EditOptionsBuilder<T>> editOption)
    Parameters
    Type Name Description
    System.Action<EditOptionsBuilder<T>> editOption

    It displays the list of EditSettings options through lambda expression

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    EnableAltRow()

    It sets a value that indicates whether to enable the alternative rows differentiation in the grid records based on corresponding theme.

    Declaration
    public GridPropertiesBuilder<T> EnableAltRow()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    EnableAltRow(Boolean)

    It sets a value that indicates whether to enable the alternative rows differentiation in the grid records based on corresponding theme.

    Declaration
    public GridPropertiesBuilder<T> EnableAltRow(bool enableAltRow)
    Parameters
    Type Name Description
    System.Boolean enableAltRow

    It accepts the boolean value and enables or disables the alternative rows difference in the grid records

    Returns
    Type Description
    GridPropertiesBuilder<T>

    EnableAutoSaveOnSelectionChange()

    It sets a value that indicates whether to enable the save action in the grid through row selection

    Declaration
    public GridPropertiesBuilder<T> EnableAutoSaveOnSelectionChange()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    EnableAutoSaveOnSelectionChange(Boolean)

    It sets a value that indicates whether to enable the save action in the grid through row selection

    Declaration
    public GridPropertiesBuilder<T> EnableAutoSaveOnSelectionChange(bool enableAutoSaveOnSelectionChange)
    Parameters
    Type Name Description
    System.Boolean enableAutoSaveOnSelectionChange

    It accepts the boolean value and enables or disables the save action on rowselection

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    EnableHeaderHover()

    It sets a value that indicates whether to enable mouse over effect on the corresponding column header cell of the grid

    Declaration
    public GridPropertiesBuilder<T> EnableHeaderHover()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    EnableHeaderHover(Boolean)

    It sets a value that indicates whether to enable mouse over effect on the corresponding column header cell of the grid

    Declaration
    public GridPropertiesBuilder<T> EnableHeaderHover(bool enableHeaderHover)
    Parameters
    Type Name Description
    System.Boolean enableHeaderHover

    It accepts the boolean value and enables or disables the mouse over effect on column header

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    EnablePersistence()

    It sets a value that indicates whether to persist the grid model state in page using applicable medium i.e., HTML5 localStorage or cookies

    Declaration
    public GridPropertiesBuilder<T> EnablePersistence()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    EnablePersistence(Boolean)

    It sets a value that indicates whether to persist the grid model state in page using applicable medium i.e., HTML5 localStorage or cookies

    Declaration
    public GridPropertiesBuilder<T> EnablePersistence(bool enablePersistence)
    Parameters
    Type Name Description
    System.Boolean enablePersistence

    It accepts the boolean value and enables or disables the grid model state

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    EnableResponsiveRow()

    It sets a value that indicates whether the grid rows has to be rendered as detail view in mobile mode

    Declaration
    public GridPropertiesBuilder<T> EnableResponsiveRow()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    EnableResponsiveRow(Boolean)

    It sets a value that indicates whether the grid rows has to be rendered as detail view in mobile mode

    Declaration
    public GridPropertiesBuilder<T> EnableResponsiveRow(bool details)
    Parameters
    Type Name Description
    System.Boolean details

    It accepts the boolean value and enables or disables the gridrows to display detailview in mobile mode

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    EnableRowHover()

    It sets a value that indicates whether to enable mouse over effect on corresponding grid row.

    Declaration
    public GridPropertiesBuilder<T> EnableRowHover()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    EnableRowHover(Boolean)

    It sets a value that indicates whether to enable mouse over effect on corresponding grid row.

    Declaration
    public GridPropertiesBuilder<T> EnableRowHover(bool rowHover)
    Parameters
    Type Name Description
    System.Boolean rowHover

    It accepts the boolean value and enables or diables the mouse hover effect

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    EnableRTL()

    Align content in the grid control from right to left by setting the property as true.

    Declaration
    public GridPropertiesBuilder<T> EnableRTL()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    EnableRTL(Boolean)

    Align content in the grid control from right to left by setting the property as true.

    Declaration
    public GridPropertiesBuilder<T> EnableRTL(bool enableRtl)
    Parameters
    Type Name Description
    System.Boolean enableRtl

    It accepts the boolean value and enables or disables to align the grid content from right to left

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    EnableToolbarItems()

    It sets a value that indicates whether to enable toolbar in the grid.

    Declaration
    public GridPropertiesBuilder<T> EnableToolbarItems()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    EnableToolbarItems(Boolean)

    It sets a value that indicates whether to enable toolbar in the grid.

    Declaration
    public GridPropertiesBuilder<T> EnableToolbarItems(bool enableToolbarItems)
    Parameters
    Type Name Description
    System.Boolean enableToolbarItems

    It accepts the boolean value and enables or disables the Toolbar items

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    EnableTouch()

    To Disable the mouse swipe property as false.

    Declaration
    public GridPropertiesBuilder<T> EnableTouch()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    EnableTouch(Boolean)

    To Disable the mouse swipe property as false.

    Declaration
    public GridPropertiesBuilder<T> EnableTouch(bool enableTouch)
    Parameters
    Type Name Description
    System.Boolean enableTouch

    It accepts the boolean value and enables or disables the mouse swipe

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    FilterSettings(FilterSettings)

    It sets an object that indicates whether to customize the filtering behavior of the grid

    Declaration
    public GridPropertiesBuilder<T> FilterSettings(FilterSettings filterOption)
    Parameters
    Type Name Description
    FilterSettings filterOption

    It displays the list of FilterSettings

    Returns
    Type Description
    GridPropertiesBuilder<T>

    FilterSettings(Action<FilterOptionsBuilder<T>>)

    It sets an object that indicates whether to customize the filtering behavior of the grid

    Declaration
    public GridPropertiesBuilder<T> FilterSettings(Action<FilterOptionsBuilder<T>> filterOption)
    Parameters
    Type Name Description
    System.Action<FilterOptionsBuilder<T>> filterOption

    It displays the list of FilterSettings through lambda expression

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    ForeignKeyField(String)

    It sets a value that indicates to define foreign key field name of the grid datasource.

    Declaration
    public GridPropertiesBuilder<T> ForeignKeyField(string foreignKeyField)
    Parameters
    Type Name Description
    System.String foreignKeyField

    It accepts the string value and displays foreignkey field name of the datasource

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    GridLines(GridLines)

    It sets a value that indicates to enable the visibility of the grid lines.

    Declaration
    public GridPropertiesBuilder<T> GridLines(GridLines gridLines)
    Parameters
    Type Name Description
    GridLines gridLines

    It displays the list of GridLines

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    GroupSettings(GroupSettings)

    It sets an object that indicates whether to customize the grouping behavior of the grid.

    Declaration
    public GridPropertiesBuilder<T> GroupSettings(GroupSettings groupOption)
    Parameters
    Type Name Description
    GroupSettings groupOption

    It displays the list of GroupSettings

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    GroupSettings(Action<GroupOptionsBuilder<T>>)

    It sets an object that indicates whether to customize the grouping behavior of the grid.

    Declaration
    public GridPropertiesBuilder<T> GroupSettings(Action<GroupOptionsBuilder<T>> groupOption)
    Parameters
    Type Name Description
    System.Action<GroupOptionsBuilder<T>> groupOption

    It displays the list of GroupSettings through lambda expression

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    HtmlAttributes(IDictionary<String, Object>)

    Declaration
    public GridPropertiesBuilder<T> HtmlAttributes(IDictionary<string, object> Attributes)
    Parameters
    Type Name Description
    System.Collections.Generic.IDictionary<System.String, System.Object> Attributes
    Returns
    Type Description
    GridPropertiesBuilder<T>

    HtmlAttributes(Object)

    Sets a collection of all attribute name and value pairs

    Declaration
    public GridPropertiesBuilder<T> HtmlAttributes(object Attributes)
    Parameters
    Type Name Description
    System.Object Attributes

    It displays the collection of all attributes based on object value passed

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    IsResponsive()

    It sets a value that indicates whether the grid design has be to made responsive.

    Declaration
    public GridPropertiesBuilder<T> IsResponsive()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    IsResponsive(Boolean)

    It sets a value that indicates whether the grid design has be to made responsive.

    Declaration
    public GridPropertiesBuilder<T> IsResponsive(bool responsive)
    Parameters
    Type Name Description
    System.Boolean responsive

    It accepts the boolean value and enables or disables the grid to be responsive

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    Locale(String)

    It sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific to a particular country or region.

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

    It accepts the string and displays in customized language

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    Mappers(Action<MappersBuilder<T>>)

    It sets the list of Exporting function to be performed.

    Declaration
    public GridPropertiesBuilder<T> Mappers(Action<MappersBuilder<T>> mapper)
    Parameters
    Type Name Description
    System.Action<MappersBuilder<T>> mapper

    It accepts the list of exporting functions to be performed through lambda expression

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    MinWidth(Int32)

    It sets a value that indicates whether to set the minimum width of the responsive grid while isResponsive property is true and enableResponsiveRow property is set as false.

    Declaration
    public GridPropertiesBuilder<T> MinWidth(int width)
    Parameters
    Type Name Description
    System.Int32 width

    It accepts the integer value and set the minimun width for the responsive grid

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    PageSettings(PageSettings)

    It sets an object that indicates whether to modify the pager default configuration.

    Declaration
    public GridPropertiesBuilder<T> PageSettings(PageSettings pageOption)
    Parameters
    Type Name Description
    PageSettings pageOption

    It displays the list of PageSettings

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    PageSettings(Action<PageOptionsBuilder<T>>)

    It sets an object that indicates whether to modify the pager default configuration.

    Declaration
    public GridPropertiesBuilder<T> PageSettings(Action<PageOptionsBuilder<T>> pageOption)
    Parameters
    Type Name Description
    System.Action<PageOptionsBuilder<T>> pageOption

    It displays the list of Pagesettings through lambda expression

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    Query(String)

    Query the dataSource from the table for Grid.

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

    It accepts the string value and query the datasource based on the value

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    QueryString(String)

    Query the dataSource from the table for Grid.

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

    It accepts the string to get the datasource from the table

    Returns
    Type Description
    GridPropertiesBuilder<T>

    Render()

    Creates a grid control

    Declaration
    public void Render()

    ResizeSettings(ResizeSettings)

    It sets a value that indicates whether to modify resizing behavior for grid column.

    Declaration
    public GridPropertiesBuilder<T> ResizeSettings(ResizeSettings resizeOption)
    Parameters
    Type Name Description
    ResizeSettings resizeOption

    It displays the list of ResizeSettings options

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    ResizeSettings(Action<ResizeSettingsBuilder<T>>)

    It sets a value that indicates whether to modify the column behavior.

    Declaration
    public GridPropertiesBuilder<T> ResizeSettings(Action<ResizeSettingsBuilder<T>> resizeOption)
    Parameters
    Type Name Description
    System.Action<ResizeSettingsBuilder<T>> resizeOption

    It displays the list of ResizeSettings options through lambda expression

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    RowDropSettings(RowDropSettings)

    It sets an object that indicates whether to customize the drag and drop behavior of the grid rows

    Declaration
    public GridPropertiesBuilder<T> RowDropSettings(RowDropSettings dropSettings)
    Parameters
    Type Name Description
    RowDropSettings dropSettings

    It displays the list of RowDropSettings options

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    RowDropSettings(Action<RowDropSettingsBuilder<T>>)

    It sets an object that indicates whether to customize the drag and drop behavior of the grid rows

    Declaration
    public GridPropertiesBuilder<T> RowDropSettings(Action<RowDropSettingsBuilder<T>> dropSettings)
    Parameters
    Type Name Description
    System.Action<RowDropSettingsBuilder<T>> dropSettings

    It displays the list of ejRowDropSettings through lambda expression

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    RowTemplate(String)

    It sets a value that indicates to render the grid with template rows. The template row must be a table row. That table row must have the JavaScript render binding format () then the grid data source binds the data to the corresponding table row of the template.

    Declaration
    public GridPropertiesBuilder<T> RowTemplate(string rowTemplate)
    Parameters
    Type Name Description
    System.String rowTemplate

    It accepts the string value and render the grid with Template rows

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    ScrollSettings(ScrollSettings)

    It sets an object that indicates whether to customize the scrolling behavior of the grid.

    Declaration
    public GridPropertiesBuilder<T> ScrollSettings(ScrollSettings scrollOption)
    Parameters
    Type Name Description
    ScrollSettings scrollOption

    It accepts the list of ScrollSettings options

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    ScrollSettings(Action<ScrollOptionsBuilder<T>>)

    It sets an object that indicates whether to customize the scrolling behavior of the grid.

    Declaration
    public GridPropertiesBuilder<T> ScrollSettings(Action<ScrollOptionsBuilder<T>> scrollOption)
    Parameters
    Type Name Description
    System.Action<ScrollOptionsBuilder<T>> scrollOption

    It accepts the list of ScrollSettings options through lambda expression

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    SearchSettings(SearchSettings)

    It sets an object that indicates whether to customize the searching behavior of the grid

    Declaration
    public GridPropertiesBuilder<T> SearchSettings(SearchSettings searchOption)
    Parameters
    Type Name Description
    SearchSettings searchOption

    It displays the list of SearchSettings

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    SearchSettings(Action<SearchOptionsBuilders>)

    It sets an object that indicates whether to customize the searching behavior of the grid

    Declaration
    public GridPropertiesBuilder<T> SearchSettings(Action<SearchOptionsBuilders> searchOption)
    Parameters
    Type Name Description
    System.Action<SearchOptionsBuilders> searchOption

    It displays the list of SearchSettings through lambda expression

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    SelectedRowIndex()

    It sets a value that indicates to select the row while initializing the grid

    Declaration
    public GridPropertiesBuilder<T> SelectedRowIndex()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    SelectedRowIndex(Int32)

    It sets a value that indicates to select the row while initializing the grid

    Declaration
    public GridPropertiesBuilder<T> SelectedRowIndex(int selectedRow)
    Parameters
    Type Name Description
    System.Int32 selectedRow

    It accepts the integer value and selects the row based on the value

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    SelectedRowIndices()

    It sets a value that indicates to select the rows while initializing the grid

    Declaration
    public GridPropertiesBuilder<T> SelectedRowIndices()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    SelectedRowIndices(List<Int32>)

    It sets a value that indicates to select the rows while initializing the grid

    Declaration
    public GridPropertiesBuilder<T> SelectedRowIndices(List<int> select)
    Parameters
    Type Name Description
    System.Collections.Generic.List<System.Int32> select
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    SelectionSettings(SelectionSettings)

    This property is used to configure the selection behavior of the grid.

    Declaration
    public GridPropertiesBuilder<T> SelectionSettings(SelectionSettings selection)
    Parameters
    Type Name Description
    SelectionSettings selection

    It displays the list of ejSelectionSettings options for selection behaviour

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    SelectionSettings(Action<SelectionOptionsBuilder<T>>)

    This property is used to configure the selection behavior of the grid.

    Declaration
    public GridPropertiesBuilder<T> SelectionSettings(Action<SelectionOptionsBuilder<T>> selectionOption)
    Parameters
    Type Name Description
    System.Action<SelectionOptionsBuilder<T>> selectionOption

    It displays the list of SelectionSettings options for selection behaviour through lambda expression

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    SelectionType(SelectionType)

    The row selection behavior of grid. Accepting types are “single” and “multiple”.

    Declaration
    public GridPropertiesBuilder<T> SelectionType(SelectionType selectionType)
    Parameters
    Type Name Description
    SelectionType selectionType

    It displays the list of SelectionType options

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    ShowColumnChooser()

    Used to hide the particular column in column chooser by giving value as false.

    Declaration
    public GridPropertiesBuilder<T> ShowColumnChooser()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    ShowStackedHeader()

    It sets a value that indicates stacked header should be shown on grid layout when the property “stackedHeaderRows” is set.

    Declaration
    public GridPropertiesBuilder<T> ShowStackedHeader()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    ShowSummary()

    It sets a value that indicates summary rows should be shown on grid layout when the property “summaryRows” is set

    Declaration
    public GridPropertiesBuilder<T> ShowSummary()
    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    ShowSummary(Boolean)

    It sets a value that indicates summary rows should be shown on grid layout when the property “summaryRows” is set

    Declaration
    public GridPropertiesBuilder<T> ShowSummary(bool showSummary)
    Parameters
    Type Name Description
    System.Boolean showSummary

    It accepts the boolean value and enables or disables the summary rows

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    SortSettings(SortSettings)

    It sets a value that indicates whether to customize the sorting behavior of the grid.

    Declaration
    public GridPropertiesBuilder<T> SortSettings(SortSettings sortOption)
    Parameters
    Type Name Description
    SortSettings sortOption

    It displays list of SortSettings options

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    SortSettings(Action<SortOptionsBuilder<T>>)

    It sets a value that indicates whether to customize the sorting behavior of the grid.

    Declaration
    public GridPropertiesBuilder<T> SortSettings(Action<SortOptionsBuilder<T>> sortOption)
    Parameters
    Type Name Description
    System.Action<SortOptionsBuilder<T>> sortOption

    It displays list of SortSettings options through lambda expression

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    StackedHeaderRows(Action<StackedHeaderRowsBuilder<T>>)

    It sets an object that indicates to managing the collection of stacked header rows for the grid.

    Declaration
    public GridPropertiesBuilder<T> StackedHeaderRows(Action<StackedHeaderRowsBuilder<T>> stcakedHeaderRow)
    Parameters
    Type Name Description
    System.Action<StackedHeaderRowsBuilder<T>> stcakedHeaderRow

    It displays the collection of stackedHeader Rows through lambda expression

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    StackedHeaderRows(List<StackedHeaderRow>)

    It sets an object that indicates to managing the collection of stacked header rows for the grid.

    Declaration
    public GridPropertiesBuilder<T> StackedHeaderRows(List<StackedHeaderRow> stackedHeaderRow)
    Parameters
    Type Name Description
    System.Collections.Generic.List<StackedHeaderRow> stackedHeaderRow

    It displays the collection of stackedHeader Rows

    Returns
    Type Description
    GridPropertiesBuilder<T>

    SummaryRow(Action<SummaryRowsBuilder<T>>)

    It sets an object that indicates to managing the collection of summary rows for the grid.

    Declaration
    public GridPropertiesBuilder<T> SummaryRow(Action<SummaryRowsBuilder<T>> summaryRow)
    Parameters
    Type Name Description
    System.Action<SummaryRowsBuilder<T>> summaryRow

    It displays collection of SummaryRows through lambda expression

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    SummaryRow(List<SummaryRow>)

    It sets an object that indicates to managing the collection of summary rows for the grid.

    Declaration
    public GridPropertiesBuilder<T> SummaryRow(List<SummaryRow> summaryRow)
    Parameters
    Type Name Description
    System.Collections.Generic.List<SummaryRow> summaryRow

    It displays the collection of SummaryRows

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    TextWrapSettings(TextWrapSettings)

    It sets an object that indicates whether to auto wrap the grid header or content or both

    Declaration
    public GridPropertiesBuilder<T> TextWrapSettings(TextWrapSettings textWrapOption)
    Parameters
    Type Name Description
    TextWrapSettings textWrapOption

    It displays the list of WrapSettings

    Returns
    Type Description
    GridPropertiesBuilder<T>

    TextWrapSettings(Action<TextWrapOptionsBuilder<T>>)

    It sets an object that indicates whether to auto wrap the grid header or content or both

    Declaration
    public GridPropertiesBuilder<T> TextWrapSettings(Action<TextWrapOptionsBuilder<T>> textWrapOption)
    Parameters
    Type Name Description
    System.Action<TextWrapOptionsBuilder<T>> textWrapOption

    It displays the list of WrapSettings through lambda expression

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    ToHtmlString()

    It converts the Grid properties into Html elements.

    Declaration
    public string ToHtmlString()
    Returns
    Type Description
    System.String

    GridPropertiesBuilder

    ToolbarSettings(ToolbarSettings)

    It sets an object that indicates whether to enable the toolbar in the grid and add toolbar items

    Declaration
    public GridPropertiesBuilder<T> ToolbarSettings(ToolbarSettings toolBar)
    Parameters
    Type Name Description
    ToolbarSettings toolBar

    It displays the list of ToolbarSettings options

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    ToolbarSettings(Action<ToolBarBuilder<T>>)

    It sets an object that indicates whether to enable the toolbar in the grid and add toolbar items

    Declaration
    public GridPropertiesBuilder<T> ToolbarSettings(Action<ToolBarBuilder<T>> toolBarOption)
    Parameters
    Type Name Description
    System.Action<ToolBarBuilder<T>> toolBarOption

    It displays the list of ToolbarSettings through lambda expression

    Returns
    Type Description
    GridPropertiesBuilder<T>

    GridPropertiesBuilder

    Implements

    IPropertiesBuilder
    System.Web.IHtmlString
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved