Class GridProperties

Gets or sets an object that indicates whether to customize the property of the grid.

Inheritance
System.Object
EJTagHelper
GridProperties
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.Models
Assembly: Syncfusion.EJ.dll
Syntax
public class GridProperties : EJTagHelper

Constructors

GridProperties()

Declaration
public GridProperties()

Properties

ActionBegin

Triggered for every grid action before its starts.

Declaration
[JsonProperty("actionBegin")]
public string ActionBegin { get; set; }
Property Value
Type Description
System.String

ActionComplete

Triggered for every grid action success event.

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

ActionFailure

Triggered for every grid action server failure event.

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

AllowCellMerging

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

Declaration
[JsonProperty("allowCellMerging")]
public bool AllowCellMerging { get; set; }
Property Value
Type Description
System.Boolean

AllowFiltering

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

AllowGrouping

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

AllowKeyboardNavigation

Gets or sets a value that indicates whether to enable keyboard support for performing grid actions. selectionType – Gets or 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
[JsonProperty("allowKeyboardNavigation")]
public bool AllowKeyboardNavigation { get; set; }
Property Value
Type Description
System.Boolean

AllowMultipleExporting

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

Declaration
[JsonProperty("allowMultipleExporting")]
public bool AllowMultipleExporting { get; set; }
Property Value
Type Description
System.Boolean

AllowMultiSorting

Gets or 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
[JsonProperty("allowMultiSorting")]
public bool AllowMultiSorting { get; set; }
Property Value
Type Description
System.Boolean

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

AllowReordering

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

AllowResizeToFit

Gets or 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
[JsonProperty("allowResizeToFit")]
public bool AllowResizeToFit { get; set; }
Property Value
Type Description
System.Boolean

AllowResizing

Gets or 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
[JsonProperty("allowResizing")]
public bool AllowResizing { get; set; }
Property Value
Type Description
System.Boolean

AllowRowDragAndDrop

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

AllowScrolling

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

Declaration
[JsonProperty("allowScrolling")]
public bool AllowScrolling { get; set; }
Property Value
Type Description
System.Boolean

AllowSearching

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

Declaration
[JsonProperty("allowSearching")]
public bool AllowSearching { get; set; }
Property Value
Type Description
System.Boolean

AllowSelection

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

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

AllowSorting

Gets or 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
[JsonProperty("allowSorting")]
public bool AllowSorting { get; set; }
Property Value
Type Description
System.Boolean

AllowTextWrap

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

AutoFormat

Gets or sets a value that indicates whether to auto format the grid.

Declaration
public AutoFormat AutoFormat { get; set; }
Property Value
Type Description
AutoFormat

BatchAdd

Triggered when record batch add.

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

BatchDelete

Triggered when record batch delete.

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

BeforeBatchAdd

Triggered before the batch add.

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

BeforeBatchDelete

Triggered before the batch delete.

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

BeforeBatchSave

Triggered before the batch save.

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

BeforePrint

Triggered when before print the grid .

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

BeforeRowDrop

Triggered when the row is before dropped.

Declaration
[JsonProperty("beforeRowDrop")]
public string BeforeRowDrop { get; set; }
Property Value
Type Description
System.String

BeginEdit

Triggered before the record is going to be edited.

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

CellDeselected

Triggered after the cell is deselected.

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

CellDeselecting

Triggered before the cell is going to be deselected.

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

CellEdit

Triggered when record cell edit.

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

CellSave

Triggered when record cell save.

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

CellSelected

Triggered after the column is selected.

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

CellSelecting

Triggered before the cell is going to be selected.

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

CheckedRowIndices

Gets or sets a value that indicates to select the row while initializing the grid.

Declaration
[JsonProperty("_checkedRowIndices")]
public ArrayList CheckedRowIndices { get; set; }
Property Value
Type Description
System.Collections.ArrayList

ChildGrid

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

Declaration
[SetLiteral]
[JsonProperty("childGrid")]
public GridProperties ChildGrid { get; set; }
Property Value
Type Description
GridProperties

ColumnDeselected

Triggered after the column is deselected.

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

ColumnDeselecting

Triggered before the column is going to be deselected.

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

ColumnDrag

Triggered when the column is being dragged.

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

ColumnDragStart

Triggered when column dragging begins.

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

ColumnDrop

Triggered when the column is dropped.

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

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
[JsonProperty("columnLayout")]
[JsonConverter(typeof(StringEnumConverter))]
public ColumnLayout ColumnLayout { get; set; }
Property Value
Type Description
ColumnLayout

Columns

Gets or sets an object that indicates to render the grid with specified columns.

Declaration
[JsonProperty("columns")]
public List<Column> Columns { get; set; }
Property Value
Type Description
System.Collections.Generic.List<Column>

ColumnSelected

Triggered after the column is selected.

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

ColumnSelecting

Triggered before the column is going to be selected.

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

CommonWidth

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

Declaration
[JsonProperty("commonWidth")]
public int CommonWidth { get; set; }
Property Value
Type Description
System.Int32

ContextClick

Triggered when context menu item is clicked

Declaration
[JsonProperty("contextClick")]
public string ContextClick { get; set; }
Property Value
Type Description
System.String

ContextOpen

Triggered before the context menu is opened.

Declaration
[JsonProperty("contextOpen")]
public string ContextOpen { get; set; }
Property Value
Type Description
System.String

ContextSettings

Gets or sets an object that indicates whether to customize the context behavior of the grid.

Declaration
[JsonProperty("contextMenuSettings")]
public ContextSettings ContextSettings { get; set; }
Property Value
Type Description
ContextSettings

Create

Triggered when the grid is rendered completely.

Declaration
[JsonProperty("create")]
public string Create { get; set; }
Property Value
Type Description
System.String

CssClass

Gets or sets a value that indicates to render the grid with custom theme.

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

CurrentIndex

Gets or sets a value that indicates whether to define the current index of the grid.

Declaration
[JsonProperty("currentIndex")]
public int CurrentIndex { get; set; }
Property Value
Type Description
System.Int32

DataBound

Triggered when the grid is bound with data during initial rendering.

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

DataManagerID

Gets or sets a value that indicates to define the data manager id in the grid.

Declaration
[HtmlAttributeName("datasource")]
[JsonProperty("dataSource")]
[JsonConverter(typeof(DataManagerConverter), "ID")]
public string DataManagerID { get; set; }
Property Value
Type Description
System.String

DataSource

Gets or sets the data to render the grid with records.

Declaration
[JsonProperty("dataSource")]
[HtmlAttributeName("datasource")]
[JsonConverter(typeof(DataManagerConverter))]
public object DataSource { get; set; }
Property Value
Type Description
System.Object

Destroy

Triggered when grid going to destroy.

Declaration
[JsonProperty("destroy")]
public string Destroy { get; set; }
Property Value
Type Description
System.String

DetailsCollapse

Triggered when detail template row is clicked to collapse.

Declaration
[JsonProperty("detailsCollapse")]
public string DetailsCollapse { get; set; }
Property Value
Type Description
System.String

DetailsDataBound

Triggered detail template row is initialized.

Declaration
[JsonProperty("detailsDataBound")]
public string DetailsDataBound { get; set; }
Property Value
Type Description
System.String

DetailsExpand

Triggered when detail template row is clicked to expand.

Declaration
[JsonProperty("detailsExpand")]
public string DetailsExpand { get; set; }
Property Value
Type Description
System.String

DetailsTemplate

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

Declaration
[JsonProperty("detailsTemplate")]
public string DetailsTemplate { get; set; }
Property Value
Type Description
System.String

EditSettings

Gets or sets an object that indicates whether to customize the editing behavior of the grid.

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

EnableAltRow

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

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

EnableAutoSaveOnSelectionChange

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

Declaration
[JsonProperty("enableAutoSaveOnSelectionChange")]
public bool EnableAutoSaveOnSelectionChange { get; set; }
Property Value
Type Description
System.Boolean

EnableHeaderHover

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

Declaration
[JsonProperty("enableHeaderHover")]
public bool EnableHeaderHover { get; set; }
Property Value
Type Description
System.Boolean

EnableLoadOnDemand

Gets or sets a value that indicates whether to enable Load on Demand for SqlDataSource.

Declaration
[JsonProperty("enableLoadOnDemand")]
public bool EnableLoadOnDemand { get; set; }
Property Value
Type Description
System.Boolean

EnablePersistence

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

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

EnableResponsiveRow

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

Declaration
[JsonProperty("enableResponsiveRow")]
public bool EnableResponsiveRow { get; set; }
Property Value
Type Description
System.Boolean

EnableRowHover

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

Declaration
[JsonProperty("enableRowHover")]
public bool EnableRowHover { get; set; }
Property Value
Type Description
System.Boolean

EnableRTL

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

Declaration
[JsonProperty("enableRTL")]
public bool EnableRTL { get; set; }
Property Value
Type Description
System.Boolean

EnableToolbarItems

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

Declaration
[JsonProperty("enableToolbarItems")]
public bool EnableToolbarItems { get; set; }
Property Value
Type Description
System.Boolean

EnableTouch

To Disable the mouse swipe property as false.

Declaration
[JsonProperty("enableTouch")]
public bool EnableTouch { get; set; }
Property Value
Type Description
System.Boolean

EndAdd

Triggered after the record is added.

Declaration
[JsonProperty("endAdd")]
public string EndAdd { get; set; }
Property Value
Type Description
System.String

EndDelete

Triggered after the record is deleted.

Declaration
[JsonProperty("endDelete")]
public string EndDelete { get; set; }
Property Value
Type Description
System.String

EndEdit

Triggered after the record is edited.

Declaration
[JsonProperty("endEdit")]
public string EndEdit { get; set; }
Property Value
Type Description
System.String

ExcelChildGridInfo

The ExcelChildGridInfo event is triggered every time a child Grid rendered to the Excel document.

Declaration
public Action<object, object, object> ExcelChildGridInfo { get; set; }
Property Value
Type Description
System.Action<System.Object, System.Object, System.Object>

ExcelColumnTemplateInfo

Declaration
public Action<object, object> ExcelColumnTemplateInfo { get; set; }
Property Value
Type Description
System.Action<System.Object, System.Object>

ExcelDetailTemplateInfo

Declaration
public Action<object, object> ExcelDetailTemplateInfo { get; set; }
Property Value
Type Description
System.Action<System.Object, System.Object>

ExportToExcelAction

Export the grid content to excel document.

Declaration
[JsonProperty("exportToExcelAction")]
public string ExportToExcelAction { get; set; }
Property Value
Type Description
System.String

ExportToPdfAction

Export the grid content to PDF document.

Declaration
[JsonProperty("exportToPdfAction")]
public string ExportToPdfAction { get; set; }
Property Value
Type Description
System.String

ExportToWordAction

Export the grid content to word document.

Declaration
[JsonProperty("exportToWordAction")]
public string ExportToWordAction { get; set; }
Property Value
Type Description
System.String

FilterSettings

Gets or sets an object that indicates whether to customize the filtering behavior of the grid.

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

ForeignKeyField

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

Declaration
[JsonProperty("foreignKeyField")]
public string ForeignKeyField { get; set; }
Property Value
Type Description
System.String

GridLines

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

Declaration
[JsonProperty("gridLines")]
[JsonConverter(typeof(StringEnumConverter))]
public GridLines GridLines { get; set; }
Property Value
Type Description
GridLines

GroupSettings

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

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

Height

Gets or sets a value that indicates to define common height for the grid.

Declaration
[JsonProperty("height")]
public object Height { get; set; }
Property Value
Type Description
System.Object

HtmlAttributes

Gets or sets an object that indicates whether the HtmlAttributes of the grid.

Declaration
[JsonIgnore]
public object HtmlAttributes { get; set; }
Property Value
Type Description
System.Object

IsResponsive

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

Declaration
[JsonProperty("isResponsive")]
public bool IsResponsive { get; set; }
Property Value
Type Description
System.Boolean

KeySettings

Gets or sets an object that indicates whether to customize the keboard setting behavior of the grid.

Declaration
[JsonProperty("keySettings")]
public KeySettings KeySettings { get; set; }
Property Value
Type Description
KeySettings

Load

Triggered initial load.

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

Locale

Gets or 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
[JsonProperty("locale")]
public string Locale { get; set; }
Property Value
Type Description
System.String

MergeCellInfo

Triggered every time a request is made to access particular cell information, element and data.

Declaration
[JsonProperty("mergeCellInfo")]
public string MergeCellInfo { get; set; }
Property Value
Type Description
System.String

MergeHeaderCellInfo

Triggered every time a request is made to access particular header cell information, element and data.

Declaration
[JsonProperty("mergeHeaderCellInfo")]
public string MergeHeaderCellInfo { get; set; }
Property Value
Type Description
System.String

MinWidth

Gets or sets a value that indicates whether to customizing minwidth of the grid.

Declaration
[JsonProperty("minWidth")]
public int MinWidth { get; set; }
Property Value
Type Description
System.Int32

PageSettings

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

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

PdfChildGridInfo

The PdfChildGridInfo event is triggered every time a child Grid rendered to the Pdf document.

Declaration
public Action<object, object, object> PdfChildGridInfo { get; set; }
Property Value
Type Description
System.Action<System.Object, System.Object, System.Object>

PdfColumnTemplateInfo

Declaration
public Action<object, object> PdfColumnTemplateInfo { get; set; }
Property Value
Type Description
System.Action<System.Object, System.Object>

PdfDetailTemplateInfo

Declaration
public Action<object, object> PdfDetailTemplateInfo { get; set; }
Property Value
Type Description
System.Action<System.Object, System.Object>

Query

Query the dataSource from the table for Grid.

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

QueryCellInfo

Triggered every time a request is made to access particular cell information, element and data.

Declaration
[JsonProperty("queryCellInfo")]
public string QueryCellInfo { get; set; }
Property Value
Type Description
System.String

QueryString

Gets or sets a value that indicates whether to pass the current page information as a query string along with the URL while navigating to other page.

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

RecordClick

Triggered when record is clicked.

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

RecordDoubleClick

Triggered when record is double clicked.

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

Resized

Triggered after column resized.

Declaration
[JsonProperty("resized")]
public string Resized { get; set; }
Property Value
Type Description
System.String

ResizeEnd

Triggered when column resize end.

Declaration
[JsonProperty("resizeEnd")]
public string ResizeEnd { get; set; }
Property Value
Type Description
System.String

ResizeSettings

Gets or sets an object that indicates whether to customize the editing behavior of the grid.

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

ResizeStart

Triggered when column resize start.

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

RightClick

Triggered when right clicked on grid element.

Declaration
[JsonProperty("rightClick")]
public string RightClick { get; set; }
Property Value
Type Description
System.String

RowDataBound

Triggered every time a request is made to access row information, element and data.

Declaration
[JsonProperty("rowDataBound")]
public string RowDataBound { get; set; }
Property Value
Type Description
System.String

RowDeselected

Triggered after the row is deselected.

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

RowDeselecting

Triggered before the row is going to be deselected.

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

RowDrag

Triggered when the row is being dragged.

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

RowDragStart

Triggered when row dragging begins.

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

RowDrop

Triggered when the row is being dropped.

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

RowDropSettings

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

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

RowHover

Triggered while hover the row in the grid .

Declaration
[JsonProperty("rowHover")]
public string RowHover { get; set; }
Property Value
Type Description
System.String

RowSelected

Triggered after the row is selected.

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

RowSelecting

Triggered before the row is going to be selected.

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

RowTemplate

Gets or 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
[JsonProperty("rowTemplate")]
public string RowTemplate { get; set; }
Property Value
Type Description
System.String

ScrollSettings

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

Declaration
[JsonProperty("scrollSettings")]
public ScrollSettings ScrollSettings { get; set; }
Property Value
Type Description
ScrollSettings

SearchSettings

Gets or sets an object that indicates whether to customize the searching behavior of the grid.

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

SelectedRowIndex

Gets or sets a value that indicates to select the row while initializing the grid.

Declaration
[JsonProperty("selectedRowIndex")]
public int SelectedRowIndex { get; set; }
Property Value
Type Description
System.Int32

SelectedRowIndices

Gets or sets a value that indicates to select the row while initializing the grid.

Declaration
[JsonProperty("selectedRowIndices")]
public List<int> SelectedRowIndices { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.Int32>

SelectionSettings

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

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

Selectiontype

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

Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("selectionType")]
public SelectionType Selectiontype { get; set; }
Property Value
Type Description
SelectionType

ServerExcelGroupCaptionInfo

The OnServerExcelGroupCaptionFormating event is triggered every time a group caption row created on the excel sheet.

Declaration
public Action<object> ServerExcelGroupCaptionInfo { get; set; }
Property Value
Type Description
System.Action<System.Object>

ServerExcelQueryCellInfo

The OnServerExcelQueryCellInfo event is triggered every time a data is entered into a cell of the Excel sheet. So this event is triggered as many times as the data is entered into a cell written in the excel sheet. The properties corresponding to the XlsIO IRange Class are obtained from server-side.

Declaration
public Action<object> ServerExcelQueryCellInfo { get; set; }
Property Value
Type Description
System.Action<System.Object>

ServerExcelRowInfo

The OnServerExcelRowInfo event is triggered every time a row is appended to the excel sheet. The properties corresponding to the XlsIO IRange Class are obtained server-side.

Declaration
public Action<object> ServerExcelRowInfo { get; set; }
Property Value
Type Description
System.Action<System.Object>

ServerPdfGroupCaptionInfo

The OnServerExcelGroupCaptionFormating event is triggered every time a group caption row created on the excel sheet.

Declaration
public Action<object> ServerPdfGroupCaptionInfo { get; set; }
Property Value
Type Description
System.Action<System.Object>

ServerPdfQueryCellInfo

The OnServerPdfQueryCellInfo event is triggered every time data is written to the cell of the PdfGrid table. So this event is triggered as many times as that of the cell written to the grid table. The properties corresponding to the Pdf.Grid.PdfGridCell Class are obtained server-side.

Declaration
public Action<object> ServerPdfQueryCellInfo { get; set; }
Property Value
Type Description
System.Action<System.Object>

ServerPdfRowInfo

The OnServerPdfRowInfo event is triggered every time a row is inserted to the PdfGrid. The properties corresponding to the Pdf.Grid.PdfGridRow Class are obtained server-side.

Declaration
public Action<object> ServerPdfRowInfo { get; set; }
Property Value
Type Description
System.Action<System.Object>

ServerWordGroupCaptionInfo

The OnServerWordGroupCaptionFormating event is triggered every time a group caption row created on the excel sheet.

Declaration
public Action<object> ServerWordGroupCaptionInfo { get; set; }
Property Value
Type Description
System.Action<System.Object>

ServerWordQueryCellInfo

The OnServerWordQueryCellInfo event is triggered every time a cell data is written to the Word document. So this event is triggered as many times as that of the cell written to the word document. The properties corresponding to the DocIO.DLS.WTableCell Class is obtained server-side.

Declaration
public Action<object> ServerWordQueryCellInfo { get; set; }
Property Value
Type Description
System.Action<System.Object>

ServerWordRowInfo

The OnServerWordRowInfo event is triggered every time a row is inserted into the word document. The properties corresponding to the DocIO.DLS.WTableRow Class is obtained server-side.

Declaration
public Action<object> ServerWordRowInfo { get; set; }
Property Value
Type Description
System.Action<System.Object>

ShowColumnChooser

Gets or sets a value that indicates whether to enable column chooser on grid. On enabling feature able to show/hide grid columns.

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

ShowStackedHeader

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

Declaration
[JsonProperty("showStackedHeader")]
public bool ShowStackedHeader { get; set; }
Property Value
Type Description
System.Boolean

ShowSummary

Gets or sets a value that indicates summary should be shown on grid layout when the property “ShowSummary” is set.

Declaration
[JsonProperty("showSummary")]
public bool ShowSummary { get; set; }
Property Value
Type Description
System.Boolean

SortedColumns

Gets or sets a value that indicates whether to define the direction and field to sort the column.

Declaration
[JsonProperty("sortedColumns")]
[JsonIgnore]
public List<SortedColumn> SortedColumns { get; set; }
Property Value
Type Description
System.Collections.Generic.List<SortedColumn>

SortSettings

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

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

StackedHeaderRows

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

Declaration
[JsonProperty("stackedHeaderRows")]
public List<StackedHeaderRow> StackedHeaderRows { get; set; }
Property Value
Type Description
System.Collections.Generic.List<StackedHeaderRow>

SummaryRows

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

Declaration
[JsonProperty("summaryRows")]
public List<SummaryRow> SummaryRows { get; set; }
Property Value
Type Description
System.Collections.Generic.List<SummaryRow>

TemplateRefresh

Triggered when refresh the template column elements in the Grid.

Declaration
[JsonProperty("templateRefresh")]
public string TemplateRefresh { get; set; }
Property Value
Type Description
System.String

TextWrapSettings

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

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

ToolbarClick

Triggered when toolbar item is clicked in grid.

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

ToolbarSettings

Gets or sets an object that indicates whether to enable the toolbar in the grid and add toolbar items.

Declaration
[JsonProperty("toolbarSettings")]
public ToolbarSettings ToolbarSettings { get; set; }
Property Value
Type Description
ToolbarSettings

VirtualLoading

Declaration
[JsonProperty("virtualLoading")]
public string VirtualLoading { get; set; }
Property Value
Type Description
System.String

Width

Gets or sets a value that indicates to define width for all the columns in the grid.

Declaration
[JsonProperty("width")]
public object Width { get; set; }
Property Value
Type Description
System.Object

WordChildGridInfo

The WordChildGridInfo event is triggered every time a child Grid rendered to the Word document.

Declaration
public Action<object, object, object> WordChildGridInfo { get; set; }
Property Value
Type Description
System.Action<System.Object, System.Object, System.Object>

WordColumnTemplateInfo

Declaration
public Action<object, object> WordColumnTemplateInfo { get; set; }
Property Value
Type Description
System.Action<System.Object, System.Object>

WordDetailTemplateInfo

Declaration
public Action<object, object> WordDetailTemplateInfo { get; set; }
Property Value
Type Description
System.Action<System.Object, System.Object>

Methods

GetControlDetails()

Declaration
protected override object GetControlDetails()
Returns
Type Description
System.Object
Overrides

ShouldSerializeColumns()

Gets or sets a value that indicates whether the columns should serialize.

Declaration
public bool ShouldSerializeColumns()
Returns
Type Description
System.Boolean

The method returns a Boolean.

ShouldSerializeEditOption()

Gets or sets a value that indicates whether the edit settings should serialize.

Declaration
public bool ShouldSerializeEditOption()
Returns
Type Description
System.Boolean

The method returns a Boolean.

ShouldSerializeFilterOption()

Gets or sets a value that indicates whether the filter settings should serialize.

Declaration
public bool ShouldSerializeFilterOption()
Returns
Type Description
System.Boolean

The method returns a Boolean.

ShouldSerializeGroupOption()

Gets or sets a value that indicates whether the group settings should serialize.

Declaration
public bool ShouldSerializeGroupOption()
Returns
Type Description
System.Boolean

The method returns a Boolean.

ShouldSerializeKeyboardOption()

Gets or sets a value that indicates whether the key settings should serialize.

Declaration
public bool ShouldSerializeKeyboardOption()
Returns
Type Description
System.Boolean

The method returns a Boolean.

ShouldSerializePageOption()

Gets or sets a value that indicates whether the page settings should serialize.

Declaration
public bool ShouldSerializePageOption()
Returns
Type Description
System.Boolean

The method returns a Boolean.

ShouldSerializeScrollOption()

Gets or sets a value that indicates whether the scroll settings should serialize.

Declaration
public bool ShouldSerializeScrollOption()
Returns
Type Description
System.Boolean

The method returns a Boolean.

ShouldSerializeSortOption()

Gets or sets a value that indicates whether the grid settings should serialize.

Declaration
public bool ShouldSerializeSortOption()
Returns
Type Description
System.Boolean

The method returns a Boolean.

ShouldSerializeStackedHeaderRow()

Gets or sets a value that indicates whether the stacked header row should serialize.

Declaration
public bool ShouldSerializeStackedHeaderRow()
Returns
Type Description
System.Boolean

The method returns a Boolean.

ShouldSerializeSummaryRow()

Gets or sets a value that indicates whether the summary rows should serialize.

Declaration
public bool ShouldSerializeSummaryRow()
Returns
Type Description
System.Boolean

The method returns a Boolean.

ShouldSerializeToolbar()

Gets or sets a value that indicates whether the toolbar should serialize.

Declaration
public bool ShouldSerializeToolbar()
Returns
Type Description
System.Boolean

The method returns a Boolean.