Class GridGroupingControl

Represents a control that provides support for displaying ADO.NET data and other datasources in a grid. Data will be loaded from the given datasource and changes will be written back to the datasource. Both flat tables and hierarchical data can be displayed. Records can be grouped into categories and summaries can be displayed for each group.

Inheritance

System.Object

GridGroupingControl

Implements

IEngineSource

System.ComponentModel.ISupportInitialize

System.ComponentModel.ICustomTypeDescriptor

ITableEventsTarget

IVisualStyle

Namespace: Syncfusion.Windows.Forms.Grid.Grouping

Assembly: Syncfusion.Grid.Grouping.Windows.dll

Syntax

public class GridGroupingControl : Control, IEngineSource, ISupportInitialize, ICustomTypeDescriptor, ITableEventsTarget, IVisualStyle

Remarks

To display a table in the GridGroupingControl at run-time, set the DataSource and DataMember properties to a valid datasource. The following datasources are valid:

A DataTable
A DataView
A DataSet
A single dimension array
Any component that implements the IListSource interface
Any component that implements the IList interface.

GridGroupingControl is a user control that hosts a GridTableControl, a GridGroupDropArea, and a RecordNavigationBar.

Its main properties for the DataModel are: DataSource, DataMember, Engine, TableDescriptor, and Table.

Properties for user display controls are: TableControl, GridGroupDropArea, and RecordNavigationBar.

The GridGroupingControl provides properties to get / set the DataSource using the DataSource and DataMember properties. The DataSource can be set through the designer.

The TableControl property gives access to the hosted GridTableControl. The GridTableControl is a grid derived from GridControlBase.

The GridGroupDropArea property gives access to the hosted GridGroupDropArea control. Its purpose is to allow dragging header columns from the GridTableControl for user-interactive grouping of records. You can hide and show this area with the ShowGroupDropArea property.

The RecordNavigationBar property gives access to the hosted RecordNavigationBar control. You can show or hide the record navigation bar with the ShowNavigationBar property.

The GridTableControl is the main element in the GridGroupingControl. The GridTableControl displays the rows from the DisplayElements collection of the Table using schema information stored in the TableDescriptor.

TableDescriptor gives access to the table schema information of the root table in the datasource.

The TableDescriptor object is instantiated by the GridEngine class and initialized with default schema information from the list assigned to DataSource.

The GridEngine is accessed through the Engine property. The GridEngine object is instantiated with the virtual CreateEngine() method. If you want to subclass the GridEngine, you should override this method.

The Engine object is the main grouping engine object. It is derived from the Engine base class and adds Windows Forms specific functionality such as support for a Forms BindingContext and CurrencyManager. GridEngine also has special overrides of the virtual Engine.CreateTableDescriptor and Engine.CreateTable methods so that the grid-specific derived GridTable class (derived from Syncfusion.Grouping.Engine) and GridTableDescriptor class (derived from Syncfusion.Grouping.TableDescriptor) are instantiated.

There is only one GridEngine object for a GridGroupingControl. GridTableDescriptor and GridTable objects on the other side can be more than one when hierarchies are displayed. For each hierarchy level, a GridTableDescriptor and GridTable are initialized. For example, if you have an ADO.NET DataSet with three tables: "Products", "Orders", and "OrderDetails", there will be three GridTableDescriptors and GridTables.

Relations between tables are defined with a Relations collection of a TableDescriptor. Each TableDescriptor can have one or multiple RelationDescriptor objects. A RelationDescriptor defines the foreign key columns in the parent table, a child TableDescriptor with information about the related child table and the primary key columns in the child table.

The GridTable object is instantiated by the GridEngine class. The Table object manages the records from the engine's DataSource and provides access to records and grouped elements through several collection classes. The most important collection used by the GridTableControl is the DisplayElements collection. This collection provides the GridTableControl with information on which element to display at a row. It returns elements such as CaptionSection, RecordRow, SummaryRow, and others. Based on the elements returned by this collection, the GridTableControl will display a record, a summary or a group caption bar. There are several collections returned such as Records which contains all records in the table. FilterRecords contains all visible records.

Constructors

GridGroupingControl()

Initializes a new instance of the GridGroupingControl class and creates a new empty engine object.

Declaration

public GridGroupingControl()

GridGroupingControl(GridEngine)

Initializes a new instance of the GridGroupingControl class and attaches it to the specified grid engine.

Declaration

public GridGroupingControl(GridEngine engine)

Parameters

Type	Name	Description
GridEngine	engine	The engine to be used by the GridGroupingControl.

GridGroupingControl(Boolean)

Initializes a new instance of the GridGroupingControl class in a special mode where it is only used to hold state information. This is used for XML serialization and saving and restoring state of a GridGroupingControl.

Declaration

public GridGroupingControl(bool stateOnly)

Parameters

Type	Name	Description
System.Boolean	stateOnly	The state information.

Properties

AccessibilityEnabled

Gets or sets a value indicating whether the control should enable its Accessibility support.

Declaration

public bool AccessibilityEnabled { get; set; }

Property Value

Type
System.Boolean

ActivateCurrentCellBehavior

Gets or sets the behavior of the current cell getting activated.

Declaration

public GridCellActivateAction ActivateCurrentCellBehavior { get; set; }

Property Value

Type
GridCellActivateAction

Examples

This example shows how to use the ActivateCurrentCellBehavior property.

// Activates the current cell on Double-clicking the cell.
this.gridGroupingControl1.ActivateCurrentCellBehavior = GridCellActivateAction.DblClickOnCell;

' Activates the current cell on Double-clicking the cell.
 Me.gridGroupingControl1.ActivateCurrentCellBehavior = GridCellActivateAction.DblClickOnCell

AllowedOptimizations

Gets or sets the value of the allowed optimizations that the engine can use when applicable.These optimizations can be used in combination with EngineCounter setting.

Declaration

public EngineOptimizations AllowedOptimizations { get; set; }

Property Value

Type
EngineOptimizations

Examples

This example shows how to use the AllowedOptimizations property.

// Sets the engine optimizations options.
this.gridGroupingControl1.AllowedOptimizations = Syncfusion.Grouping.EngineOptimizations.VirtualMode;

' Sets the engine optimizations options.
Me.gridGroupingControl1.AllowedOptimizations = Syncfusion.Grouping.EngineOptimizations.VirtualMode

AllowOptimizeLoadTime

Gets or sets a value indicating whether the grid should try and reduce flickering at startup.

Declaration

public bool AllowOptimizeLoadTime { get; set; }

Property Value

Type
System.Boolean

Remarks

If set to true the grid will be rendered once into a offline bitmap before the form is shown for the first time. This offline rendering of the grid ensures that all required code is loaded into memory (jitted) and all grid data are initialized. Default is true.

AllowProportionalColumnSizing

Gets or sets a value indicating whether to resize the columns proportionally fit its content or not.

Declaration

public bool AllowProportionalColumnSizing { get; set; }

Property Value

Type
System.Boolean

AllowResetTableDescriptorWhenDataSourceSetNull

Gets or sets a value indicating whether the engine should reset the TableDescriptor, Relations and clear out the SourceListSet or not when you set the Engine.DataSource = null.

Declaration

public bool AllowResetTableDescriptorWhenDataSourceSetNull { get; set; }

Property Value

Type
System.Boolean

AllowScrollCurrentCellInView

Gets or sets the scroll cell in view behavior of the grid.

Declaration

public GridScrollCurrentCellReason AllowScrollCurrentCellInView { get; set; }

Property Value

Type
GridScrollCurrentCellReason

AllowSetCurrentRecordOnFocus

Gets or sets whether the grid should move the current cell to the first visible record when the focus is moved to the grid.

Declaration

public bool AllowSetCurrentRecordOnFocus { get; set; }

Property Value

Type
System.Boolean

AllowSwapDataViewWithDataTableList

Gets or sets a value indicating whether the engine can wrap access to a System.Data.DataTable with a DataTableList which provides optimized access to the rows of the DataTable.

The Engine will access a DataTable through this wrapper class instead of accessing records through the DataTable.DefaultView to increase performance when adding, removing and changing records when AllowSwapDataViewWithDataTableList is enabled. The default value is False.

Declaration

public bool AllowSwapDataViewWithDataTableList { get; set; }

Property Value

Type
System.Boolean

AlphaBlendSelectionColor

Gets or sets the color for alpha blended color value for cell selections.

Declaration

public Color AlphaBlendSelectionColor { get; set; }

Property Value

Type
System.Drawing.Color

Examples

This example shows how to use the AlphaBlendSelectionColor property.

// Sets the selection-highlighting color.
this.gridGroupingControl1.AlphaBlendSelectionColor = Color.SteelBlue;

' Sets the selection- highlighting color.
Me.gridGroupingControl1.AlphaBlendSelectionColor = Color.SteelBlue

Appearance

Gets or sets the default GridTableCellAppearance with default GridTableCellStyleInfo information for all cell elements in the control. This property lets you control almost any aspect of the appearance of the grouping grid like cell backcolor, font, or the cell type.

Declaration

public GridTableCellAppearance Appearance { get; set; }

Property Value

Type
GridTableCellAppearance

ApplyVisualStyles

Gets or sets a value indicating whether to enable or disable the Legacy styles in the Table Model. The value should be false to apply ColorStyles.

Declaration

public bool ApplyVisualStyles { get; set; }

Property Value

Type
System.Boolean

AutoPopulateRelations

Gets or sets a value indicating whether to auto-populate relations or not.

It specifies if relations should be automatically generated when you assign a DataSource a DataTable with constraints or a DataSet with relations defined. Default is True.

Version 4.4 also added support for automatically populated nested collections. If you upgrade from an earlier version and relied on the engine not populating nested collections from your strong typed collection you should set this property to be false.

With nested collection you can also specify the level of recursion allowed when self-relations are detected. See the Engine.MaxNestedCollectionRecurseLevel property.

Declaration

public bool AutoPopulateRelations { get; set; }

Property Value

Type
System.Boolean

BackColor

Gets or sets the back color of the grid.

Declaration

public override Color BackColor { get; set; }

Property Value

Type
System.Drawing.Color

Examples

This example shows how to use the BackColor property.

// Sets the back-color to the grid.
this.gridGroupingControl1.BackColor = Color.SteelBlue;

' Sets the back-color to the grid.
Me.gridGroupingControl1.BackColor = Color.SteelBlue

BaseStyles

Gets or sets the base styles for the grid.

Declaration

public GridTableBaseStyleCollection BaseStyles { get; set; }

Property Value

Type
GridTableBaseStyleCollection

Remarks

Maintains a collection of base styles. Users can add BaseStyles to the engine (also in design-time) and then inherit style settings through the GridStyleInfo.BaseStyle property in GridTableCellStyleInfo property of GridTableCellAppearance.

BindToCurrencyManager

Gets or sets the value that indicates whether the list should be attached to CurrencyManager property or if you would like the engine to be detached from the CurrencyManager. The default value is True.

Declaration

public bool BindToCurrencyManager { get; set; }

Property Value

Type
System.Boolean

BlinkTime

Gets or sets the time in milliseconds how long to highlight values in a record after a change was detected. The engine will highlight a cell for the specified period in milliseconds if the value was increased or decreased. If set to 0 the feature is disabled.

Declaration

public int BlinkTime { get; set; }

Property Value

Type
System.Int32

BlinkTimerRefreshInterval

Gets or sets the timer interval (in milliseconds) used with BlinkUpdateTriggerModeStyle is set to use one of its timer methods to determine when the grid is refreshed for blinking.

Declaration

public int BlinkTimerRefreshInterval { get; set; }

Property Value

Type
System.Int32

BlinkUpdateMode

Gets or sets when checks for updates will happen while blinking support is enabled.

Declaration

public BlinkUpdateTriggerModeStyle BlinkUpdateMode { get; set; }

Property Value

Type
BlinkUpdateTriggerModeStyle

Remarks

When blinking support is enabled, the default behavior is to use the Application.Idle event to test whether pending cell refreshes are required. If the Idle event is not being reliably raised in a timely fashion in your application, you can use this property to tell the grid to use either a System.Threading.Timer or a System.Windows.Forms.Timer to facilitate the grid testing for pending cell updates.

BorderStyle

Gets or sets the border style of the control.

Declaration

public BorderStyle BorderStyle { get; set; }

Property Value

Type
System.Windows.Forms.BorderStyle

Examples

This example shows how to use the BorderStyle property.

// Sets the border style of the grid.
this.gridGroupingControl1.BorderStyle = BorderStyle.FixedSingle;

' Sets the border style of the grid.
Me.gridGroupingControl1.BorderStyle = BorderStyle.FixedSingle

BrowseOnly

Gets or sets a value indicating whether to make the grid read-only or not.

Declaration

public bool BrowseOnly { get; set; }

Property Value

Type
System.Boolean

CacheRecordValues

Gets or sets a value indicating whether the engine should cache copies of the old values from a record in the record object. You can access these values with the Record.GetOldValue method. Setting this property will override the default value returned by CacheRecordValues.

Declaration

public bool CacheRecordValues { get; set; }

Property Value

Type
System.Boolean

ChildGroupOptions

Gets or sets GridGroupOptionsStyleInfo to control the look of inner groups like whether the Caption Row is visible, or what CaptionText is.

Declaration

public GridGroupOptionsStyleInfo ChildGroupOptions { get; set; }

Property Value

Type
GridGroupOptionsStyleInfo

ClickedOnDisabledCellBehavior

Gets or sets Excel-like current cell behavior. When the user clicks on a cell out of a selected range for which .Enabled has been set to false.

Declaration

public GridClickedOnDisabledCellBehavior ClickedOnDisabledCellBehavior { get; set; }

Property Value

Type
GridClickedOnDisabledCellBehavior

ColorStyles

[Deprecated] Gets or sets the enhanced VisualStyles (skins) like Office2010, Office2007, Office2003.

Declaration

public ColorStyles ColorStyles { get; set; }

Property Value

Type
ColorStyles

CounterLogic

Gets or sets the counter logic to be used within the engine. If you have a large datasource and need support for groups and filtered records you can reduce the memory footprint by selectively disabling counters you do not need in your application.

See EngineOptimizations.DisableCounters for completely disabling counter logic for the RecordsDetails collection if you do not need grouping and filtering.

See EngineOptimizations.VirtualMode for using the engine in a virtual mode if you do not need support for sorting.

Declaration

public EngineCounters CounterLogic { get; set; }

Property Value

Type
EngineCounters

CreateParams

Gets the instance of the System.Windows.Forms.CreateParams.Style to show or hide scrollbars and also consider the control's BorderStyle setting.

Declaration

protected override CreateParams CreateParams { get; }

Property Value

Type
System.Windows.Forms.CreateParams

Culture

Gets or sets the culture information which holds rules for parsing and formatting numbers and dates in expression fields.

Declaration

public CultureInfo Culture { get; set; }

Property Value

Type
System.Globalization.CultureInfo

Remarks

In invariant format numbers and dates are always in English format, e.g. use a '.' as decimal separator and dates in format mm/dd/yy. In UI culture dependent format the decimal separator can be a ',' or some other setting specified in CultureInfo.CurrentUICulture.

CurrencyManager

Gets the System.Windows.Forms.CurrencyManager for the assigned DataSource and DataMember.

Declaration

public CurrencyManager CurrencyManager { get; }

Property Value

Type
System.Windows.Forms.CurrencyManager

DataMember

Gets or sets the specific list in a DataSource for which the control displays the data.

Declaration

public string DataMember { get; set; }

Property Value

Type
System.String

DataSource

Gets or sets the data source that the control is displaying data for.

Declaration

public object DataSource { get; set; }

Property Value

Type
System.Object

Examples

This example shows how to use the DataSource property.

// Data source.
DataCollection dataSource = new DataCollection();
//Assigning datasource for grid.
this.gridGroupingControl1.DataSource = dataSource;

' Data source.
Dim dataSource As New DataCollection()
'Assigning datasource for grid.
Me.gridGroupingControl1.DataSource = dataSource

DefaultAppearance

Gets the default appearance settings for the grid at runtime. These settings will not be serialized or written to good and can be used if you want to specify default settings for a derived GridGroupingControl. Any appearance element in the engine will inherit these settings.

Declaration

public GridTableCellAppearance DefaultAppearance { get; }

Property Value

Type
GridTableCellAppearance

DefaultGridBorderStyle

Gets or sets the GridBorderStyle value to be used as default for cell borders.

Declaration

public GridBorderStyle DefaultGridBorderStyle { get; set; }

Property Value

Type
GridBorderStyle

DefaultSize

Gets the default size of the control.

Declaration

protected override Size DefaultSize { get; }

Property Value

Type
System.Drawing.Size

DelayUpdateBehavior

Specifies delayed update behavior when changes are made to the underlying engine from outside of WndProc of this control, for example when changes made through an external PropertyGrid attached to the engine.

Declaration

public GridDelayUpdateBehavior DelayUpdateBehavior { get; set; }

Property Value

Type
GridDelayUpdateBehavior

Remarks

The grid does not to call update after each and every operation. Instead it leaves the update to the end user or to user interaction. Normally, operations on the engine are triggered from within a WndProc call. In the grids WndProc routine the grid will call its base class version and then after the WndProc returns it will call synchronize any changes to the underlying engine with the display if the message was a mouse operation.

This has the big advantage that users don't have to worry about calling BeginUpdate / EndUpdate in mouse handling code. You can just batch operations and then manually call Update(). The programmer does not have to worry about calling Update() since that will be done once the Mouse event returns and the GridTableControl.WndProc is executed. The idea is to have good performance for the most typical case. Updating the grid after every operation would be too expensive (e.g. if you loop through the records and set IsExpanded = true for each record).

DisplayHorizontalLines

Gets or sets a value indicating whether horizontal lines should be displayed or not.

Declaration

public bool DisplayHorizontalLines { get; set; }

Property Value

Type
System.Boolean

DisplayVerticalLines

Gets or sets a value indicating whether vertical lines should be displayed or not.

Declaration

public bool DisplayVerticalLines { get; set; }

Property Value

Type
System.Boolean

EnableAutoSize

Gets or sets a value indicating whether the AutoSize behavior should be enabled or not.

Declaration

public bool EnableAutoSize { get; set; }

Property Value

Type
System.Boolean

EnableTouchMode

Gets or sets a value that indicating whether to enable or disable the touch mode.

Declaration

public virtual bool EnableTouchMode { get; set; }

Property Value

Type
System.Boolean

Engine

Gets or sets the engine object which maintains all TableDescriptors and tables to be displayed in the grid control.

Declaration

public GridEngine Engine { get; set; }

Property Value

Type
GridEngine

Remarks

When you assign a GridEngine object using this property, the existing engine object is not replaced. Instead all properties and collections are copied from the assigned engine object using the InitializeFrom(Engine) method.

InitializeFrom(Engine) initializes the object and copies properties from another object. PropertyChanging and PropertyChanged events are raised for every property that is modified. If both objects are equal, no events are raised.

FilterRuntimeProperties

Property FilterRuntimeProperties (bool)

Declaration

public bool FilterRuntimeProperties { get; set; }

Property Value

Type
System.Boolean

Font

Gets or sets the font used to display text in the grid.

Declaration

public override Font Font { get; set; }

Property Value

Type
System.Drawing.Font

ForceDisposeOnResetDataSource

Gets or sets the value indicating whether to force the grid to dispose or not when the data source gets reset.

Declaration

public bool ForceDisposeOnResetDataSource { get; set; }

Property Value

Type
System.Boolean

ForeColor

Gets or sets the font color of the grid.

Declaration

public override Color ForeColor { get; set; }

Property Value

Type
System.Drawing.Color

ForwardTableEvents

Gets or sets an object that handles events raised by the Table object.

Declaration

public ITableEventsTarget ForwardTableEvents { get; set; }

Property Value

Type
ITableEventsTarget

FreezeCaption

Gets or sets a value indicating whether the caption row is frozen or not. It works only when ShowCaption property is set to True.

Declaration

public bool FreezeCaption { get; set; }

Property Value

Type
System.Boolean

GridGroupDropArea

Gets the GridGroupDropArea control to the grid. Its purpose is to allow dragging header columns from the GridTableControl for user-interactive grouping of records.

Declaration

public GridGroupDropArea GridGroupDropArea { get; }

Property Value

Type
GridGroupDropArea

Remarks

The control is a child control of the GroupDropPanel.

GridLineColor

Gets or sets the color of grid lines.

Declaration

public Color GridLineColor { get; set; }

Property Value

Type
System.Drawing.Color

GridOfficeScrollBars

Gets or sets the Office like scrollbars.

Declaration

public OfficeScrollBars GridOfficeScrollBars { get; set; }

Property Value

Type
OfficeScrollBars

GridTablePanel

Gets the panel which hosts the TableControl control.

Declaration

public Panel GridTablePanel { get; }

Property Value

Type
System.Windows.Forms.Panel

GridVisualStyles

Gets or sets the VisualStyles property values to the grid.

Declaration

public GridVisualStyles GridVisualStyles { get; set; }

Property Value

Type
GridVisualStyles

Examples

This example shows how to use the GridVisualStyles property.

// Sets the visual styles for the grid. Make sure to set the "ThemesEnabled=true;"
this.gridGroupingControl1.GridVisualStyles = GridVisualStyles.Metro;

' Sets the visual styles for the grid. Make sure to set the "ThemesEnabled=true;"
Me.gridGroupingControl1.GridVisualStyles = GridVisualStyles.Metro

GroupDropAreaAlignment

Gets or sets whether the GridGroupDropAreaAlignment should be top,right,left or bottom.

Declaration

public GridGroupDropAreaAlignment GroupDropAreaAlignment { get; set; }

Property Value

Type
GridGroupDropAreaAlignment

Examples

This example shows how to use the GroupDropAreaAlignment property.

// Sets the alignment of the group drop area in the grid.
this.gridGroupingControl1.GroupDropAreaAlignment = GridGroupDropAreaAlignment.Top;

' Sets the alignment of the group drop area in the grid.
Me.gridGroupingControl1.GroupDropAreaAlignment = GridGroupDropAreaAlignment.Top

GroupDropPanel

Gets the panel which hosts the GridGroupDropArea control.

Declaration

public GroupPanel GroupDropPanel { get; }

Property Value

Type
GroupPanel

HierarchicalGroupDropArea

Gets or sets a value indicating whether the GridGroupDropArea should be in Hierarchical or not.

Declaration

public bool HierarchicalGroupDropArea { get; set; }

Property Value

Type
System.Boolean

HorizontalScrollTips

Gets or sets whether ScrollTips should be displayed when the user drags the horizontal scrollbar's thumb bar.

Declaration

public bool HorizontalScrollTips { get; set; }

Property Value

Type
System.Boolean

HorizontalThumbTrack

Gets or sets a value indicating whether the grid should scroll and update its contents or not while the user drags the horizontal scrollbar's thumb bar.

Declaration

public bool HorizontalThumbTrack { get; set; }

Property Value

Type
System.Boolean

InsertRemoveBehavior

Specifies how the grid should react if records are inserted or deleted.

Declaration

public GridListChangedInsertRemoveBehavior InsertRemoveBehavior { get; set; }

Property Value

Type
GridListChangedInsertRemoveBehavior

InsertRemoveBehaviorWithEndEdit

Specifies how the grid should react if records are inserted or deleted through direct user interaction with AddNew record.

Declaration

public GridListChangedInsertRemoveBehavior InsertRemoveBehaviorWithEndEdit { get; set; }

Property Value

Type
GridListChangedInsertRemoveBehavior

IntelliMousePanning

Gets or sets a value indicating whether the Intelisense of mouse should be spanned or not when the user presses the middle mouse button and drags the mouse, the window will scroll.

Declaration

public bool IntelliMousePanning { get; set; }

Property Value

Type
System.Boolean

InvalidateAllWhenListChanged

Lets you specify whether the grid should simply call Invalidate when a ListChanged event is handled or if it should determine the area that is affected by the change and call InvalidateRange. With version 4.4 check also the InsertRemoveBehavior and SortPositionChangedBehavior properties.

Declaration

public bool InvalidateAllWhenListChanged { get; set; }

Property Value

Type
System.Boolean

Remarks

On first sight, you might think it better to determine the area that is affected by a change and call InvalidateRange. But when calling InvalidateRange, the grid needs to know the exact position of the record in the table before it can mark that area dirty. In order to determine the record position (and y-position of the row in the display), counters need to be evaluated. This operation can cost more time than simply calling Invalidate in high-frequency update scenarios.

Also, be aware that the group caption bar needs to be updated when a record changes.

With version 4.4 check out the new InsertRemoveBehavior and SortPositionChangedBehavior properties and the UpdateDisplayFrequency properties that will speed up things a lot if InvalidateAllWhenListChanged = false.

IsDynamicData

Gets or sets whether the bounded datasource is composed of dynamic objects or not. Applicable only for .NET Framework 4.0 and later.

Declaration

public bool IsDynamicData { get; set; }

Property Value

Type
System.Boolean

IsHandleDestroyed

Gets a value that indicates whether the window handle is destroyed or not.

Declaration

public bool IsHandleDestroyed { get; }

Property Value

Type
System.Boolean

MarkColHeader

Gets or sets a value indicating whether the column header for the current cell should be highlighted or not.

Declaration

public bool MarkColHeader { get; set; }

Property Value

Type
System.Boolean

MarkRowHeader

Gets or sets a value indicating whether the row header for the current cell should be highlighted or not.

Declaration

public bool MarkRowHeader { get; set; }

Property Value

Type
System.Boolean

NestedTableGroupOptions

Gets or sets the look of the topmost group of nested tables such as whether the Caption Row is visible, or what CaptionText is.

Declaration

public GridGroupOptionsStyleInfo NestedTableGroupOptions { get; set; }

Property Value

Type
GridGroupOptionsStyleInfo

Examples

This example shows how to use the NestedTableGroupOptions property.

// Provides options to handle Nested tables in the grid.
this.gridGroupingControl1.NestedTableGroupOptions.CaptionText = "myNestedTable";
int captionLength = this.gridGroupingControl1.NestedTableGroupOptions.CaptionSummaryRow.Length;
Console.WriteLine("The length of the caption text is " + captionLength);

' Provides options to handle Nested tables in the grid.
Me.gridGroupingControl1.NestedTableGroupOptions.CaptionText = "myNestedTable"
Dim captionLength As Integer = Me.gridGroupingControl1.NestedTableGroupOptions.CaptionSummaryRow.Length
Console.WriteLine("The length of the caption text is " & captionLength)

Office2007ScrollBars

Gets or sets a value indicating whether to enable or disable Office2007ScrollBars.

Declaration

public bool Office2007ScrollBars { get; set; }

Property Value

Type
System.Boolean

Office2007ScrollBarsColorScheme

Gets or sets the style of Office2007 scroll bars.

Declaration

public Office2007ColorScheme Office2007ScrollBarsColorScheme { get; set; }

Property Value

Type
Office2007ColorScheme

Examples

This example shows how to use the Office2007ScrollBarsColorScheme property.

// Enables the Office2007 scroll bars.
this.gridGroupingControl1.Office2007ScrollBars = true;
// Sets the color schemes for the Office2007 scroll bars.
this.gridGroupingControl1.Office2007ScrollBarsColorScheme = Office2007ColorScheme.Black;

' Enables the Office2007 scroll bars.
Me.gridGroupingControl1.Office2007ScrollBars = True
' Sets the color schemes for the Office2007 scroll bars.
Me.gridGroupingControl1.Office2007ScrollBarsColorScheme = Office2007ColorScheme.Black

Office2010ScrollBarsColorScheme

Gets or sets the styles of Office2010 scroll bars.

Declaration

public Office2010ColorScheme Office2010ScrollBarsColorScheme { get; set; }

Property Value

Type
Office2010ColorScheme

Office2016ScrollBarsColorScheme

Gets or sets the styles of Office2016 scroll bars.

Declaration

public ScrollBarOffice2016ColorScheme Office2016ScrollBarsColorScheme { get; set; }

Property Value

Type
ScrollBarOffice2016ColorScheme

OptimizeFilterPerformance

Gets or sets a value indicating whether to use optimization filter in GridGroupingControl or not.

Declaration

public bool OptimizeFilterPerformance { get; set; }

Property Value

Type
System.Boolean

PrintColumnHeader

Gets or sets a value indicating whether column headers should be printed while printing the grid or not.

Declaration

public bool PrintColumnHeader { get; set; }

Property Value

Type
System.Boolean

PrintHorizontalLines

Gets or sets a value indicating whether the grid should draw horizontal lines while printing or not.

Declaration

public bool PrintHorizontalLines { get; set; }

Property Value

Type
System.Boolean

PrintRowHeader

Gets or sets a value indicating whether row headers should be printed while printing the grid or not.

Declaration

public bool PrintRowHeader { get; set; }

Property Value

Type
System.Boolean

PrintVerticalLines

Gets or sets a value indicating whether the grid should draw vertical lines while printing the grid or not.

Declaration

public bool PrintVerticalLines { get; set; }

Property Value

Type
System.Boolean

PropertyTypeDefaultStyles

Gets the collection of GridPropertyTypeDefaultStyle with default GridTableCellStyleInfo information for RecordFieldCell elements based on the columns System.Type. Each basic type has default style information registered with this collection.

Declaration

public GridPropertyTypeDefaultStyleCollection PropertyTypeDefaultStyles { get; }

Property Value

Type
GridPropertyTypeDefaultStyleCollection

Remarks

The collection contains pre-defined settings such as HorizontalAlignment for numbers and cell type (e.g. check box for boolean).

GridPropertyTypeDefaultStyle settings have less precedence in styles inheritance than Appearance styles.

Note: Changes you make to this collection do not get serialized; you will need to reapply any changes even if you read back the schema from an XML file.

RaiseSourceListChangedEventsOnEngineOnly

Gets or sets a value indicating whether the engine handles the ListChanged event or not. This will itself raise numerous events. When set to true this the events will only be raised on the Engine object. If set to false then events will also be raised on inner objects (will bubble up on nested tables which caused some performance overhead). Property will only have effect if UseOldListChangedHandler = false.

Declaration

public bool RaiseSourceListChangedEventsOnEngineOnly { get; set; }

Property Value

Type
System.Boolean

RecordNavigationBar

Gets or sets the navigation bar.

Declaration

public RecordNavigationBar RecordNavigationBar { get; set; }

Property Value

Type
RecordNavigationBar

RecordNavigationControl

Gets the record navigation control which hosts the record navigation bar in the grid and also the TableControl.

Declaration

public RecordNavigationControl RecordNavigationControl { get; }

Property Value

Type
RecordNavigationControl

Remarks

The control is only visible if ShowNavigationBar is set. It is a child control of the GridTablePanel.

RightToLeft

Gets or sets the RTL mode of the grid.

Declaration

public override RightToLeft RightToLeft { get; set; }

Property Value

Type
System.Windows.Forms.RightToLeft

ShowColumnHeaders

Gets or sets a value indicating whether the grid should display the column headers or not.

Declaration

public bool ShowColumnHeaders { get; set; }

Property Value

Type
System.Boolean

ShowCurrentCellBorderBehavior

Gets or sets the ShowCurrentCellBorderBehavior in the GridModel class for information.

Declaration

public GridShowCurrentCellBorder ShowCurrentCellBorderBehavior { get; set; }

Property Value

Type
GridShowCurrentCellBorder

ShowDefaultValuesInAddNewRecord

Gets or sets if the default value for fields in the AddNewRecord should be shown when it is not in edit-mode or not. If the ShowDefaultValuesInAddNewRecord is false then the default values will only be assigned when AddNewRecord.BeginEdit is called. Prior calls to AddNewRecord will return no value in that case.

Declaration

public bool ShowDefaultValuesInAddNewRecord { get; set; }

Property Value

Type
System.Boolean

ShowGroupDropArea

Gets or sets a value that indicating whether the GridGroupDropArea should be visible or not.

Declaration

public bool ShowGroupDropArea { get; set; }

Property Value

Type
System.Boolean

ShowNavigationBar

Gets or sets a value indicating whether the RecordNavigationBar should be visible or not.

Declaration

public bool ShowNavigationBar { get; set; }

Property Value

Type
System.Boolean

ShowNavigationBarToolTips

Gets or sets a value indicating whether the ToolTips should be shown or not when the user hovers the mouse over elements of the RecordNavigationBar.

Declaration

public bool ShowNavigationBarToolTips { get; set; }

Property Value

Type
System.Boolean

ShowNestedPropertiesFields

Gets or sets a a value indicating whether to display nested property fields or not.

Declaration

public bool ShowNestedPropertiesFields { get; set; }

Property Value

Type
System.Boolean

Remarks

This property affects the auto population of the FieldDescriptorCollection.

It specifies if individual fields should be added for every property of a type when a type has nested properties. You can also control this behavior at run-time with the QueryShowNestedPropertiesFields event. Default is True.

ShowRelationFields

Gets or sets the show relational fields enum value.

Declaration

public ShowRelationFields ShowRelationFields { get; set; }

Property Value

Type
ShowRelationFields

Remarks

This property affects the auto population of the FieldDescriptorCollection.

It specifies if dependent fields from a related table in a foreign key relation (or related collection) should be added to the main tables FieldDescriptorCollection. You can also control this behavior at run-time with the QueryShowRelationDisplayFields event. Default is ShowRelationFields.ShowDisplayFieldsOnly.

ShowRowHeaders

Gets or sets a value indicating whether row headers should be displayed or hidden. (Might be better to use HideCols[0] = false) instead.

Declaration

public bool ShowRowHeaders { get; set; }

Property Value

Type
System.Boolean

Site

Gets or sets the site of the control.

Declaration

public override ISite Site { get; set; }

Property Value

Type
System.ComponentModel.ISite

SortIconPlacement

Gets or sets a value to assign the placement of the sort icon.

Declaration

public SortIconPlacement SortIconPlacement { get; set; }

Property Value

Type
SortIconPlacement

SortMappingNames

Gets or sets a value indicating whether the engine should sort mapping names alphabetically or not in the dropdown editors of the property grid. Default value is false.

Declaration

public bool SortMappingNames { get; set; }

Property Value

Type
System.Boolean

SortPositionChangedBehavior

Specifies how the grid should react if the sort position of a record records changes.

Declaration

public GridListChangedInsertRemoveBehavior SortPositionChangedBehavior { get; set; }

Property Value

Type
GridListChangedInsertRemoveBehavior

SortPositionChangedBehaviorWithEndEdit

Specifies how the grid should react if the sort position of a record records changes when the current record is edited interactively by user.

Declaration

public GridListChangedInsertRemoveBehavior SortPositionChangedBehaviorWithEndEdit { get; set; }

Property Value

Type
GridListChangedInsertRemoveBehavior

SourceListSet

Gets the reference to the SourceListSet that maintains a collection of IList or DataTables that are used by main table or related tables as datasources.

Declaration

public SourceListSet SourceListSet { get; }

Property Value

Type
SourceListSet

Splitter

Gets the vertical splitter which divides the GroupDropPanel and GridTablePanel.

Declaration

public Splitter Splitter { get; }

Property Value

Type
System.Windows.Forms.Splitter

Table

Gets the table value associated with the engine.

Declaration

public GridTable Table { get; }

Property Value

Type
GridTable

Remarks

The table object manages the records from the engine's DataSource and provides access to records and grouped elements through several collection classes, most prominent the DisplayElementsInTableCollection.

TableControl

Gets the hosted GridTableControl. The GridTableControl is a grid derived from GridControlBase and displays and allows user interaction and modification of data.

Declaration

public GridTableControl TableControl { get; }

Property Value

Type
GridTableControl

Remarks

This control is either a child control of the GridTablePanel or RecordNavigationControl depending on whether ShowNavigationBar is set.

TableDescriptor

Gets or sets the table schema information of the root table from the datasource.

Declaration

public GridTableDescriptor TableDescriptor { get; set; }

Property Value

Type
GridTableDescriptor

TableDirtyOnSourceListReset

Gets or sets a value indicating whether the engine should set TableDirtyOnSourceListReset to true when the data source raises a ListChanged event with ListChangedType.Reset notification. The default is false.

Declaration

public bool TableDirtyOnSourceListReset { get; set; }

Property Value

Type
System.Boolean

TableModel

Gets the GridTableModel of the TableControl. The GridTableModel is derived from the GridModel and adds support for retrieving data from the datasource for a GridTableControl.

Declaration

public GridTableModel TableModel { get; }

Property Value

Type
GridTableModel

TableOptions

Gets or sets the table-wide properties like the width of the indent column, or whether header rows should be visible.

Declaration

public GridTableOptionsStyleInfo TableOptions { get; set; }

Property Value

Type
GridTableOptionsStyleInfo

ThemesEnabled

Gets or sets a value indicating whether the control should be drawn using Windows XP Themes(if available) or not.

Declaration

public bool ThemesEnabled { get; set; }

Property Value

Type
System.Boolean

TopLevelGroupOptions

Gets or sets look of the top most group such as whether the Caption Row is visible, or what CaptionText is.

Declaration

public GridGroupOptionsStyleInfo TopLevelGroupOptions { get; set; }

Property Value

Type
GridGroupOptionsStyleInfo

Examples

This example shows how to use the TopLevelGroupOptions property.

// Provides the top-level (parent level) features to handle.
this.gridGroupingControl1.TopLevelGroupOptions.ShowCaption = true;
this.gridGroupingControl1.TopLevelGroupOptions.CaptionText = "Info of GGC";

' Provides the top-level (parent level) features to handle.
Me.gridGroupingControl1.TopLevelGroupOptions.ShowCaption = True
Me.gridGroupingControl1.TopLevelGroupOptions.CaptionText = "Info of GGC"

UpdateDisplayFrequency

Specifies the number of milliseconds to wait between display updates when new ListChanged event handler logic is used. This property does have no any effect if UseOldListChangedHandler = true. Special values are 0 - only manually update display by calling grid.Update() and 1 - update display immediately after each change.

Declaration

public int UpdateDisplayFrequency { get; set; }

Property Value

Type
System.Int32

UseCustomUpdateOnListChanged

Specify this if you do not want TableControl to use built-in paint mechanism when ListChanged events are handled. (Makes TableControl.Table_SourceListRecordChanging and TableControl.Table_SourceListRecordChanged return immediately)

Declaration

public bool UseCustomUpdateOnListChanged { get; set; }

Property Value

Type
System.Boolean

UseDefaultsForFasterDrawing

Initializes recommended settings to improve handling of ListChanged events and scrolling through grid. Affected settings are: TableOptions.ColumnsMaxLengthStrategy, TableOptions.GridLineBorder, TableOptions.DrawTextWithGdiInterop, TableOptions.VerticalPixelScroll, Appearance.AnyRecordFieldCell.WrapText and Appearance.AnyRecordFieldCell.Trimming.

Declaration

public bool UseDefaultsForFasterDrawing { get; set; }

Property Value

Type
System.Boolean

UseInvariantCulture

Gets or sets a value indicting whether the culture format of numbers and dates in expressions should be in invariant format or UI culture dependent format

Declaration

public bool UseInvariantCulture { get; set; }

Property Value

Type
System.Boolean

Remarks

UseLazyUniformChildListRelation

When you use the new UniformChildList behavior (i.e. when Engine.UseOldUniformChildListRelation = false) you can specify with this UseLazyUniformChildListRelation property whether the engine should access and enumerate the child collections only once the user expands a record. This will speed up load time of the grid and reduce memory usage when not all records get expanded.

Declaration

public bool UseLazyUniformChildListRelation { get; set; }

Property Value

Type
System.Boolean

UseOldListChangedHandler

Gets or sets a value indicating whether the grid should use old list changed event handler or not.

Declaration

public bool UseOldListChangedHandler { get; set; }

Property Value

Type
System.Boolean

Remarks

With version 4.4 the engine changed the way how the ListChanged event is handled internally to fix short-comings with performance of the code that was in place earlier. This property lets you switch back the behavior of the engine to the old mechanism if you notice compatibility issues. The default value is false.

UseRightToLeftCompatibleTextBox

Gets or sets a value indicating whether the control can use the kind of textbox control which is compatible for RTL mode or not.

Declaration

public bool UseRightToLeftCompatibleTextBox { get; set; }

Property Value

Type
System.Boolean

Remarks

In general the original text box behaves better than the rich-text box with Hebrew and Arabic languages. By default the grid uses the RichTextBox control for cell editing, but if you set UseRightToLeftCompatibleTextBox to true then the grid will do editing with original TextBox controls instead.

VersionInfo

Gets or sets the value that will be written out by CodeDom serializer to help us internally determine the version that was used when code was generated.

Declaration

public string VersionInfo { get; set; }

Property Value

Type
System.String

VerticalScrollTips

Gets or sets a value indicating whether ScrollTips should be displayed or not when the user drags the vertical scrollbar's thumb bar.

Declaration

public bool VerticalScrollTips { get; set; }

Property Value

Type
System.Boolean

VerticalThumbTrack

Gets or sets a value indicating whether the grid should scroll and update its contents while the user drags the vertical scrollbar's thumb bar.

Declaration

public bool VerticalThumbTrack { get; set; }

Property Value

Type
System.Boolean

WantTabKey

Gets or sets a value indicating whether the Tab key should be used to move from cell to cell (= true) or if it should select the next control in the parent form (= false). Default is true.

Declaration

public bool WantTabKey { get; set; }

Property Value

Type
System.Boolean

Methods

AddGroupDropArea(GridTable)

Adds the group drop area for the specified instance of the GridTable class. Users have to manually add rows for nested relations to allow end-users grouping of nested relations.

Declaration

public void AddGroupDropArea(GridTable relatedTable)

Parameters

Type	Name	Description
GridTable	relatedTable	The nested table for which to add support for grouping.

Examples

This example shows how to use the AddGroupDropArea(GridTable) method.

// Adds a Group drop area for the child table. Make sure to set "ShowGroupDropArea=true"
GridTable myTable = new GridTable(this.gridGroupingControl1.TableDescriptor, null);
this.gridGroupingControl1.AddGroupDropArea(myTable);

' Adds a Group drop area for the child table. Make sure to set "ShowGroupDropArea=true"
Dim myTable As New GridTable(Me.gridGroupingControl1.TableDescriptor, Nothing)
Me.gridGroupingControl1.AddGroupDropArea(myTable)

AddGroupDropArea(String)

Adds the group drop area for the specified mapping name of the table. Users have to manually add rows for nested relations to allow end-users grouping nested relations.

Declaration

public void AddGroupDropArea(string name)

Parameters

Type	Name	Description
System.String	name	The name of the relation for which to add support for grouping.

Examples

This example shows how to use the AddGroupDropArea(String) method.

// Adds a Group drop area for individual child tables. Make sure to set "ShowGroupDropArea=true"
this.gridGroupingControl1.AddGroupDropArea("Child_Table_Name");

' Adds a Group drop area for individual child tables. Make sure to set "ShowGroupDropArea=true"
Me.gridGroupingControl1.AddGroupDropArea("Child_Table_Name")

AddPendingSummaryUpdate(Group, String)

Marks a summary field to be updated next time when the grid paints pending changes from ListChanged events as specified with UpdateDisplayFrequency.

Declaration

public void AddPendingSummaryUpdate(Group group, string fieldName)

Parameters

Type	Name	Description
Group	group	The group that defines a set to record that belongs to a category.
System.String	fieldName	The field the summary is dependent on.

AddPendingUpdate(Record)

Marks the record to be repainted later when the grid paints pending changes from ListChanged events as specified with UpdateDisplayFrequency.

Declaration

public void AddPendingUpdate(Record record)

Parameters

Type	Name	Description
Record	record	The record.

Examples

This example shows how to use the AddPendingUpdate(Record) method.

// Repaints the given record.
Record recd = this.gridGroupingControl1.Table.CurrentRecord;
this.gridGroupingControl1.AddPendingUpdate(recd);

' Repaints the given record.
Dim recd As Record = Me.gridGroupingControl1.Table.CurrentRecord
Me.gridGroupingControl1.AddPendingUpdate(recd)

AddPendingUpdate(Record, String)

Marks the field in the record to be repainted later when the grid paints pending changes from ListChanged events as specified with UpdateDisplayFrequency.

Declaration

public void AddPendingUpdate(Record record, string fieldName)

Parameters

Type	Name	Description
Record	record	The record.
System.String	fieldName	The name of the file.

Examples

This example shows how to use the AddPendingUpdate(Record, String) method.

// Repaints the given record with respect to the field name.
Record recd = this.gridGroupingControl1.Table.CurrentRecord;
this.gridGroupingControl1.AddPendingUpdate(recd,"StateId");

' Repaints the given record with respect to the field name.
Dim recd As Record = Me.gridGroupingControl1.Table.CurrentRecord
Me.gridGroupingControl1.AddPendingUpdate(recd,"StateId")

ApplyScaleToControl(Single)

Applies the scaling to the control.

Declaration

public void ApplyScaleToControl(float sf)

Parameters

Type	Name	Description
System.Single	sf	The scaling value.

ApplyXmlLookAndFeel(XmlReader)

Loads GridGroupingLookAndFeel state from an XML stream.

Declaration

public void ApplyXmlLookAndFeel(XmlReader xr)

Parameters

Type	Name	Description
System.Xml.XmlReader	xr	The XML reader stream.

ApplyXmlSchema(XmlReader)

Loads engine settings from an XML stream.

Declaration

public void ApplyXmlSchema(XmlReader xr)

Parameters

Type	Name	Description
System.Xml.XmlReader	xr	The XML reader stream.

BeginInit()

Begins the initialization of the control that is used on a form or used by another component. The initialization occurs at run-time.

Declaration

public void BeginInit()

BeginUpdate()

Suspends the painting of the control until the EndUpdate(Boolean) method is called.

Declaration

public void BeginUpdate()

Remarks

When many paints are made to the appearance of a control, you should invoke the BeginUpdate method to temporarily freeze the drawing of the control. This results in less distraction to the user, and a performance gain. After all updates have been made, invoke the EndUpdate method to resume drawing of the control.

The BeginUpdate method will call both the BeginUpdate() method for the TableControl and GridGroupDropArea. This suspends drawing for both child controls.

CancelEdit()

Discards current cells and current record changes.

Declaration

public void CancelEdit()

CreateEngine()

Override this method if you would like to have a derived engine object. The method is called to create a default engine object when no engine objects were manually instantiated. See also the discussion in GridEngineFactory.

Declaration

public virtual GridEngine CreateEngine()

Returns

Type	Description
GridEngine	If the CreateEngine method is not overridden, a new GridEngine object is returned, otherwise an object derived from GridEngine might be returned.

CreateEngineForBeginInit()

Creates an engine object that is used temporarily only after BeginInit was called from within the parent forms InitializeComponent method.

Declaration

protected virtual GridEngine CreateEngineForBeginInit()

Returns

Type	Description
GridEngine	Returns the GridEngine

CreateGroupDropArea(GridTableControl, GridGroupDropAreaModel)

Creates an instance of the group drop area associated with the engine.

Declaration

public virtual GridGroupDropArea CreateGroupDropArea(GridTableControl tableControl, GridGroupDropAreaModel groupDropAreaModel)

Parameters

Type	Name	Description
GridTableControl	tableControl
GridGroupDropAreaModel	groupDropAreaModel

Returns

Type	Description
GridGroupDropArea	The instance of the GridGroupDropArea class.

CreateNestedTableControl(GridTableModel, GridTableControl, GridNestedTableControlCellRenderer)

Creates an instance of the GridNestedTableControl class.

Declaration

public virtual GridNestedTableControl CreateNestedTableControl(GridTableModel relatedTableModel, GridTableControl parentGrid, GridNestedTableControlCellRenderer parentRenderer)

Parameters

Type	Name	Description
GridTableModel	relatedTableModel	An instance of the GridTableModel class.
GridTableControl	parentGrid	The parent grid.
GridNestedTableControlCellRenderer	parentRenderer	The GridNestedTableControlCellRenderer class.

Returns

Type	Description
GridNestedTableControl	The table control.

CreateRecordNavigationControl()

Creates the instance of the RecordNavigationControl that have a splitter frame at the bottom of the scrollbar control.

Declaration

public virtual RecordNavigationControl CreateRecordNavigationControl()

Returns

Type	Description
RecordNavigationControl	The RecordNavigationControl.

CreateTableControl(GridTableModel)

Creates a table control associated with the GridTableModel class.

Declaration

public virtual GridTableControl CreateTableControl(GridTableModel model)

Parameters

Type	Name	Description
GridTableModel	model	An instance of the GridTableModel class.

Returns

Type	Description
GridTableControl	The table control.

CreateTableModel()

Creates a table model associated with the table control.

Declaration

public virtual GridTableModel CreateTableModel()

Returns

Type	Description
GridTableModel	The table model used by the TableControl.

Dispose(Boolean)

Overrides and cleans up any resources being used.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

EndInit()

Ends the initialization of the control that is used on a form or used by another component. The initialization occurs at run-time.

Declaration

public void EndInit()

EndUpdate(Boolean)

Resumes the painting of the control suspended by calling the BeginUpdate method.

Declaration

public void EndUpdate(bool update)

Parameters

Type	Name	Description
System.Boolean	update	True if pending paint operations should be executed immediately; False if they should be discarded.

Remarks

The EndUpdate method will call both the EndUpdate(Boolean) method for the TableControl and GridGroupDropArea. This resumes drawing for both child controls.

ForceEngineDispose()

Forces the Engine to Dispose.

Declaration

public void ForceEngineDispose()

GetBlinkState(Record, FieldDescriptor)

Gets the current BlinkState for a cell indicating whether the cells value was increased or decreased or if the record has been recently added. The BlinkState will be reset to BlinkState.None after the interval specified in BlinkTime elapsed.

Declaration

public BlinkState GetBlinkState(Record r, FieldDescriptor fd)

Parameters

Type	Name	Description
Record	r	The descriptor of the field to which the cell belongs to.
FieldDescriptor	fd	The record object.

Returns

Type	Description
BlinkState	Returns the current BlinkState for the given cell.

GetBlinkState(GridTableCellStyleInfoIdentity)

Declaration

public BlinkState GetBlinkState(GridTableCellStyleInfoIdentity tableCellIdentity)

Parameters

Type	Name	Description
GridTableCellStyleInfoIdentity	tableCellIdentity	The identity for the table cell.

Returns

Type	Description
BlinkState	Blink state.

GetTable(String)

Gets the table for the specified current instance associated with the grid. specified name.

Declaration

public GridTable GetTable(string name)

Parameters

Type	Name	Description
System.String	name	The name of the table to search.

Returns

Type	Description
GridTable	The table or NULL if not found.

Examples

This example shows how to use the GetTable(String) method.

// Gets the given table and performs the required operations.
this.gridGroupingControl1.GetTable("myTable").DefaultRecordRowHeight= 22;

' Gets the given table and performs the required operations.
Me.gridGroupingControl1.GetTable("myTable").DefaultRecordRowHeight= 22

GetTableControl(String)

Gets the value of the TableControl property or the instance of the GridNestedTableControl class of any nested relation that matches the specified name.

Declaration

public GridTableControl GetTableControl(string name)

Parameters

Type	Name	Description
System.String	name	The mapping name of the table control to search.

Returns

Type	Description
GridTableControl	The table control or NULL if not found.

GetTableDescriptor(String)

Gets the value of the property TableDescriptor or an instance of the GridTableDescriptor class of any nested relation that matches the specified mapping name.

Declaration

public GridTableDescriptor GetTableDescriptor(string name)

Parameters

Type	Name	Description
System.String	name	The mapping name of the table descriptor to be found.

Returns

Type	Description
GridTableDescriptor	The table descriptor or NULL if not found.

GetTableModel(String)

Gets the value of the property TableModel or an instance of the GridTableModel class of any nested relation that matches the specified name.

Declaration

public GridTableModel GetTableModel(string name)

Parameters

Type	Name	Description
System.String	name	The mapping name of the table model to search.

Returns

Type	Description
GridTableModel	The table model or null if not found.

InitializeFrom(GridGroupingControl)

Initializes this object and copies properties from another object. The PropertyChanging and PropertyChanged events are raised for every property that is modified. If both objects are equal, no events are raised.

Declaration

public void InitializeFrom(GridGroupingControl other)

Parameters

Type	Name	Description
GridGroupingControl	other	The source object.

InitLayout()

Overrides and initializes the layout.

Declaration

protected override void InitLayout()

InvalidateDisplay()

Marks the whole grid to be repainted later when the grid paints pending changes from ListChanged events as specified with UpdateDisplayFrequency.

Declaration

public void InvalidateDisplay()

IsInputKey(Keys)

Determines a value that indicates whether the specified key is a regular input key or a special key that requires preprocessing.

Declaration

protected override bool IsInputKey(Keys keyData)

Parameters

Type	Name	Description
System.Windows.Forms.Keys	keyData	The System.Windows.Forms.Keys contains the values.

Returns

Type	Description
System.Boolean	True if the specified key is a regular input key; otherwise, false.

OnBackColorChanged(EventArgs)

Overrides and triggered when the back color values gets changed.

Declaration

protected override void OnBackColorChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.EventArgs contains the event data.

OnBackgroundImageChanged(EventArgs)

Overridden to set the background image for the grid.

Declaration

protected override void OnBackgroundImageChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.EventArgs contains the event data.

OnBackgroundImageLayoutChanged(EventArgs)

Overridden to set the background image layout for the grid.

Declaration

protected override void OnBackgroundImageLayoutChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.EventArgs contains the event data.

OnBindingContextChanged(EventArgs)

Overrides and raises the binding of context changed event.

Declaration

protected override void OnBindingContextChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.EventArgs contains the event data.

OnCategorizedRecords(TableEventArgs)

Raises the CategorizedRecords event.

Declaration

protected virtual void OnCategorizedRecords(TableEventArgs e)

Parameters

Type	Name	Description
TableEventArgs	e	A TableEventArgs that contains the event data.

OnCategorizingRecords(TableEventArgs)

Raises the CategorizingRecords event.

Declaration

protected virtual void OnCategorizingRecords(TableEventArgs e)

Parameters

Type	Name	Description
TableEventArgs	e	A TableEventArgs that contains the event data.

OnChangeUICues(UICuesEventArgs)

Overrides and triggered when the UI gets changing.

Declaration

protected override void OnChangeUICues(UICuesEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.UICuesEventArgs	e	The System.Windows.Forms.UICuesEventArgs contains the event data.

OnCreateControl()

Overrides and triggered to create control.

Declaration

protected override void OnCreateControl()

OnCurrentRecordContextChange(CurrentRecordContextChangeEventArgs)

Raises the CurrentRecordContextChange event.

Declaration

protected virtual void OnCurrentRecordContextChange(CurrentRecordContextChangeEventArgs e)

Parameters

Type	Name	Description
CurrentRecordContextChangeEventArgs	e	A CurrentRecordContextChangeEventArgs that contains the event data.

OnCurrentRecordManagerReset(TableEventArgs)

Raises the CurrentRecordManagerReset event.

Declaration

protected virtual void OnCurrentRecordManagerReset(TableEventArgs e)

Parameters

Type	Name	Description
TableEventArgs	e	A TableEventArgs that contains the event data.

OnDataSourceChanged()

Triggered when the datasource gets changed.

Declaration

protected virtual void OnDataSourceChanged()

OnDataSourceChanging(GridGroupingControl.DataSourceChangingEventArgs)

Triggered when the datasource is getting change.

Declaration

protected virtual void OnDataSourceChanging(GridGroupingControl.DataSourceChangingEventArgs e)

Parameters

Type	Name	Description
GridGroupingControl.DataSourceChangingEventArgs	e	The GridGroupingControl.DataSourceChangingEventArgs contains the event data.

OnDisplayElementChanged(DisplayElementChangedEventArgs)

Raises the DisplayElementChanged event.

Declaration

protected virtual void OnDisplayElementChanged(DisplayElementChangedEventArgs e)

Parameters

Type	Name	Description
DisplayElementChangedEventArgs	e	A DisplayElementChangedEventArgs that contains the event data.

OnDisplayElementChanging(DisplayElementChangingEventArgs)

Raises the DisplayElementChanging event.

Declaration

protected virtual void OnDisplayElementChanging(DisplayElementChangingEventArgs e)

Parameters

Type	Name	Description
DisplayElementChangingEventArgs	e	A DisplayElementChangingEventArgs that contains the event data.

OnEnter(EventArgs)

Overrides and process the Enter key press.

Declaration

protected override void OnEnter(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.EventArgs contains the even data.

OnExceptionRaised(ExceptionRaisedEventArgs)

Raises the ExceptionRaised event.

Declaration

protected virtual void OnExceptionRaised(ExceptionRaisedEventArgs e)

Parameters

Type	Name	Description
ExceptionRaisedEventArgs	e	An ExceptionRaisedEventArgs that contains the event data.

OnFieldChooserClosed(FieldChooserClosedEventArgs)

Triggered when the fieldchooser gets closed.

Declaration

public virtual void OnFieldChooserClosed(FieldChooserClosedEventArgs e)

Parameters

Type	Name	Description
FieldChooserClosedEventArgs	e	The FieldChooserClosedEventArgs contains the event data.

OnFieldChooserClosing(FieldChooserClosingEventArgs)

Raises the FieldChooserClosing event.

Declaration

public virtual void OnFieldChooserClosing(FieldChooserClosingEventArgs e)

Parameters

Type	Name	Description
FieldChooserClosingEventArgs	e	The event data.

OnFieldChooserShowing(FieldChooserShowingEventArgs)

Triggered when the fieldchooser is getting shown.

Declaration

public virtual void OnFieldChooserShowing(FieldChooserShowingEventArgs e)

Parameters

Type	Name	Description
FieldChooserShowingEventArgs	e	The FieldChooserShowingEventArgs contains the event data.

OnFieldChooserShown(FieldChooserShownEventArgs)

Triggered when the fieldChooser dialog had shown.

Declaration

public virtual void OnFieldChooserShown(FieldChooserShownEventArgs e)

Parameters

Type	Name	Description
FieldChooserShownEventArgs	e	The FieldChooserShownEventArgs contains the event data.

OnFilterBarSelectedItemChanged(FilterBarSelectedItemChangedEventArgs)

Occurs when the FilterBarSelectedItemChanged event is done.

Declaration

public virtual void OnFilterBarSelectedItemChanged(FilterBarSelectedItemChangedEventArgs e)

Parameters

Type	Name	Description
FilterBarSelectedItemChangedEventArgs	e	The FilterBarSelectedItemChangedEventArgs contains the event data.

OnFilterBarSelectedItemChanging(FilterBarSelectedItemChangingEventArgs)

Occurs when the FilterBarSelectedItemChanging event is done.

Declaration

public virtual void OnFilterBarSelectedItemChanging(FilterBarSelectedItemChangingEventArgs e)

Parameters

Type	Name	Description
FilterBarSelectedItemChangingEventArgs	e	The FilterBarSelectedItemChangingEventArgs contains the event data.

OnFontChanged(EventArgs)

Overrides and triggered when the font gets changed.

Declaration

protected override void OnFontChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.EventArgs contains the event data.

OnForeColorChanged(EventArgs)

Overrides and triggered when the text color gets changed.

Declaration

protected override void OnForeColorChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.EventArgs contains the event data.

OnGotFocus(EventArgs)

Overrides and raises the System.Windows.Forms.Control.GotFocus event.

Declaration

protected override void OnGotFocus(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.EventArgs contains the event data.

OnGroupAdded(GroupEventArgs)

Raises the GroupAdded event.

Declaration

protected virtual void OnGroupAdded(GroupEventArgs e)

Parameters

Type	Name	Description
GroupEventArgs	e	A GroupEventArgs that contains the event data.

OnGroupCollapsed(GroupEventArgs)

Raises the GroupCollapsed event.

Declaration

protected virtual void OnGroupCollapsed(GroupEventArgs e)

Parameters

Type	Name	Description
GroupEventArgs	e	A GroupEventArgs that contains the event data.

OnGroupCollapsing(GroupEventArgs)

Raises the GroupCollapsing event.

Declaration

protected virtual void OnGroupCollapsing(GroupEventArgs e)

Parameters

Type	Name	Description
GroupEventArgs	e	A GroupEventArgs that contains the event data.

OnGroupExpanded(GroupEventArgs)

Raises the GroupExpanded event.

Declaration

protected virtual void OnGroupExpanded(GroupEventArgs e)

Parameters

Type	Name	Description
GroupEventArgs	e	A GroupEventArgs that contains the event data.

OnGroupExpanding(GroupEventArgs)

Raises the GroupExpanding event.

Declaration

protected virtual void OnGroupExpanding(GroupEventArgs e)

Parameters

Type	Name	Description
GroupEventArgs	e	A GroupEventArgs that contains the event data.

OnGroupRemoving(GroupEventArgs)

Raises the GroupRemoving event.

Declaration

protected virtual void OnGroupRemoving(GroupEventArgs e)

Parameters

Type	Name	Description
GroupEventArgs	e	A GroupEventArgs that contains the event data.

OnGroupSummaryInvalidated(GroupEventArgs)

Raises the GroupSummaryInvalidated event.

Declaration

protected virtual void OnGroupSummaryInvalidated(GroupEventArgs e)

Parameters

Type	Name	Description
GroupEventArgs	e	A GroupEventArgs that contains the event data.

OnHandleCreated(EventArgs)

Overrides and triggered while handle is created.

Declaration

protected override void OnHandleCreated(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.EventArgs contains the event data.

OnHandleDestroyed(EventArgs)

Overrides and triggered while the handle gets destroyed.

Declaration

protected override void OnHandleDestroyed(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.EventArgs contains the event data.

OnInvalidatingCounters(TableEventArgs)

Raises the InvalidatingCounters event.

Declaration

protected virtual void OnInvalidatingCounters(TableEventArgs e)

Parameters

Type	Name	Description
TableEventArgs	e	A TableEventArgs that contains the event data.

OnInvalidatingSummaries(TableEventArgs)

Raises the InvalidatingSummaries event.

Declaration

protected virtual void OnInvalidatingSummaries(TableEventArgs e)

Parameters

Type	Name	Description
TableEventArgs	e	A TableEventArgs that contains the event data.

OnKeyDown(KeyEventArgs)

Overrides and triggered when the System.Windows.Forms.Control.KeyDown event is done.

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.KeyEventArgs	e

OnLeave(EventArgs)

Overrides and triggered when the tab key is pressed.

Declaration

protected override void OnLeave(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.EventArgs contains the event data.

OnLostFocus(EventArgs)

Overrides and triggered when the control lost focus.

Declaration

protected override void OnLostFocus(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.EventArgs contains the event data.

OnNavigationBarRecordChanged(CurrentRecordEventArgs)

Raises the NavigationBarRecordChanged event.

Declaration

protected virtual void OnNavigationBarRecordChanged(CurrentRecordEventArgs e)

Parameters

Type	Name	Description
CurrentRecordEventArgs	e	A CurrentRecordEventArgs that contains the event data.

OnNavigationBarRecordChanging(CurrentRecordEventArgs)

Raises the NavigationBarRecordChanging event.

Declaration

protected virtual void OnNavigationBarRecordChanging(CurrentRecordEventArgs e)

Parameters

Type	Name	Description
CurrentRecordEventArgs	e	A CurrentRecordEventArgs that contains the event data.

OnOffice2007ScrollBarsChanged(EventArgs)

Triggered when the Office2007ScrollBarsChanged event is done.

Declaration

protected virtual void OnOffice2007ScrollBarsChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	A System.EventArgs that contains the event data.

OnOffice2007ScrollBarsColorSchemeChanged(EventArgs)

Triggered when the Office2007ScrollBarsColorSchemeChanged event is done.

Declaration

protected virtual void OnOffice2007ScrollBarsColorSchemeChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.EventArgs contains the event data.

OnOffice2010ScrollBarsColorSchemeChanged(EventArgs)

Triggered when the OnOffice2010ScrollBarsColorSchemeChanged(EventArgs) event is done.

Declaration

protected virtual void OnOffice2010ScrollBarsColorSchemeChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.EventArgs contains the event data.

OnOffice2016ScrollBarsColorSchemeChanged(EventArgs)

Triggered when the OnOffice2016ScrollBarsColorSchemeChanged(EventArgs) event is done.

Declaration

protected virtual void OnOffice2016ScrollBarsColorSchemeChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.EventArgs contains the event data.

OnOfficeScrollBarsChanged(GridGroupingControl.OfficeScrollBarsEventArgs)

Triggered the OfficeScrollBarsChanged event is done.

Declaration

protected virtual void OnOfficeScrollBarsChanged(GridGroupingControl.OfficeScrollBarsEventArgs e)

Parameters

Type	Name	Description
GridGroupingControl.OfficeScrollBarsEventArgs	e	The GridGroupingControl.OfficeScrollBarsEventArgs contains the event data.

OnPaint(PaintEventArgs)

Overrides and paints the grid.

Declaration

protected override void OnPaint(PaintEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.PaintEventArgs	e	The System.Windows.Forms.PaintEventArgs contains the event data.

OnPaintingFields(EventArgs)

Triggered when the PaintingFields event is done in the grid.

Declaration

public virtual void OnPaintingFields(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.EventArgs contains the event data.

OnParentChanged(EventArgs)

Declaration

protected override void OnParentChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

OnParentFontChanged(EventArgs)

Overrides and triggered when the grid font's gets changed.

Declaration

protected override void OnParentFontChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.EventArgs contains the event data.

OnParseCommonFormats(GridCellTextEventArgs)

Raises the ParseCommonFormats event.

Declaration

protected virtual void OnParseCommonFormats(GridCellTextEventArgs e)

Parameters

Type	Name	Description
GridCellTextEventArgs	e	A GridCellTextEventArgs that contains the event data.

OnPropertyChanged(DescriptorPropertyChangedEventArgs)

Triggered when the PropertyChanged event is done.

Declaration

protected virtual void OnPropertyChanged(DescriptorPropertyChangedEventArgs e)

Parameters

Type	Name	Description
DescriptorPropertyChangedEventArgs	e	A DescriptorPropertyChangedEventArgs contains the event data.

OnPropertyChanging(DescriptorPropertyChangedEventArgs)

Triggered when the PropertyChanging event is done.

Declaration

protected virtual void OnPropertyChanging(DescriptorPropertyChangedEventArgs e)

Parameters

Type	Name	Description
DescriptorPropertyChangedEventArgs	e	A DescriptorPropertyChangedEventArgs contains the event data.

OnQueryCellFormattedText(GridCellTextEventArgs)

Raises the QueryCellFormattedText event.

Declaration

protected virtual void OnQueryCellFormattedText(GridCellTextEventArgs e)

Parameters

Type	Name	Description
GridCellTextEventArgs	e	A GridCellTextEventArgs that contains the event data.

OnQueryCellStyleInfo(GridTableCellStyleInfoEventArgs)

Triggered when the QueryCellStyleInfo event is done.

Declaration

protected virtual void OnQueryCellStyleInfo(GridTableCellStyleInfoEventArgs e)

Parameters

Type	Name	Description
GridTableCellStyleInfoEventArgs	e	A GridTableCellStyleInfoEventArgs that contains the event data.

OnQueryCellText(GridCellTextEventArgs)

Raises the QueryCellText event.

Declaration

protected virtual void OnQueryCellText(GridCellTextEventArgs e)

Parameters

Type	Name	Description
GridCellTextEventArgs	e	A GridCellTextEventArgs that contains the event data.

OnQueryCoveredRange(GridTableQueryCoveredRangeEventArgs)

Raises the QueryCoveredRange event.

Declaration

protected virtual void OnQueryCoveredRange(GridTableQueryCoveredRangeEventArgs e)

Parameters

Type	Name	Description
GridTableQueryCoveredRangeEventArgs	e	A GridTableCellStyleInfoEventArgs that contains the event data.

OnQueryCustomSummary(GridQueryCustomSummaryEventArgs)

Triggered when the QueryCustomSummary event is done.

Declaration

protected virtual void OnQueryCustomSummary(GridQueryCustomSummaryEventArgs e)

Parameters

Type	Name	Description
GridQueryCustomSummaryEventArgs	e	A GridQueryCustomSummaryEventArgs that contains the event data.

OnQueryFilterBarChoices(GridQueryFilterBarChoicesEventArgs)

Raises the QueryFilterBarChoices event.

Declaration

public virtual void OnQueryFilterBarChoices(GridQueryFilterBarChoicesEventArgs e)

Parameters

Type	Name	Description
GridQueryFilterBarChoicesEventArgs	e	Event data.

OnQueryRecordMeetsFilterCriteria(QueryRecordMeetsFilterCriteriaEventArgs)

Triggered when the QueryRecordMeetsFilterCriteria event is done.

Declaration

protected virtual void OnQueryRecordMeetsFilterCriteria(QueryRecordMeetsFilterCriteriaEventArgs e)

Parameters

Type	Name	Description
QueryRecordMeetsFilterCriteriaEventArgs	e	A QueryRecordMeetsFilterCriteriaEventArgs that contains the event data.

OnQueryValue(FieldValueEventArgs)

Raises the QueryValue event

Declaration

protected virtual void OnQueryValue(FieldValueEventArgs e)

Parameters

Type	Name	Description
FieldValueEventArgs	e	The FieldValueEventArgs with event data.

OnRecordCollapsed(RecordEventArgs)

Raises the RecordCollapsed event.

Declaration

protected virtual void OnRecordCollapsed(RecordEventArgs e)

Parameters

Type	Name	Description
RecordEventArgs	e	A RecordEventArgs that contains the event data.

OnRecordCollapsing(RecordEventArgs)

Raises the RecordCollapsing event.

Declaration

protected virtual void OnRecordCollapsing(RecordEventArgs e)

Parameters

Type	Name	Description
RecordEventArgs	e	A RecordEventArgs that contains the event data.

OnRecordDeleted(RecordEventArgs)

Raises the RecordDeleted event.

Declaration

protected virtual void OnRecordDeleted(RecordEventArgs e)

Parameters

Type	Name	Description
RecordEventArgs	e	A RecordEventArgs that contains the event data.

OnRecordDeleting(RecordEventArgs)

Raises the RecordDeleting event.

Declaration

protected virtual void OnRecordDeleting(RecordEventArgs e)

Parameters

Type	Name	Description
RecordEventArgs	e	A RecordEventArgs that contains the event data.

OnRecordExpanded(RecordEventArgs)

Raises the RecordExpanded event.

Declaration

protected virtual void OnRecordExpanded(RecordEventArgs e)

Parameters

Type	Name	Description
RecordEventArgs	e	A RecordEventArgs that contains the event data.

OnRecordExpanding(RecordEventArgs)

Raises the RecordExpanding event.

Declaration

protected virtual void OnRecordExpanding(RecordEventArgs e)

Parameters

Type	Name	Description
RecordEventArgs	e	A RecordEventArgs that contains the event data.

OnRecordValueChanged(RecordValueChangedEventArgs)

Raises the RecordValueChanged event.

Declaration

protected virtual void OnRecordValueChanged(RecordValueChangedEventArgs e)

Parameters

Type	Name	Description
RecordValueChangedEventArgs	e	A RecordValueChangedEventArgs that contains the event data.

OnRecordValueChanging(RecordValueChangingEventArgs)

Raises the RecordValueChanging event.

Declaration

protected virtual void OnRecordValueChanging(RecordValueChangingEventArgs e)

Parameters

Type	Name	Description
RecordValueChangingEventArgs	e	A RecordValueChangingEventArgs that contains the event data.

OnSaveCellFormattedText(GridCellTextEventArgs)

Raises the SaveCellFormattedText event.

Declaration

protected virtual void OnSaveCellFormattedText(GridCellTextEventArgs e)

Parameters

Type	Name	Description
GridCellTextEventArgs	e	A GridCellTextEventArgs that contains the event data.

OnSaveCellText(GridCellTextEventArgs)

Raises the SaveCellText event.

Declaration

protected virtual void OnSaveCellText(GridCellTextEventArgs e)

Parameters

Type	Name	Description
GridCellTextEventArgs	e	A GridCellTextEventArgs that contains the event data.

OnSaveValue(FieldValueEventArgs)

Raises the SaveValue event.

Declaration

protected virtual void OnSaveValue(FieldValueEventArgs e)

Parameters

Type	Name	Description
FieldValueEventArgs	e	The FieldValueEventArgs with event data.

OnSelectedRecordsChanged(SelectedRecordsChangedEventArgs)

Raises the SelectedRecordsChanged event.

Declaration

protected virtual void OnSelectedRecordsChanged(SelectedRecordsChangedEventArgs e)

Parameters

Type	Name	Description
SelectedRecordsChangedEventArgs	e	A SelectedRecordsChangedEventArgs that contains the event data.

OnSelectedRecordsChanging(SelectedRecordsChangedEventArgs)

Raises the SelectedRecordsChanging event.

Declaration

protected virtual void OnSelectedRecordsChanging(SelectedRecordsChangedEventArgs e)

Parameters

Type	Name	Description
SelectedRecordsChangedEventArgs	e	A SelectedRecordsChangedEventArgs that contains the event data.

OnSizeChanged(EventArgs)

Overrides and triggered when the size gets changed.

Declaration

protected override void OnSizeChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.EventArgs contains the event data.

OnSortedItemsInGroup(GroupEventArgs)

Raises the SortedItemsInGroup event.

Declaration

protected virtual void OnSortedItemsInGroup(GroupEventArgs e)

Parameters

Type	Name	Description
GroupEventArgs	e	A GroupEventArgs that contains the event data.

OnSortingItemsInGroup(GroupEventArgs)

Raises the SortingItemsInGroup event.

Declaration

protected virtual void OnSortingItemsInGroup(GroupEventArgs e)

Parameters

Type	Name	Description
GroupEventArgs	e	A GroupEventArgs that contains the event data.

OnSourceListListChanged(TableListChangedEventArgs)

Raises the SourceListListChanged event.

Declaration

protected virtual void OnSourceListListChanged(TableListChangedEventArgs e)

Parameters

Type	Name	Description
TableListChangedEventArgs	e	A TableListChangedEventArgs that contains the event data.

OnSourceListListChangedCompleted(TableListChangedEventArgs)

Raises the SourceListListChangedCompleted event.

Declaration

protected virtual void OnSourceListListChangedCompleted(TableListChangedEventArgs e)

Parameters

Type	Name	Description
TableListChangedEventArgs	e	A TableListChangedEventArgs that contains the event data.

OnSourceListRecordChanged(RecordChangedEventArgs)

Raises the SourceListRecordChanged event.

Declaration

protected virtual void OnSourceListRecordChanged(RecordChangedEventArgs e)

Parameters

Type	Name	Description
RecordChangedEventArgs	e	A RecordChangedEventArgs that contains the event data.

OnSourceListRecordChanging(RecordChangedEventArgs)

Raises the SourceListRecordChanging event.

Declaration

protected virtual void OnSourceListRecordChanging(RecordChangedEventArgs e)

Parameters

Type	Name	Description
RecordChangedEventArgs	e	A RecordChangedEventArgs that contains the event data.

OnTableControlCellButtonClicked(GridTableControlCellButtonClickedEventArgs)

Raises the TableControlCellButtonClicked event.

Declaration

protected virtual void OnTableControlCellButtonClicked(GridTableControlCellButtonClickedEventArgs e)

Parameters

Type	Name	Description
GridTableControlCellButtonClickedEventArgs	e	A GridTableControlCellButtonClickedEventArgs that contains the event data.

OnTableControlCellCancelMode(GridTableControlCellMouseEventArgs)

Raises the TableControlCellCancelMode event.

Declaration

protected virtual void OnTableControlCellCancelMode(GridTableControlCellMouseEventArgs e)

Parameters

Type	Name	Description
GridTableControlCellMouseEventArgs	e	A GridTableControlCellMouseEventArgs that contains the event data.

OnTableControlCellClick(GridTableControlCellClickEventArgs)

Raises the TableControlCellClick event.

Declaration

protected virtual void OnTableControlCellClick(GridTableControlCellClickEventArgs e)

Parameters

Type	Name	Description
GridTableControlCellClickEventArgs	e	A GridTableControlCellClickEventArgs that contains the event data.

OnTableControlCellCursor(GridTableControlCellCursorEventArgs)

Raises the TableControlCellCursor event.

Declaration

protected virtual void OnTableControlCellCursor(GridTableControlCellCursorEventArgs e)

Parameters

Type	Name	Description
GridTableControlCellCursorEventArgs	e	A GridTableControlCellCursorEventArgs that contains the event data.

OnTableControlCellDoubleClick(GridTableControlCellClickEventArgs)

Raises the TableControlCellDoubleClick event.

Declaration

protected virtual void OnTableControlCellDoubleClick(GridTableControlCellClickEventArgs e)

Parameters

Type	Name	Description
GridTableControlCellClickEventArgs	e	A GridTableControlCellClickEventArgs that contains the event data.

OnTableControlCellDrawn(GridTableControlDrawCellEventArgs)

Raises the TableControlCellDrawn event.

Declaration

protected virtual void OnTableControlCellDrawn(GridTableControlDrawCellEventArgs e)

Parameters

Type	Name	Description
GridTableControlDrawCellEventArgs	e	A GridTableControlDrawCellEventArgs that contains the event data.

OnTableControlCellHitTest(GridTableControlCellHitTestEventArgs)

Raises the TableControlCellHitTest event.

Declaration

protected virtual void OnTableControlCellHitTest(GridTableControlCellHitTestEventArgs e)

Parameters

Type	Name	Description
GridTableControlCellHitTestEventArgs	e	A GridTableControlCellHitTestEventArgs that contains the event data.

OnTableControlCellMouseDown(GridTableControlCellMouseEventArgs)

Raises the TableControlCellMouseDown event.

Declaration

protected virtual void OnTableControlCellMouseDown(GridTableControlCellMouseEventArgs e)

Parameters

Type	Name	Description
GridTableControlCellMouseEventArgs	e	A GridTableControlCellMouseEventArgs that contains the event data.

OnTableControlCellMouseHover(GridTableControlCellMouseEventArgs)

Raises the TableControlCellMouseHover event.

Declaration

protected virtual void OnTableControlCellMouseHover(GridTableControlCellMouseEventArgs e)

Parameters

Type	Name	Description
GridTableControlCellMouseEventArgs	e	A GridTableControlCellMouseEventArgs that contains the event data.

OnTableControlCellMouseHoverEnter(GridTableControlCellMouseEventArgs)

Raises the TableControlCellMouseHoverEnter event.

Declaration

protected virtual void OnTableControlCellMouseHoverEnter(GridTableControlCellMouseEventArgs e)

Parameters

Type	Name	Description
GridTableControlCellMouseEventArgs	e	A GridTableControlCellMouseEventArgs that contains the event data.

OnTableControlCellMouseHoverLeave(GridTableControlCellMouseEventArgs)

Raises the TableControlCellMouseHoverLeave event.

Declaration

protected virtual void OnTableControlCellMouseHoverLeave(GridTableControlCellMouseEventArgs e)

Parameters

Type	Name	Description
GridTableControlCellMouseEventArgs	e	A GridTableControlCellMouseEventArgs that contains the event data.

OnTableControlCellMouseMove(GridTableControlCellMouseEventArgs)

Raises the TableControlCellMouseMove event.

Declaration

protected virtual void OnTableControlCellMouseMove(GridTableControlCellMouseEventArgs e)

Parameters

Type	Name	Description
GridTableControlCellMouseEventArgs	e	A GridTableControlCellMouseEventArgs that contains the event data.

OnTableControlCellMouseUp(GridTableControlCellMouseEventArgs)

Raises the TableControlCellMouseUp event.

Declaration

protected virtual void OnTableControlCellMouseUp(GridTableControlCellMouseEventArgs e)

Parameters

Type	Name	Description
GridTableControlCellMouseEventArgs	e	A GridTableControlCellMouseEventArgs that contains the event data.

OnTableControlCheckBoxClick(GridTableControlCellClickEventArgs)

Raises the TableControlCheckBoxClick event.

Declaration

protected virtual void OnTableControlCheckBoxClick(GridTableControlCellClickEventArgs e)

Parameters

Type	Name	Description
GridTableControlCellClickEventArgs	e	A GridTableControlCellClickEventArgs that contains the event data.

OnTableControlCurrentCellAcceptedChanges(GridTableControlCancelEventArgs)

Raises the TableControlCurrentCellAcceptedChanges event.

Declaration

protected virtual void OnTableControlCurrentCellAcceptedChanges(GridTableControlCancelEventArgs e)

Parameters

Type	Name	Description
GridTableControlCancelEventArgs	e

OnTableControlCurrentCellActivated(GridTableControlEventArgs)

Triggered when the TableControlCurrentCellActivated event is done.

Declaration

protected virtual void OnTableControlCurrentCellActivated(GridTableControlEventArgs e)

Parameters

Type	Name	Description
GridTableControlEventArgs	e	A GridTableControlEventArgs that contains the event data.

OnTableControlCurrentCellActivateFailed(GridTableControlCurrentCellActivateFailedEventArgs)

Raises the TableControlCurrentCellActivateFailed event.

Declaration

protected virtual void OnTableControlCurrentCellActivateFailed(GridTableControlCurrentCellActivateFailedEventArgs e)

Parameters

Type	Name	Description
GridTableControlCurrentCellActivateFailedEventArgs	e	A GridTableControlCurrentCellActivateFailedEventArgs that contains the event data.

OnTableControlCurrentCellActivating(GridTableControlCurrentCellActivatingEventArgs)

Raises the TableControlCurrentCellActivating event.

Declaration

protected virtual void OnTableControlCurrentCellActivating(GridTableControlCurrentCellActivatingEventArgs e)

Parameters

Type	Name	Description
GridTableControlCurrentCellActivatingEventArgs	e	A GridTableControlCurrentCellActivatingEventArgs that contains the event data.

OnTableControlCurrentCellChanged(GridTableControlEventArgs)

Triggered when the TableControlCurrentCellChanged event is done.

Declaration

protected virtual void OnTableControlCurrentCellChanged(GridTableControlEventArgs e)

Parameters

Type	Name	Description
GridTableControlEventArgs	e	A GridTableControlEventArgs that contains the event data.

OnTableControlCurrentCellChanging(GridTableControlCancelEventArgs)

Raises the TableControlCurrentCellChanging event.

Declaration

protected virtual void OnTableControlCurrentCellChanging(GridTableControlCancelEventArgs e)

Parameters

Type	Name	Description
GridTableControlCancelEventArgs	e	A GridTableControlCancelEventArgs that contains the event data.

OnTableControlCurrentCellCloseDropDown(GridTableControlPopupClosedEventArgs)

Raises the TableControlCurrentCellCloseDropDown event.

Declaration

protected virtual void OnTableControlCurrentCellCloseDropDown(GridTableControlPopupClosedEventArgs e)

Parameters

Type	Name	Description
GridTableControlPopupClosedEventArgs	e	A GridTableControlPopupClosedEventArgs that contains the event data.

OnTableControlCurrentCellConfirmChangesFailed(GridTableControlEventArgs)

Raises the TableControlCurrentCellConfirmChangesFailed event.

Declaration

protected virtual void OnTableControlCurrentCellConfirmChangesFailed(GridTableControlEventArgs e)

Parameters

Type	Name	Description
GridTableControlEventArgs	e	A GridTableControlEventArgs that contains the event data.

OnTableControlCurrentCellControlDoubleClick(GridTableControlControlEventArgs)

Triggered when the TableControlCurrentCellControlDoubleClick event is done.

Declaration

protected virtual void OnTableControlCurrentCellControlDoubleClick(GridTableControlControlEventArgs e)

Parameters

Type	Name	Description
GridTableControlControlEventArgs	e	A GridTableControlControlEventArgs that contains the event data.

OnTableControlCurrentCellControlGotFocus(GridTableControlControlEventArgs)

Raises the TableControlCurrentCellControlGotFocus event.

Declaration

protected virtual void OnTableControlCurrentCellControlGotFocus(GridTableControlControlEventArgs e)

Parameters

Type	Name	Description
GridTableControlControlEventArgs	e	A GridTableControlControlEventArgs that contains the event data.

OnTableControlCurrentCellControlKeyMessage(GridTableControlCurrentCellControlKeyMessageEventArgs)

Raises the TableControlCurrentCellControlKeyMessage event.

Declaration

protected virtual void OnTableControlCurrentCellControlKeyMessage(GridTableControlCurrentCellControlKeyMessageEventArgs e)

Parameters

Type	Name	Description
GridTableControlCurrentCellControlKeyMessageEventArgs	e	A GridTableControlCurrentCellControlKeyMessageEventArgs that contains the event data.

OnTableControlCurrentCellControlLostFocus(GridTableControlControlEventArgs)

Raises the TableControlCurrentCellControlLostFocus event.

Declaration

protected virtual void OnTableControlCurrentCellControlLostFocus(GridTableControlControlEventArgs e)

Parameters

Type	Name	Description
GridTableControlControlEventArgs	e	A GridTableControlControlEventArgs that contains the event data.

OnTableControlCurrentCellDeactivated(GridTableControlCurrentCellDeactivatedEventArgs)

Raises the TableControlCurrentCellDeactivated event.

Declaration

protected virtual void OnTableControlCurrentCellDeactivated(GridTableControlCurrentCellDeactivatedEventArgs e)

Parameters

Type	Name	Description
GridTableControlCurrentCellDeactivatedEventArgs	e	A GridTableControlCurrentCellDeactivatedEventArgs that contains the event data.

OnTableControlCurrentCellDeactivateFailed(GridTableControlEventArgs)

Triggered when the TableControlCurrentCellDeactivateFailed event is done.

Declaration

protected virtual void OnTableControlCurrentCellDeactivateFailed(GridTableControlEventArgs e)

Parameters

Type	Name	Description
GridTableControlEventArgs	e	A GridTableControlEventArgs that contains the event data.

OnTableControlCurrentCellDeactivating(GridTableControlCancelEventArgs)

Triggered when the TableControlCurrentCellDeactivating event is done.

Declaration

protected virtual void OnTableControlCurrentCellDeactivating(GridTableControlCancelEventArgs e)

Parameters

Type	Name	Description
GridTableControlCancelEventArgs	e	A GridTableControlCancelEventArgs that contains the event data.

OnTableControlCurrentCellDeleting(GridTableControlCancelEventArgs)

Triggered when the TableControlCurrentCellDeleting event is done.

Declaration

protected virtual void OnTableControlCurrentCellDeleting(GridTableControlCancelEventArgs e)

Parameters

Type	Name	Description
GridTableControlCancelEventArgs	e	A GridTableControlCancelEventArgs that contains the event data.

OnTableControlCurrentCellEditingComplete(GridTableControlEventArgs)

Raises the TableControlCurrentCellEditingComplete event.

Declaration

protected virtual void OnTableControlCurrentCellEditingComplete(GridTableControlEventArgs e)

Parameters

Type	Name	Description
GridTableControlEventArgs	e

OnTableControlCurrentCellErrorMessage(GridTableControlCurrentCellErrorMessageEventArgs)

Raises the TableControlCurrentCellErrorMessage event.

Declaration

protected virtual void OnTableControlCurrentCellErrorMessage(GridTableControlCurrentCellErrorMessageEventArgs e)

Parameters

Type	Name	Description
GridTableControlCurrentCellErrorMessageEventArgs	e	A GridTableControlCurrentCellErrorMessageEventArgs that contains the event data.

OnTableControlCurrentCellInitializeControlText(GridTableControlCurrentCellInitializeControlTextEventArgs)

Raises the TableControlCurrentCellInitializeControlText event.

Declaration

protected virtual void OnTableControlCurrentCellInitializeControlText(GridTableControlCurrentCellInitializeControlTextEventArgs e)

Parameters

Type	Name	Description
GridTableControlCurrentCellInitializeControlTextEventArgs	e	A GridTableControlCurrentCellInitializeControlTextEventArgs that contains the event data.

OnTableControlCurrentCellKeyDown(GridTableControlKeyEventArgs)

Triggered when the TableControlCurrentCellKeyDown event is done.

Declaration

protected virtual void OnTableControlCurrentCellKeyDown(GridTableControlKeyEventArgs e)

Parameters

Type	Name	Description
GridTableControlKeyEventArgs	e	A GridTableControlKeyEventArgs that contains the event data.

OnTableControlCurrentCellKeyPress(GridTableControlKeyPressEventArgs)

Raises the TableControlCurrentCellKeyPress event.

Declaration

protected virtual void OnTableControlCurrentCellKeyPress(GridTableControlKeyPressEventArgs e)

Parameters

Type	Name	Description
GridTableControlKeyPressEventArgs	e

OnTableControlCurrentCellKeyUp(GridTableControlKeyEventArgs)

Triggered when the TableControlCurrentCellKeyUp event is done.

Declaration

protected virtual void OnTableControlCurrentCellKeyUp(GridTableControlKeyEventArgs e)

Parameters

Type	Name	Description
GridTableControlKeyEventArgs	e	A GridTableControlKeyEventArgs that contains the event data.

OnTableControlCurrentCellMoved(GridTableControlCurrentCellMovedEventArgs)

Raises the TableControlCurrentCellMoved event.

Declaration

protected virtual void OnTableControlCurrentCellMoved(GridTableControlCurrentCellMovedEventArgs e)

Parameters

Type	Name	Description
GridTableControlCurrentCellMovedEventArgs	e	A GridTableControlCurrentCellMovedEventArgs that contains the event data.

OnTableControlCurrentCellMoveFailed(GridTableControlCurrentCellMoveFailedEventArgs)

Raises the TableControlCurrentCellMoveFailed event.

Declaration

protected virtual void OnTableControlCurrentCellMoveFailed(GridTableControlCurrentCellMoveFailedEventArgs e)

Parameters

Type	Name	Description
GridTableControlCurrentCellMoveFailedEventArgs	e	A GridTableControlCurrentCellMoveFailedEventArgs that contains the event data.

OnTableControlCurrentCellMoving(GridTableControlCurrentCellMovingEventArgs)

Raises the TableControlCurrentCellMoving event.

Declaration

protected virtual void OnTableControlCurrentCellMoving(GridTableControlCurrentCellMovingEventArgs e)

Parameters

Type	Name	Description
GridTableControlCurrentCellMovingEventArgs	e	A GridTableControlCurrentCellMovingEventArgs that contains the event data.

OnTableControlCurrentCellRejectedChanges(GridTableControlEventArgs)

Raises the TableControlCurrentCellRejectedChanges event.

Declaration

protected virtual void OnTableControlCurrentCellRejectedChanges(GridTableControlEventArgs e)

Parameters

Type	Name	Description
GridTableControlEventArgs	e	A GridTableControlEventArgs that contains the event data.

OnTableControlCurrentCellShowedDropDown(GridTableControlEventArgs)

Raises the TableControlCurrentCellShowedDropDown event.

Declaration

protected virtual void OnTableControlCurrentCellShowedDropDown(GridTableControlEventArgs e)

Parameters

Type	Name	Description
GridTableControlEventArgs	e

OnTableControlCurrentCellShowingDropDown(GridTableControlCurrentCellShowingDropDownEventArgs)

Raises the TableControlCurrentCellShowingDropDown event.

Declaration

protected virtual void OnTableControlCurrentCellShowingDropDown(GridTableControlCurrentCellShowingDropDownEventArgs e)

Parameters

Type	Name	Description
GridTableControlCurrentCellShowingDropDownEventArgs	e	A GridTableControlCurrentCellShowingDropDownEventArgs that contains the event data.

OnTableControlCurrentCellStartEditing(GridTableControlCancelEventArgs)

Raises the TableControlCurrentCellStartEditing event.

Declaration

protected virtual void OnTableControlCurrentCellStartEditing(GridTableControlCancelEventArgs e)

Parameters

Type	Name	Description
GridTableControlCancelEventArgs	e	A GridTableControlCancelEventArgs that contains the event data.

OnTableControlCurrentCellValidated(GridTableControlEventArgs)

Raises the TableControlCurrentCellValidated event is done.

Declaration

protected virtual void OnTableControlCurrentCellValidated(GridTableControlEventArgs e)

Parameters

Type	Name	Description
GridTableControlEventArgs	e	A GridTableControlEventArgs that contains the event data.

OnTableControlCurrentCellValidateString(GridTableControlCurrentCellValidateStringEventArgs)

Raises the TableControlCurrentCellValidateString event.

Declaration

protected virtual void OnTableControlCurrentCellValidateString(GridTableControlCurrentCellValidateStringEventArgs e)

Parameters

Type	Name	Description
GridTableControlCurrentCellValidateStringEventArgs	e	A GridTableControlCurrentCellValidateStringEventArgs that contains the event data.

OnTableControlCurrentCellValidating(GridTableControlCancelEventArgs)

Raises the TableControlCurrentCellValidating event.

Declaration

protected virtual void OnTableControlCurrentCellValidating(GridTableControlCancelEventArgs e)

Parameters

Type	Name	Description
GridTableControlCancelEventArgs	e

OnTableControlDrawCell(GridTableControlDrawCellEventArgs)

Raises the TableControlDrawCell event.

Declaration

protected virtual void OnTableControlDrawCell(GridTableControlDrawCellEventArgs e)

Parameters

Type	Name	Description
GridTableControlDrawCellEventArgs	e	A GridTableControlDrawCellEventArgs that contains the event data.

OnTableControlDrawCellBackground(GridTableControlDrawCellBackgroundEventArgs)

Raises the TableControlDrawCellBackground event.

Declaration

protected virtual void OnTableControlDrawCellBackground(GridTableControlDrawCellBackgroundEventArgs e)

Parameters

Type	Name	Description
GridTableControlDrawCellBackgroundEventArgs	e	A GridTableControlDrawCellBackgroundEventArgs that contains the event data.

OnTableControlDrawCellButton(GridTableControlDrawCellButtonEventArgs)

Raises the TableControlDrawCellButton event.

Declaration

protected virtual void OnTableControlDrawCellButton(GridTableControlDrawCellButtonEventArgs e)

Parameters

Type	Name	Description
GridTableControlDrawCellButtonEventArgs	e	A GridTableControlDrawCellButtonEventArgs that contains the event data.

OnTableControlDrawCellButtonBackground(GridTableControlDrawCellButtonBackgroundEventArgs)

Raises the TableControlDrawCellButtonBackground event.

Declaration

protected virtual void OnTableControlDrawCellButtonBackground(GridTableControlDrawCellButtonBackgroundEventArgs e)

Parameters

Type	Name	Description
GridTableControlDrawCellButtonBackgroundEventArgs	e	A GridTableControlDrawCellButtonBackgroundEventArgs that contains the event data.

OnTableControlDrawCellDisplayText(GridTableControlDrawCellDisplayTextEventArgs)

Draws the display text.

Declaration

protected virtual void OnTableControlDrawCellDisplayText(GridTableControlDrawCellDisplayTextEventArgs e)

Parameters

Type	Name	Description
GridTableControlDrawCellDisplayTextEventArgs	e	A GridTableControlDrawCellDisplayTextEventArgs contains the event data.

OnTableControlDrawCellFrameAppearance(GridTableControlDrawCellBackgroundEventArgs)

Raises the TableControlDrawCellFrameAppearance event.

Declaration

protected virtual void OnTableControlDrawCellFrameAppearance(GridTableControlDrawCellBackgroundEventArgs e)

Parameters

Type	Name	Description
GridTableControlDrawCellBackgroundEventArgs	e	A GridTableControlDrawCellBackgroundEventArgs that contains the event data.

OnTableControlDrawCurrentCellBorder(GridTableControlDrawCurrentCellBorderEventArgs)

Raises the TableControlDrawCurrentCellBorder event.

Declaration

protected virtual void OnTableControlDrawCurrentCellBorder(GridTableControlDrawCurrentCellBorderEventArgs e)

Parameters

Type	Name	Description
GridTableControlDrawCurrentCellBorderEventArgs	e	A GridTableControlDrawCurrentCellBorderEventArgs that contains the event data.

OnTableControlHScrollPixelPosChanged(GridTableControlScrollPositionChangedEventArgs)

Raises the TableControlHScrollPixelPosChanged event.

Declaration

protected virtual void OnTableControlHScrollPixelPosChanged(GridTableControlScrollPositionChangedEventArgs e)

Parameters

Type	Name	Description
GridTableControlScrollPositionChangedEventArgs	e	A GridTableControlScrollPositionChangedEventArgs that contains the event data.

OnTableControlHScrollPixelPosChanging(GridTableControlScrollPositionChangingEventArgs)

Raises the TableControlHScrollPixelPosChanging event.

Declaration

protected virtual void OnTableControlHScrollPixelPosChanging(GridTableControlScrollPositionChangingEventArgs e)

Parameters

Type	Name	Description
GridTableControlScrollPositionChangingEventArgs	e	A GridTableControlScrollPositionChangingEventArgs that contains the event data.

OnTableControlKeyDown(GridTableControlKeyEventArgs)

Triggered when the TableControlKeyDown event is done.

Declaration

protected virtual void OnTableControlKeyDown(GridTableControlKeyEventArgs e)

Parameters

Type	Name	Description
GridTableControlKeyEventArgs	e	A GridTableControlKeyEventArgs that contains the event data.

OnTableControlKeyPress(GridTableControlKeyPressEventArgs)

Raises the TableControlKeyPress event.

Declaration

protected virtual void OnTableControlKeyPress(GridTableControlKeyPressEventArgs e)

Parameters

Type	Name	Description
GridTableControlKeyPressEventArgs	e	A GridTableControlKeyPressEventArgs that contains the event data.

OnTableControlKeyUp(GridTableControlKeyEventArgs)

Triggered when the TableControlKeyUp event is done.

Declaration

protected virtual void OnTableControlKeyUp(GridTableControlKeyEventArgs e)

Parameters

Type	Name	Description
GridTableControlKeyEventArgs	e	A GridTableControlKeyEventArgs that contains the event data.

OnTableControlLeftColChanged(GridTableControlRowColIndexChangedEventArgs)

Raises the TableControlLeftColChanged event.

Declaration

protected virtual void OnTableControlLeftColChanged(GridTableControlRowColIndexChangedEventArgs e)

Parameters

Type	Name	Description
GridTableControlRowColIndexChangedEventArgs	e	A GridTableControlRowColIndexChangedEventArgs that contains the event data.

OnTableControlLeftColChanging(GridTableControlRowColIndexChangingEventArgs)

Raises the TableControlLeftColChanging event.

Declaration

protected virtual void OnTableControlLeftColChanging(GridTableControlRowColIndexChangingEventArgs e)

Parameters

Type	Name	Description
GridTableControlRowColIndexChangingEventArgs	e	A GridTableControlRowColIndexChangingEventArgs that contains the event data.

OnTableControlMouseDown(GridTableControlMouseEventArgs)

Raises the TableControlMouseDown event.

Declaration

protected virtual void OnTableControlMouseDown(GridTableControlMouseEventArgs e)

Parameters

Type	Name	Description
GridTableControlMouseEventArgs	e	A GridTableControlMouseEventArgs that contains the event data.

OnTableControlMouseWheel(GridTableControlMouseEventArgs)

Raises the TableControlMouseWheel event.

Declaration

protected virtual void OnTableControlMouseWheel(GridTableControlMouseEventArgs e)

Parameters

Type	Name	Description
GridTableControlMouseEventArgs	e	A GridTableControlDrawCellBackgroundEventArgs that contains the event data.

OnTableControlMoveCurrentCellDirection(GridTableControlMoveCurrentCellDirectionEventArgs)

Raises the TableControlMoveCurrentCellDirection event.

Declaration

protected virtual void OnTableControlMoveCurrentCellDirection(GridTableControlMoveCurrentCellDirectionEventArgs e)

Parameters

Type	Name	Description
GridTableControlMoveCurrentCellDirectionEventArgs	e	A GridTableControlMoveCurrentCellDirectionEventArgs that contains the event data.

OnTableControlPrepareViewStyleInfo(GridTableControlPrepareViewStyleInfoEventArgs)

Raises the TableControlPrepareViewStyleInfo event.

Declaration

protected virtual void OnTableControlPrepareViewStyleInfo(GridTableControlPrepareViewStyleInfoEventArgs e)

Parameters

Type	Name	Description
GridTableControlPrepareViewStyleInfoEventArgs	e	A GridTableControlPrepareViewStyleInfoEventArgs that contains the event data.

OnTableControlPushButtonClick(GridTableControlCellPushButtonClickEventArgs)

Raises the TableControlPushButtonClick event.

Declaration

protected virtual void OnTableControlPushButtonClick(GridTableControlCellPushButtonClickEventArgs e)

Parameters

Type	Name	Description
GridTableControlCellPushButtonClickEventArgs	e

OnTableControlQueryAllowArrowKeyNavigateTo(GridQueryAllowArrowKeyNavigateToEventArgs)

Triggered when the TableControlQueryAllowArrowKeyNavigateTo event is done..

Declaration

protected virtual void OnTableControlQueryAllowArrowKeyNavigateTo(GridQueryAllowArrowKeyNavigateToEventArgs e)

Parameters

Type	Name	Description
GridQueryAllowArrowKeyNavigateToEventArgs	e	A GridQueryAllowArrowKeyNavigateToEventArgs that contains the event data.

OnTableControlQueryAllowDragColumn(GridQueryAllowDragColumnEventArgs)

Raises the TableControlQueryAllowDragColumn event.

Declaration

protected virtual void OnTableControlQueryAllowDragColumn(GridQueryAllowDragColumnEventArgs e)

Parameters

Type	Name	Description
GridQueryAllowDragColumnEventArgs	e	A GridQueryAllowDragColumnEventArgs that contains the event data.

OnTableControlQueryAllowGroupByColumn(GridQueryAllowGroupByColumnEventArgs)

Triggered when the TableControlQueryAllowGroupByColumn event is done.

Declaration

protected virtual void OnTableControlQueryAllowGroupByColumn(GridQueryAllowGroupByColumnEventArgs e)

Parameters

Type	Name	Description
GridQueryAllowGroupByColumnEventArgs	e	A GridQueryAllowGroupByColumnEventArgs that contains the event data.

OnTableControlQueryAllowSortColumn(GridQueryAllowSortColumnEventArgs)

Triggered when the TableControlQueryAllowSortColumn event is done.

Declaration

protected virtual void OnTableControlQueryAllowSortColumn(GridQueryAllowSortColumnEventArgs e)

Parameters

Type	Name	Description
GridQueryAllowSortColumnEventArgs	e	A GridQueryAllowSortColumnEventArgs that contains the event data.

OnTableControlQueryNextCurrentCellPosition(GridTableControlQueryNextCurrentCellPositionEventArgs)

Raises the TableControlQueryNextCurrentCellPosition event.

Declaration

protected virtual void OnTableControlQueryNextCurrentCellPosition(GridTableControlQueryNextCurrentCellPositionEventArgs e)

Parameters

Type	Name	Description
GridTableControlQueryNextCurrentCellPositionEventArgs	e	A GridTableControlQueryNextCurrentCellPositionEventArgs that contains the event data.

OnTableControlQueryScrollCellInView(GridTableControlQueryScrollCellInViewEventArgs)

Raises the TableControlQueryScrollCellInView event.

Declaration

protected virtual void OnTableControlQueryScrollCellInView(GridTableControlQueryScrollCellInViewEventArgs e)

Parameters

Type	Name	Description
GridTableControlQueryScrollCellInViewEventArgs	e	A GridTableControlQueryScrollCellInViewEventArgs that contains the event data.

OnTableControlResizingColumns(GridTableControlResizingColumnsEventArgs)

Raises the TableControlResizingColumns event.

Declaration

protected virtual void OnTableControlResizingColumns(GridTableControlResizingColumnsEventArgs e)

Parameters

Type	Name	Description
GridTableControlResizingColumnsEventArgs	e	A GridTableControlResizingColumnsEventArgs that contains the event data.

OnTableControlResizingRows(GridTableControlResizingRowsEventArgs)

Raises the TableControlResizingRows event.

Declaration

protected virtual void OnTableControlResizingRows(GridTableControlResizingRowsEventArgs e)

Parameters

Type	Name	Description
GridTableControlResizingRowsEventArgs	e	A GridTableControlResizingRowsEventArgs that contains the event data.

OnTableControlScrollTipFeedback(GridTableControlScrollTipFeedbackEventArgs)

Raises the TableControlScrollTipFeedback event.

Declaration

protected virtual void OnTableControlScrollTipFeedback(GridTableControlScrollTipFeedbackEventArgs e)

Parameters

Type	Name	Description
GridTableControlScrollTipFeedbackEventArgs	e

OnTableControlTopRowChanged(GridTableControlRowColIndexChangedEventArgs)

Raises the TableControlTopRowChanged event.

Declaration

protected virtual void OnTableControlTopRowChanged(GridTableControlRowColIndexChangedEventArgs e)

Parameters

Type	Name	Description
GridTableControlRowColIndexChangedEventArgs	e	A GridTableControlRowColIndexChangedEventArgs that contains the event data.

OnTableControlTopRowChanging(GridTableControlRowColIndexChangingEventArgs)

Raises the TableControlTopRowChanging event.

Declaration

protected virtual void OnTableControlTopRowChanging(GridTableControlRowColIndexChangingEventArgs e)

Parameters

Type	Name	Description
GridTableControlRowColIndexChangingEventArgs	e	A GridTableControlRowColIndexChangingEventArgs that contains the event data.

OnTableControlVScrollPixelPosChanged(GridTableControlScrollPositionChangedEventArgs)

Raises the TableControlVScrollPixelPosChanged event.

Declaration

protected virtual void OnTableControlVScrollPixelPosChanged(GridTableControlScrollPositionChangedEventArgs e)

Parameters

Type	Name	Description
GridTableControlScrollPositionChangedEventArgs	e	A GridTableControlScrollPositionChangedEventArgs that contains the event data.

OnTableControlVScrollPixelPosChanging(GridTableControlScrollPositionChangingEventArgs)

Raises the TableControlVScrollPixelPosChanging event.

Declaration

protected virtual void OnTableControlVScrollPixelPosChanging(GridTableControlScrollPositionChangingEventArgs e)

Parameters

Type	Name	Description
GridTableControlScrollPositionChangingEventArgs	e	A GridTableControlScrollPositionChangingEventArgs that contains the event data.

OnTableControlWrapCellNextControlInForm(GridTableControlWrapCellNextControlInFormEventArgs)

Raises the TableControlWrapCellNextControlInForm event.

Declaration

protected virtual void OnTableControlWrapCellNextControlInForm(GridTableControlWrapCellNextControlInFormEventArgs e)

Parameters

Type	Name	Description
GridTableControlWrapCellNextControlInFormEventArgs	e	A GridTableControlWrapCellNextControlInFormEventArgs that contains the event data.

OnTableSourceListChanged(TableEventArgs)

Raises the TableSourceListChanged event.

Declaration

protected virtual void OnTableSourceListChanged(TableEventArgs e)

Parameters

Type	Name	Description
TableEventArgs	e	A TableEventArgs that contains the event data.

OnValidating(CancelEventArgs)

Overrides and performs the validating operation.

Declaration

protected override void OnValidating(CancelEventArgs e)

Parameters

Type	Name	Description
System.ComponentModel.CancelEventArgs	e	The System.ComponentModel.CancelEventArgs contains the event data.

OptimizeIListGroupingPeformance(Object, ListChangedEventArgs)

Improves the Grouping performance with IList datasource.

Declaration

[Obsolete("Use OptimizeIListGroupingPerformance method instead")]
public void OptimizeIListGroupingPeformance(object src, ListChangedEventArgs e)

Parameters

Type	Name	Description
System.Object	src	The source object.
System.ComponentModel.ListChangedEventArgs	e	A System.ComponentModel.ListChangedEventArgs contains the event data.

OptimizeIListGroupingPerformance(Object, ListChangedEventArgs)

Improves the Grouping performance with IList datasource.

Declaration

public void OptimizeIListGroupingPerformance(object src, ListChangedEventArgs e)

Parameters

Type	Name	Description
System.Object	src	The source object.
System.ComponentModel.ListChangedEventArgs	e	A System.ComponentModel.ListChangedEventArgs contains the event data.

ProcessDialogKey(Keys)

Overrides and determines a value indicating whether to processes a dialog key or not.

Declaration

protected override bool ProcessDialogKey(Keys keyData)

Parameters

Type	Name	Description
System.Windows.Forms.Keys	keyData	One of the System.Windows.Forms.Keys values that represents the key to process.

Returns

Type	Description
System.Boolean	True if the key was processed by the control; Otherwise, false.

RaiseParseCommonFormats(GridCellTextEventArgs)

Used internally.

Declaration

public void RaiseParseCommonFormats(GridCellTextEventArgs e)

Parameters

Type	Name	Description
GridCellTextEventArgs	e

RaiseQueryCellFormattedText(GridCellTextEventArgs)

Used internally.

Declaration

public void RaiseQueryCellFormattedText(GridCellTextEventArgs e)

Parameters

Type	Name	Description
GridCellTextEventArgs	e

RaiseQueryCellText(GridCellTextEventArgs)

Used internally.

Declaration

public void RaiseQueryCellText(GridCellTextEventArgs e)

Parameters

Type	Name	Description
GridCellTextEventArgs	e

RaiseQueryValue(FieldValueEventArgs)

Raises the QueryValue event

Declaration

public void RaiseQueryValue(FieldValueEventArgs e)

Parameters

Type	Name	Description
FieldValueEventArgs	e	The FieldValueEventArgs with event data.

RaiseSaveCellFormattedText(GridCellTextEventArgs)

Used internally.

Declaration

public void RaiseSaveCellFormattedText(GridCellTextEventArgs e)

Parameters

Type	Name	Description
GridCellTextEventArgs	e

RaiseSaveCellText(GridCellTextEventArgs)

Used internally.

Declaration

public void RaiseSaveCellText(GridCellTextEventArgs e)

Parameters

Type	Name	Description
GridCellTextEventArgs	e

RaiseSaveValue(FieldValueEventArgs)

Raises the SaveValue event.

Declaration

public void RaiseSaveValue(FieldValueEventArgs e)

Parameters

Type	Name	Description
FieldValueEventArgs	e	The FieldValueEventArgs with event data.

Refresh()

Overrides and forces the control to invalidate its client area and immediately redraws itself and any child controls.

Declaration

public override void Refresh()

Reinitialize()

Discards changes, refreshes the counters and summaries and redraws the grid.

Declaration

public void Reinitialize()

ResetAllowScrollCurrentCellInView()

Resets the AllowScrollCurrentCellInView back to its default value.

Declaration

public void ResetAllowScrollCurrentCellInView()

ResetAlphaBlendSelectionColor()

Resets the AlphaBlendSelectionColor back to its default value.

Declaration

public void ResetAlphaBlendSelectionColor()

ResetAppearance()

Discards any changes for the Appearance object.

Declaration

public void ResetAppearance()

ResetBaseStyles()

Resets the values of BaseStyles property associated with the grid.

Declaration

public void ResetBaseStyles()

ResetBrowseOnly()

Resets the BrowseOnly back to its default value.

Declaration

public void ResetBrowseOnly()

ResetCacheRecordValues()

Resets the CacheRecordValues back to its default value.

Declaration

public void ResetCacheRecordValues()

ResetChildGroupOptions()

Resets the modifications done in the ChildGroupOptions property values.

Declaration

public void ResetChildGroupOptions()

ResetClickedOnDisabledCellBehavior()

Resets the ClickedOnDisabledCellBehavior back to its default value.

Declaration

public void ResetClickedOnDisabledCellBehavior()

ResetCultureInfo()

Discards any changes for the Culture property value.

Declaration

public void ResetCultureInfo()

ResetDefaultGridBorderStyle()

Resets the DefaultGridBorderStyle back to its default value.

Declaration

public void ResetDefaultGridBorderStyle()

ResetDisplayHorizontalLines()

Resets the DisplayHorizontalLines back to its default value.

Declaration

public void ResetDisplayHorizontalLines()

ResetDisplayVerticalLines()

Resets the DisplayVerticalLines back to its default value.

Declaration

public void ResetDisplayVerticalLines()

ResetEnableAutoSize()

Discards any changes for the EnableAutoSize property.

Declaration

public void ResetEnableAutoSize()

ResetFreezeCaption()

Discards any changes for the FreezeCaption object.

Declaration

public void ResetFreezeCaption()

ResetGridLineColor()

Resets the GridLineColor back to its default value.

Declaration

public void ResetGridLineColor()

ResetGroupDropAreaAlignment()

Resets the GroupDropAreaAlignment back to its default value.

Declaration

public void ResetGroupDropAreaAlignment()

ResetHierarchicalGroupDropArea()

Resets the HierarchicalGroupDropArea back to its default value.

Declaration

public void ResetHierarchicalGroupDropArea()

ResetInvalidateAllWhenListChanged()

Discards any changes for the InvalidateAllWhenListChanged object.

Declaration

public void ResetInvalidateAllWhenListChanged()

ResetIsDynamicData()

Resets the IsDynamicData back to its default value.

Declaration

public void ResetIsDynamicData()

ResetMarkColHeader()

Resets the MarkColHeader back to its default value.

Declaration

public void ResetMarkColHeader()

ResetMarkRowHeader()

Resets the MarkRowHeader back to its default value.

Declaration

public void ResetMarkRowHeader()

ResetNestedTableGroupOptions()

Resets the modified values in the NestedTableGroupOptions instance.

Declaration

public void ResetNestedTableGroupOptions()

ResetPrintColumnHeader()

Resets the PrintColumnHeader back to its default value.

Declaration

public void ResetPrintColumnHeader()

ResetPrintRowHeader()

Resets the PrintRowHeader back to its default value.

Declaration

public void ResetPrintRowHeader()

ResetShowColumnHeaders()

Resets the ShowColumnHeaders back to its default value.

Declaration

public void ResetShowColumnHeaders()

ResetShowCurrentCellBorderBehavior()

Resets the ShowCurrentCellBorderBehavior back to its default value.

Declaration

public void ResetShowCurrentCellBorderBehavior()

ResetShowDefaultValuesInAddNewRecord()

Resets the ShowDefaultValuesInAddNewRecord back to its default value.

Declaration

public void ResetShowDefaultValuesInAddNewRecord()

ResetShowRowHeaders()

Resets the ShowRowHeaders back to its default value.

Declaration

public void ResetShowRowHeaders()

ResetSortIconPlacement()

Resets the SortIconPlacement back to its default value.

Declaration

public void ResetSortIconPlacement()

ResetTableDescriptor()

Resets the values of the TableDescriptor property back to its default state and auto populates schema information on demand.

Declaration

public void ResetTableDescriptor()

ResetTableDirtyOnSourceListReset()

Resets the TableDirtyOnSourceListReset back to its default value.

Declaration

public void ResetTableDirtyOnSourceListReset()

ResetTableOptions()

Resets the modification done in the values of the TableOptions property.

Declaration

public void ResetTableOptions()

ResetTopLevelGroupOptions()

Resets the modified values in the TopLevelGroupOptions property.

Declaration

public void ResetTopLevelGroupOptions()

ResetUseLazyUniformChildListRelation()

Discards any changes for the UseLazyUniformChildListRelation property.

Declaration

public void ResetUseLazyUniformChildListRelation()

ResetUseOldListChangedHandler()

Discards any changes for the UseOldListChangedHandler property.

Declaration

public void ResetUseOldListChangedHandler()

ResetUseRightToLeftCompatibleTextBox()

Resets the UseRightToLeftCompatibleTextBox back to its default value.

Declaration

public void ResetUseRightToLeftCompatibleTextBox()

SetMetroStyle(GridMetroColors)

Sets the color for grid when metro theme applied.

Declaration

public void SetMetroStyle(GridMetroColors metroColor)

Parameters

Type	Name	Description
GridMetroColors	metroColor	Collection of metro colors.

SetMetroStyle(Object, Object, Object, Object)

Sets the custom Metro Colors to the Grid.

Declaration

public void SetMetroStyle(object metroColor, object metroHoverColor, object metroColorPressed, object metroGroupBarColor)

Parameters

Type	Name	Description
System.Object	metroColor	Custom Metro Color.
System.Object	metroHoverColor	Custom color for mouse hovering.
System.Object	metroColorPressed	Custom color for mouse pressed.
System.Object	metroGroupBarColor	Custom color for the group bars.

SetOffice2016ThemeStyle(GridVisualStyles, GridOffice2016ThemeColors)

Sets the color for grid when office2016 theme applied.

Declaration

public void SetOffice2016ThemeStyle(GridVisualStyles style, GridOffice2016ThemeColors office2016ThemeColor)

Parameters

Type	Name	Description
GridVisualStyles	style	The custom colors for Office 2016 theme.
GridOffice2016ThemeColors	office2016ThemeColor	Collection of office2016ThemeColor colors.

ShouldSerializeAllowScrollCurrentCellInView()

Determines whether AllowScrollCurrentCellInView has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeAllowScrollCurrentCellInView()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeAlphaBlendSelectionColor()

Determines whether AlphaBlendSelectionColor has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeAlphaBlendSelectionColor()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeAppearance()

Determines whether to serialize the changed values of the Appearance property or not at design-time.

Declaration

public bool ShouldSerializeAppearance()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeBaseStyles()

Determines a value indicating whether to serialize BaseStyles collection was modified or not.

Declaration

public bool ShouldSerializeBaseStyles()

Returns

Type	Description
System.Boolean	True if the collection was modified; Otherwise False.

ShouldSerializeBrowseOnly()

Determines whether BrowseOnly has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeBrowseOnly()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeCacheRecordValues()

Determines if the CacheRecordValues has been modified from its default state.

Declaration

public bool ShouldSerializeCacheRecordValues()

Returns

Type	Description
System.Boolean	True if CacheRecordValues was manually modified

ShouldSerializeChildGroupOptions()

Determines a value indicating whether the changed values of the property should ChildGroupOptions were modified and whether their contents should be serialized at design-time.

Declaration

public bool ShouldSerializeChildGroupOptions()

Returns

Type	Description
System.Boolean	True if contents are changed; False otherwise.

ShouldSerializeClickedOnDisabledCellBehavior()

Determines whether ClickedOnDisabledCellBehavior has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeClickedOnDisabledCellBehavior()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeCultureInfo()

Determines a value indicating whether the value Culture was modified or not.

Declaration

public bool ShouldSerializeCultureInfo()

Returns

Type	Description
System.Boolean	True if content is changed; False otherwise.

ShouldSerializeDefaultGridBorderStyle()

Determines whether DefaultGridBorderStyle has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeDefaultGridBorderStyle()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeDisplayHorizontalLines()

Determines whether DisplayHorizontalLines has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeDisplayHorizontalLines()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeDisplayVerticalLines()

Determines whether DisplayVerticalLines has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeDisplayVerticalLines()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeEnableAutoSize()

Determines whether the EnableAutoSize property was modified or not.

Declaration

public bool ShouldSerializeEnableAutoSize()

Returns

Type	Description
System.Boolean	True if it was modified.

ShouldSerializeFreezeCaption()

Creates an instance of the Syncfusion.Windows.Forms.Grid.Grouping.GridGroupingControlOptimizeListChanged class with grid grouping control to optimize list changed. Determines whether FreezeCaption has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeFreezeCaption()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeGridLineColor()

Determines whether GridLineColor has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeGridLineColor()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeGroupDropAreaAlignment()

Determines whether GroupDropAreaAlignment has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeGroupDropAreaAlignment()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeHierarchicalGroupDropArea()

Determines whether HierarchicalGroupDropArea has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeHierarchicalGroupDropArea()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeInvalidateAllWhenListChanged()

Determines whether InvalidateAllWhenListChanged was modified.

Declaration

public bool ShouldSerializeInvalidateAllWhenListChanged()

Returns

Type	Description
System.Boolean	True if content is changed;False, otherwise.

ShouldSerializeIsDynamicData()

Determines whether IsDynamicData has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeIsDynamicData()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeMarkColHeader()

Determines whether MarkColHeader has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeMarkColHeader()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeMarkRowHeader()

Determines whether MarkRowHeader has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeMarkRowHeader()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeNestedTableGroupOptions()

Determines a value indicating whether to serialize the modified values in NestedTableGroupOptions property at design-time.

Declaration

public bool ShouldSerializeNestedTableGroupOptions()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializePrintColumnHeader()

Determines whether PrintColumnHeader has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializePrintColumnHeader()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializePrintRowHeader()

Determines whether PrintRowHeader has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializePrintRowHeader()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeShowColumnHeaders()

Determines whether ShowColumnHeaders has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeShowColumnHeaders()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeShowCurrentCellBorderBehavior()

Determines whether ShowCurrentCellBorderBehavior has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeShowCurrentCellBorderBehavior()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeShowDefaultValuesInAddNewRecord()

Determines whether ShowDefaultValuesInAddNewRecord has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeShowDefaultValuesInAddNewRecord()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeShowRowHeaders()

Determines whether ShowRowHeaders has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeShowRowHeaders()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeSortIconPlacement()

Determines whether SortIconPlacement has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeSortIconPlacement()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeTableDescriptor()

Determines whether to serialize the TableDescriptor has been modified from its default state or not.

Declaration

public bool ShouldSerializeTableDescriptor()

Returns

Type	Description
System.Boolean	True if TableDescriptor was manually modified; False if it only contains auto-populated data.

ShouldSerializeTableDirtyOnSourceListReset()

Determines a value whether the TableDirtyOnSourceListReset has been modified from its default state or not.

Declaration

public bool ShouldSerializeTableDirtyOnSourceListReset()

Returns

Type	Description
System.Boolean	True if TableDirtyOnSourceListReset was manually modified;

ShouldSerializeTableOptions()

Determines a value indicating whether TableOptions were modified or not and whether their contents should be serialized at design-time.

Declaration

public bool ShouldSerializeTableOptions()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeTopLevelGroupOptions()

Determines a value indicating whether to serialize the top level group options or not at the design-time.

Declaration

public bool ShouldSerializeTopLevelGroupOptions()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeUseLazyUniformChildListRelation()

Determines whether the content of UseLazyUniformChildListRelation property was modified or not.

Declaration

public bool ShouldSerializeUseLazyUniformChildListRelation()

Returns

Type	Description
System.Boolean	True if it was modified.

ShouldSerializeUseOldListChangedHandler()

Determines whether the UseOldListChangedHandler property was modified.

Declaration

public bool ShouldSerializeUseOldListChangedHandler()

Returns

Type	Description
System.Boolean	True if it was modified; Otherwise False.

ShouldSerializeUseRightToLeftCompatibleTextBox()

Determines whether UseRightToLeftCompatibleTextBox has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeUseRightToLeftCompatibleTextBox()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ToString()

Overrides and gets a string containing the current object.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A string containing the current object.

Update()

Updates the display after changes were made to schema or data in the engine or datasource.

Declaration

public void Update()

UpdateNavigationBar()

Updates the record navigation bar properties such as maximum count, current record, etc.

Declaration

public void UpdateNavigationBar()

UpdateThrottled()

Checks the grid if there are pending changes from ListChanged events and enough time has elapsed since the last update as specified with UpdateDisplayFrequency.

Declaration

public void UpdateThrottled()

WndProc(ref Message)

Overrides and process the window message.

Declaration

protected override void WndProc(ref Message msg)

Parameters

Type	Name	Description
System.Windows.Forms.Message	msg

WriteXmlLookAndFeel(XmlWriter)

Writes GridGroupingLookAndFeel state to an XML stream.

Declaration

public void WriteXmlLookAndFeel(XmlWriter xw)

Parameters

Type	Name	Description
System.Xml.XmlWriter	xw	The XML writer stream.

WriteXmlSchema(XmlWriter)

Writes engines settings to an XML stream.

Declaration

public void WriteXmlSchema(XmlWriter xw)

Parameters

Type	Name	Description
System.Xml.XmlWriter	xw	The XML writer stream.

Events

CategorizedRecords

Occurs after records are categorized after a table is marked dirty (TableDirty)

Declaration

public event TableEventHandler CategorizedRecords

Event Type

Type
TableEventHandler

Remarks

When TableDirty is set to True, e.g. because schema information for a table was changed or because the grouped columns were changed, the table will categorize records on demand the first time information about a record is accessed. At that time, the Element of the Table will start categorization.

CategorizingRecords

Occurs before records are categorized after a table is marked dirty (TableDirty).

Declaration

public event TableEventHandler CategorizingRecords

Event Type

Type
TableEventHandler

Remarks

CurrentRecordContextChange

Occurs before and after the status of the current record is changed. Check the Action of the CurrentRecordContextChangeEventArgs to get information on which current record state was changed.

Declaration

public event CurrentRecordContextChangeEventHandler CurrentRecordContextChange

Event Type

Type
CurrentRecordContextChangeEventHandler

CurrentRecordManagerReset

Occurs when the Reset() method of the CurrentRecordManager was called.

Declaration

public event TableEventHandler CurrentRecordManagerReset

Event Type

Type
TableEventHandler

Remarks

The GridGroupingControl listens to this events and resets any "Current Cell" state when this event is raised.

DataSourceChanged

Occurs When the DataSource is to Changed.

Declaration

public event EventHandler DataSourceChanged

Event Type

Type
System.EventHandler

DataSourceChanging

Occurs When the DataSource is about to Change.

Declaration

public event GridGroupingControl.DataSourceChangingEventHandler DataSourceChanging

Event Type

Type
GridGroupingControl.DataSourceChangingEventHandler

DisplayElementChanged

When number of visible elements were changed.

Declaration

public event DisplayElementChangedEventHandler DisplayElementChanged

Event Type

Type
DisplayElementChangedEventHandler

DisplayElementChanging

When number of visible elements were changed.

Declaration

public event DisplayElementChangingEventHandler DisplayElementChanging

Event Type

Type
DisplayElementChangingEventHandler

ExceptionRaised

Occurs when a unknown exception has been cached while modifying underlying data in the datasource.

Declaration

public event ExceptionRaisedEventHandler ExceptionRaised

Event Type

Type
ExceptionRaisedEventHandler

Remarks

If necessary, you can rethrow the exception in your event handler.

FieldChooserClosed

Occurs immediately after the FieldChooser dialog is closed.

Declaration

public event FieldChooserClosedEventHandler FieldChooserClosed

Event Type

Type
FieldChooserClosedEventHandler

FieldChooserClosing

Occurs immediately before the FieldChooser dialog is closed.

Declaration

public event FieldChooserClosingEventHandler FieldChooserClosing

Event Type

Type
FieldChooserClosingEventHandler

FieldChooserShowing

Occurs immediately before the FieldChooser dialog is displayed.

Declaration

public event FieldChooserShowingEventHandler FieldChooserShowing

Event Type

Type
FieldChooserShowingEventHandler

FieldChooserShown

Occurs after the FieldChooser dialog is displayed.

Declaration

public event FieldChooserShownEventHandler FieldChooserShown

Event Type

Type
FieldChooserShownEventHandler

FilterBarSelectedItemChanged

Occurs when the filterbar's selected item gets changed in the filter dropdown.

Declaration

public event FilterBarSelectedItemChangedEventHandler FilterBarSelectedItemChanged

Event Type

Type
FilterBarSelectedItemChangedEventHandler

FilterBarSelectedItemChanging

Occurs when an item selected through the filtered dropdown is changing.

Declaration

public event FilterBarSelectedItemChangingEventHandler FilterBarSelectedItemChanging

Event Type

Type
FilterBarSelectedItemChangingEventHandler

GroupAdded

Occurs when a new group is added in a table after the table was categorized and when a record is changed. The event does not occur during categorization of the table. See the CategorizedRecords elements to when categorization finished.

Declaration

public event GroupEventHandler GroupAdded

Event Type

Type
GroupEventHandler

GroupCollapsed

Occurs before a group is collapsed.

Declaration

public event GroupEventHandler GroupCollapsed

Event Type

Type
GroupEventHandler

GroupCollapsing

Occurs before a group is collapsed.

Declaration

public event GroupEventHandler GroupCollapsing

Event Type

Type
GroupEventHandler

GroupExpanded

Occurs after a group was expanded.

Declaration

public event GroupEventHandler GroupExpanded

Event Type

Type
GroupEventHandler

GroupExpanding

Occurs before a group is expanded.

Declaration

public event GroupEventHandler GroupExpanding

Event Type

Type
GroupEventHandler

GroupRemoving

Occurs when a group is removed from a table after the table was categorized and when a record is changed. The event does not occur during categorization of the table. See the CategorizedRecords elements to when categorization finished.

Declaration

public event GroupEventHandler GroupRemoving

Event Type

Type
GroupEventHandler

GroupSummaryInvalidated

Occurs when a summary has been marked dirty.

Declaration

public event GroupEventHandler GroupSummaryInvalidated

Event Type

Type
GroupEventHandler

Remarks

The GridGroupingControl listens to this event and will force a repaint of the specified summary if it is visible when this event was raised.

InvalidatingCounters

Occurs when the InvalidateCounterTopDown(Boolean) of a Table was called and before all counters are marked dirty.

Declaration

public event TableEventHandler InvalidatingCounters

Event Type

Type
TableEventHandler

InvalidatingSummaries

Occurs when the InvalidateSummariesTopDown() of a Table is called and before all summaries in that table are marked dirty.

Declaration

public event TableEventHandler InvalidatingSummaries

Event Type

Type
TableEventHandler

NavigationBarRecordChanged

Occurs after the current record of the navigation bar is changed.

Declaration

public event CurrentRecordChangedEventHandler NavigationBarRecordChanged

Event Type

Type
CurrentRecordChangedEventHandler

NavigationBarRecordChanging

Occurs before the current record of the navigation bar is changed.

Declaration

public event CurrentRecordChangedEventHandler NavigationBarRecordChanging

Event Type

Type
CurrentRecordChangedEventHandler

Office2007ScrollBarsChanged

Occurs when the Office2007ScrollBars property has changed.

Declaration

public event EventHandler Office2007ScrollBarsChanged

Event Type

Type
System.EventHandler

Office2007ScrollBarsColorSchemeChanged

Occurs when the Office2007ColorScheme property has changed.

Declaration

public event EventHandler Office2007ScrollBarsColorSchemeChanged

Event Type

Type
System.EventHandler

Office2010ScrollBarsColorSchemeChanged

Occurs when the Office2010ScrollBarsColorScheme property has changed.

Declaration

public event EventHandler Office2010ScrollBarsColorSchemeChanged

Event Type

Type
System.EventHandler

Office2016ScrollBarsColorSchemeChanged

Occurs when the Office2016ScrollBarsColorScheme property has changed.

Declaration

public event EventHandler Office2016ScrollBarsColorSchemeChanged

Event Type

Type
System.EventHandler

OfficeScrollBarsChanged

Triggered when the Office2007ScrollBars property has changed.

Declaration

public event GridGroupingControl.OfficeScrollBarsEventHandler OfficeScrollBarsChanged

Event Type

Type
GridGroupingControl.OfficeScrollBarsEventHandler

PaintingFields

Triggered when grid paints pending changes from ListChanged events as specified with UpdateDisplayFrequency.

Declaration

public event EventHandler PaintingFields

Event Type

Type
System.EventHandler

ParseCommonFormats

Use this event to provide support for parsing the formatted string and convert it into the the underlying cell's value considering Format and CellValueType.

This event is raised from GridCellModelBase.ApplyFormattedText after SaveCellFormattedText was raised. The event is raised only if the SaveCellFormattedText did not set e.Handled.

Declaration

public event GridCellTextEventHandler ParseCommonFormats

Event Type

Type
GridCellTextEventHandler

Remarks

The grid has built-in support for parsing the Percent format (Format = "P") and Hexadecimal format (Format = "X"). You should handle this event if you want to add support for other formats.

GridCellTextEventArgs has information about the style settings of the cell. You can inspect that style to get information about Format and CellValueType of the cell.

PropertyChanged

Occurs when a property is changed.

Declaration

public event DescriptorPropertyChangedEventHandler PropertyChanged

Event Type

Type
DescriptorPropertyChangedEventHandler

PropertyChanging

Occurs before a property is changed.

Declaration

public event DescriptorPropertyChangedEventHandler PropertyChanging

Event Type

Type
DescriptorPropertyChangedEventHandler

QueryCellFormattedText

Occurs each time the FormattedText is called to get the formatted string that represents the underlying cell's value considering Format.

Declaration

public event GridCellTextEventHandler QueryCellFormattedText

Event Type

Type
GridCellTextEventHandler

Remarks

This event allows you to customize how to format a cell's value as string at run-time on demand based on Format.

If you do want to customize the grid's default formatting, you should assign the resulting string to Text and set Handled to True. The grid will check this flag to see whether it should return Text or use a default formatting routine.

If you need identity information about the cell such as row and column index, you can get that information by querying the CellIdentity of the Style object.

QueryCellStyleInfo

Occurs for each cell before a GridTableControl starts painting and lets users customize the display of cells.

Declaration

public event GridTableCellStyleInfoEventHandler QueryCellStyleInfo

Event Type

Type
GridTableCellStyleInfoEventHandler

QueryCellText

Occurs each time the Text is called to get the raw string that represents the underlying cell's value.

Declaration

public event GridCellTextEventHandler QueryCellText

Event Type

Type
GridCellTextEventHandler

Remarks

This event allows you to customize how to represent a cell's value as string at run-time on demand.

If you do want to customize the grid's default conversion, you should assign the result string to Text and set Handled to True. The grid will check this flag to see whether it should return Text or use a default conversion.

If you need identity information about the cell such as row and column index, you can get that information by querying CellIdentity of the Style object.

QueryCoveredRange

Occurs to determine if the cell belongs to a covered range and returns the covered range of the cell or the cell itself as GridRangeInfo if it is not a covered range.

Declaration

public event GridTableQueryCoveredRangeEventHandler QueryCoveredRange

Event Type

Type
GridTableQueryCoveredRangeEventHandler

QueryCustomSummary

Occurs for each GridSummaryColumnDescriptor before the SummaryDescriptor is determined. You must handle this event if you specified Custom as SummaryType.

Declaration

public event GridQueryCustomSummaryEventHandler QueryCustomSummary

Event Type

Type
GridQueryCustomSummaryEventHandler

QueryFilterBarChoices

Occurs when GridTableDescriptor is initializing columns with .AllowFilter set and gives you the option to handle filterbarchoices through custom code. In such case the event is also raised when the user clicks on dropdown button of a GridTableFilterBarCell.

Declaration

public event GridQueryFilterBarChoicesEventHandler QueryFilterBarChoices

Event Type

Type
GridQueryFilterBarChoicesEventHandler

QueryRecordMeetsFilterCriteria

Occurs when a record is checked whether it meets filter criteria and should appear visible in the table's DisplayElements.

Declaration

public event QueryRecordMeetsFilterCriteriaEventHandler QueryRecordMeetsFilterCriteria

Event Type

Type
QueryRecordMeetsFilterCriteriaEventHandler

QueryValue

Occurs when a value for a field descriptor and record is returned. See the Grid\Grouping\Samples\CustomSummary sample how to use this event with unbound field descriptors.

Declaration

public event FieldValueEventHandler QueryValue

Event Type

Type
FieldValueEventHandler

RecordCollapsed

Occurs after a record with nested tables is collapsed.

Declaration

public event RecordEventHandler RecordCollapsed

Event Type

Type
RecordEventHandler

RecordCollapsing

Occurs before a record with nested tables is collapsed.

Declaration

public event RecordEventHandler RecordCollapsing

Event Type

Type
RecordEventHandler

RecordDeleted

Occurs after a record is deleted.

Declaration

public event RecordEventHandler RecordDeleted

Event Type

Type
RecordEventHandler

Remarks

This event is raised only when the Table or Record triggers the deletion. If the underlying source list deletes the record, a SourceListListChanged event is raised instead.

RecordDeleting

Occurs before a record is deleted.

Declaration

public event RecordEventHandler RecordDeleting

Event Type

Type
RecordEventHandler

Remarks

This event is raised only when the Table or Record triggers the deletion. If the underlying source list deletes the record, a SourceListListChanged event is raised instead.

RecordExpanded

Occurs after a record with nested tables is expanded.

Declaration

public event RecordEventHandler RecordExpanded

Event Type

Type
RecordEventHandler

RecordExpanding

Occurs before a record with nested tables is expanded.

Declaration

public event RecordEventHandler RecordExpanding

Event Type

Type
RecordEventHandler

RecordValueChanged

Occurs when a RecordFieldCell cell's value is changed and after Record.SetValue returned.

Declaration

public event RecordValueChangedEventHandler RecordValueChanged

Event Type

Type
RecordValueChangedEventHandler

RecordValueChanging

Occurs when a RecordFieldCell cell's value is changed and before Record.SetValue is called.

Declaration

public event RecordValueChangingEventHandler RecordValueChanging

Event Type

Type
RecordValueChangingEventHandler

SaveCellFormattedText

Occurs each time the FormattedText is called to parse the formatted string that represents the underlying cell's value considering Format and CellValueType.

Declaration

public event GridCellTextEventHandler SaveCellFormattedText

Event Type

Type
GridCellTextEventHandler

Remarks

This event allows you to customize how to parse the formatted text into a cell value at run-time on demand.

If you do want to customize the grid's default parsing behavior, you should assign the resulting value to the CellValue of the GridStyleInfo object and set Handled to True. The grid will check this flag to see whether it should accept your modification or use a default parsing routine.

If you need identity information about the cell such as row and column index, you can get that information by querying the CellIdentity of the Style object.

This event is normally called from within ApplyFormattedText(GridStyleInfo, String, Int32), which is called when the user enters text into a text box or when text is assigned to FormattedText. ApplyFormattedText method checks if there are event handlers for SaveCellFormattedText and if the Handled is not set, they try to convert the input text into the type specified with CellValueType.

If this conversion fails, ApplyFormattedText(GridStyleInfo, String, Int32) will check StrictValueType. If it is True, an exception is thrown which itself results in a warning message displayed to the user at the time from CurrentCellValidating.

If you set StrictValueType to False, ApplyFormattedText(GridStyleInfo, String, Int32) will not throw an exception and simply store the text as CellValue.

If you need a more specialized customization of this behavior, you should handle the SaveCellFormattedText event. This lets you parse the text input and change the cells CellValueType at run-time. See the attached example.

Examples

This example parses the text input and changes the cell's CellValueType at run-time if the input does not match the current CellValueType.

void InitializeComponent()
{
    // initialize code
    // ...
    this.gridControl1.SaveCellText += new Syncfusion.Windows.Forms.Grid.GridCellTextEventHandler(this.gridControl1_SaveCellText);
    this.gridControl1.QueryCellFormattedText += new Syncfusion.Windows.Forms.Grid.GridCellTextEventHandler(this.gridControl1_QueryCellFormattedText);
    this.gridControl1.SaveCellFormattedText += new Syncfusion.Windows.Forms.Grid.GridCellTextEventHandler(this.gridControl1_SaveCellFormattedText);
    this.gridControl1.QueryCellText += new Syncfusion.Windows.Forms.Grid.GridCellTextEventHandler(this.gridControl1_QueryCellText);
}

private void gridControl1_QueryCellFormattedText(object sender, Syncfusion.Windows.Forms.Grid.GridCellTextEventArgs e)
{

}

private void gridControl1_QueryCellText(object sender, Syncfusion.Windows.Forms.Grid.GridCellTextEventArgs e)
{

}

private void gridControl1_SaveCellText(object sender, Syncfusion.Windows.Forms.Grid.GridCellTextEventArgs e)
{
    ParseText(e);
}

private void gridControl1_SaveCellFormattedText(object sender, GridCellTextEventArgs e)
{
    ParseText(e);
}

void ParseText(GridCellTextEventArgs e)
{
    // By default, the grid will display a warning message box informing the user
    // the entered value is not valid and the user will have to change the value.
    //
    // In this event handler, we change the grid default's behavior such that
    // when the user enters a value that does not fit the cell's CellValueType,
    // the input text is accepted and no warning message is shown.
    if (e.Handled)
        return;

    System.Globalization.CultureInfo ci = e.Style.CultureInfo;
    System.Globalization.NumberFormatInfo nfi = ci != null ? ci.NumberFormat : null;
    try
    {
        e.Style.CellValue = GridCellValueConvert.Parse(e.Text, e.Style.CellValueType, nfi, e.Style.Format);
    }
    catch (Exception ex)
    {
        if (ex is FormatException || ex.InnerException is FormatException)
        {
            e.Style.CellValue = e.Text;
            // possibly could also change CellValueType here
            e.Style.CellValueType = typeof(string);
            // - or -
            // you could also further analyze the input text and assign a type
            // that fits the input text, e.g.
            // e.Style.CellValueType = typeof(datetime);
            // - or -
            // e.Style.CellValueType = typeof(decimal);
            // etc.
        }
        else
            throw;
    }
    e.Handled = true;
}

Private Sub InitializeComponent()
    ' Initalize code
    ' ...
    AddHandler Me.gridControl1.SaveCellText, AddressOf Me.gridControl1_SaveCellText
    AddHandler Me.gridControl1.QueryCellFormattedText, AddressOf Me.gridControl1_QueryCellFormattedText
    AddHandler Me.gridControl1.SaveCellFormattedText, AddressOf Me.gridControl1_SaveCellFormattedText
    AddHandler Me.gridControl1.QueryCellText, AddressOf Me.gridControl1_QueryCellText
End Sub 'InitializeComponent

Private Sub gridControl1_QueryCellFormattedText(sender As Object, e As Syncfusion.Windows.Forms.Grid.GridCellTextEventArgs)
End Sub 'gridControl1_QueryCellFormattedText

Private Sub gridControl1_QueryCellText(sender As Object, e As Syncfusion.Windows.Forms.Grid.GridCellTextEventArgs)
End Sub 'gridControl1_QueryCellText

Private Sub gridControl1_SaveCellText(sender As Object, e As Syncfusion.Windows.Forms.Grid.GridCellTextEventArgs)
    ParseText(e)
End Sub 'gridControl1_SaveCellText

Private Sub gridControl1_SaveCellFormattedText(sender As Object, e As GridCellTextEventArgs)
    ParseText(e)
End Sub 'gridControl1_SaveCellFormattedText

Sub ParseText(e As GridCellTextEventArgs)
    ' By default, the grid will display a warning message box informing the user
    ' the entered value is not valid and the user will have to change the value.
    '
    ' In this event handler we change the grid default's behavior such that
    ' when the user enters a value that does not fit the cell's CellValueType,
    ' the input text is accepted and no warning message is shown.
    If e.Handled Then
        Return
    End If
    Dim ci As System.Globalization.CultureInfo = e.Style.CultureInfo
    Dim nfi As System.Globalization.NumberFormatInfo = Nothing
    If (Not (ci Is Nothing)) Then nfi = ci.NumberFormat
    Try
        e.Style.CellValue = GridCellValueConvert.Parse(e.Text, e.Style.CellValueType, nfi, e.Style.Format)
    Catch ex As Exception
        If TypeOf ex Is FormatException OrElse TypeOf ex.InnerException Is FormatException Then
            e.Style.CellValue = e.Text
        ' possibly could also change CellValueType here
        ' e.Style.CellValueType = typeof(string);
        ' - or -
        ' you could also further analyze the input text and assign a type
        ' that fits the input text, e.g.
        ' e.Style.CellValueType = typeof(datetime);
        ' - or -
        ' e.Style.CellValueType = typeof(decimal);
        ' etc.
        Else
            Throw
        End If
    End Try
    e.Handled = True
End Sub 'ParseText

SaveCellText

Occurs each time the Text is called to set the unformatted string that represents the underlying cell's value.

Declaration

public event GridCellTextEventHandler SaveCellText

Event Type

Type
GridCellTextEventHandler

Remarks

This event allows you to customize how to parse the unformatted text into a cell value at run-time on demand.

If you need identity information about the cell such as row and column index, query the CellIdentity of the Style object.

See the SaveCellFormattedText event for further discussion since these two events are very similar. Often you will need to handle both events in your code in the same way.

SaveValue

Occurs when a value for a field descriptor and record is saved. See the Grid\Grouping\Samples\CustomSummary sample how to use this event with unbound field descriptors.

Declaration

public event FieldValueEventHandler SaveValue

Event Type

Type
FieldValueEventHandler

SelectedRecordsChanged

Occurs after the SelectedRecords collection was modified.

Declaration

public event SelectedRecordsChangedEventHandler SelectedRecordsChanged

Event Type

Type
SelectedRecordsChangedEventHandler

SelectedRecordsChanging

Occurs before the SelectedRecords collection is modified.

Declaration

public event SelectedRecordsChangedEventHandler SelectedRecordsChanging

Event Type

Type
SelectedRecordsChangedEventHandler

SortedItemsInGroup

Occurs after the records for a group are sorted.

Declaration

public event GroupEventHandler SortedItemsInGroup

Event Type

Type
GroupEventHandler

Remarks

The engine has a built-in optimization for sorting columns that allows it to perform the sorting on an on-demand basis group-by-group. Suppose you have a table with 200 different countries and you change the sort order of the cities. It is not necessary to sort the whole table. Instead, the individual groups can be sorted when they are scrolled into view. SortingItemsInGroup and SortedItemsInGroup events are fired in such case when a specific group was sorted on demand.

If the whole table was set to dirty (see TableDirty), then the whole table is simply recategorized. In that case, only a CategorizedElements event is raised but no SortingItemsInGroup event.

SortingItemsInGroup

Occurs before the records for a group are sorted.

Declaration

public event GroupEventHandler SortingItemsInGroup

Event Type

Type
GroupEventHandler

Remarks

If the whole table was set to dirty (see TableDirty), then the whole table is simply recategorized. In that case, only a CategorizedElements event is raised but no SortingItemsInGroup event.

SourceListListChanged

Occurs before the Table processes the System.ComponentModel.IBindingList.ListChanged event of an attached source list. More detailed SourceListRecordChanged events will be raised after this event.

Declaration

public event TableListChangedEventHandler SourceListListChanged

Event Type

Type
TableListChangedEventHandler

Remarks

The reason for firing this event is to give a programmer the chance to react to an System.ComponentModel.IBindingList.ListChanged event before the engine since there is otherwise no order guaranteed when an IBindingList raises a ListChanged event.

SourceListListChangedCompleted

Occurs after the Table processes the System.ComponentModel.IBindingList.ListChanged event of an attached source list.

Declaration

public event TableListChangedEventHandler SourceListListChangedCompleted

Event Type

Type
TableListChangedEventHandler

Remarks

The reason for firing this event is to give a programmer the chance to react to an System.ComponentModel.IBindingList.ListChanged event right after the engine since there is otherwise no order guaranteed when an IBindingList raises a ListChanged event.

SourceListRecordChanged

Occurs when a record in the underlying data source is added, removed, or changed and after the Table was updated with that change.

Declaration

public event RecordChangedEventHandler SourceListRecordChanged

Event Type

Type
RecordChangedEventHandler

SourceListRecordChanging

Occurs when a record in the underlying data source is added, removed or changed and before the Table is updated with that change.

Declaration

public event RecordChangedEventHandler SourceListRecordChanging

Event Type

Type
RecordChangedEventHandler

TableControlCellButtonClicked

Occurs when the CellButtonClicked event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCellButtonClickedEventArgs class.

Declaration

public event GridTableControlCellButtonClickedEventHandler TableControlCellButtonClicked

Event Type

Type
GridTableControlCellButtonClickedEventHandler

TableControlCellCancelMode

Occurs when the CellCancelMode event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCellMouseEventArgs class.

Declaration

public event GridTableControlCellMouseEventHandler TableControlCellCancelMode

Event Type

Type
GridTableControlCellMouseEventHandler

TableControlCellClick

Occurs when the CellClick event of the underlying GridTableControl is raised. The original event arguments of the event are provided with the Inner property of the GridTableControlCellClickEventArgs class.

Declaration

public event GridTableControlCellClickEventHandler TableControlCellClick

Event Type

Type
GridTableControlCellClickEventHandler

TableControlCellCursor

Occurs when the CellCursor event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCellCursorEventArgs class.

Declaration

public event GridTableControlCellCursorEventHandler TableControlCellCursor

Event Type

Type
GridTableControlCellCursorEventHandler

TableControlCellDoubleClick

Occurs when the CellDoubleClick event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCellClickEventArgs class.

Declaration

public event GridTableControlCellClickEventHandler TableControlCellDoubleClick

Event Type

Type
GridTableControlCellClickEventHandler

TableControlCellDrawn

Occurs when the CellDrawn event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlDrawCellEventArgs class.

Declaration

public event GridTableControlDrawCellEventHandler TableControlCellDrawn

Event Type

Type
GridTableControlDrawCellEventHandler

TableControlCellHitTest

Occurs when the CellHitTest event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCellHitTestEventArgs class.

Declaration

public event GridTableControlCellHitTestEventHandler TableControlCellHitTest

Event Type

Type
GridTableControlCellHitTestEventHandler

TableControlCellMouseDown

Occurs when the CellMouseDown event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCellMouseEventArgs class.

Declaration

public event GridTableControlCellMouseEventHandler TableControlCellMouseDown

Event Type

Type
GridTableControlCellMouseEventHandler

TableControlCellMouseHover

Occurs when the CellMouseHover event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCellMouseEventArgs class.

Declaration

public event GridTableControlCellMouseEventHandler TableControlCellMouseHover

Event Type

Type
GridTableControlCellMouseEventHandler

TableControlCellMouseHoverEnter

Occurs when the CellMouseHoverEnter event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCellMouseEventArgs class.

Declaration

public event GridTableControlCellMouseEventHandler TableControlCellMouseHoverEnter

Event Type

Type
GridTableControlCellMouseEventHandler

TableControlCellMouseHoverLeave

Occurs when the CellMouseHoverLeave event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCellMouseEventArgs class.

Declaration

public event GridTableControlCellMouseEventHandler TableControlCellMouseHoverLeave

Event Type

Type
GridTableControlCellMouseEventHandler

TableControlCellMouseMove

Occurs when the CellMouseMove event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCellMouseEventArgs class.

Declaration

public event GridTableControlCellMouseEventHandler TableControlCellMouseMove

Event Type

Type
GridTableControlCellMouseEventHandler

TableControlCellMouseUp

Occurs when the CellMouseUp event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCellMouseEventArgs class.

Declaration

public event GridTableControlCellMouseEventHandler TableControlCellMouseUp

Event Type

Type
GridTableControlCellMouseEventHandler

TableControlCheckBoxClick

Occurs when the CheckBoxClick event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCellClickEventArgs class.

Declaration

public event GridTableControlCellClickEventHandler TableControlCheckBoxClick

Event Type

Type
GridTableControlCellClickEventHandler

TableControlCurrentCellAcceptedChanges

Occurs when the CurrentCellAcceptedChanges event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCancelEventArgs class.

Declaration

public event GridTableControlCancelEventHandler TableControlCurrentCellAcceptedChanges

Event Type

Type
GridTableControlCancelEventHandler

TableControlCurrentCellActivated

Occurs when the CurrentCellActivated event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlEventArgs class.

Declaration

public event GridTableControlEventHandler TableControlCurrentCellActivated

Event Type

Type
GridTableControlEventHandler

TableControlCurrentCellActivateFailed

Occurs when the CurrentCellActivateFailed event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCurrentCellActivateFailedEventArgs class.

Declaration

public event GridTableControlCurrentCellActivateFailedEventHandler TableControlCurrentCellActivateFailed

Event Type

Type
GridTableControlCurrentCellActivateFailedEventHandler

TableControlCurrentCellActivating

Occurs when the CurrentCellActivating event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCurrentCellActivatingEventArgs class.

Declaration

public event GridTableControlCurrentCellActivatingEventHandler TableControlCurrentCellActivating

Event Type

Type
GridTableControlCurrentCellActivatingEventHandler

TableControlCurrentCellChanged

Occurs when the CurrentCellChanged event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlEventArgs class.

Declaration

public event GridTableControlEventHandler TableControlCurrentCellChanged

Event Type

Type
GridTableControlEventHandler

TableControlCurrentCellChanging

Occurs when the CurrentCellChanging event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCancelEventArgs class.

Declaration

public event GridTableControlCancelEventHandler TableControlCurrentCellChanging

Event Type

Type
GridTableControlCancelEventHandler

TableControlCurrentCellCloseDropDown

Occurs when the CurrentCellCloseDropDown event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlPopupClosedEventArgs class.

Declaration

public event GridTableControlPopupClosedEventHandler TableControlCurrentCellCloseDropDown

Event Type

Type
GridTableControlPopupClosedEventHandler

TableControlCurrentCellConfirmChangesFailed

Occurs when the CurrentCellConfirmChangesFailed event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlEventArgs class.

Declaration

public event GridTableControlEventHandler TableControlCurrentCellConfirmChangesFailed

Event Type

Type
GridTableControlEventHandler

TableControlCurrentCellControlDoubleClick

Occurs when the CurrentCellControlDoubleClick event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlControlEventArgs class.

Declaration

public event GridTableControlControlEventHandler TableControlCurrentCellControlDoubleClick

Event Type

Type
GridTableControlControlEventHandler

TableControlCurrentCellControlGotFocus

Occurs when the CurrentCellControlGotFocus event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlControlEventArgs class.

Declaration

public event GridTableControlControlEventHandler TableControlCurrentCellControlGotFocus

Event Type

Type
GridTableControlControlEventHandler

TableControlCurrentCellControlKeyMessage

Occurs when the CurrentCellControlKeyMessage event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCurrentCellControlKeyMessageEventArgs class.

Declaration

public event GridTableControlCurrentCellControlKeyMessageEventHandler TableControlCurrentCellControlKeyMessage

Event Type

Type
GridTableControlCurrentCellControlKeyMessageEventHandler

TableControlCurrentCellControlLostFocus

Occurs when the CurrentCellControlLostFocus event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlControlEventArgs class.

Declaration

public event GridTableControlControlEventHandler TableControlCurrentCellControlLostFocus

Event Type

Type
GridTableControlControlEventHandler

TableControlCurrentCellDeactivated

Occurs when the CurrentCellDeactivated event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCurrentCellDeactivatedEventArgs class.

Declaration

public event GridTableControlCurrentCellDeactivatedEventHandler TableControlCurrentCellDeactivated

Event Type

Type
GridTableControlCurrentCellDeactivatedEventHandler

TableControlCurrentCellDeactivateFailed

Occurs when the CurrentCellDeactivateFailed event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlEventArgs class.

Declaration

public event GridTableControlEventHandler TableControlCurrentCellDeactivateFailed

Event Type

Type
GridTableControlEventHandler

TableControlCurrentCellDeactivating

Occurs when the CurrentCellDeactivating event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCancelEventArgs class.

Declaration

public event GridTableControlCancelEventHandler TableControlCurrentCellDeactivating

Event Type

Type
GridTableControlCancelEventHandler

TableControlCurrentCellDeleting

Occurs when the CurrentCellDeleting event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCancelEventArgs class.

Declaration

public event GridTableControlCancelEventHandler TableControlCurrentCellDeleting

Event Type

Type
GridTableControlCancelEventHandler

TableControlCurrentCellEditingComplete

Occurs when the CurrentCellEditingComplete event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlEventArgs class.

Declaration

public event GridTableControlEventHandler TableControlCurrentCellEditingComplete

Event Type

Type
GridTableControlEventHandler

TableControlCurrentCellErrorMessage

Occurs when the CurrentCellErrorMessage event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCurrentCellErrorMessageEventArgs class.

Declaration

public event GridTableControlCurrentCellErrorMessageEventHandler TableControlCurrentCellErrorMessage

Event Type

Type
GridTableControlCurrentCellErrorMessageEventHandler

TableControlCurrentCellInitializeControlText

Occurs when the CurrentCellInitializeControlText event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCurrentCellInitializeControlTextEventArgs class.

Declaration

public event GridTableControlCurrentCellInitializeControlTextEventHandler TableControlCurrentCellInitializeControlText

Event Type

Type
GridTableControlCurrentCellInitializeControlTextEventHandler

TableControlCurrentCellKeyDown

Occurs when the CurrentCellKeyDown event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlKeyEventArgs class.

Declaration

public event GridTableControlKeyEventHandler TableControlCurrentCellKeyDown

Event Type

Type
GridTableControlKeyEventHandler

TableControlCurrentCellKeyPress

Occurs when the CurrentCellKeyPress event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlKeyPressEventArgs class.

Declaration

public event GridTableControlKeyPressEventHandler TableControlCurrentCellKeyPress

Event Type

Type
GridTableControlKeyPressEventHandler

TableControlCurrentCellKeyUp

Occurs when the CurrentCellKeyUp event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlKeyEventArgs class.

Declaration

public event GridTableControlKeyEventHandler TableControlCurrentCellKeyUp

Event Type

Type
GridTableControlKeyEventHandler

TableControlCurrentCellMoved

Occurs when the CurrentCellMoved event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCurrentCellMovedEventArgs class.

Declaration

public event GridTableControlCurrentCellMovedEventHandler TableControlCurrentCellMoved

Event Type

Type
GridTableControlCurrentCellMovedEventHandler

TableControlCurrentCellMoveFailed

Occurs when the CurrentCellMoveFailed event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCurrentCellMoveFailedEventArgs class.

Declaration

public event GridTableControlCurrentCellMoveFailedEventHandler TableControlCurrentCellMoveFailed

Event Type

Type
GridTableControlCurrentCellMoveFailedEventHandler

TableControlCurrentCellMoving

Occurs when the CurrentCellMoving event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCurrentCellMovingEventArgs class.

Declaration

public event GridTableControlCurrentCellMovingEventHandler TableControlCurrentCellMoving

Event Type

Type
GridTableControlCurrentCellMovingEventHandler

TableControlCurrentCellRejectedChanges

Occurs when the CurrentCellRejectedChanges event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlEventArgs class.

Declaration

public event GridTableControlEventHandler TableControlCurrentCellRejectedChanges

Event Type

Type
GridTableControlEventHandler

TableControlCurrentCellShowedDropDown

Occurs when the CurrentCellShowedDropDown event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlEventArgs class.

Declaration

public event GridTableControlEventHandler TableControlCurrentCellShowedDropDown

Event Type

Type
GridTableControlEventHandler

TableControlCurrentCellShowingDropDown

Occurs when the CurrentCellShowingDropDown event of the underlying GridTableControl is raised. The original event arguments of the event are provided with the Inner property of the GridTableControlCurrentCellShowingDropDownEventArgs class.

Declaration

public event GridTableControlCurrentCellShowingDropDownEventHandler TableControlCurrentCellShowingDropDown

Event Type

Type
GridTableControlCurrentCellShowingDropDownEventHandler

TableControlCurrentCellStartEditing

Occurs when the CurrentCellStartEditing event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCancelEventArgs class.

Declaration

public event GridTableControlCancelEventHandler TableControlCurrentCellStartEditing

Event Type

Type
GridTableControlCancelEventHandler

TableControlCurrentCellValidated

Occurs when the CurrentCellValidated event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlEventArgs class.

Declaration

public event GridTableControlEventHandler TableControlCurrentCellValidated

Event Type

Type
GridTableControlEventHandler

TableControlCurrentCellValidateString

Occurs when the CurrentCellValidateString event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCurrentCellValidateStringEventArgs class.

Declaration

public event GridTableControlCurrentCellValidateStringEventHandler TableControlCurrentCellValidateString

Event Type

Type
GridTableControlCurrentCellValidateStringEventHandler

TableControlCurrentCellValidating

Occurs when the CurrentCellValidating event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCancelEventArgs class.

Declaration

public event GridTableControlCancelEventHandler TableControlCurrentCellValidating

Event Type

Type
GridTableControlCancelEventHandler

TableControlDrawCell

Occurs when the DrawCell event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlDrawCellEventArgs class.

Declaration

public event GridTableControlDrawCellEventHandler TableControlDrawCell

Event Type

Type
GridTableControlDrawCellEventHandler

TableControlDrawCellBackground

Occurs when the DrawCellBackground event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlDrawCellBackgroundEventArgs class.

Declaration

public event GridTableControlDrawCellBackgroundEventHandler TableControlDrawCellBackground

Event Type

Type
GridTableControlDrawCellBackgroundEventHandler

TableControlDrawCellButton

Occurs when the DrawCellButton event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlDrawCellButtonEventArgs class.

Declaration

public event GridTableControlDrawCellButtonEventHandler TableControlDrawCellButton

Event Type

Type
GridTableControlDrawCellButtonEventHandler

TableControlDrawCellButtonBackground

Occurs when the DrawCellButtonBackground event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlDrawCellButtonBackgroundEventArgs class.

Declaration

public event GridTableControlDrawCellButtonBackgroundEventHandler TableControlDrawCellButtonBackground

Event Type

Type
GridTableControlDrawCellButtonBackgroundEventHandler

TableControlDrawCellDisplayText

Occurs when the DrawCellDisplayText event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlDrawCellDisplayTextEventArgs class.

Declaration

public event GridTableControlDrawCellDisplayTextEventHandler TableControlDrawCellDisplayText

Event Type

Type
GridTableControlDrawCellDisplayTextEventHandler

TableControlDrawCellFrameAppearance

Occurs when the DrawCellFrameAppearance event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlDrawCellBackgroundEventArgs class.

Declaration

public event GridTableControlDrawCellBackgroundEventHandler TableControlDrawCellFrameAppearance

Event Type

Type
GridTableControlDrawCellBackgroundEventHandler

TableControlDrawCurrentCellBorder

Occurs when the DrawCurrentCellBorder event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlDrawCurrentCellBorderEventArgs class.

Declaration

public event GridTableControlDrawCurrentCellBorderEventHandler TableControlDrawCurrentCellBorder

Event Type

Type
GridTableControlDrawCurrentCellBorderEventHandler

TableControlHScrollPixelPosChanged

Occurs when the HScrollPixelPosChanged event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlScrollPositionChangedEventArgs class.

Declaration

public event GridTableControlScrollPositionChangedEventHandler TableControlHScrollPixelPosChanged

Event Type

Type
GridTableControlScrollPositionChangedEventHandler

TableControlHScrollPixelPosChanging

Occurs when the HScrollPixelPosChanging event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlScrollPositionChangingEventArgs class.

Declaration

public event GridTableControlScrollPositionChangingEventHandler TableControlHScrollPixelPosChanging

Event Type

Type
GridTableControlScrollPositionChangingEventHandler

TableControlKeyDown

Occurs when the System.Windows.Forms.Control.KeyDown event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlKeyEventArgs class.

Declaration

public event GridTableControlKeyEventHandler TableControlKeyDown

Event Type

Type
GridTableControlKeyEventHandler

TableControlKeyPress

Occurs when the System.Windows.Forms.Control.KeyPress event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlKeyPressEventArgs class.

Declaration

public event GridTableControlKeyPressEventHandler TableControlKeyPress

Event Type

Type
GridTableControlKeyPressEventHandler

TableControlKeyUp

Occurs when the System.Windows.Forms.Control.KeyUp event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlKeyEventArgs class.

Declaration

public event GridTableControlKeyEventHandler TableControlKeyUp

Event Type

Type
GridTableControlKeyEventHandler

TableControlLeftColChanged

Occurs when the LeftColChanged event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlRowColIndexChangedEventArgs class.

Declaration

public event GridTableControlRowColIndexChangedEventHandler TableControlLeftColChanged

Event Type

Type
GridTableControlRowColIndexChangedEventHandler

TableControlLeftColChanging

Occurs when the LeftColChanging event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlRowColIndexChangingEventArgs class.

Declaration

public event GridTableControlRowColIndexChangingEventHandler TableControlLeftColChanging

Event Type

Type
GridTableControlRowColIndexChangingEventHandler

TableControlMouseDown

Occurs when the System.Windows.Forms.Control.MouseDown event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlMouseEventArgs class.

Declaration

public event GridTableControlMouseEventHandler TableControlMouseDown

Event Type

Type
GridTableControlMouseEventHandler

TableControlMouseWheel

Occurs when the System.Windows.Forms.Control.MouseWheel event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlDrawCellBackgroundEventArgs class.

Declaration

public event GridTableControlMouseEventHandler TableControlMouseWheel

Event Type

Type
GridTableControlMouseEventHandler

TableControlMoveCurrentCellDirection

Occurs when the MoveCurrentCellDirection event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlMoveCurrentCellDirectionEventArgs class.

Declaration

public event GridTableControlMoveCurrentCellDirectionEventHandler TableControlMoveCurrentCellDirection

Event Type

Type
GridTableControlMoveCurrentCellDirectionEventHandler

TableControlPrepareViewStyleInfo

Occurs when the PrepareViewStyleInfo event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlPrepareViewStyleInfoEventArgs class.

Declaration

public event GridTableControlPrepareViewStyleInfoEventHandler TableControlPrepareViewStyleInfo

Event Type

Type
GridTableControlPrepareViewStyleInfoEventHandler

TableControlPushButtonClick

Occurs when the PushButtonClick event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlCellPushButtonClickEventArgs class.

Declaration

public event GridTableControlCellPushButtonClickEventHandler TableControlPushButtonClick

Event Type

Type
GridTableControlCellPushButtonClickEventHandler

TableControlQueryAllowArrowKeyNavigateTo

Occurs when the user navigates though display elements with arrow keys. In your event handler you can determine if the specified display element (e.g. a CaptionRow) can be stepped on or if it should be skipped.

Declaration

public event GridQueryAllowArrowKeyNavigateToEventHandler TableControlQueryAllowArrowKeyNavigateTo

Event Type

Type
GridQueryAllowArrowKeyNavigateToEventHandler

Remarks

You can set AllowNavigateTo if you want arrow keys to skip over specific display elements (e.g. skip caption rows).

TableControlQueryAllowDragColumn

Occurs when the user hovers the mouse over a column header or clicks on it. In your event handler, you can determine if the selected column can be dragged.

Declaration

public event GridQueryAllowDragColumnEventHandler TableControlQueryAllowDragColumn

Event Type

Type
GridQueryAllowDragColumnEventHandler

Remarks

You can disallow dragging the column when you assign False to AllowDrag.

TableControlQueryAllowGroupByColumn

Occurs when the user drags a column header over the GroupDropArea. In your event handler, you can determine if the grid can be grouped by the selected column.

Declaration

public event GridQueryAllowGroupByColumnEventHandler TableControlQueryAllowGroupByColumn

Event Type

Type
GridQueryAllowGroupByColumnEventHandler

Remarks

You can disallow grouping by the column when you assign False to AllowGroupByColumn.

TableControlQueryAllowSortColumn

Occurs when the user hovers the mouse over a column header or clicks on it. In your event handler, you can determine if the selected column can be sorted.

Declaration

public event GridQueryAllowSortColumnEventHandler TableControlQueryAllowSortColumn

Event Type

Type
GridQueryAllowSortColumnEventHandler

Remarks

You can disallow sorting by the column when you assign False to AllowSort.

TableControlQueryNextCurrentCellPosition

Occurs when the QueryNextCurrentCellPosition event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlQueryNextCurrentCellPositionEventArgs class.

Declaration

public event GridTableControlQueryNextCurrentCellPositionEventHandler TableControlQueryNextCurrentCellPosition

Event Type

Type
GridTableControlQueryNextCurrentCellPositionEventHandler

TableControlQueryScrollCellInView

Occurs when the QueryScrollCellInView event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlQueryScrollCellInViewEventArgs class.

Declaration

public event GridTableControlQueryScrollCellInViewEventHandler TableControlQueryScrollCellInView

Event Type

Type
GridTableControlQueryScrollCellInViewEventHandler

TableControlResizingColumns

Occurs when the ResizingColumns event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlResizingColumnsEventArgs class.

Declaration

public event GridTableControlResizingColumnsEventHandler TableControlResizingColumns

Event Type

Type
GridTableControlResizingColumnsEventHandler

TableControlResizingRows

Occurs when the ResizingRows event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlResizingRowsEventArgs class.

Declaration

public event GridTableControlResizingRowsEventHandler TableControlResizingRows

Event Type

Type
GridTableControlResizingRowsEventHandler

TableControlScrollTipFeedback

Occurs when the ScrollTipFeedback event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlScrollTipFeedbackEventArgs class.

Declaration

public event GridTableControlScrollTipFeedbackEventHandler TableControlScrollTipFeedback

Event Type

Type
GridTableControlScrollTipFeedbackEventHandler

TableControlTopRowChanged

Occurs when the TopRowChanged event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlRowColIndexChangedEventArgs class.

Declaration

public event GridTableControlRowColIndexChangedEventHandler TableControlTopRowChanged

Event Type

Type
GridTableControlRowColIndexChangedEventHandler

TableControlTopRowChanging

Occurs when the TopRowChanging event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlRowColIndexChangingEventArgs class.

Declaration

public event GridTableControlRowColIndexChangingEventHandler TableControlTopRowChanging

Event Type

Type
GridTableControlRowColIndexChangingEventHandler

TableControlVScrollPixelPosChanged

Occurs when the VScrollPixelPosChanged event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlScrollPositionChangedEventArgs class.

Declaration

public event GridTableControlScrollPositionChangedEventHandler TableControlVScrollPixelPosChanged

Event Type

Type
GridTableControlScrollPositionChangedEventHandler

TableControlVScrollPixelPosChanging

Occurs when the VScrollPixelPosChanging event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlScrollPositionChangingEventArgs class.

Declaration

public event GridTableControlScrollPositionChangingEventHandler TableControlVScrollPixelPosChanging

Event Type

Type
GridTableControlScrollPositionChangingEventHandler

TableControlWrapCellNextControlInForm

Occurs when the WrapCellNextControlInForm event of the underlying GridTableControl is raised. The original event arguments are provided with the Inner property of the GridTableControlWrapCellNextControlInFormEventArgs class.

Declaration

public event GridTableControlWrapCellNextControlInFormEventHandler TableControlWrapCellNextControlInForm

Event Type

Type
GridTableControlWrapCellNextControlInFormEventHandler

TableSourceListChanged

Occurs after the datasource was replaced.

Declaration

public event TableEventHandler TableSourceListChanged

Event Type

Type
TableEventHandler

Explicit Interface Implementations

IEngineSource.GetEngine()

Gets the engine associated with the grid.

Declaration

Engine IEngineSource.GetEngine()

Returns

Type	Description
Engine	The engine.

ITableEventsTarget.OnCategorizedRecords(TableEventArgs)

Declaration

void ITableEventsTarget.OnCategorizedRecords(TableEventArgs e)

Parameters

Type	Name	Description
TableEventArgs	e

ITableEventsTarget.OnCategorizingRecords(TableEventArgs)

Declaration

void ITableEventsTarget.OnCategorizingRecords(TableEventArgs e)

Parameters

Type	Name	Description
TableEventArgs	e

ITableEventsTarget.OnCurrentRecordContextChange(CurrentRecordContextChangeEventArgs)

Declaration

void ITableEventsTarget.OnCurrentRecordContextChange(CurrentRecordContextChangeEventArgs e)

Parameters

Type	Name	Description
CurrentRecordContextChangeEventArgs	e

ITableEventsTarget.OnCurrentRecordManagerReset(TableEventArgs)

Declaration

void ITableEventsTarget.OnCurrentRecordManagerReset(TableEventArgs e)

Parameters

Type	Name	Description
TableEventArgs	e

ITableEventsTarget.OnDisplayElementChanged(DisplayElementChangedEventArgs)

Declaration

void ITableEventsTarget.OnDisplayElementChanged(DisplayElementChangedEventArgs e)

Parameters

Type	Name	Description
DisplayElementChangedEventArgs	e

ITableEventsTarget.OnDisplayElementChanging(DisplayElementChangingEventArgs)

Declaration

void ITableEventsTarget.OnDisplayElementChanging(DisplayElementChangingEventArgs e)

Parameters

Type	Name	Description
DisplayElementChangingEventArgs	e

ITableEventsTarget.OnExceptionRaised(ExceptionRaisedEventArgs)

Declaration

void ITableEventsTarget.OnExceptionRaised(ExceptionRaisedEventArgs e)

Parameters

Type	Name	Description
ExceptionRaisedEventArgs	e

ITableEventsTarget.OnGroupAdded(GroupEventArgs)

Declaration

void ITableEventsTarget.OnGroupAdded(GroupEventArgs e)

Parameters

Type	Name	Description
GroupEventArgs	e

ITableEventsTarget.OnGroupCollapsed(GroupEventArgs)

Declaration

void ITableEventsTarget.OnGroupCollapsed(GroupEventArgs e)

Parameters

Type	Name	Description
GroupEventArgs	e

ITableEventsTarget.OnGroupCollapsing(GroupEventArgs)

Declaration

void ITableEventsTarget.OnGroupCollapsing(GroupEventArgs e)

Parameters

Type	Name	Description
GroupEventArgs	e

ITableEventsTarget.OnGroupExpanded(GroupEventArgs)

Declaration

void ITableEventsTarget.OnGroupExpanded(GroupEventArgs e)

Parameters

Type	Name	Description
GroupEventArgs	e

ITableEventsTarget.OnGroupExpanding(GroupEventArgs)

Declaration

void ITableEventsTarget.OnGroupExpanding(GroupEventArgs e)

Parameters

Type	Name	Description
GroupEventArgs	e

ITableEventsTarget.OnGroupRemoving(GroupEventArgs)

Declaration

void ITableEventsTarget.OnGroupRemoving(GroupEventArgs e)

Parameters

Type	Name	Description
GroupEventArgs	e

ITableEventsTarget.OnGroupSummaryInvalidated(GroupEventArgs)

Declaration

void ITableEventsTarget.OnGroupSummaryInvalidated(GroupEventArgs e)

Parameters

Type	Name	Description
GroupEventArgs	e

ITableEventsTarget.OnInvalidatingCounters(TableEventArgs)

Declaration

void ITableEventsTarget.OnInvalidatingCounters(TableEventArgs e)

Parameters

Type	Name	Description
TableEventArgs	e

ITableEventsTarget.OnInvalidatingSummaries(TableEventArgs)

Declaration

void ITableEventsTarget.OnInvalidatingSummaries(TableEventArgs e)

Parameters

Type	Name	Description
TableEventArgs	e

ITableEventsTarget.OnRecordCollapsed(RecordEventArgs)

Declaration

void ITableEventsTarget.OnRecordCollapsed(RecordEventArgs e)

Parameters

Type	Name	Description
RecordEventArgs	e

ITableEventsTarget.OnRecordCollapsing(RecordEventArgs)

Declaration

void ITableEventsTarget.OnRecordCollapsing(RecordEventArgs e)

Parameters

Type	Name	Description
RecordEventArgs	e

ITableEventsTarget.OnRecordDeleted(RecordEventArgs)

Declaration

void ITableEventsTarget.OnRecordDeleted(RecordEventArgs e)

Parameters

Type	Name	Description
RecordEventArgs	e

ITableEventsTarget.OnRecordDeleting(RecordEventArgs)

Declaration

void ITableEventsTarget.OnRecordDeleting(RecordEventArgs e)

Parameters

Type	Name	Description
RecordEventArgs	e

ITableEventsTarget.OnRecordExpanded(RecordEventArgs)

Declaration

void ITableEventsTarget.OnRecordExpanded(RecordEventArgs e)

Parameters

Type	Name	Description
RecordEventArgs	e

ITableEventsTarget.OnRecordExpanding(RecordEventArgs)

Declaration

void ITableEventsTarget.OnRecordExpanding(RecordEventArgs e)

Parameters

Type	Name	Description
RecordEventArgs	e

ITableEventsTarget.OnRecordValueChanged(RecordValueChangedEventArgs)

Declaration

void ITableEventsTarget.OnRecordValueChanged(RecordValueChangedEventArgs e)

Parameters

Type	Name	Description
RecordValueChangedEventArgs	e

ITableEventsTarget.OnRecordValueChanging(RecordValueChangingEventArgs)

Declaration

void ITableEventsTarget.OnRecordValueChanging(RecordValueChangingEventArgs e)

Parameters

Type	Name	Description
RecordValueChangingEventArgs	e

ITableEventsTarget.OnSelectedRecordsChanged(SelectedRecordsChangedEventArgs)

Declaration

void ITableEventsTarget.OnSelectedRecordsChanged(SelectedRecordsChangedEventArgs e)

Parameters

Type	Name	Description
SelectedRecordsChangedEventArgs	e

ITableEventsTarget.OnSelectedRecordsChanging(SelectedRecordsChangedEventArgs)

Declaration

void ITableEventsTarget.OnSelectedRecordsChanging(SelectedRecordsChangedEventArgs e)

Parameters

Type	Name	Description
SelectedRecordsChangedEventArgs	e

ITableEventsTarget.OnSortedItemsInGroup(GroupEventArgs)

Declaration

void ITableEventsTarget.OnSortedItemsInGroup(GroupEventArgs e)

Parameters

Type	Name	Description
GroupEventArgs	e

ITableEventsTarget.OnSortingItemsInGroup(GroupEventArgs)

Declaration

void ITableEventsTarget.OnSortingItemsInGroup(GroupEventArgs e)

Parameters

Type	Name	Description
GroupEventArgs	e

ITableEventsTarget.OnSourceListListChanged(TableListChangedEventArgs)

Declaration

void ITableEventsTarget.OnSourceListListChanged(TableListChangedEventArgs e)

Parameters

Type	Name	Description
TableListChangedEventArgs	e

ITableEventsTarget.OnSourceListListChangedCompleted(TableListChangedEventArgs)

Declaration

void ITableEventsTarget.OnSourceListListChangedCompleted(TableListChangedEventArgs e)

Parameters

Type	Name	Description
TableListChangedEventArgs	e

ITableEventsTarget.OnSourceListRecordChanged(RecordChangedEventArgs)

Declaration

void ITableEventsTarget.OnSourceListRecordChanged(RecordChangedEventArgs e)

Parameters

Type	Name	Description
RecordChangedEventArgs	e

ITableEventsTarget.OnSourceListRecordChanging(RecordChangedEventArgs)

Declaration

void ITableEventsTarget.OnSourceListRecordChanging(RecordChangedEventArgs e)

Parameters

Type	Name	Description
RecordChangedEventArgs	e

ITableEventsTarget.OnTableSourceListChanged(TableEventArgs)

Declaration

void ITableEventsTarget.OnTableSourceListChanged(TableEventArgs e)

Parameters

Type	Name	Description
TableEventArgs	e

IVisualStyle.VisualTheme

Declaration

string IVisualStyle.VisualTheme { get; set; }

Returns

Type
System.String

Implements

IEngineSource

System.ComponentModel.ISupportInitialize

System.ComponentModel.ICustomTypeDescriptor

ITableEventsTarget

IVisualStyle