Class Grid

Inheritance

System.Object

CommonDataBoundControl

Grid

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService

Inherited Members

CommonDataBoundControl.PerformDataBinding(IEnumerable)

CommonDataBoundControl.RaisePostBackEvent(String)

CommonDataBoundControl.OnLoad(EventArgs)

CommonDataBoundControl.OnPreRender(EventArgs)

CommonDataBoundControl.RenderContents(HtmlTextWriter)

Namespace: Syncfusion.JavaScript.Web

Assembly: Syncfusion.EJ.Web.dll

Syntax

public class Grid : CommonDataBoundControl, INamingContainer, IPostBackEventHandler, IPostBackDataHandler, IUrlResolutionService

Constructors

Grid()

Declaration

public Grid()

Properties

AllowCellMerging

Declaration

public bool AllowCellMerging { get; set; }

Property Value

Type	Description
System.Boolean

AllowFiltering

Declaration

public bool AllowFiltering { get; set; }

Property Value

Type	Description
System.Boolean

AllowGrouping

Declaration

public bool AllowGrouping { get; set; }

Property Value

Type	Description
System.Boolean

AllowKeyboardNavigation

Declaration

public bool AllowKeyboardNavigation { get; set; }

Property Value

Type	Description
System.Boolean

AllowMultiSorting

Declaration

public bool AllowMultiSorting { get; set; }

Property Value

Type	Description
System.Boolean

AllowPaging

Declaration

public bool AllowPaging { get; set; }

Property Value

Type	Description
System.Boolean

AllowReordering

Declaration

public bool AllowReordering { get; set; }

Property Value

Type	Description
System.Boolean

AllowResizeToFit

Declaration

public bool AllowResizeToFit { get; set; }

Property Value

Type	Description
System.Boolean

AllowResizing

Declaration

public bool AllowResizing { get; set; }

Property Value

Type	Description
System.Boolean

AllowRowDragAndDrop

Declaration

public bool AllowRowDragAndDrop { get; set; }

Property Value

Type	Description
System.Boolean

AllowScrolling

Declaration

public bool AllowScrolling { get; set; }

Property Value

Type	Description
System.Boolean

AllowSearching

Declaration

public bool AllowSearching { get; set; }

Property Value

Type	Description
System.Boolean

AllowSelection

Declaration

public bool AllowSelection { get; set; }

Property Value

Type	Description
System.Boolean

AllowSorting

Declaration

public bool AllowSorting { get; set; }

Property Value

Type	Description
System.Boolean

AllowTextWrap

Declaration

public bool AllowTextWrap { get; set; }

Property Value

Type	Description
System.Boolean

ClientSideEvents

Declaration

public ClientSideEvents ClientSideEvents { get; set; }

Property Value

Type	Description
ClientSideEvents

ColumnLayout

Declaration

public ColumnLayout ColumnLayout { get; set; }

Property Value

Type	Description
ColumnLayout

Columns

Declaration

public List<Column> Columns { get; }

Property Value

Type	Description
System.Collections.Generic.List<Column>

CommonWidth

Declaration

public int CommonWidth { get; set; }

Property Value

Type	Description
System.Int32

ContextMenuSettings

Declaration

public ContextSettings ContextMenuSettings { get; set; }

Property Value

Type	Description
ContextSettings

CssClass

Declaration

public override string CssClass { get; set; }

Property Value

Type	Description
System.String

DataManager

Declaration

public DataSource DataManager { get; set; }

Property Value

Type	Description
DataSource

DataManagerID

Declaration

public string DataManagerID { get; set; }

Property Value

Type	Description
System.String

DataSourceCachingMode

Declaration

public DataSourceCachingMode DataSourceCachingMode { get; set; }

Property Value

Type	Description
DataSourceCachingMode

DetailsTemplate

Declaration

public string DetailsTemplate { get; set; }

Property Value

Type	Description
System.String

EditSettings

Declaration

public EditSettings EditSettings { get; set; }

Property Value

Type	Description
EditSettings

EnableAltRow

Declaration

public bool EnableAltRow { get; set; }

Property Value

Type	Description
System.Boolean

EnableAutoSaveOnSelectionChange

Declaration

public bool EnableAutoSaveOnSelectionChange { get; set; }

Property Value

Type	Description
System.Boolean

EnableHeaderHover

Declaration

public bool EnableHeaderHover { get; set; }

Property Value

Type	Description
System.Boolean

EnableLoadOnDemand

Declaration

public bool EnableLoadOnDemand { get; set; }

Property Value

Type	Description
System.Boolean

EnablePersistence

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean

EnableResponsiveRow

Declaration

public bool EnableResponsiveRow { get; set; }

Property Value

Type	Description
System.Boolean

EnableRowHover

Declaration

public bool EnableRowHover { get; set; }

Property Value

Type	Description
System.Boolean

EnableRTL

Declaration

public bool EnableRTL { get; set; }

Property Value

Type	Description
System.Boolean

EnableToolbarItems

Declaration

public bool EnableToolbarItems { get; set; }

Property Value

Type	Description
System.Boolean

EnableTouch

Declaration

public bool EnableTouch { get; set; }

Property Value

Type	Description
System.Boolean

Fields

Declaration

public List<string> Fields { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>

FilterSettings

Declaration

public FilterSettings FilterSettings { get; set; }

Property Value

Type	Description
FilterSettings

GridLines

Declaration

public GridLines GridLines { get; set; }

Property Value

Type	Description
GridLines

GroupedColumns

Declaration

public List<string> GroupedColumns { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>

GroupSettings

Declaration

public GroupSettings GroupSettings { get; set; }

Property Value

Type	Description
GroupSettings

Height

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

Declaration

public override Unit Height { get; set; }

Property Value

Type	Description
System.Web.UI.WebControls.Unit

IsResponsive

Declaration

public bool IsResponsive { get; set; }

Property Value

Type	Description
System.Boolean

KeySettings

Declaration

public KeySettings KeySettings { get; set; }

Property Value

Type	Description
KeySettings

Locale

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String

MinWidth

Declaration

public int MinWidth { get; set; }

Property Value

Type	Description
System.Int32

Model

Declaration

public GridProperties Model { get; set; }

Property Value

Type	Description
GridProperties

PageSettings

Declaration

public PageSettings PageSettings { get; set; }

Property Value

Type	Description
PageSettings

Query

Declaration

public string Query { get; set; }

Property Value

Type	Description
System.String

ResizeSettings

Declaration

public ResizeSettings ResizeSettings { get; set; }

Property Value

Type	Description
ResizeSettings

RowDropSettings

Declaration

public RowDropSettings RowDropSettings { get; set; }

Property Value

Type	Description
RowDropSettings

RowTemplate

Declaration

public string RowTemplate { get; set; }

Property Value

Type	Description
System.String

ScrollSettings

Declaration

public ScrollSettings ScrollSettings { get; set; }

Property Value

Type	Description
ScrollSettings

SearchSettings

Declaration

public SearchSettings SearchSettings { get; set; }

Property Value

Type	Description
SearchSettings

SelectedRowIndex

Declaration

public int SelectedRowIndex { get; set; }

Property Value

Type	Description
System.Int32

SelectedRowIndices

Declaration

public List<int> SelectedRowIndices { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.Int32>

SelectionSettings

Declaration

public SelectionSettings SelectionSettings { get; set; }

Property Value

Type	Description
SelectionSettings

Selectiontype

Declaration

public SelectionType Selectiontype { get; set; }

Property Value

Type	Description
SelectionType

ShowColumnChooser

Declaration

public bool ShowColumnChooser { get; set; }

Property Value

Type	Description
System.Boolean

ShowStackedHeader

Declaration

public bool ShowStackedHeader { get; set; }

Property Value

Type	Description
System.Boolean

ShowSummary

Declaration

public bool ShowSummary { get; set; }

Property Value

Type	Description
System.Boolean

SortedColumns

Declaration

public List<SortedColumn> SortedColumns { get; }

Property Value

Type	Description
System.Collections.Generic.List<SortedColumn>

StackedHeaderRows

Declaration

public List<StackedHeaderRow> StackedHeaderRows { get; }

Property Value

Type	Description
System.Collections.Generic.List<StackedHeaderRow>

SummaryRows

Declaration

public List<SummaryRow> SummaryRows { get; }

Property Value

Type	Description
System.Collections.Generic.List<SummaryRow>

TextWrapSettings

Declaration

public TextWrapSettings TextWrapSettings { get; set; }

Property Value

Type	Description
TextWrapSettings

ToolbarSettings

Declaration

public ToolbarSettings ToolbarSettings { get; set; }

Property Value

Type	Description
ToolbarSettings

Width

Gets or sets a value that indicates to define the width of the grid.

Declaration

public override Unit Width { get; set; }

Property Value

Type	Description
System.Web.UI.WebControls.Unit

Methods

DependentScripts()

Gets the refrence of Dependent scripts.

Declaration

public List<string> DependentScripts()

Returns

Type	Description
System.Collections.Generic.List<System.String>	It retruns the String

FetchData(IEnumerable)

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

Declaration

public override void FetchData(IEnumerable data)

Parameters

Type	Name	Description
System.Collections.IEnumerable	data	It accepts the IEnumerable an ddisplays the record

Overrides

CommonDataBoundControl.FetchData(IEnumerable)

GetCollection<T>(Object)

Declaration

protected List<T> GetCollection<T>(object collection)

Parameters

Type	Name	Description
System.Object	collection

Returns

Type	Description
System.Collections.Generic.List<T>

Type Parameters

Name	Description
T

GetCollectionList<T>(ArrayList)

Declaration

protected List<T> GetCollectionList<T>(ArrayList arrayList)

Parameters

Type	Name	Description
System.Collections.ArrayList	arrayList

Returns

Type	Description
System.Collections.Generic.List<T>

Type Parameters

Name	Description
T

GetDependentFiles()

Gets the reference of dependent list.

Declaration

public override List<string> GetDependentFiles()

Returns

Type	Description
System.Collections.Generic.List<System.String>	It returns the String

Overrides

CommonDataBoundControl.GetDependentFiles()

LoadViewState(Object)

Gets a object that specifies the model of the grid.

Declaration

protected override void LoadViewState(object state)

Parameters

Type	Name	Description
System.Object	state	It accepts the Object and display

Overrides

CommonDataBoundControl.LoadViewState(Object)

PostBackEventHandler(String, Dictionary<String, Object>)

Declaration

public override void PostBackEventHandler(string EventName, Dictionary<string, object> args)

Parameters

Type	Name	Description
System.String	EventName
System.Collections.Generic.Dictionary<System.String, System.Object>	args

Overrides

CommonDataBoundControl.PostBackEventHandler(String, Dictionary<String, Object>)

Render()

Gets a value that specifies to render the grid.

Declaration

public string Render()

Returns

Type	Description
System.String	It returns the String

Render(HtmlTextWriter)

Gets a value that specifies to render the grid.

Declaration

protected override void Render(HtmlTextWriter writer)

Parameters

Type	Name	Description
System.Web.UI.HtmlTextWriter	writer	It accepts the HtmlTextWriter and display

Overrides

CommonDataBoundControl.Render(HtmlTextWriter)

SaveViewState()

Gets a object that specifies the serializable model of the grid.

Declaration

protected override object SaveViewState()

Returns

Type	Description
System.Object	It returns the Object

UpdateServerModel(Dictionary<String, Object>)

Gets the value for the functions to be performed and update on the server.

Declaration

public override void UpdateServerModel(Dictionary<string, object> ClientModel)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	ClientModel	It accepts the string value and object value passed for update.

Overrides

CommonDataBoundControl.UpdateServerModel(Dictionary<String, Object>)

Events

ServerAddRow

The OnServerAddRow event is triggered upon saving the added record to the grid. The details of the added record can be obtained server-side.

Declaration

public event Grid.GridEventHandler ServerAddRow

Event Type

Type	Description
Grid.GridEventHandler

ServerBatchEditRow

The OnServerBatchEditRow event is triggered upon saving the batch changes to the grid when the EditMode is set to “Batch”. The batch changes details can be obtained at server-side.

Declaration

public event Grid.GridEventHandler ServerBatchEditRow

Event Type

Type	Description
Grid.GridEventHandler

ServerCommandButtonClick

The OnServerCommandButtonClick event is triggered when a command(pre-defined or custom) button is clicked. The selected row details and the button details is obtained from server-side.

Declaration

public event Grid.GridEventHandler ServerCommandButtonClick

Event Type

Type	Description
Grid.GridEventHandler

ServerDeleteRow

The OnServerDeleteRow event is triggered upon deleting a record from the grid. The details of the deleted record can be obtained from the server-side.

Declaration

public event Grid.GridEventHandler ServerDeleteRow

Event Type

Type	Description
Grid.GridEventHandler

ServerEditRow

The OnServerEditRow event is triggered upon saving the edited record to the grid. The details of the edited record can be obtained from server-side.

Declaration

public event Grid.GridEventHandler ServerEditRow

Event Type

Type	Description
Grid.GridEventHandler

ServerExcelColumnTemplateInfo

Declaration

public event Action<object, object> ServerExcelColumnTemplateInfo

Event Type

Type	Description
System.Action<System.Object, System.Object>

ServerExcelDetailTemplateInfo

Declaration

public event Action<object, object> ServerExcelDetailTemplateInfo

Event Type

Type	Description
System.Action<System.Object, System.Object>

ServerExcelExporting

The OnServerExcelExporting event is triggered when a request is made to Export the grid to excel file. The grid model details can be obtained from server-side.

Declaration

public event Grid.GridEventHandler ServerExcelExporting

Event Type

Type	Description
Grid.GridEventHandler

ServerExcelGroupCaptionInfo

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

Declaration

public event Action<object> ServerExcelGroupCaptionInfo

Event Type

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 event Action<object> ServerExcelQueryCellInfo

Event Type

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 event Action<object> ServerExcelRowInfo

Event Type

Type	Description
System.Action<System.Object>

ServerPdfColumnTemplateInfo

Declaration

public event Action<object, object> ServerPdfColumnTemplateInfo

Event Type

Type	Description
System.Action<System.Object, System.Object>

ServerPdfDetailTemplateInfo

Declaration

public event Action<object, object> ServerPdfDetailTemplateInfo

Event Type

Type	Description
System.Action<System.Object, System.Object>

ServerPdfExporting

The OnServerPdfExporting event is triggered when a request to Export the grid to PDF document. The grid model details can be obtained from server-side.

Declaration

public event Grid.GridEventHandler ServerPdfExporting

Event Type

Type	Description
Grid.GridEventHandler

ServerPdfGroupCaptionInfo

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

Declaration

public event Action<object> ServerPdfGroupCaptionInfo

Event Type

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 from server-side.

Declaration

public event Action<object> ServerPdfQueryCellInfo

Event Type

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 from server-side.

Declaration

public event Action<object> ServerPdfRowInfo

Event Type

Type	Description
System.Action<System.Object>

ServerRecordClick

The OnServerRecordClick event is triggered when a record is clicked. The selected record details and the selected record index is obtained from server-side.

Declaration

public event Grid.GridEventHandler ServerRecordClick

Event Type

Type	Description
Grid.GridEventHandler

ServerRecordDoubleClick

The OnServerRecordDoubleClick event is triggered when any grid record is double clicked. The details of the record double clicked can be obtained from server-side.

Declaration

public event Grid.GridEventHandler ServerRecordDoubleClick

Event Type

Type	Description
Grid.GridEventHandler

ServerRowDeselected

The ServerRowDeselected event is triggered when any of the rows are deselected. The details of the deselected row is obtained from server-side in the event argument.

Declaration

public event Grid.GridEventHandler ServerRowDeselected

Event Type

Type	Description
Grid.GridEventHandler

ServerRowSelected

The OnServerRowSelected event is triggered when any of the rows are selected. The details of the row selected is obtained from server-side in the event argument.

Declaration

public event Grid.GridEventHandler ServerRowSelected

Event Type

Type	Description
Grid.GridEventHandler

ServerToolBarClick

The OnServerToolBarClick event is triggered when any of the toolbar icon is clicked. The details of the icon clicked can be obtained from server-side.

Declaration

public event Grid.GridEventHandler ServerToolBarClick

Event Type

Type	Description
Grid.GridEventHandler

ServerWordColumnTemplateInfo

Declaration

public event Action<object, object> ServerWordColumnTemplateInfo

Event Type

Type	Description
System.Action<System.Object, System.Object>

ServerWordDetailTemplateInfo

Declaration

public event Action<object, object> ServerWordDetailTemplateInfo

Event Type

Type	Description
System.Action<System.Object, System.Object>

ServerWordExporting

The OnServerWordExporting event is triggered when a request to export the grid to a word document. The grid model details can be obtained from server-side.

Declaration

public event Grid.GridEventHandler ServerWordExporting

Event Type

Type	Description
Grid.GridEventHandler

ServerWordGroupCaptionInfo

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

Declaration

public event Action<object> ServerWordGroupCaptionInfo

Event Type

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 from server-side.

Declaration

public event Action<object> ServerWordQueryCellInfo

Event Type

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 from server-side.

Declaration

public event Action<object> ServerWordRowInfo

Event Type

Type	Description
System.Action<System.Object>

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService