GridControl Control Members

Public Methods

Method	Description
AboutBox	Displays a dialog box that indicates the current version of the control.
AddRecord	Adds a record to the grid.
AddRecordEx	Adds record to records collection and associates a row with it.
AddRecordEx2	Adds record to records collection and associates a row with it.
AddRecordEx3	Adds record to records collection and associates a row with it.
ClearContent	Clears all memory from the grid.
CollapseAll	Collapses all rows.
Copy	Copies the data (in the Binary and Text data formats) from all currently selected records to the clipboard. Selected records will remain.
CreateIconViewAndRowNumberColumn	Creates an icon column to be used in the grid.
CreatePrintView	If the CommandBars control is used, CreatePrintView allows the CommandBars Control's PrintPreview control to be used to display the Grid.
CreateRecords	Creates an empty records collection.
CreateRecordsFromDropArray	Creates a GridRecords collection object from a ByteArray.
CreateRowNumberColumn	Creates a row number column.
Cut	Copies the data (in the Binary and Text data formats) from all currently selected records to the clipboard. Selected records will be removed.
DoPropExchange	Exchanges layout and state information to/from a PropExchange object.
DragRecords	Prepares records to be dropped into the Grid Control.
EditItem	The EditItem method is used to set focus to a specific row and column so that it can be edited.
EnableDragDrop	Enables drag and drop functionality.
EnableToolTips	The EnableToolTips method enables or disables the use of tool tips in the GridControl.
ExpandAll	Expands all rows that are collapsed.
GetElementRect	Retrieves a grid element rectangle.
HitTest	Returns hit test information for a given X and Y pixel on the screen.
IconViewRowNumberSetup	Sets up the IconView and row number methods.
IconViewSetup	Specifies the icon used for all items in IconView.
InsertRecord	Inserts a record into the grid.
IsShowIconWhenEditing	Determines if icons are displayed for an item while it is being edited.
LoadSettings	Loads the GridColumn settings of the GridControl from a string.
Paste	Reads records from the clipboard and adds them to the records collection.
Populate	Populates the GridControl's with GridRow collection with the data contained in the GridRecords.
PopulateFooterRows	Performs control's footer rows population, creating view from the data.
PopulateHeaderRows	Performs control's header rows population, creating view from the data.
PrintGrid	Prints the current Grid view.
PrintGrid2	Prints the current Grid view with the option to print immediately without showing any dialogs or needing any HDC handle.
PrintPreview	Displays a print preview window.
PrintPreviewExt	Runs print preview in non-maximized mode with given screen position and size.
ReCalc	Updates the results of a given Formula for an item.
Redraw	Redraws the GridControl.
RemoveRecordEx	Removes a Row in the grid by specifying the attached GridRecord.
RemoveRowEx	Removes a Row in the grid.
SaveSettings	Saves the GridColumn settings of the GridControl.
SetCustomDraw	Specifies which of the three custom draw events should be executed when the rows and items are drawn.
SetFieldChooserHandle	Associates a FieldChooser control with the GridControl.
SetIconViewToDefaults	Resets all IconView parameters to their defaults.
SetImageList	Associates an ImageList with the GridControl.
SetScrollBars	Sets custom ScrollBars from the SuitePackage to be used by the GridControl.
SetVirtualMode	Enables virtual mode of the Grid Control.
SetWatermarkBitmap	Sets a watermark bitmap to be shown in the Grid control background from a resource.
SetWatermarkBitmapFromFile	Sets a watermark bitmap to be shown in the Grid control background using a bmp file.
ShowIconWhenEditing	Specifies whether icons displayed for an item will be visible while the item is getting edited.
ShowPrintPageSetup	Displays a custom "Page Setup" print dialog for the Grid.
ShowRowNumber	Shows a column that displays the row numbers.
UpdateRecord	Updates a record that has been modified to the current grouping and sorting.

Public Properties

Property	Description
AllowColumnRemove	Specifies whether GridColumns can be removed from the GridControl.
AllowColumnReorder	Specifies whether GridColumns can be reordered in the GridControl.
AllowColumnResize	Specifies whether GridColumns can be resized.
AllowColumnSort	Specifies whether GridColumns can be sorted.
AllowEdit	Allows the text in all GridRecordItems to be edited.
AllowEditPreview	Allows the preview rows to be edited by the user.
AllowGroup	Specifies whether to allow grouping.
AllowSelectionCheck	Specifies whether to allow a check box to be checked using the right mouse button.
AllowSort	Specifies whether to allow sorting.
AutoColumnSizing	Specifies if AutoColumnSizing should be used.
AutoVScrollTimerResolution	Gets or sets the vertical scrolling timer resolution.
Behavior	Specifies the behavior of the Grid control when a mouse button or keystroke is performed on a row/group row in the grid.
BorderStyle	The type of border style that is placed around the GridControl.
CanCopy	Specifies whether the Copy operation can be performed.
CanCut	Specifies whether the Cut operation can be performed.
CanPaste	Specifies whether the Paste operation can be performed.
Columns	The GridControl's collection of GridColumn objects.
CustomTitle	Used for unique title - e.g. for PrintJob name.
DataManager	Gets or sets the grid data manager.
DefaultRowFreeHeight	Specifies the default height for free rows.
DesktopTrackerMode	Specifies whether to use Vista Tracker Mode (On or Off). This fixes desktop flicker.
DisableReorderColumnsCount	Gets or sets the count of the columns at the left side where reordering is disabled.
DragSensitivityX	Horizontal sensitivity of Drag'n'Drop operation in pixels. Default value is 3.
DragSensitivityY	Vertical sensitivity of Drag'n'Drop operation in pixels. Default value is 3.
EditMode	Indicates whether the in-place edit control is currently active (visible and focused).
EditOnClick	Determines whether a GridRecordItem can be edited by single-clicking on the item.
EditOnDelayClick	Enables or disables the delay click edit feature for GridRecordItems (like editing a file name in Windows explorer).
EditOnDoubleClick	Specifies whether a GridRecordItem can be edited by double-clicking on the item.
Enabled	Gets or sets a value indicating whether the GridControl can respond to user interaction.
EnableMarkup	Enables the use of XAML to display text in the Grid control.
EnsureFocusedRowVisible	Gets or sets whether focused rows will be forced visible.
FastDeselectMode	Specifies whether all selected rows can quickly be de-selected with the click of a mouse.
FieldChooser	Associates a FieldChooser control with the GridControl.
FilterHiddenColumns	Specifies whether to search filter text in hidden columns.
FilterSeparatorStrict	Specifies whether text filtering will be strict.
FilterText	The FilterText property is used to filter the rows in the Grid Control by one or more text strings.
FocusedColumn	The FocusedColumn property returns a reference to the Column that contains the GridRecordItem (SubItem) that currently has focus in the GridControl.
FocusedRow	Returns a reference to the row that currently has focus in the GridControl.
FocusSubItems	Specifies whether sub-items should receive focus.
FooterRecords	Returns the collection of footer records.
FooterRows	Returns the collection of the grid footer rows.
FooterRowsAllowAccess	Specifies whether to allow user to move selection to footer rows.
FooterRowsAllowEdit	Allows the text in all Footer Row GridRecordItems to be edited.
FooterRowsAllowGroup	Specifies whether to allow grouping in footer rows.
FooterRowsAllowSort	Specifies whether to allow sorting in footer rows.
FooterRowsEnableSelection	Enables or disables selection in footer rows.
ForcePagination	Specifies whether to force the grid to be split up into "pages" while in print preview mode.
FreeHeightMode	Allows row height to be changed using the mouse to drag to a new height.
FreezeColumnsAbs	Gets or sets whether the freeze column is absolute or relative.
FreezeColumnsCount	Gets/Sets the number of columns that are frozen when the grid is scrolled horizontally.
FullColumnScrolling	Specifies whether full column scrolling will be used.
GroupsOrder	Used to determine how the GridControl is grouped.
HeaderRecords	Returns the collection of header records.
HeaderRows	Returns the collection of the grid header rows.
HeaderRowsAllowAccess	Specifies whether to allow user to move selection to header rows.
HeaderRowsAllowEdit	Allows the text in all Header Row GridRecordItems to be edited.
HeaderRowsAllowGroup	Specifies whether to allow grouping in header rows.
HeaderRowsAllowSort	Specifies whether to allow sorting in header rows.
HeaderRowsEnableSelection	Enables or disables selection in header rows.
HideColumnAfterGroupBoxDrop	Specifies whether to hide the column after it is dropped into the group box.
HScrollStep	Gets or sets the amount of pixels the grid is scrolled when the horizontal scroll bar buttons are clicked.
hWnd	The hWnd property returns the handle to the Grid Control.
Icons	A collection of icons that can be used in GridRecordItem and GridColumn objects.
IconView	Displays or hides Icon View, a view similar to the Icon View in Windows Explorer.
InitialSelectionEnable	Specifies whether the first row in the grid will become selected when initially populated.
InplaceEditHwnd	Returns the handle to the currently used In-place Edit control.
LeftOffset	Gets or sets the horizontal scroll position.
LockExpand	Specifies whether collapsing/expanding rows is locked.
MarkupContext	Object used to connect XML Markup with methods, functions, and events.
MaxColumnWidth	Get or set the maximum column width for all columns.
MovePivot	Specifies whether multiple selections are allowed.
MultipleSelection	Enables/disables the multiple selection mode for the control.
Navigator	Object used to handle navigation activities in the Grid Control.
OLEDropAbove	Specifies whether the drop marker is above or below the current row when using OLEDragDrop.
OLEDropMode	Specifies the drop mode used by the task panel for dropping external items.
OverrideThemeMetrics	Specifies whether to allow themes to override control metrics.
PaintManager	A GridPaintManager object used for drawing the GridControl.
PinFooterRows	Specifies whether to pin footer records to the last body row.
PinFooterRowsPrinted	Specifies whether to pin footer records to the last body row when printed.
PopulatedRecordsCount	The current number of records displayed in the grid.
PreviewMode	Specifies whether PreviewMode is enabled.
PrintGroupRowIcon	Specifies whether the group row expand/collapse icons should be displayed.
PrintOptions	Options that specify how the Grid should look when sent to a print device.
PrintPreviewOptions	Object that contains options for the print preview window.
Records	The GridControl's collection of GridRecord objects.
RecordsTreeFilterMode	Gets or sets the filtering mode for the Record tree.
ReCreateReparented	Specifies whether to re-create reparented records.
ReleaseOnDestroy	Before destroying, check until WM_DESTROY handling is complete.
RightToLeft	Gets or sets a value indicating whether the CommandBars elements are aligned to support locales using right-to-left fonts.
RightToLeftReading	Allows Right-To-Left (RTL) reading order without changing the entire layout of the control.
Rows	The GridControl's collection of GridRow objects.
ScrollMode	Gets or sets the scroll mode for the Grid control.
ScrollModeH	Gets or sets the scroll mode for horizontal scrolling in the Grid control.
ScrollModeV	Gets or sets the scroll mode for vertical scrolling in the Grid control.
Sections	Collection of grid sections (header, footer, or body).
SelectedRows	The collection of currently selected rows in the GridControl.
SelectionEnable	Gets or sets whether rows will become selected when clicked or navigated with the arrow keys.
SelectionExcludeGroupRows	Specifies whether group rows will be included in the selection when the collapse (+/-) button is pressed while selecting multiple rows.
SendContextMenuForWholeHeaderArea	The ColumnClick event will be called when the right mouse button is clicked anywhere over the grid header or column headers.
ShowFooter	Shows or hides the grid column footer.
ShowFooterRows	Hides or shows the footer rows.
ShowGroupBox	Specifies whether the Group By box is shown at the top of the GridControl.
ShowHeader	The ShowHeader property is used to hide or display the Column Headers in the Grid Control.
ShowHeaderRows	Hides or shows the header rows.
ShowItemsInGroups	GridRecordItems will be automatically shown in groups when a column is sorted.
ShowRowFocus	Specifies whether to draw a focus rectangle around the focused row.
SkipGroupsFocus	Specifies whether groups are skipped when navigating the GridControl with the Up and Down keys.
SortLocale	Specifies how text, dates, times, and currencies are sorted based on locale.
SortOrder	Used to determine how the GridControl is sorted.
SortRecordChildren	Specifies the sort order to record children.
StrictBestFit	BestFitMode will only be used in non-autosize mode (when AutoSize is False).
ToolTipContext	ToolTipContext object represents the tool tip window that is used to display tool tips.
TopRowIndex	The TopRowIndex property will either return the index of the topmost row or it will scroll a row until it is the topmost row in the Grid control view.
TrapTabKey	Traps the TAB key when an item begins to be edited by the user.
UnrestrictedDragDrop	Specifies whether child rows can be dropped to any position, not just among sibling child records.
VisualTheme	Gets or sets the theme for the grid.
WatermarkAlignment	Gets or sets the alignment of the watermark.

Events

Event	Description
BeforeCopyToText	Occurs before all text data from a record is copied to the clipboard.
BeforeDrawRow	Occurs before a GridRecordItem is drawn in each GridRow.
BeforePaste	Occurs before a record that contains ONLY text data is inserted/pasted into the grid.
BeforePasteFromText	Occurs after creating new record using binary data read from the clipboard, but before the record is added to the grid.
BeginDrag	Occurs when records start to be dragged from/within the Grid Control.
BeginEdit	Occurs when the user begins to edit an item.
ColumnClick	Occurs when a GridColumn header or Grid Header Area is right-clicked in the GridControl.
ColumnOrderChangedEx	Occurs when the order of the columns change.
ColumnWidthChanged	Occurs when the width of a column has changed.
ConstraintSelecting	Occurs when a constraints list is navigated with the keyboard arrow keys.
DragDropCompleted	Occurs when the drag and drop operation has completed.
DragOverRecords	Occurs when the user is dragging records over other records.
DrawItem	Occurs before a GridRecordItem is drawn.
DrawPreviewItem	Occurs before a preview item is drawn.
DropRecordsEx	Occurs when records are dropped into a Grid Control but before they are actually added to the grid.
EditCanceled	Occurs when in-place editing is canceled and value is not changed.
FocusChanging	Occurs before a user selects a row or a column.
GetToolTipInfo	Occurs before a tooltip is displayed in the grid.
GiveFeedback	Called during drag operations, provides visual feedback during drag-and-drop operations.
GroupOrderChangedEx	Occurs when the user changes the columns group order of Grid control.
HScroll	Occurs when the grid has been horizontally scrolled.
HyperlinkClick	Occurs when a hyperlink in an item is clicked.
InplaceButtonDown	Occurs when an in-place button is used to edit an item's value.
InplaceEditChanging	Occurs when an item/cell enters edit mode.
ItemButtonClick	Occurs when a GridItemControl button is clicked.
ItemCheck	Occurs when a GridRecordItem is clicked.
KeyDown	Occurs when a key is pressed on the keyboard and the GridControl has focus.
KeyUp	Occurs when a key on the keyboard has been released (after being pressed) and the GridControl has focus.
MeasurePreviewItem	Occurs before a Preview Item is drawn.
MeasureRow	Occurs before a row is drawn.
MouseDown	Occurs when a button on the mouse is pressed anywhere on the GridControl.
MouseMove	Occurs when the mouse pointer is moved anywhere over the GridControl.
MouseUp	Occurs when a button on the mouse has been released anywhere on the GridControl.
OLEDragDrop	Occurs when a source component is dropped onto a target component when the source component determines that a drop can occur.
OLEDragOver	Occurs when one component is dragged over another.
PlusMinusClick	Occurs when a plus/minus button is clicked.
PreviewKeyDown	Occurs when a key is pressed on the keyboard during the Preview KeyDown event.
RecordsDropped	Occurs immediately after records have been dropped onto the grid and the records have actually been added to the grid and the grid has been updated.
ReCreated	Occurs when a record is recreated.
RequestEdit	Occurs when a request to edit an item is made.
RowDblClick	Occurs when a GridRecordItem in a GridRow is double-clicked.
RowExpanded	Occurs when a GridRow is expanded.
RowHeightChanged	Occurs when the height of a row has changed.
RowRClick	Occurs when a GridRecordItem in a GridRow is right-clicked.
SelectionChanged	Occurs when the selection changes in the GridControl.
SelectionChanging	Occurs when the selection is in the process of changing in the GridControl.
SortOrderChanged	Occurs when the column sort order is changed.
ValueChanged	Occurs when the value of a GridRecordItem has changed.
ValueChanging	Occurs before the value of an item is changed by the user.
VScroll	Occurs when the grid has been vertically scrolled.

GridControl Control Members

See Also

GridControl Control Members

Public Methods

Public Properties

Events

See Also