Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Expand]Controls and Libraries
 [Expand]Common Features
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [Expand]DevExpress.DataAccess.UI.Localization
  [Expand]DevExpress.DataAccess.UI.ObjectBinding
  [Expand]DevExpress.DataAccess.UI.Sql
  [Expand]DevExpress.DataAccess.UI.Wizard
  [Expand]DevExpress.DataAccess.UI.Wizard.Services
  [Expand]DevExpress.DataAccess.UI.Wizard.Views
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.DocumentView.Controls
  [Expand]DevExpress.LookAndFeel
  [Expand]DevExpress.LookAndFeel.Helpers
  [Expand]DevExpress.Skins
  [Expand]DevExpress.Snap
  [Expand]DevExpress.Snap.API.Native
  [Expand]DevExpress.Snap.Core
  [Expand]DevExpress.Snap.Core.API
  [Expand]DevExpress.Snap.Core.Fields
  [Expand]DevExpress.Snap.Core.Forms
  [Expand]DevExpress.Snap.Core.Options
  [Expand]DevExpress.Snap.Core.Services
  [Expand]DevExpress.Snap.Extensions
  [Expand]DevExpress.Snap.Extensions.Localization
  [Expand]DevExpress.Snap.Localization
  [Expand]DevExpress.Snap.Options
  [Expand]DevExpress.Snap.Services
  [Expand]DevExpress.Utils
  [Expand]DevExpress.Utils.Animation
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.Drawing
  [Expand]DevExpress.Utils.Menu
  [Expand]DevExpress.Utils.Taskbar
  [Expand]DevExpress.Utils.Taskbar.Core
  [Expand]DevExpress.Utils.UI.Localization
  [Expand]DevExpress.Utils.VisualEffects
  [Expand]DevExpress.Utils.Win
  [Expand]DevExpress.XtraBars
  [Expand]DevExpress.XtraBars.Alerter
  [Expand]DevExpress.XtraBars.Docking
  [Expand]DevExpress.XtraBars.Docking2010
  [Expand]DevExpress.XtraBars.Docking2010.Customization
  [Expand]DevExpress.XtraBars.Docking2010.Views
  [Expand]DevExpress.XtraBars.Docking2010.Views.NativeMdi
  [Expand]DevExpress.XtraBars.Docking2010.Views.Tabbed
  [Expand]DevExpress.XtraBars.Docking2010.Views.Widget
  [Expand]DevExpress.XtraBars.Docking2010.Views.WindowsUI
  [Expand]DevExpress.XtraBars.Localization
  [Expand]DevExpress.XtraBars.Navigation
  [Expand]DevExpress.XtraBars.Ribbon
  [Expand]DevExpress.XtraBars.Ribbon.Gallery
  [Expand]DevExpress.XtraBars.Ribbon.ViewInfo
  [Expand]DevExpress.XtraBars.ToastNotifications
  [Expand]DevExpress.XtraBars.Utils
  [Expand]DevExpress.XtraBars.WinRTLiveTiles
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Designer
  [Expand]DevExpress.XtraCharts.Wizard
  [Expand]DevExpress.XtraDataLayout
  [Expand]DevExpress.XtraDiagram
  [Expand]DevExpress.XtraDiagram.Options
  [Expand]DevExpress.XtraEditors
  [Expand]DevExpress.XtraEditors.ButtonPanel
  [Expand]DevExpress.XtraEditors.Calendar
  [Expand]DevExpress.XtraEditors.Camera
  [Expand]DevExpress.XtraEditors.Container
  [Expand]DevExpress.XtraEditors.Controls
  [Expand]DevExpress.XtraEditors.CustomEditor
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraEditors.Filtering
  [Expand]DevExpress.XtraEditors.Mask
  [Expand]DevExpress.XtraEditors.Persistent
  [Expand]DevExpress.XtraEditors.Repository
  [Expand]DevExpress.XtraEditors.ViewInfo
  [Expand]DevExpress.XtraFilterEditor
  [Expand]DevExpress.XtraGauges.Presets.Styles
  [Expand]DevExpress.XtraGauges.Win
  [Expand]DevExpress.XtraGauges.Win.Base
  [Expand]DevExpress.XtraGauges.Win.Gauges.Circular
  [Expand]DevExpress.XtraGauges.Win.Gauges.Digital
  [Expand]DevExpress.XtraGauges.Win.Gauges.Linear
  [Expand]DevExpress.XtraGauges.Win.Gauges.State
  [Collapse]DevExpress.XtraGrid
    FormatConditionEnum Enumeration
   [Expand]GridColumnSummaryItem Class
   [Expand]GridColumnSummaryItemCollection Class
   [Collapse]GridControl Class
     GridControl Members
     GridControl Constructor
    [Expand]GridControl Properties
    [Expand]GridControl Events
    [Collapse]GridControl Methods
      About Method
     [Expand]AccessibleNotifyClients Method
      BeginInit Method
      BeginUpdate Method
      CreateSplitContainer Method
      CreateView Method
      EndUpdate Method
     [Expand]ExportToCsv Method
      ExportToExcelOld Method
     [Expand]ExportToHtml Method
      ExportToHtmlOld Method
     [Expand]ExportToMht Method
     [Expand]ExportToPdf Method
     [Expand]ExportToRtf Method
     [Expand]ExportToText Method
      ExportToTextOld Method
     [Expand]ExportToXls Method
     [Expand]ExportToXlsx Method
      FireChanged Method
      ForceInitialize Method
      GetViewAt Method
      InternalGetService Method
      IsVisibleView Method
      LockFireChanged Method
      Print Method
      PrintDialog Method
      RefreshDataSource Method
      RemoveSplitContainer Method
      ShowPreview Method
      ShowPrintPreview Method
      ShowRibbonPrintPreview Method
      SwitchPaintStyle Method
      UnlockFireChanged Method
   [Expand]GridControlViewCollection Class
   [Expand]GridFormatRule Class
   [Expand]GridFormatRuleCollection Class
   [Expand]GridGroupSummaryItem Class
   [Expand]GridGroupSummaryItemCollection Class
   [Expand]GridLevelNode Class
   [Expand]GridLevelNodeCollection Class
   [Expand]GridLevelTree Class
   [Expand]GridSplitContainer Class
   [Expand]GridSummaryItem Class
   [Expand]GridSummaryItemCollection Class
   [Expand]StyleFormatCondition Class
   [Expand]StyleFormatConditionCollection Class
   [Expand]ViewFocusEventArgs Class
    ViewFocusEventHandler Delegate
   [Expand]ViewOperationEventArgs Class
    ViewOperationEventHandler Delegate
  [Expand]DevExpress.XtraGrid.Columns
  [Expand]DevExpress.XtraGrid.EditForm
  [Expand]DevExpress.XtraGrid.FilterEditor
  [Expand]DevExpress.XtraGrid.Localization
  [Expand]DevExpress.XtraGrid.Views.BandedGrid
  [Expand]DevExpress.XtraGrid.Views.BandedGrid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Base
  [Expand]DevExpress.XtraGrid.Views.Base.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Card
  [Expand]DevExpress.XtraGrid.Views.Card.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Grid
  [Expand]DevExpress.XtraGrid.Views.Grid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Layout
  [Expand]DevExpress.XtraGrid.Views.Layout.Events
  [Expand]DevExpress.XtraGrid.Views.Layout.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Printing
  [Expand]DevExpress.XtraGrid.Views.Tile
  [Expand]DevExpress.XtraGrid.Views.WinExplorer
  [Expand]DevExpress.XtraGrid.WinExplorer
  [Expand]DevExpress.XtraLayout
  [Expand]DevExpress.XtraLayout.Customization
  [Expand]DevExpress.XtraLayout.HitInfo
  [Expand]DevExpress.XtraLayout.Localization
  [Expand]DevExpress.XtraLayout.Utils
  [Expand]DevExpress.XtraMap
  [Expand]DevExpress.XtraMap.Printing
  [Expand]DevExpress.XtraNavBar
  [Expand]DevExpress.XtraNavBar.ViewInfo
  [Expand]DevExpress.XtraPdfViewer
  [Expand]DevExpress.XtraPdfViewer.Commands
  [Expand]DevExpress.XtraPdfViewer.Localization
  [Expand]DevExpress.XtraPivotGrid
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.Control
  [Expand]DevExpress.XtraPrinting.Preview
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Commands
  [Expand]DevExpress.XtraRichEdit.Export
  [Expand]DevExpress.XtraRichEdit.Import
  [Expand]DevExpress.XtraRichEdit.Localization
  [Expand]DevExpress.XtraRichEdit.Menu
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.Printing
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Reporting.UI
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpellChecker.Localization
  [Expand]DevExpress.XtraSplashForm
  [Expand]DevExpress.XtraSplashScreen
  [Expand]DevExpress.XtraSpreadsheet
  [Expand]DevExpress.XtraSpreadsheet.Services
  [Expand]DevExpress.XtraTab
  [Expand]DevExpress.XtraTab.Buttons
  [Expand]DevExpress.XtraTab.ViewInfo
  [Expand]DevExpress.XtraTabbedMdi
  [Expand]DevExpress.XtraToolbox
  [Expand]DevExpress.XtraTreeList
  [Expand]DevExpress.XtraTreeList.Columns
  [Expand]DevExpress.XtraTreeList.Data
  [Expand]DevExpress.XtraTreeList.Localization
  [Expand]DevExpress.XtraTreeList.Menu
  [Expand]DevExpress.XtraTreeList.Nodes
  [Expand]DevExpress.XtraTreeList.Nodes.Operations
  [Expand]DevExpress.XtraTreeList.StyleFormatConditions
  [Expand]DevExpress.XtraTreeMap
  [Expand]DevExpress.XtraVerticalGrid
  [Expand]DevExpress.XtraVerticalGrid.Events
  [Expand]DevExpress.XtraVerticalGrid.Localization
  [Expand]DevExpress.XtraVerticalGrid.Rows
  [Expand]DevExpress.XtraWaitForm
  [Expand]DevExpress.XtraWizard
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

GridControl Methods

Displays data from a data source in a standard tabular form (view), or in various other forms (as a banded grid, cards or tiles). Supports numerous editing and data-shaping features, such as summaries, filtration, data grouping, master-detail mode, etc. See Data Grid.

Expanded Public Methods

Show: Inherited
  Name Description
Public methodStatic member About Activates the control's About dialog box.
Public method AccessibleNotifyClients Overloaded. Notifies accessibility client applications of the specified System.Windows.Forms.AccessibleEvents event for the specified child control.
Public method BeginInit Starts the grid's runtime initialization.
Public method BeginInvoke Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on. (Inherited from System.Windows.Forms.Control)
Public method BeginUpdate Locks the GridControl object by preventing visual updates of the object and its elements until the EndUpdate method is called.
Public method BringToFront Brings the control to the front of the z-order. (Inherited from System.Windows.Forms.Control)
Public method Contains Retrieves a value indicating whether the specified control is a child of the control. (Inherited from System.Windows.Forms.Control)
Public method CreateControl Forces the creation of the control, including the creation of the handle and any child controls. (Inherited from System.Windows.Forms.Control)
Public method CreateGraphics Creates the System.Drawing.Graphics for the control. (Inherited from System.Windows.Forms.Control)
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public method CreateSplitContainer Creates a Split Container and places the current GridControl to it.
Public method CreateView Creates a View of the specified type.
Public method Dispose Releases all resources used by the System.ComponentModel.Component. (Inherited from System.ComponentModel.Component)
Public method DoDragDrop Begins a drag-and-drop operation. (Inherited from System.Windows.Forms.Control)
Public method DrawToBitmap Supports rendering to the specified bitmap. (Inherited from System.Windows.Forms.Control)
Public method EndInit Notifies the control that the initialization has been completed. (Inherited from EditorContainer)
Public method EndInvoke Retrieves the return value of the asynchronous operation represented by the System.IAsyncResult passed. (Inherited from System.Windows.Forms.Control)
Public method EndUpdate Unlocks the GridControl object after a call to the BeginUpdate method and causes an immediate visual update.
Public methodStatic member Equals Determines whether the specified System.Object instances are considered equal. (Inherited from System.Object)
Public method Equals Determines whether the specified System.Object is equal to the current System.Object. (Inherited from System.Object)
Public method ExportToCsv Overloaded. Exports the data displayed by the DefaultView (the MainView or the currently maximized detail View) to the specified stream in CSV format using the specified options.
Public method ExportToExcelOld Obsolete. Exports the data displayed by the DefaultView (the MainView or the currently maximized detail View) to the specified file in XLS format.
Public method ExportToHtml Overloaded. Exports the data displayed by the DefaultView (the MainView or the currently maximized detail View) to the specified stream in HTML format with the specified title, using the specified character encoding. The output file can be compressed (secondary characters e.g. spaces are removed) if required.
Public method ExportToHtmlOld Obsolete. Exports the data displayed by the DefaultView (the MainView or the currently maximized detail View) to the specified file in HTML format.
Public method ExportToMht Overloaded. Exports the data displayed by the DefaultView (the MainView or the currently maximized detail View) to the specified file in MHT format using the specified character encoding.
Public method ExportToPdf Overloaded. Exports the data displayed by the DefaultView (the MainView or the currently maximized detail View) to the specified stream in PDF format.
Public method ExportToRtf Overloaded. Exports the data displayed by the DefaultView (the MainView or the currently maximized detail View) to a stream in RTF format.
Public method ExportToText Overloaded. Exports the data displayed by the DefaultView (the MainView or the currently maximized detail View) to a stream in TXT format using the specified separator string, quotation and text encoding settings.
Public method ExportToTextOld Obsolete. Exports the data displayed by the DefaultView (the MainView or the currently maximized detail View) to the specified file in TXT format.
Public method ExportToXls Overloaded. Exports the data displayed by the DefaultView (the MainView or the currently maximized detail View) to a stream in XLS format.
Public method ExportToXlsx Overloaded. Exports the data displayed by the DefaultView (the MainView or the currently maximized detail View) to the specified file in XLSX (MS Excel 2007) format using the specified options.
Public method FindForm Retrieves the form that the control is on. (Inherited from System.Windows.Forms.Control)
Public method FireChanged Forces an update to the control's properties that are listed within the property grid at design time.
Public method Focus Sets input focus to the control. (Inherited from System.Windows.Forms.Control)
Public method ForceInitialize Forces the grid control to finish its initialization.
Public methodStatic member FromChildHandle Retrieves the control that contains the specified handle. (Inherited from System.Windows.Forms.Control)
Public methodStatic member FromHandle Returns the control that is currently associated with the specified handle. (Inherited from System.Windows.Forms.Control)
Public method GetChildAtPoint Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type. (Inherited from System.Windows.Forms.Control)
Public method GetContainerControl Returns the next System.Windows.Forms.ContainerControl up the control's chain of parent controls. (Inherited from System.Windows.Forms.Control)
Public method GetHashCode Serves as a hash function for a particular type. System.Object.GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from System.Object)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public method GetNextControl Retrieves the next control forward or back in the tab order of child controls. (Inherited from System.Windows.Forms.Control)
Public method GetPreferredSize Retrieves the size of a rectangular area into which a control can be fitted. (Inherited from System.Windows.Forms.Control)
Public method GetToolTipController Returns the actual tooltip controller that controls the behavior and appearance of hints for the container editor. (Inherited from EditorContainer)
Public method GetType Gets the System.Type of the current instance. (Inherited from System.Object)
Public method GetViewAt Gets the View owning the specific point.
Public method Hide Conceals the control from the user. (Inherited from System.Windows.Forms.Control)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public method InternalGetService The function supports the internal infrastructure and is not intended to be called from your code.
Public method Invalidate Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. (Inherited from System.Windows.Forms.Control)
Public method Invoke Executes the specified delegate on the thread that owns the control's underlying window handle. (Inherited from System.Windows.Forms.Control)
Public methodStatic member IsKeyLocked Determines whether the CAPS LOCK, NUM LOCK, or SCROLL LOCK key is in effect. (Inherited from System.Windows.Forms.Control)
Public methodStatic member IsMnemonic Determines if the specified character is the mnemonic character assigned to the control in the specified string. (Inherited from System.Windows.Forms.Control)
Public method IsVisibleView Indicates whether a specific View is currently visible.
Public method LockFireChanged Prevents change notifications from being sent until the UnlockFireChanged method is called.
Public method LogicalToDeviceUnits (Inherited from System.Windows.Forms.Control)
Public method PerformLayout Forces the control to apply layout logic to all its child controls. (Inherited from System.Windows.Forms.Control)
Public method PointToClient Computes the location of the specified screen point into client coordinates. (Inherited from System.Windows.Forms.Control)
Public method PointToScreen Computes the location of the specified client point into screen coordinates. (Inherited from System.Windows.Forms.Control)
Public method PreProcessControlMessage Preprocesses keyboard or input messages within the message loop before they are dispatched. (Inherited from System.Windows.Forms.Control)
Public method PreProcessMessage Preprocesses keyboard or input messages within the message loop before they are dispatched. (Inherited from System.Windows.Forms.Control)
Public method Print Prints the grid control's DefaultView (the MainView or the currently maximized detail View) without showing a print preview or print dialog.
Public method PrintDialog Displays the standard Print dialog to print the data displayed in the Grid Control's DefaultView.
Public method RectangleToClient Computes the size and location of the specified screen rectangle in client coordinates. (Inherited from System.Windows.Forms.Control)
Public method RectangleToScreen Computes the size and location of the specified client rectangle in screen coordinates. (Inherited from System.Windows.Forms.Control)
Public methodStatic member ReferenceEquals Determines whether the specified System.Object instances are the same instance. (Inherited from System.Object)
Public method Refresh Forces the control to invalidate its client area and immediately redraw itself and any child controls. (Inherited from System.Windows.Forms.Control)
Public method RefreshDataSource Updates the MainView to reflect changes made to a data source.
Public method RemoveSplitContainer Removes the Grid Control from a Split Container and disposes of this Split Container.
Public method ResetBackColor Resets the System.Windows.Forms.Control.BackColor property to its default value. (Inherited from System.Windows.Forms.Control)
Public method ResetBindings Causes a control bound to the System.Windows.Forms.BindingSource to reread all the items in the list and refresh their displayed values. (Inherited from System.Windows.Forms.Control)
Public method ResetCursor Resets the System.Windows.Forms.Control.Cursor property to its default value. (Inherited from System.Windows.Forms.Control)
Public method ResetFont Resets the System.Windows.Forms.Control.Font property to its default value. (Inherited from System.Windows.Forms.Control)
Public method ResetForeColor Resets the System.Windows.Forms.Control.ForeColor property to its default value. (Inherited from System.Windows.Forms.Control)
Public method ResetImeMode Resets the System.Windows.Forms.Control.ImeMode property to its default value. (Inherited from System.Windows.Forms.Control)
Public method ResetRightToLeft Resets the System.Windows.Forms.Control.RightToLeft property to its default value. (Inherited from System.Windows.Forms.Control)
Public method ResetText Resets the System.Windows.Forms.Control.Text property to its default value. (Inherited from System.Windows.Forms.Control)
Public method ResumeLayout Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests. (Inherited from System.Windows.Forms.Control)
Public method Scale Scales the control and all child controls by the specified scaling factor. (Inherited from System.Windows.Forms.Control)
Public method ScaleBitmapLogicalToDevice (Inherited from System.Windows.Forms.Control)
Public method Select Activates the control. (Inherited from System.Windows.Forms.Control)
Public method SelectNextControl Activates the next control. (Inherited from System.Windows.Forms.Control)
Public method SendToBack Sends the control to the back of the z-order. (Inherited from System.Windows.Forms.Control)
Public method SetBounds Sets the bounds of the control to the specified location and size. (Inherited from System.Windows.Forms.Control)
Public method Show Displays the control to the user. (Inherited from System.Windows.Forms.Control)
Public method ShowPreview Obsolete. Opens the Print Preview window for the grid control's Default View.
Public method ShowPrintPreview Opens the Print Preview window with a Bars UI.
Public method ShowRibbonPrintPreview Displays the Print Preview window with a Ribbon UI.
Public method SuspendLayout Temporarily suspends the layout logic for the control. (Inherited from System.Windows.Forms.Control)
Public method SwitchPaintStyle Applies the specified paint style to all Views.
Public method ToString Returns a System.String containing the name of the System.ComponentModel.Component, if any. This method should not be overridden. (Inherited from System.ComponentModel.Component)
Public method UnlockFireChanged Re-enables change notifications after a call to the LockFireChanged method.
Public method Update Causes the control to redraw the invalidated regions within its client area. (Inherited from System.Windows.Forms.Control)
Top

Expanded See Also

How would you rate this topic?​​​​​​​