General Information
.NET Subscription
Quality Assurance and Productivity
Desktop
Frameworks and Libraries
Web
Controls and Extensions
Maintenance Mode
Enterprise and Analytic Tools
End-User Documentation
DataGridView Members
A data grid view.Constructors
| Name | Description |
|---|---|
| DataGridView() | Initializes a new instance of the DataGridView class with default settings. |
Fields
Properties
| Name | Description |
|---|---|
| ActualFilterString | Gets the string that specifies a filter currently used in the grid. |
| AllowCascadeTreeCreation | Gets or sets whether the grid performs deferred data loading on start. |
| AllowCascadeUpdate | Gets or sets whether the grid performs deferred data loading while vertical scrolling. |
| AllowGroupCollapse | Specifies whether end users can collapse and expand groups of rows. |
| AllowSort | Specifies whether end users can sort data in the grid. |
| AutoGenerateColumnsMode | Gets or sets whether columns should be automatically created for fields of the underlying data source, depending on whether the grid contains any columns. |
| BorderColor | Gets or sets the grid border color. |
| BorderThickness | Gets or sets the grid border thickness. |
| CellStyle | Gets or sets the data cell appearance settings. |
| ColumnHeaderContentTemplate | Gets or sets the template that defines the visual representation of column headers. |
| ColumnHeaderHeight | Gets or sets the height of column headers in the grid. |
| ColumnHeaderStyle | Gets or sets the column header appearance settings. |
| Columns | Provides access to the grid's collection of columns. |
| EditorShowMode | Gets or sets a gesture by which a user can invoke an in-place editor for a data cell. |
| EndSwipeItems | Provides access to objects that contain information on action buttons shown on the right side of a data row when a user swipes the row from right to left. |
| FilterExpression | Gets or sets the grid's filter expression. |
| FilterString | Gets or sets the grid's filter expression string. |
| FixedColumnSeparatorWidth | Gets or sets the thickness of the line that separates fixed and scrollable columns. |
| FullSwipeMode | Specifies whether a full swipe across the row performs the first action from the grid's StartSwipeItems or EndSwipeItems collection. |
| GroupCaptionTemplate | Gets or sets the template that defines the visual representation of a group row caption. |
| GroupRowHeight | Gets or sets the height of group rows in the grid. |
| GroupRowStyle | Gets or sets the group row appearance settings. |
| GroupRowTemplate | Gets or sets the template that defines the visual representation of group rows. |
| GroupSummaries | Provides access to the collection of group summary items. |
| GroupSummaryTemplate | Gets or sets the template that defines the visual representation of summary items displayed within group rows. |
| IndicatorColor | Gets or sets the color of the load-more (iOS and Android) and pull-to-refresh (iOS only) indicators. |
| IsColumnHeaderVisible | Specifies whether column headers are shown in the grid. |
| IsEditing | |
| IsGrouped | Gets whether the grid's data is grouped. |
| IsHorizontalScrollBarVisible | Gets or sets whether the horizontal scrollbar is shown in the grid. |
| IsLoadMoreEnabled | Gets or sets whether the load-more functionality is enabled in the grid. |
| IsPullToRefreshEnabled | Gets or sets whether the pull-to-refresh functionality is enabled in the grid. |
| IsReadOnly | Gets or sets whether the grid is read-only. |
| IsRefreshing | Gets or sets whether the grid shows the refresh indicator that provides the pull-to-refresh activity status. |
| IsUpdateLocked | Gets or sets whether the grid is locked for updating. |
| IsVerticalScrollBarVisible | Gets or sets whether the vertical scrollbar is shown in the grid. |
| ItemsSource | Gets or sets the grid's data source. |
| LoadMoreCommand | Gets or sets the command executed when a user scrolls to the bottom of the grid to load new data items. |
| PullToRefreshCommand | Gets or sets the command executed when a user pulls the grid down to request content update. |
| RowCount | Gets the number of data rows in the grid. |
| RowHeight | Gets or sets the height of data rows in the grid. |
| RowTapCommand | Gets or sets the command executed when a user taps a row within the grid. |
| SelectedItem | Returns an object that specifies a data source record to which a data row currently selected in the grid corresponds. |
| SelectedRowHandle | Gets or sets the selected row handle. |
| SelectionMode | Gets or sets whether end users can select rows in the grid. |
| ShowGroupedColumns | Gets or sets whether the grid displays a column used to group data. |
| SortMode | Specifies whether the grid allows data sorting by multiple columns or by a single column only. |
| StartSwipeItems | Provides access to objects that contain information on action buttons shown on the left side of a data row when a user swipes the row from left to right. |
| SwipeItemStyle | Gets or sets the swipe item appearance settings. |
| SwipeItemTemplate | Gets or sets the template that defines the visual representation of grid's swipe items. |
| TotalSummaries | Provides access to the collection of total summary items. |
| TotalSummaryHeight | Gets or sets the total summary panel height. |
| TotalSummaryStyle | Gets or sets the total summary panel appearance settings. |
| TotalSummaryTemplate | Gets or sets the template that defines the visual representation of total summary items. |
| TotalSummaryVisibility | Specifies whether the total summary panel is displayed. |
| VerticalLineThickness | Gets or sets the thickness of the grid's vertical lines. |
| VisibleColumns | Gets the collection of visible columns. |
Methods
| Name | Description |
|---|---|
| BeginUpdate() | |
| 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 cell in-place editor. |
| CollapseAllGroups() | Collapses all groups of rows. |
| CollapseGroupRow(Int32) | Collapses the specified group of rows. |
| DeleteRow(Int32) | Deletes the specified data row. |
| EndUpdate() | |
| Equals(Object) |
Determines whether the specified object is equal to the current object.
(Inherited from Object) |
| Equals(Object, Object) static |
Determines whether the specified object instances are considered equal.
(Inherited from Object) |
| ExpandAllGroups() | Expands all groups of rows. |
| ExpandGroupRow(Int32) | Expands the specified group of rows. |
| FindRow(Predicate<IRowData>) | Returns the handle of the first row that matches the specified criteria. |
| FindRowByValue(String, Object) | Searches for the value in the column and returns the handle of the corresponding row. |
| GetCellDisplayText(Int32, GridColumn) | Gets the text displayed within the specified cell. |
| GetCellDisplayText(Int32, String) | Gets the text displayed within the specified cell. |
| GetCellValue(Int32, GridColumn) | Gets the value of the specified cell. |
| GetCellValue(Int32, String) | Gets the value of the specified cell. |
| GetGroup(Int32) | Provides access to the information on the specified group of rows. |
| GetGroupRowValue(Int32) | Gets the value of the specified group row. |
| GetHashCode() |
Serves as the default hash function.
(Inherited from Object) |
| GetRow(Int32) | Gets an object that provides access to the data of the specified row. |
| GetRowHandle(Int32) | Returns the handle of the row that corresponds to the specified record in the data source. |
| GetSourceRowIndex(Int32) | Gets the index of the data source record to which the specified row handle corresponds. |
| GetType() |
Gets the Type of the current instance.
(Inherited from Object) |
| GroupBy(GridColumn) | Groups data in the grid by the specified column. |
| GroupBy(String) | Groups data in the grid by the specified column. |
| MemberwiseClone() protected |
Creates a shallow copy of the current Object.
(Inherited from Object) |
| OpenEditor(Int32, String) | Invokes an in-place editor for the specified cell. |
| ReferenceEquals(Object, Object) static |
Determines whether the specified Object instances are the same instance.
(Inherited from Object) |
| 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. |
| SortBy(GridColumn) | Sorts data by values of the specified column in ascending order. |
| SortBy(GridColumn, ColumnSortOrder) | Sorts data by values of the specified column in the specified order. |
| SortBy(GridColumn, ColumnSortOrder, Int32) | Sorts data by 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 values of the column bound to the specified data field in the ascending order. |
| ToString() |
Returns a string that represents the current object.
(Inherited from Object) |
Events
| Name | Description |
|---|---|
| AutoGeneratingColumn | Occurs each time an individual column is generated automatically. |
| CalculateCustomSummary | Allows you to specify a custom rule to calculate data summaries. |
| CustomizeCellDisplayText | Allows you to provide a custom display text for any data cell. |
| CustomUnboundColumnData | Enables you to populate unbound columns with data, and save changes that users made in unbound columns. |
| DoubleTap | Occurs when a user double taps the grid. |
| LoadMore | Occurs when a user scrolls to the bottom of the grid to load new data items. |
| LongPress | Occurs when a user taps and holds anywhere within the grid. |
| PullToRefresh | Occurs when a user pulls the grid down to refresh its content. |
| SelectionChanged | Occurs after the selected row has been changed in the grid. |
| Tap | Occurs when a user taps the grid. |
| TapConfirmed | Occurs when a single tap is confirmed (a user tapped the grid and a second tap leading to the double-tap gesture did not follow). |
| ValidateCell | Occurs after a user changes a cell value in the in-place editor and attempts to select another cell. |
| ValidationError | Occurs when a value in the in-place cell editor fails validation or when it cannot be saved to a data source. |
See Also
Feedback