GridControl Members

Constructors

Name Description
GridControl()

Initializes a new instance of the GridControl class with default settings.

Fields

Name Description
ActualFilterStringProperty

Identifies the GridControl.ActualFilterString bindable property.

AllowDeleteRowsProperty

Identifies the GridControl.AllowDeleteRows bindable property.

AllowEditRowsProperty

Identifies the GridControl.AllowEditRows bindable property.

AllowGroupCollapseProperty

Identifies the GridControl.AllowGroupCollapse bindable property.

AllowGroupProperty

Identifies the GridControl.AllowGroup bindable property.

AllowResizeColumnsProperty

Identifies the GridControl.AllowResizeColumns bindable property.

AllowSortProperty

Identifies the GridControl.AllowSort bindable property.

AutoFilterPanelHeightProperty

Identifies the GridControl.AutoFilterPanelHeight bindable property.

AutoFilterPanelVisibilityProperty

Identifies the GridControl.AutoFilterPanelVisibility bindable property.

AutoGenerateColumnsModeProperty

Identifies the GridControl.AutoGenerateColumnsMode bindable property.

ColumnHeadersHeightProperty

Identifies the GridControl.ColumnHeadersHeight bindable property.

ColumnHeadersVisibilityProperty

Identifies the GridControl.ColumnHeadersVisibility bindable property.

ColumnsAutoWidthProperty

Identifies the GridControl.ColumnsAutoWidth bindable property.

DefaultColumnHeaderHeight

The default column header height. Returns 44.

DefaultColumnWidth

The default column width. Returns 120.

DefaultRowHeight

The default row height. Returns 44.

FilterPanelHeightProperty

Identifies the GridControl.FilterPanelHeight bindable property.

FilterPanelVisibilityProperty

Identifies the GridControl.FilterPanelVisibility bindable property.

FilterStringProperty

Identifies the GridControl.FilterString bindable property.

GroupsInitiallyExpandedProperty

Identifies the GridControl.GroupsInitiallyExpanded bindable property.

HighlightMenuTargetElementsProperty

Identifies the GridControl.HighlightMenuTargetElements bindable property.

InvalidRowHandle

An invalid row handle. This value is returned when an attempt to obtain a particular row fails.

IsColumnChooserEnabledProperty

Identifies the GridControl.IsColumnChooserEnabled bindable property.

IsColumnMenuEnabledProperty

Identifies the GridControl.IsColumnMenuEnabled bindable property.

IsGroupRowMenuEnabledProperty

Identifies the GridControl.IsGroupRowMenuEnabled bindable property.

IsLoadMoreEnabledProperty

Identifies the GridControl.IsLoadMoreEnabled bindable property.

IsPullToRefreshEnabledProperty

Identifies the GridControl.IsPullToRefreshEnabled bindable property.

IsReadOnlyProperty

Identifies the GridControl.IsReadOnly bindable property.

IsRowCellMenuEnabledProperty

Identifies the GridControl.IsRowCellMenuEnabled bindable property.

IsTotalSummaryMenuEnabledProperty

Identifies the GridControl.IsTotalSummaryMenuEnabled bindable property.

ItemsSourceProperty

Identifies the GridControl.ItemsSource bindable property.

LoadMoreCommandProperty

Identifies the GridControl.LoadMoreCommand bindable property.

NewItemRowVisibilityProperty

Identifies the GridControl.NewItemRowVisibility bindable property.

OptionsExportCsvProperty

Identifies the GridControl.OptionsExportCsv bindable property.

OptionsExportXlsProperty

Identifies the GridControl.OptionsExportXls bindable property.

OptionsExportXlsxProperty

Identifies the GridControl.OptionsExportXlsx bindable property.

PullToRefreshCommandProperty

Identifies the GridControl.PullToRefreshCommand bindable property.

RowEditModeProperty

Identifies the GridControl.RowEditMode bindable property.

RowHeightProperty

Identifies the GridControl.RowHeight bindable property.

RowTapCommandProperty

Identifies the GridControl.RowTapCommand bindable property.

SelectedDataObjectProperty

Identifies the GridControl.SelectedDataObject bindable property.

SelectedRowHandleProperty

Identifies the GridControl.SelectedRowHandle bindable property.

SortModeProperty

Identifies the GridControl.SortMode bindable property.

SwipeButtonCommandProperty

Identifies the GridControl.SwipeButtonCommand bindable property.

TotalSummaryHeightProperty

Identifies the GridControl.TotalSummaryHeight bindable property.

TotalSummaryVisibilityProperty

Identifies the GridControl.TotalSummaryVisibility bindable property.

Properties

Name Description
ActualFilterString

Returns the string that specifies a filter currently used in the grid.

AllowDeleteRows

Gets or sets whether end-users are allowed to delete data rows. This is a bindable property.

AllowEditRows

Gets or sets whether end-users are allowed to change cell values in the grid. This is a bindable property.

AllowGroup

Gets or sets whether end-users are allowed to group data in the grid. This is a bindable property.

AllowGroupCollapse

Gets or sets whether end-users are allowed to collapse and expand group rows. This is a bindable property.

AllowHorizontalScrollingVirtualization

Gets or sets a value indicating whether virtualization is enabled for horizontal scrolling.

AllowResizeColumns

Gets or sets whether end-users are allowed to change column widths. This is a bindable property.

AllowSort

Gets or sets whether end-users are allowed to sort data in the grid. This is a bindable property.

AutoFilterPanelHeight

Gets or sets the auto-filter panel height. This is a bindable property.

AutoFilterPanelVisibility

Gets or sets whether the auto-filter panel is displayed in the grid. This is a bindable property.

AutoGenerateColumnsMode

Gets or sets how columns should be automatically created for fields of the underlying data source, depending on whether the grid contains any columns.

ColumnHeadersHeight

Gets or sets the height of column headers in the grid. This is a bindable property.

ColumnHeadersVisibility

Gets or sets whether column headers are shown in the grid. This is a bindable property.

Columns

Provides access to the grid's collection of columns.

ColumnsAutoWidth

Gets or sets whether column widths are automatically changed, so that the total column width matches the grid's width. This is a bindable property.

EditFormContent

Gets or sets the template used to define the visual presentation of the grid's row edit form.

FilterExpression

Gets or sets the grid filter expression.

FilterPanelHeight

Gets or sets the filter panel height. This is a bindable property.

FilterPanelVisibility

Gets or sets when the filter panel is shown at the bottom of the grid. This is a bindable property.

FilterString

Gets or sets the grid filter expression string. This is a bindable property.

FormatConditions

Contains format conditions applied to the grid.

GroupSummaries

Provides access to group summary items.

GroupsInitiallyExpanded

Gets or sets whether groups should appear expanded or collapsed immediately after a grouping is applied in the grid.

HighlightMenuTargetElements

Specifies whether the grid should highlight a row and column for which an end-user invokes a context menu. This is a bindable property.

HorizontalScrollOffset

Gets or sets a horizontal scrolling offset.

IsColumnChooserEnabled

Gets or sets whether the column chooser is available to end-users. This is a bindable property.

IsColumnMenuEnabled

Gets or sets whether a context menu is shown when an end-user touches and holds a column header. This is a bindable property.

IsGroupRowMenuEnabled

Gets or sets whether a context menu is shown when an end-user touches and holds a group row. This is a bindable property.

IsGrouped

Gets whether the grid's data is grouped.

IsLoadMoreEnabled

Gets or sets whether the load-more functionality is enabled in the grid. This is a bindable property.

IsLoadedInVisualTree

For internal use.

IsPullToRefreshEnabled

Gets or sets whether the pull-to-refresh functionality is enabled in the grid. This is a bindable property.

IsReadOnly

Gets or sets whether the grid is read-only. This is a bindable property.

IsRowCellMenuEnabled

Gets or sets whether a context menu is shown when an end-user touches and holds a data row cell. This is a bindable property.

IsTotalSummaryMenuEnabled

Gets or sets whether a context menu is shown when an end-user touches and holds a total summary panel. This is a bindable property.

ItemsSource

Gets or sets the grid's data source. This is a bindable property.

LeftSwipeButtons

Provides access to objects containing information on buttons shown on the left side of a data row when an end-user swipes left to right over a data row.

LoadMoreCommand

Gets or sets the command executed when an end-user scrolls to the bottom of the grid to load new data items. This is a bindable property.

NewItemRowVisibility

Gets or sets whether the New Item Row is shown in the grid to allow end-users to enter new data records. This is a bindable property.

OptionsExportCsv

Gets or sets how grid data is exported to CSV format.

OptionsExportXls

Gets or sets how grid data is exported to XLS format.

OptionsExportXlsx

Gets or sets how grid data is exported to XLSX format.

PullToRefreshCommand

Gets or sets the command executed when an end-user pulls the grid down to refresh data. This is a bindable property.

RightSwipeButtons

Provides access to objects containing information on buttons shown on the right side of a data row when an end-user swipes right to left over a data row.

RowCount

Gets the number of data rows in the grid.

RowEditMode

Specifies whether the grid invokes an in-place editor or edit form when an end-user starts to edit a data cell or add a new row.

RowHeight

Gets or sets the height of rows in the grid. This is a bindable property.

RowTapCommand

Gets or sets the command executed when an end-user taps a row within the grid. This is a bindable property.

SelectedDataObject

Returns an object that specifies a data source record to which a data row currently selected in the grid corresponds. This is a bindable property.

SelectedRowHandle

Gets or sets the selected row handle. This is a bindable property.

SortMode

Specifies whether the grid allows data sorting by multiple columns or by a single column only. This is a bindable property.

SwipeButtonCommand

Gets or sets the command executed when a swipe button is tapped. This is a bindable property.

TotalSummaries

Provides access to a collection of total summary items.

TotalSummaryHeight

Gets or sets the total summary panel height. This is a bindable property.

TotalSummaryVisibility

Gets or sets whether the total summary panel is displayed. This is a bindable property.

VisibleColumns

Gets the collection of visible columns.

Methods

Name Description
ClearFilter()

Clears the filter applied to data in the grid.

ClearGrouping()

Ungroups data in the grid.

ClearSorting()

Clears the sorting applied to the grid.

CloseEditor(Boolean)

Closes a data row editor (an in-place editor or edit form, depending on the edit mode set in the grid).

CollapseAllGroups()

Collapses all group rows.

CollapseGroupRow(Int32)

Collapses the specified group row.

DeleteRow(Int32)

Deletes the specified data row.

Dispose()

Releases all resources used by the GridControl.

ExpandAllGroups()

Expands all group rows.

ExpandGroupRow(Int32)

Expands the specified group row.

ExportToExcel(Stream, ExportTarget)

Exports data from the grid to the specified stream in the XLS, XLSX or CSV format.

FindRow(Predicate<IRowData>)

Returns the handle of the first row that matches the specified criteria.

FindRowByValue(GridColumn, Object)

Searches for the value in the column and returns the handle of the corresponding row.

FindRowByValue(String, Object)

Searches for the value in the column and returns the handle of the corresponding row.

GetCellDisplayText(Int32, GridColumn)

Returns the text displayed within the specified cell.

GetCellDisplayText(Int32, String)

Returns the text displayed within the specified cell.

GetCellValue(Int32, GridColumn)

Returns the value of the specified data cell in the grid.

GetCellValue(Int32, String)

Returns the value of the specified data cell.

GetGroupInfo(Int32)

Provides access to information on the specified data group.

GetGroupRowValue(Int32)

Returns the value of the specified group row.

GetRow(Int32)

Gets an object that provides access to the data of a row specified by its handle.

GetRowHandle(Int32)

Returns the handle of the row which corresponds to the specified record in the data source.

GetService(Type)

Gets the service object of the specified type.

GetService<T>()

Gets the specified service.

GetSourceRowIndex(Int32)

Returns the index of the data source record to which the specified row handle corresponds.

GroupBy(GridColumn)

Groups data in the grid by the specified column.

GroupBy(String)

Groups data in the grid by the specified column.

HideColumnChooser()

Hides the column chooser.

HideColumnChooser(Boolean)

Hides the column chooser, applying or discarding its current settings.

IsGroupCollapsed(Int32)

Indicates whether the specified group row is collapsed.

IsGroupRow(Int32)

Indicates whether the specified handle corresponds to a group row.

LoadInVisualTree()

For internal use.

OpenEditor(CellIndex)

Invokes an editor (an in-place editor or edit form, depending on the edit mode set in the grid) for a data row containing the specified cell.

Redraw(Boolean)

Forces the control to immediately redraw itself.

RefreshData()

Updates the grid data.

RestoreLayoutFromStream(Stream)

Restores a grid's layout from the specified stream.

RestoreLayoutFromXml(String)

Restores a grid's layout from the specified XML string.

SaveLayoutToStream(Stream)

Saves a grid's layout to the specified stream.

SaveLayoutToXml()

Saves a gird's layout to an XML string.

ScrollToRow(Int32)

Scrolls the grid to make the specified row visible.

SetCellValue(Int32, GridColumn, Object)

Assigns a value to the specified cell.

SetCellValue(Int32, String, Object)

Assigns a value to the specified cell.

ShowColumnChooser()

Invokes the column chooser.

SortBy(GridColumn)

Sorts data by the values of the specified column in ascending order.

SortBy(GridColumn, ColumnSortOrder)

Sorts data by the values of the specified column in the specified order.

SortBy(GridColumn, ColumnSortOrder, Int32)

Sorts data by the values of the specified column in the specified order, and places the column at the specified position among the sorted columns.

SortBy(String)

Sorts data by the values of the column bound to the specified data field in the ascending order.

add_AutoGeneratingColumn(AutoGeneratingColumnEventHandler)
add_CalculateCustomSummary(CustomSummaryEventHandler)
add_CustomUnboundColumnData(GridColumnDataEventHandler)
add_CustomizeCell(CustomizeCellEventHandler)
add_CustomizeCellDisplayText(CustomizeCellDisplayTextEventHandler)
add_EndRowEdit(RowEditingEventHandler)
add_GroupRowCollapsed(RowEventHandler)
add_GroupRowCollapsing(RowAllowEventHandler)
add_GroupRowExpanded(RowEventHandler)
add_GroupRowExpanding(RowAllowEventHandler)
add_HorizontalScrollOffsetChanged(HorizontalScrollOffsetEventHandler)
add_InitNewRow(InitNewRowEventHandler)
add_PopupMenuCustomization(PopupMenuEventHandler)
add_RowTap(RowTapEventHandler)
add_SelectionChanged(RowEventHandler)
add_SwipeButtonClick(SwipeButtonEventHandler)
add_SwipeButtonShowing(SwipeButtonShowingEventHandler)
remove_AutoGeneratingColumn(AutoGeneratingColumnEventHandler)
remove_CalculateCustomSummary(CustomSummaryEventHandler)
remove_CustomUnboundColumnData(GridColumnDataEventHandler)
remove_CustomizeCell(CustomizeCellEventHandler)
remove_CustomizeCellDisplayText(CustomizeCellDisplayTextEventHandler)
remove_EndRowEdit(RowEditingEventHandler)
remove_GroupRowCollapsed(RowEventHandler)
remove_GroupRowCollapsing(RowAllowEventHandler)
remove_GroupRowExpanded(RowEventHandler)
remove_GroupRowExpanding(RowAllowEventHandler)
remove_HorizontalScrollOffsetChanged(HorizontalScrollOffsetEventHandler)
remove_InitNewRow(InitNewRowEventHandler)
remove_PopupMenuCustomization(PopupMenuEventHandler)
remove_RowTap(RowTapEventHandler)
remove_SelectionChanged(RowEventHandler)
remove_SwipeButtonClick(SwipeButtonEventHandler)
remove_SwipeButtonShowing(SwipeButtonShowingEventHandler)

Events

Name Description
AutoGeneratingColumn

Occurs each time an individual column is auto-generated.

CalculateCustomSummary

Allows you to calculate summary values manually.

CustomUnboundColumnData

Enables you to populate unbound columns with data, and save changes made by end-users in unbound columns.

CustomizeCell

Allows you to customize the appearance of cells in the grid.

CustomizeCellDisplayText

Enables custom display text to be provided for any data cell.

EndRowEdit

Occurs after a row editor (an in-place editor or edit form, depending on the edit mode set in the grid) is closed and modified cell values are applied or canceled.

GroupRowCollapsed

Occurs after a group row has been collapsed.

GroupRowCollapsing

Occurs before a group row is collapsed.

GroupRowExpanded

Occurs after a group row has been expanded.

GroupRowExpanding

Occurs before a group row is expanded.

HorizontalScrollOffsetChanged

Occurs after the GridControl.HorizontalScrollOffset property has been changed.

InitNewRow

Enables you to initialize newly added rows.

LoadMore

Occurs when an end-user scrolls to the bottom of the grid to load new data items.

PopupMenuCustomization

Enables you to customize the grid's popup menus.

PullToRefresh

Occurs when an end-user pulls the grid down to refresh its content.

RowTap

Occurs when a data row is tapped.

SelectionChanged

Occurs after the selection has been changed.

SwipeButtonClick

Occurs when a swipe button is tapped.

SwipeButtonShowing

Occurs before a swipe button is shown when an end-user swipes left to right, or right to left, over a data row.