GridControl Members
In This Article
#Constructors
Name | Description |
---|---|
Grid |
Initializes a new instance of the Grid |
#Fields
#Properties
Name | Description |
---|---|
Active |
Gets the active editor. This is a dependency property.
Inherited from Data |
Actual |
Gets the actual number of grouping columns. |
Actual |
Gets whether the filter panel is displayed within a grid. This is a dependency property.
Inherited from Data |
Allow |
Gets or sets whether or not a cell’s value that has failed validation specified by the Data Annotations attribute |
Allow |
Gets or sets whether to enable copy operations. This is a dependency property.
Inherited from Data |
Allow |
Gets or sets whether an editor that did not pass validation can lose focus. This is a dependency property.
Inherited from Data |
Allow |
Gets or sets whether the Grid |
Alternate |
Gets or sets a brush used to paint the background of alternate rows. This is a dependency property.
Inherited from Data |
Alternate |
Gets or sets a palette used to paint the background of alternate rows. This is a dependency property.
Inherited from Data |
Alternation |
Gets or sets the alternate row frequency. This is a dependency property.
Inherited from Data |
Auto |
Gets or sets whether all group rows are automatically expanded after each grouping operation. This is a dependency property. |
Auto |
Gets or sets whether columns should be created automatically for all fields in a data source. This is a dependency property.
Inherited from Data |
Auto |
Gets or sets whether a grid is automatically scrolled after the order of rows has been changed. This is a dependency property.
Inherited from Data |
Auto |
Gets or sets whether column widths are automatically changed so that the total column width matches the grid width.
Inherited from Data |
Cell |
Gets or sets whether to display cell tooltips. This is a dependency property.
Inherited from Data |
Clipboard |
Gets or sets file formats in which the Grid |
Column |
Gets or sets a context menu that is invoked when a user right-clicks a column header. |
Columns |
Gets a collection of the Grid |
Columns |
Gets or sets a source from which the Grid |
Column |
Gets or sets a template that describes grid columns. This is a dependency property.
Inherited from Data |
Column |
Gets or sets a column template selector. This is a dependency property.
Inherited from Data |
Commands | Contains grid commands. |
Copy |
Gets or sets whether to add column headers to the clipboard when you copy Grid |
Current |
Gets or sets a column that contains the focused cell.
Inherited from Data |
Current |
Gets or sets the currently focused data row.
Inherited from Data |
Current |
Gets or sets the focused row’s handle.
Inherited from Data |
Data |
Gets or sets the control’s data context.
Inherited from Data |
Filter |
Gets or sets the grid’s filter criteria. This is a dependency property.
Inherited from Data |
Filtering |
Gets the context that binds a filter item to the Grid |
Filter |
Gets the text displayed within the Filter Panel. This is a dependency property.
Inherited from Data |
Filter |
Gets or sets the grid’s filter expression. This is a dependency property.
Inherited from Data |
Fixed |
Gets total summaries displayed within the Fixed Summary Panel and aligned to the left.
Inherited from Data |
Fixed |
Gets total summaries displayed within the Fixed Summary Panel and aligned to the right.
Inherited from Data |
Fixed |
Gets or sets a template that defines the appearance of total summary items in the Fixed Summary Panel. This is a dependency property.
Inherited from Data |
Font |
Gets or sets the Grid |
Font |
Gets or sets the Grid |
Font |
Gets or sets the Grid |
Font |
Gets or sets a text style applied to the Grid |
Font |
Gets or sets the Grid |
Foreground |
Gets or sets a brush that paints the Grid |
Format |
Stores conditional formats applied to the Grid |
Grid |
Gets or sets a context menu that is invoked when a user right-clicks an empty space within the Grid |
Group |
Gets or sets a width of the group indent. |
Group |
Gets or sets a context menu that is invoked when a user right-clicks the Group Panel. |
Group |
Gets or sets style settings applied to the group row‘s expand button. |
Group |
Gets or sets a template that defines the appearance of expand buttons displayed in group rows. |
Group |
Gets or sets a group row‘s minimum height. |
Group |
Gets or sets style settings applied to group rows. |
Group |
Provides access to group summary items. |
Group |
Gets or sets the position of group summaries within a group row. This is a dependency property. |
Group |
Gets or sets a template that defines the appearance of group summary items. This is a dependency property. |
Group |
Gets or sets a template that defines the appearance of column values in group rows. This is a dependency property. |
Has |
Gets whether a validation error has been defined for the grid. This is a dependency property.
Inherited from Data |
Header |
Gets or sets whether to display column header tooltips. This is a dependency property.
Inherited from Data |
Highlight |
Gets or sets whether to highlight a row when a user hovers a mouse pointer over this row.
Inherited from Data |
Horizontal |
Gets or sets the horizontal scrollbar’s visibility. This is a dependence property.
Inherited from Data |
Imply |
Inherited from Data |
Incremental |
Gets or sets the threshold range that governs when the grid will begin to prefetch more row items. This is a dependency property.
Inherited from Data |
Is |
Gets whether the focused cell is currently being edited. This is a dependency property.
Inherited from Data |
Is |
Gets or sets whether the current filter is enabled. This is a dependency property.
Inherited from Data |
Is |
Gets whether the grid’s data is grouped. |
Is |
Gets whether the Group Panel is displayed in the Grid |
Is |
Gets whether the Grid |
Is |
Gets or sets whether a grid should keep the Data |
Items |
Gets or sets the grid’s data source. This is a dependency property.
Inherited from Data |
Keep |
Gets or sets whether the focused row retains focus when a user sorts or filters Grid |
Line |
Gets or sets a brush that paints grid lines.
Inherited from Data |
Navigation |
Gets or sets whether to allow users to focus rows and cells. This is a dependency property.
Inherited from Data |
New |
Gets or sets the New Item Row‘s position within the grid. This is a dependency property.
Inherited from Data |
Paste |
Gets or sets how to paste rows from the clipboard to the Grid |
Predefined |
Contains predefined formats used in conditional formatting rules. This is a dependency property.
Inherited from Data |
Preserve |
Gets or sets whether clicking a column header clears the existing sort settings. This is a dependency property.
Inherited from Data |
Print |
Gets or sets whether to print the grid with all group rows expanded. This is a dependency property. |
Print |
Gets or sets whether columns should fit to the report page in a printed document. This is a dependency property. |
Print |
Gets or sets whether to print column headers. This is a dependency property. |
Print |
Gets or sets the style applied to column header items in a printed document. This is a dependency property. |
Print |
Gets or sets whether to print the fixed total summary panel. This is a dependency property. |
Print |
Gets or sets the style applied to fixed total summary items in a printed document. This is a dependency property. |
Print |
Gets or sets the indent between group rows at neighboring group levels when the Grid |
Print |
Gets or sets the style applied to group row items (including Group Summary) in a printed document. This is a dependency property. |
Print |
Gets or sets whether to print the group summary panel. This is a dependency property. |
Print |
Gets or sets whether to print the summary panel. This is a dependency property. |
Print |
Gets or sets the style applied to total summary items when they are printed. This is a dependency property. |
Row |
Gets or sets a context menu that is invoked when a user right-clicks a data cell, a row, or row indicator cells. |
Row |
Gets or sets a template that defines the appearance of the row indicator header.
Inherited from Data |
Row |
Gets or sets style settings applied to the Row Indicator Panel.
Inherited from Data |
Row |
Gets or sets a template that defines the appearance of row indicator cells.
Inherited from Data |
Row |
Gets or sets the width of the Row Indicator Panel.
Inherited from Data |
Row |
Gets or sets a data row’s minimum height.
Inherited from Data |
Row |
Gets or sets style settings applied to grid rows.
Inherited from Data |
Search |
Gets or sets the field names against which searches are performed by the Search Panel. This is a dependency property.
Inherited from Data |
Search |
Gets or sets the amount of time in milliseconds, after which a data search is initiated (in an automatic find mode). This is a dependency property.
Inherited from Data |
Search |
Gets or sets whether the grid displays only those records that match the search criteria. This is a dependency property.
Inherited from Data |
Search |
Gets or sets whether to clear the search string when the Search Panel is closed. This is a dependency property.
Inherited from Data |
Search |
Gets or sets the logical operator type (AND or OR). This is a dependency property.
Inherited from Data |
Search |
Gets or sets the type of the comparison operator used to create filter conditions. This is a dependency property.
Inherited from Data |
Search |
Gets or sets whether data searching starts automatically, or must be started manually. This is a dependency property.
Inherited from Data |
Search |
Gets or sets whether to highlight search results within located records. This is a dependency property.
Inherited from Data |
Search |
Gets or sets settings applied to search results.
Inherited from Data |
Search |
Gets or sets the search string specified within the Search Panel. This is a dependency property.
Inherited from Data |
Selected |
Get or sets the currently focused data item.
Inherited from Data |
Selected |
Gets data objects that correspond to items currently selected within a grid.
Inherited from Data |
Selection |
Gets or sets whether multiple row/cell selection is enabled. This is a dependency property.
Inherited from Data |
Show |
Gets or sets whether to display the Automatic Filter Row.
Inherited from Data |
Show |
Gets or sets whether a grid displays column headers. This is a dependency property.
Inherited from Data |
Show |
Gets or sets when the Filter Panel is displayed within a grid. This is a dependency property.
Inherited from Data |
Show |
Gets or sets whether or not the Fixed Summary Panel is displayed within the grid. This is a dependency property.
Inherited from Data |
Show |
Gets or sets whether to display grouped columns in the Grid |
Show |
Gets or sets whether to display the Group Panel. This is a dependency property. |
Show |
Gets or sets whether to display expand buttons in group rows. |
Show |
Gets or sets whether to display horizontal grid lines.
Inherited from Data |
Show |
Gets or sets whether to display the Loading Panel in the Grid |
Show |
Gets or sets whether to display the Row Indicator Panel.
Inherited from Data |
Show |
Gets or sets when the Search Panel is shown within the grid. This is a dependency property.
Inherited from Data |
Show |
Gets or sets whether to display the total summary panel.
Inherited from Data |
Show |
Gets or sets whether to display vertical grid lines.
Inherited from Data |
Summaries |
Gets or sets whether null values must be ignored when calculating data summaries. This is a dependency property.
Inherited from Data |
Top |
Gets or sets the index of the top visible row.
Inherited from Data |
Total |
Provides access to a collection of total summary items. |
Total |
Gets or sets the template that defines the presentation of total summary items. This is a dependency property.
Inherited from Data |
Validation |
Provides access to the object, which contains information about the validation error. This is a dependency property.
Inherited from Data |
Vertical |
Gets or sets the vertical scrollbar’s visibility. This is a dependence property.
Inherited from Data |
Visible |
Gets a list of visible columns. This is a dependency property.
Inherited from Data |
Visible |
Gets the total number of rows displayed in the Grid |
#Methods
Name | Description |
---|---|
Add |
Adds a new record. |
Begin |
Prevents visual and internal data updates until the Data |
Begin |
Prevents selection updates until the Data |
Clear |
Removes the filter condition applied to the specified column.
Inherited from Data |
Clear |
Removes the filter condition applied to the specified column.
Inherited from Data |
Clear |
Ungroups the grid. |
Clear |
Clears sort by summary operations applied to the grid. |
Clear |
Clears the sorting applied to the grid.
Inherited from Data |
Collapse |
Collapses all group rows. |
Collapse |
Collapses the specified group row and optionally any child group rows at all nesting levels. |
Collapse |
Collapses the specified group row. |
Commit |
Hides the active editor and posts all the changes made within the focused row to a data source if the row values are valid.
Inherited from Data |
Copy |
Copies selected rows/cells to the clipboard. |
Delete |
Deletes the specified data row. |
End |
Enables visual and internal data updates after the Data |
End |
Enables selection updates after calling the Data |
Equals |
Determines whether the specified object instances are considered equal. Inherited from Object. |
Expand |
Expands all group rows. |
Expand |
Expands the specified group row and optionally any child group rows at all nesting levels. |
Expand |
Expands the specified group row. |
Find |
Searches for the data row in the Grid |
Get |
Returns the specified cell’s UI element.
Inherited from Data |
Get |
Returns the value of the specified data cell. |
Get |
Returns the value of the specified data cell. |
Get |
Returns the specified cell’s value. |
Get |
Returns the specified cell’s value. |
Get |
Returns the number of child rows (group or data) contained within the specified group row. |
Get |
Returns the handle of the row contained within the specified group row, at the specified position. |
Get |
Returns a filter applied to the specified column.
Inherited from Data |
Get |
Returns a filter applied to the specified column.
Inherited from Data |
Get |
Returns a filter expression applied to the specified column.
Inherited from Data |
Get |
Returns a filter expression applied to the specified column.
Inherited from Data |
Get |
Returns the handle of the first data row in the specified group row. |
Get |
Returns the value of the group row that corresponds to the specified column. |
Get |
Returns the value of the specified group row. |
Get |
Returns the value of the group summary displayed in the specified group row. |
Get |
Returns the specified data row’s index in a data source. |
Get |
Determines a particular row’s parent group row. |
Get |
Returns an object in a data source that corresponds to the specified row. |
Get |
Returns an object that represents the specified row. |
Get |
Returns a UI element that is the specified row.
Inherited from Data |
Get |
Returns the data row’s handle by its index in a data source. |
Get |
Returns a row’s handle by its visible index. |
Get |
Returns the specified row’s group level. |
Get |
Returns the specified row’s group level. |
Get |
Returns the row’s position in the Grid |
Get |
Returns a list of selected data cells. |
Get |
Returns the value of the specified total summary item. |
Get |
Gets the Type of the current instance. Inherited from Object. |
Group |
Groups data by the values of the specified column and specifies its sort order and group index. |
Group |
Groups data by the values of the specified column with the specified sort order. |
Group |
Groups data by the values of the specified column with the specified group index. |
Group |
Groups data by the values of the specified column. |
Group |
Groups data by the values of the specified column. |
Hide |
Closes the active editor, discarding all the changes made.
Inherited from Data |
Is |
Indicates whether the specified cell is selected.
Inherited from Data |
Is |
Indicates whether the specified group row is expanded. |
Is |
Indicates whether the specified handle corresponds to a group row. |
Is |
Indicates whether the specified row is selected.
Inherited from Data |
Is |
Indicates whether the specified row is visible. |
Is |
Indicates whether the specified row handle is valid. |
Memberwise |
Creates a shallow copy of the current Object. Inherited from Object. |
Merge |
Combines the specified filter with the grid’s current filter with the AND operator.
Inherited from Data |
Merge |
Combines the specified filter with the grid’s current filter with the AND operator.
Inherited from Data |
Move |
Moves the specified column to the specified position.
Inherited from Data |
Move |
Moves focus to the first visible row within a grid.
Inherited from Data |
Move |
Moves focus to the last visible row within a grid.
Inherited from Data |
Move |
Moves focus forward to the bottom row displayed onscreen within a grid.
Inherited from Data |
Move |
Moves focus to the row following the one currently focused. |
Move |
Moves focus backward to the top row displayed onscreen within a grid.
Inherited from Data |
Move |
Moves focus to the row that precedes the focused row, and specifies whether this method can focus the Automatic Filter Row. |
Paste |
Pastes clipboard data to the Grid |
Post |
Saves the active editor’s value to a data source without closing the editor.
Inherited from Data |
Reference |
Determines whether the specified Object instances are the same instance. Inherited from Object. |
Refresh |
Updates the control data.
Inherited from Data |
Refresh |
Reloads the specified row from a data source. |
Scroll |
Makes the specified column visible onscreen.
Inherited from Data |
Scroll |
Makes the specified row visible onscreen.
Inherited from Data |
Scroll |
Makes the specified row visible onscreen.
Inherited from Data |
Select |
Selects all items within a grid.
Inherited from Data |
Select |
Selects the specified cell.
Inherited from Data |
Select |
Selects multiple cells.
Inherited from Data |
Select |
Selects the specified row.
Inherited from Data |
Select |
Selects the specified item.
Inherited from Data |
Select |
Selects multiple items, while preserving the current selection (if any).
Inherited from Data |
Set |
Sets the specified cell’s value. |
Set |
Sets the specified cell’s value. |
Show |
Activates the focused cell’s inplace editor.
Inherited from Data |
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.
Inherited from Data |
Sort |
Sorts data by the values of the specified column in the specified order.
Inherited from Data |
Sort |
Sorts data by the values of the specified column.
Inherited from Data |
Sort |
Sorts data by the values of the specified column in the specified order.
Inherited from Data |
Sort |
Sorts data by the values of the specified column.
Inherited from Data |
To |
Returns a string that represents the current object. Inherited from Object. |
Ungroup |
Ungroups data by the values of the specified column. |
Ungroup |
Ungroups data by the values of the specified column. |
Unselect |
Unselects any selected items within a grid.
Inherited from Data |
Unselect |
Unselects the specified cell.
Inherited from Data |
Unselect |
Unselects multiple cells.
Inherited from Data |
Unselect |
Unselects the specified row.
Inherited from Data |
Unselect |
Unselects the specified item.
Inherited from Data |
Update |
Recalculates group summaries. |
Update |
Updates total summaries.
Inherited from Data |
#Events
Name | Description |
---|---|
Adding |
Fires before a new row is added to the data source via the Grid. |
Auto |
Occurs after the columns have been automatically generated.
Inherited from Data |
Auto |
Occurs each time an individual column is auto-generated.
Inherited from Data |
Cell |
Occurs when a cell value is changed. |
Cell |
Occurs when a user edits a cell value (for example, types or deletes a character, or chooses a value from the drop-down list). |
Clipboard |
Occurs before the Grid |
Clipboard |
Occurs before clipboard data is pasted in the Grid |
Context |
Occurs after a user closes a context menu. |
Context |
Occurs after a user opens a context menu. |
Context |
Occurs before a user opens a context menu. |
Current |
Occurs after the focused column has been changed.
Inherited from Data |
Current |
Occurs after the focused row is changed.
Inherited from Data |
Custom |
Allows you to customize cell appearance.
Inherited from Data |
Custom |
Allows you to customize a data cell’s display text. |
Custom |
Provides the capability to group data using custom rules. |
Custom |
Enables you to sort data using custom rules. |
Custom |
Allows you to display custom text in group rows. |
Custom |
Allows you to use custom rules to filter data rows. |
Custom |
Allows you to calculate summary values manually. |
Custom |
Enables you to specify which summaries should be calculated and displayed. |
Custom |
Enables data to be supplied to unbound columns. |
Custom |
Allows you to specify unique values displayed in a column’s drop-down filter.
Inherited from Data |
End |
Occurs after the grouping operation has been completed. |
End |
Occurs after a sorting operation has been completed. |
Filter |
Occurs after the grid’s filter has been changed.
Inherited from Data |
Group |
Occurs after a group row has been collapsed. |
Group |
Occurs when a group row is about to be collapsed, allowing cancellation of the action. |
Group |
Occurs after a group row has been expanded. |
Group |
Occurs when a group row is about to be expanded, allowing cancellation of the action. |
Hidden |
Occurs after a cell’s editor is closed. |
Init |
Allows you to initialize a new row with default values. |
Invalid |
Occurs when a row fails validation or cannot be saved to a data source. |
Items |
Occurs after the Data |
Row |
Occurs when the changes made in a row are discarded. |
Row |
Occurs when the Grid |
Selection |
Occurs after grid’s selection is changed. |
Show |
Enables you to customize a column’s drop-down filter.
Inherited from Data |
Shown |
Occurs after the focused cell’s editor is shown. |
Start |
Occurs before a grouping operation is started. |
Start |
Occurs before a sorting operation is started. |
Validate |
Enables you to specify whether the focused cell’s data is valid, and whether the cell’s editor can be closed. |
Validate |
Allows you to validate row values. |
See Also