GridControl Members
In This Article
#Constructors
Name | Description |
---|---|
Grid |
Initializes a new instance of the Grid |
#Fields
#Properties
Name | Description |
---|---|
Actual |
Returns the string that specifies a filter currently used in the grid. |
Allow |
Gets or sets whether end-users are allowed to delete data rows. This is a bindable property. |
Allow |
Gets or sets whether end-users are allowed to change cell values in the grid. This is a bindable property. |
Allow |
Gets or sets whether end-users are allowed to group data in the grid. This is a bindable property. |
Allow |
Gets or sets whether end-users are allowed to collapse and expand group rows. This is a bindable property. |
Allow |
Gets or sets a value indicating whether virtualization is enabled for horizontal scrolling. |
Allow |
Gets or sets whether end-users are allowed to change column widths. This is a bindable property. |
Allow |
Gets or sets whether end-users are allowed to sort data in the grid. This is a bindable property. |
Auto |
Gets or sets the auto-filter panel height. This is a bindable property. |
Auto |
Gets or sets whether the auto-filter panel is displayed in the grid. This is a bindable property. |
Auto |
Gets or sets how columns should be automatically created for fields of the underlying data source, depending on whether the grid contains any columns. |
Column |
Gets or sets the height of column headers in the grid. This is a bindable property. |
Column |
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. |
Columns |
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. |
Edit |
Gets or sets the template used to define the visual presentation of the grid’s row edit form. |
Filter |
Gets or sets the grid filter expression. |
Filter |
Gets or sets the filter panel height. This is a bindable property. |
Filter |
Gets or sets when the filter panel is shown at the bottom of the grid. This is a bindable property. |
Filter |
Gets or sets the grid filter expression string. This is a bindable property. |
Format |
Contains format conditions applied to the grid. |
Groups |
Gets or sets whether groups should appear expanded or collapsed immediately after a grouping is applied in the grid. |
Group |
Provides access to group summary items. |
Highlight |
Specifies whether the grid should highlight a row and column for which an end-user invokes a context menu. This is a bindable property. |
Horizontal |
Gets or sets a horizontal scrolling offset. |
Is |
Gets or sets whether the column chooser is available to end-users. This is a bindable property. |
Is |
Gets or sets whether a context menu is shown when an end-user touches and holds a column header. This is a bindable property. |
Is |
Gets whether the grid’s data is grouped. |
Is |
Gets or sets whether a context menu is shown when an end-user touches and holds a group row. This is a bindable property. |
Is |
For internal use. |
Is |
Gets or sets whether the load-more functionality is enabled in the grid. This is a bindable property. |
Is |
Gets or sets whether the pull-to-refresh functionality is enabled in the grid. This is a bindable property. |
Is |
Gets or sets whether the grid is read-only. This is a bindable property. |
Is |
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. |
Is |
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. |
Items |
Gets or sets the grid’s data source. This is a bindable property. |
Left |
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. |
Load |
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. |
New |
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. |
Options |
Gets or sets how grid data is exported to CSV format. |
Options |
Gets or sets how grid data is exported to XLS format. |
Options |
Gets or sets how grid data is exported to XLSX format. |
Pull |
Gets or sets the command executed when an end-user pulls the grid down to refresh data. This is a bindable property. |
Right |
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. |
Row |
Gets the number of data rows in the grid. |
Row |
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. |
Row |
Gets or sets the height of rows in the grid. This is a bindable property. |
Row |
Gets or sets the command executed when an end-user taps a row within the grid. This is a bindable property. |
Selected |
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. |
Selected |
Gets or sets the selected row handle. This is a bindable property. |
Sort |
Specifies whether the grid allows data sorting by multiple columns or by a single column only. This is a bindable property. |
Swipe |
Gets or sets the command executed when a swipe button is tapped. This is a bindable property. |
Total |
Provides access to a collection of total summary items. |
Total |
Gets or sets the total summary panel height. This is a bindable property. |
Total |
Gets or sets whether the total summary panel is displayed. This is a bindable property. |
Visible |
Gets the collection of visible columns. |
#Methods
Name | Description |
---|---|
Clear |
Clears the filter applied to data in the grid. |
Clear |
Ungroups data in the grid. |
Clear |
Clears the sorting applied to the grid. |
Close |
Closes a data row editor (an in-place editor or edit form, depending on the edit mode set in the grid). |
Collapse |
Collapses all group rows. |
Collapse |
Collapses the specified group row. |
Delete |
Deletes the specified data row. |
Dispose() |
Releases all resources used by the Grid |
Expand |
Expands all group rows. |
Expand |
Expands the specified group row. |
Export |
Exports data from the grid to the specified stream in the XLS, XLSX or CSV format. |
Find |
Returns the handle of the first row that matches the specified criteria. |
Find |
Searches for the value in the column and returns the handle of the corresponding row. |
Find |
Searches for the value in the column and returns the handle of the corresponding row. |
Get |
Returns the text displayed within the specified cell. |
Get |
Returns the text displayed within the specified cell. |
Get |
Returns the value of the specified data cell in the grid. |
Get |
Returns the value of the specified data cell. |
Get |
Provides access to information on the specified data group. |
Get |
Returns the value of the specified group row. |
Get |
Gets an object that provides access to the data of a row specified by its handle. |
Get |
Returns the handle of the row which corresponds to the specified record in the data source. |
Get |
Gets the service object of the specified type. |
Get |
Gets the specified service. |
Get |
Returns the index of the data source record to which the specified row handle corresponds. |
Group |
Groups data in the grid by the specified column. |
Group |
Groups data in the grid by the specified column. |
Hide |
Hides the column chooser. |
Hide |
Hides the column chooser, applying or discarding its current settings. |
Is |
Indicates whether the specified group row is collapsed. |
Is |
Indicates whether the specified handle corresponds to a group row. |
Load |
For internal use. |
Open |
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 |
Forces the control to immediately redraw itself. |
Refresh |
Updates the grid data. |
Restore |
Restores a grid’s layout from the specified stream. |
Restore |
Restores a grid’s layout from the specified XML string. |
Save |
Saves a grid’s layout to the specified stream. |
Save |
Saves a gird’s layout to an XML string. |
Scroll |
Scrolls the grid to make the specified row visible. |
Set |
Assigns a value to the specified cell. |
Set |
Assigns a value to the specified cell. |
Show |
Invokes the column chooser. |
Sort |
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. |
Sort |
Sorts data by the values of the specified column in the specified order. |
Sort |
Sorts data by the values of the specified column in ascending order. |
Sort |
Sorts data by the values of the column bound to the specified data field in the ascending order. |
#Events
Name | Description |
---|---|
Auto |
Occurs each time an individual column is auto-generated. |
Calculate |
Allows you to calculate summary values manually. |
Customize |
Allows you to customize the appearance of cells in the grid. |
Customize |
Enables custom display text to be provided for any data cell. |
Custom |
Enables you to populate unbound columns with data, and save changes made by end-users in unbound columns. |
End |
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. |
Filter |
|
Group |
Occurs after a group row has been collapsed. |
Group |
Occurs before a group row is collapsed. |
Group |
Occurs after a group row has been expanded. |
Group |
Occurs before a group row is expanded. |
Horizontal |
Occurs after the Grid |
Init |
Enables you to initialize newly added rows. |
Load |
Occurs when an end-user scrolls to the bottom of the grid to load new data items. |
Popup |
Enables you to customize the grid’s popup menus. |
Pull |
Occurs when an end-user pulls the grid down to refresh its content. |
Row |
|
Row |
Occurs when a data row is tapped. |
Selection |
Occurs after the selection has been changed. |
Swipe |
Occurs when a swipe button is tapped. |
Swipe |
Occurs before a swipe button is shown when an end-user swipes left to right, or right to left, over a data row. |
See Also