GridEventIds Enumeration

Uniquely identifies each UltraGrid specific event

Syntax

Visual Basic
C#

'Declaration
 
Public Enum GridEventIds 
   Inherits System.Enum

public enum GridEventIds : System.Enum

Members

Member	Description
AfterAutoSizeColumn	Event id that identifies the AfterAutoSizeColumn event.
AfterBandHiddenChanged	Event id that identifies AfterBandHiddenChanged event.
AfterCardCompressedStateChanged	Event id that identifies AfterCardCompressedStateChanged event.
AfterCardsScroll	Event id that identifies AfterCardsScroll event.
AfterCellActivate	event id that identifies AfterCellActivate event
AfterCellCancelUpdate	event id that identifies AfterCellCancelUpdate event
AfterCellListCloseUp	event id that identifies AfterCellListCloseUp event
AfterCellUpdate	event id that identifies AfterCellUpdate event
AfterChildBandCollapsed	event id that identifies BeforeChildBandCollapsed event
AfterChildBandExpanded	event id that identifies BeforeChildBandExpanded event
AfterClearAllFilterButtonClicked	Event id that identifies the AfterClearAllFilterButtonClicked event.
AfterColPosChanged	event id that identifies AfterColPosChanged event
AfterColRegionScroll	event id that identifies AfterColRegionScroll event
AfterColRegionSize	event id that identifies AfterColRegionSize event
AfterEnterEditMode	event id that identifies AfterEnterEditMode event
AfterExitEditMode	event id that identifies AfterExitEditMode event
AfterGroupCollapsed	event id that identifies AfterGroupCollapsed event
AfterGroupExpanded	event id that identifies AfterGroupExpanded event
AfterGroupPosChanged	event id that identifies AfterGroupPosChanged event
AfterHeaderCheckStateChanged	Event id that identifies the AfterHeaderCheckStateChanged event.
AfterHeaderEnterEditMode	event id that identifies AfterHeaderEnterEditMode event
AfterHeaderExitEditMode	event id that identifies AfterHeaderExitEditMode event
AfterPerformAction	Event id that identifies AfterPerformAction event.
AfterRowActivate	event id that identifies AfterRowActivate event
AfterRowCancelUpdate	event id that identifies AfterRowCancelUpdate event
AfterRowCollapsed	event id that identifies AfterRowCollapsed event
AfterRowEditTemplateClosed	Event id that identifies the AfterRowEditTemplateClosed event.
AfterRowEditTemplateDisplayed	Event id that identifies the AfterRowEditTemplateDisplayed event.
AfterRowExpanded	event id that identifies AfterRowExpanded event
AfterRowFilterChanged	Event id that identifies AfterRowFilterChanged event.
AfterRowFilterDropDownPopulate	Event id that identifies AfterRowFilterDropDownPopulate event.
AfterRowFixedStateChanged	Event id that identifies AfterRowFixedStateChanged event.
AfterRowInsert	event id that identifies AfterRowInsert event
AfterRowLayoutItemResized	Event id that identifies AfterRowLayoutItemResized event.
AfterRowRegionScroll	event id that identifies AfterRowRegionScroll event
AfterRowRegionSize	event id that identifies AfterRowRegionSize event
AfterRowResize	event id that identifies AfterRowResize event
AfterRowsDeleted	event id that identifies AfterRowsDeleted event
AfterRowUpdate	event id that identifies AfterRowUpdate event
AfterSelectChange	event id that identifies AfterSelectChange event
AfterSortChange	event id that identifies AfterSortChange event
AfterSummaryDialog	Event id that identifies AfterSummaryDialog event.
BeforeAutoSizeColumn	Event id that identifies the BeforeAutoSizeColumn event.
BeforeAutoSizeEdit	event id that identifies BeforeAutoSizeEdit event
BeforeBandHiddenChanged	Event id that identifies BeforeBandHiddenChanged event.
BeforeCardCompressedStateChanged	Event id that identifies BeforeCardCompressedStateChanged event.
BeforeCellActivate	event id that identifies BeforeCellActivate event
BeforeCellCancelUpdate	event id that identifies BeforeCellCancelUpdate event
BeforeCellDeactivate	event id that identifies BeforeCellDeactivate event
BeforeCellListDropDown	event id that identifies BeforeCellListDropDown event
BeforeCellUpdate	event id that identifies BeforeCellUpdate event
BeforeChildBandCollapsed	event id that identifies BeforeChildBandCollapsed event
BeforeChildBandExpanded	event id that identifies BeforeChildBandExpanded event
BeforeClearAllFilterButtonClicked	Event id that identifies the BeforeClearAllFilterButtonClicked event.
BeforeColPosChanged	event id that identifies BeforeColPosChanged event
BeforeColRegionRemoved	event id that identifies BeforeColRegionRemoved event
BeforeColRegionScroll	event id that identifies BeforeColRegionScroll event
BeforeColRegionSize	event id that identifies BeforeColRegionSize event
BeforeColRegionSplit	event id that identifies BeforeColRegionSplit event
BeforeColumnChooserDisplayed	Event id that identifies BeforeColumnChooserDisplayed event.
BeforeCustomRowFilterDialog	event id that identifies BeforeCustomRowFilterDialog event.
BeforeDisplayDataErrorTooltip	Event id that identifies BeforeDisplayDataErrorTooltip event.
BeforeEnterEditMode	event id that identifies BeforeEnterEditMode event
BeforeExitEditMode	event id that identifies BeforeExitEditMode event
BeforeGroupCollapsed	event id that identifies BeforeGroupCollapsed event
BeforeGroupExpanded	event id that identifies BeforeGroupExpanded event
BeforeGroupPosChanged	event id that identifies BeforeGroupPosChanged event
BeforeHeaderCheckStateChanged	Event id that identifies the BeforeHeaderCheckStateChanged event.
BeforeHeaderEnterEditMode	event id that identifies BeforeHeaderEnterEditMode event
BeforeHeaderExitEditMode	event id that identifies BeforeHeaderExitEditMode event
BeforeMultiCellOperation	Event id that identifies BeforeMultiCellOperation event.
BeforePerformAction	Event id that identifies BeforePerformAction event.
BeforePrint	event id that identifies BeforePrint event
BeforeRowActivate	event id that identifies BeforeRowActivate event
BeforeRowCancelUpdate	event id that identifies BeforeRowCancelUpdate event
BeforeRowCollapsed	event id that identifies BeforeRowCollapsed event
BeforeRowDeactivate	event id that identifies BeforeRowDeactivate event
BeforeRowEditTemplateClosed	Event id that identifies the BeforeRowEditTemplateClosed event.
BeforeRowEditTemplateDisplayed	Event id that identifies the BeforeRowEditTemplateDisplayed event.
BeforeRowExpanded	event id that identifies BeforeRowExpanded event
BeforeRowFilterChanged	Event id that identifies BeforeRowFilterChanged event.
BeforeRowFilterDropDown	event id that identifies BeforeRowFilterDropDown event.
BeforeRowFilterDropDownPopulate	Event id that identifies BeforeRowFilterDropDownPopulate event.
BeforeRowFixedStateChanged	Event id that identifies BeforeRowFixedStateChanged event.
BeforeRowInsert	event id that identifies BeforeRowInsert event
BeforeRowLayoutItemResized	Event id that identifies BeforeRowLayoutItemResized event.
BeforeRowRegionRemoved	event id that identifies BeforeRowRegionRemoved event
BeforeRowRegionScroll	event id that identifies BeforeRowRegionScroll event
BeforeRowRegionSize	event id that identifies BeforeRowRegionSize event
BeforeRowRegionSplit	event id that identifies BeforeRowRegionSplit event
BeforeRowResize	event id that identifies BeforeRowResize event
BeforeRowsDeleted	event id that identifies BeforeRowsDeleted event
BeforeRowUpdate	event id that identifies BeforeRowUpdate event
BeforeSelectChange	event id that identifies BeforeSelectChange event
BeforeSortChange	event id that identifies BeforeSortChange event
BeforeSummaryDialog	Event id that identifies BeforeSummaryDialog event.
CellChange	event id that identifies CellChange event
CellDataError	Event id that identifies CellDataError event.
CellListSelect	event id that identifies CellListSelect event
Click	event id that identifies Click event
ClickCell	Event id that identifies the ClickCell event.
ClickCellButton	event id that identifies ClickCellButton event
DblClick	event id that identifies DblClick event
DoubleClickCell	Event id that identifies DoubleClickCell event.
DoubleClickHeader	Event id that identifies DoubleClickHeader event.
DoubleClickRow	Event id that identifies DoubleClickRow event.
Error	event id that identifies Error event
ExternalSummaryValueRequested	Event id that identifies the ExternalSummaryValueRequested event.
FilterCellValueChanged	Event id that identifies FilterCellValueChanged event.
FilterRow	event id that identifies FilterRow event
GestureCompleted	The GestureCompleted event.
GestureQueryStatus	The GestureQueryStatus event.
GestureStarting	The GestureStarting event.
InitializeGroupByRow	event id that identifies InitializeGroupByRow event
InitializeLayout	event id that identifies InitializeLayout event
InitializeLogicalPrintPage	event id that identifies InitializeLogicalPrintPage event
InitializePrint	event id that identifies InitializePrint event
InitializePrintPreview	event id that identifies InitializePrintPreview event
InitializeRow	event id that identifies InitializeRow event
InitializeRowsCollection	Event id that identifies InitializeRowsCollection event.
InitializeTemplateAddRow	Event id that identifies InitializeTemplateAddRow event.
MouseEnterElement	event id that identifies MouseEnterElement event
MouseLeaveElement	event id that identifies MouseLeaveElement event
OnSelectionDrag	event id that identifies OnSelectionDrag event
PanGesture	The PanGesture event.
PressAndHoldGesture	The PressAndHoldGesture event.
PressAndTapGesture	The PressAndTapGesture event.
RotateGesture	The RotateGesture event.
RowEditTemplateRequested	Event id that identifies the RowEditTemplateRequested event.
SummaryValueChanged	Event id that identifies SummaryValueChanged event.
TwoFingerTapGesture	The TwoFingerTapGesture event.
ZoomGesture	The ZoomGesture event.

Example

The following sample code illustrates how the event manager can be used to temporarily enable/disable events.

Visual Basic

Imports Infragistics.Win.UltraWinGrid

Private Sub Button2_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button2.Click

If Me.ultraGrid1.ActiveRow Is Nothing Then Return

Dim eventManager As GridEventManager

' Get the grid's event manager.
' The event manager is used to temporarily disable events
' to prevent them from being raised. This can be very
' convenient in a situation where one or more properties
' are being set in code and the events they would normally
' raise would cause unnecessary or counter-productive
' code to be executed.
'
' Note: All events are enabled by default.
eventManager = Me.ultraGrid1.EventManager

' Disable the Before/AfterSelectChange events
eventManager.SetEnabled(GridEventIds.BeforeSelectChange, False)
eventManager.SetEnabled(GridEventIds.AfterSelectChange, False)

' Toggle the selection state of the active row.
' Note: This would normally cause the Before/AfterSelectChange
' events to be raised. However, since the above code disabled
' the events they won't be.
Me.ultraGrid1.ActiveRow.Selected = Not Me.ultraGrid1.ActiveRow.Selected

' Re-enable the Before/AfterSelectChange events
eventManager.SetEnabled(GridEventIds.BeforeSelectChange, True)
eventManager.SetEnabled(GridEventIds.AfterSelectChange, True)

' The 'AllEventsEnabled' property lets you enable/disable
' all events will a single line of code. If any event is
' disabled the 'AllEventsEnabled' property returns false.
If eventManager.AllEventsEnabled = False Then
eventManager.AllEventsEnabled = True
End If

' The event manager also exposes an 'IsEnabled' method
' to see if an event is enabled or disbled.
If False = eventManager.IsEnabled(GridEventIds.BeforeSelectChange) Then
eventManager.SetEnabled(GridEventIds.BeforeSelectChange, True)
End If

' The grid event manager also exposes overloaded
' 'IsEnabled' and 'SetEnabled' methods that take an
' event group so that, for example all 'Before' or all
' 'After' events can be enabled/disabled. If any event
' in the group is disabled the 'IsEnabled' method returns
' false.
If False = eventManager.IsEnabled(EventGroups.BeforeEvents) Then
eventManager.SetEnabled(EventGroups.BeforeEvents, True)
End If

eventManager.SetEnabled(EventGroups.AfterEvents, True)

' The 'InProgress' method will return true if the
' specified event is currently being raised. This
' is often helpful in methods that can be called
' from various points in an application to determine
' what is triggering the call.
If eventManager.InProgress(GridEventIds.BeforeSelectChange) Then
' ...
End If

' The UltraCombo and UltraDropDown controls also expose
' event managers for their custom events. However,
' since they have considerably fewer events they don't
' expose overloaded 'IsEnabled' and 'SetEnabled' methods
' to control groups of events.
Dim comboManager As ComboEventManager
comboManager = Me.ultraCombo1.EventManager
comboManager.SetEnabled(ComboEventIds.BeforeDropDown, True)

Dim dropDownManager As DropDownEventManager
dropDownManager = Me.UltraDropDown1.EventManager
dropDownManager.SetEnabled(DropDownEventIds.AfterCloseUp, True)

End Sub

using Infragistics.Win.UltraWinGrid;

private void button2_Click(object sender, System.EventArgs e)
{

	if ( this.ultraGrid1.ActiveRow == null )
		return;

	// Get the grid's event manager.
	// The event manager is used to temporarily disable events
	// to prevent them from being raised. This can be very
	// convenient in a situation where one or more properties
	// are being set in code and the events they would normally 
	// raise would cause unnecessary or counter-productive
	// code to be executed.
	//
	// Note: All events are enabled by default.
	GridEventManager eventManager = this.ultraGrid1.EventManager;

	// Disable the Before/AfterSelectChange events
	eventManager.SetEnabled( GridEventIds.BeforeSelectChange, false );
	eventManager.SetEnabled( GridEventIds.AfterSelectChange, false );

	// Toggle the selection state of the active row.
	// Note: This would normally cause the Before/AfterSelectChange 
	// events to be raised. However, since the above code disabled
	// the events they won't be.
	this.ultraGrid1.ActiveRow.Selected = 
		!this.ultraGrid1.ActiveRow.Selected;

	// Re-enable the Before/AfterSelectChange events
	eventManager.SetEnabled( GridEventIds.BeforeSelectChange, true );
	eventManager.SetEnabled( GridEventIds.AfterSelectChange, true );

	// The 'AllEventsEnabled' property lets you enable/disable
	// all events will a single line of code. If any event is 
	// disabled the 'AllEventsEnabled' property returns false.
	if ( !eventManager.AllEventsEnabled )
		eventManager.AllEventsEnabled = true;

	// The event manager also exposes an 'IsEnabled' method
	// to see if an event is enabled or disbled.
	if ( !eventManager.IsEnabled(GridEventIds.BeforeSelectChange ) )
		eventManager.SetEnabled(GridEventIds.BeforeSelectChange, true );

	// The grid event manager also exposes overloaded 
	// 'IsEnabled' and 'SetEnabled' methods that take an  
	// event group so that, for example all 'Before' or all
	// 'After' events can be enabled/disabled. If any event
	// in the group is disabled the 'IsEnabled' method returns
	// false.
	if ( !eventManager.IsEnabled(EventGroups.BeforeEvents ) )
		eventManager.SetEnabled(EventGroups.BeforeEvents, true );

	eventManager.SetEnabled(EventGroups.AfterEvents, true );

	// The 'InProgress' method will return true if the 
	// specified event is currently being raised. This
	// is often helpful in methods that can be called
	// from various points in an application to determine
	// what is triggering the call.
	if ( eventManager.InProgress( GridEventIds.BeforeSelectChange ) )
	{
		// ... 
	}

	// The UltraCombo and UltraDropDown controls also expose 
	// event managers for their custom events. However,
	// since they have considerably fewer events they don't
	// expose overloaded 'IsEnabled' and 'SetEnabled' methods 
	// to control groups of events.
	ComboEventManager comboManager = this.ultraCombo1.EventManager;
	comboManager.SetEnabled( ComboEventIds.BeforeDropDown, true );

	DropDownEventManager dropDownManager = this.ultraDropDown1.EventManager;
	dropDownManager.SetEnabled( DropDownEventIds.AfterCloseUp, true );

}

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

Infragistics.Win.UltraWinGrid Namespace

Windows Forms | Help Topics

GridEventIds Enumeration

Reference