ToolbarEventIds Enumeration

Value that uniquely identifies each UltraToolbarsManager event.

Syntax

Visual Basic
C#

'Declaration
 
Public Enum ToolbarEventIds 
   Inherits System.Enum

public enum ToolbarEventIds : System.Enum

Members

Member	Description
AfterApplicationMenu2010Closed	Event ID that identifies the UltraToolbarsManager.AfterApplicationMenu2010Closed event.
AfterApplicationMenu2010Displayed	Event ID that identifies the UltraToolbarsManager.AfterApplicationMenu2010Displayed event.
AfterApplicationMenuCloseUp	Event ID that identifies the UltraToolbarsManager.AfterApplicationMenuCloseUp event.
AfterApplicationMenuDropDown	Event ID that identifies the UltraToolbarsManager.AfterApplicationMenuDropDown event.
AfterAutoHideRibbonCloseUp	Event ID that identifies the UltraToolbarsManager.AfterAutoHideRibbonCloseUp event.
AfterAutoHideRibbonDropDown	Event ID that identifies the UltraToolbarsManager.AfterAutoHideRibbonDropDown event.
AfterComponentReset	Event ID that identifies the UltraToolbarsManager.AfterComponentReset event.
AfterCustomizeDialogClosed	Event ID that identifies the UltraToolbarsManager.AfterCustomizeDialogClosed event.
AfterMiniToolbarHidden	Event ID that identifies the UltraToolbarsManager.AfterMiniToolbarHidden event.
AfterMiniToolbarShown	Event ID that identifies the UltraToolbarsManager.AfterMiniToolbarShown event.
AfterNavigation	Event ID that identifies the UltraToolbarsManager.AfterNavigation event.
AfterRibbonCustomizationDialogClosed	Event ID that identifies the UltraToolbarsManager.AfterRibbonCustomizationDialogClosed event.
AfterRibbonGroupCloseUp	Event ID that identifies the UltraToolbarsManager.AfterRibbonGroupCloseUp event.
AfterRibbonGroupDropDown	Event ID that identifies the UltraToolbarsManager.AfterRibbonGroupDropDown event.
AfterRibbonTabCloseUp	Event ID that identifies the UltraToolbarsManager.AfterRibbonTabCloseUp event.
AfterRibbonTabDropDown	Event ID that identifies the UltraToolbarsManager.AfterRibbonTabDropDown event.
AfterRibbonTabSelected	Event ID that identifies the UltraToolbarsManager.AfterRibbonTabSelected event.
AfterTaskPaneToolSelected	Event ID that identifies the UltraToolbarsManager.AfterTaskPaneToolSelected event.
AfterToolActivate	Event ID that identifies the UltraToolbarsManager.AfterToolActivate event.
AfterToolbarReset	Event ID that identifies the UltraToolbarsManager.AfterToolbarReset event.
AfterToolCloseup	Event ID that identifies the UltraToolbarsManager.AfterToolCloseup event.
AfterToolDeactivate	Event ID that identifies the UltraToolbarsManager.AfterToolDeactivate event.
AfterToolDragEnd	Event ID that identifies the UltraToolbarsManager.AfterToolDragEnd event.
AfterToolDropdown	Event ID that identifies the UltraToolbarsManager.AfterToolDropdown event.
AfterToolEnterEditMode	Event ID that identifies the UltraToolbarsManager.AfterToolEnterEditMode event.
AfterToolExitEditMode	Event ID that identifies the UltraToolbarsManager.AfterToolExitEditMode event.
BeforeApplicationMenu2010Closed	Event ID that identifies the UltraToolbarsManager.BeforeApplicationMenu2010Closed event.
BeforeApplicationMenu2010Displayed	Event ID that identifies the UltraToolbarsManager.BeforeApplicationMenu2010Displayed event.
BeforeApplicationMenuDropDown	Event ID that identifies the UltraToolbarsManager.BeforeApplicationMenuDropDown event.
BeforeAutoHideRibbonDropDown	Event ID that identifies the UltraToolbarsManager.BeforeAutoHideRibbonDropDown event.
BeforeComponentReset	Event ID that identifies the UltraToolbarsManager.BeforeComponentReset event.
BeforeDisplayCustomizeDialog	Event ID that identifies the UltraToolbarsManager.BeforeDisplayCustomizeDialog event.
BeforeDisplayMoreItemsDialog	Event ID that identifies the UltraToolbarsManager.BeforeDisplayMoreItemsDialog event.
BeforeMiniToolbarShown	Event ID that identifies the UltraToolbarsManager.BeforeMiniToolbarShown event.
BeforeNavigation	Event ID that identifies the UltraToolbarsManager.BeforeNavigation event.
BeforeRibbonCustomizationDialogDisplayed	Event ID that identifies the UltraToolbarsManager.BeforeRibbonCustomizationDialogDisplayed event.
BeforeRibbonGroupDropDown	Event ID that identifies the UltraToolbarsManager.BeforeRibbonGroupDropDown event.
BeforeRibbonTabDropDown	Event ID that identifies the UltraToolbarsManager.BeforeRibbonTabDropDown event.
BeforeRibbonTabSelected	Event ID that identifies the UltraToolbarsManager.BeforeRibbonTabSelected event.
BeforeShortcutKeyProcessed	Event ID that identifies the UltraToolbarsManager.BeforeShortcutKeyProcessed event.
BeforeTaskPaneToolSelected	Event ID that identifies the UltraToolbarsManager.BeforeTaskPaneToolSelected event.
BeforeToolActivate	Event ID that identifies the UltraToolbarsManager.BeforeToolActivate event.
BeforeToolbarListDropdown	Event ID that identifies the UltraToolbarsManager.BeforeToolbarListDropdown event.
BeforeToolbarReset	Event ID that identifies the UltraToolbarsManager.BeforeToolbarReset event.
BeforeToolDragBegin	Event ID that identifies the UltraToolbarsManager.BeforeToolDragBegin event.
BeforeToolDropdown	Event ID that identifies the UltraToolbarsManager.BeforeToolDropdown event.
BeforeToolEnterEditMode	Event ID that identifies the UltraToolbarsManager.BeforeToolEnterEditMode event.
BeforeToolExitEditMode	Event ID that identifies the UltraToolbarsManager.BeforeToolExitEditMode event.
GalleryToolActiveItemChange	Event ID that identifies the PopupGalleryTool.GalleryToolActiveItemChange event.
GalleryToolFilterChange	Event ID that identifies the PopupGalleryTool.GalleryToolFilterChange event.
GalleryToolItemClick	Event ID that identifies the PopupGalleryTool.GalleryToolItemClick event.
GestureCompleted	The GestureCompleted event.
GestureQueryStatus	The GestureQueryStatus event.
GestureStarting	The GestureStarting event.
LoadHelperComplete	Event ID that identifies the UltraToolbarsManager.LoadHelperComplete event.
MouseEnterElement	Event ID that identifies the Infragistics.Win.UltraComponentControlManagerBase.MouseEnterElement event.
MouseLeaveElement	Event ID that identifies the Infragistics.Win.UltraComponentControlManagerBase.MouseLeaveElement event.
PanGesture	The PanGesture event.
PressAndHoldGesture	The PressAndHoldGesture event.
PressAndTapGesture	The PressAndTapGesture event.
QuickAccessToolbarModified	Event ID that identifies the UltraToolbarsManager.QuickAccessToolbarModified event.
Restored	Event ID that identifies the UltraToolbarsManager.Restored event.
RotateGesture	The RotateGesture event.
TaskPaneToolResize	Event ID that identifies the UltraToolbarsManager.TaskPaneToolResize event.
TearawayToolbarCreated	Event ID that identifies the UltraToolbarsManager.TearawayToolbarCreated event.
ToolbarModified	Event ID that identifies the UltraToolbarsManager.ToolbarModified event.
ToolClick	Event ID that identifies the UltraToolbarsManager.ToolClick event.
ToolDoubleClick	Event ID that identifies the UltraToolbarsManager.ToolDoubleClick event.
ToolEditError	Event ID that identifies the UltraToolbarsManager.ToolEditError event.
ToolKeyDown	Event ID that identifies the UltraToolbarsManager.ToolKeyDown event.
ToolKeyPress	Event ID that identifies the UltraToolbarsManager.ToolKeyPress event.
ToolKeyUp	Event ID that identifies the UltraToolbarsManager.ToolKeyUp event.
ToolValueChanged	Event ID that identifies the UltraToolbarsManager.ToolValueChanged event.
TwoFingerTapGesture	The TwoFingerTapGesture event.
ZoomGesture	The ZoomGesture event.

Example

The following sample code illustrates how to use the UltraToolbarManager's EventManager.

Visual Basic

Imports Infragistics.Win.UltraWinToolbars

Private Sub button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles button1.Click

' Get the toolbar manager'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.
Dim eventManager As ToolbarsEventManager

eventManager = Me.ultraToolbarsManager1.EventManager

' Disable the ToolClick event
eventManager.SetEnabled(ToolbarEventIds.ToolClick, False)

' Toggle the 'Checked' property of a state button tool.
' Note: This would normally cause the ToolClick event to
' be raised. However, since the above code disabled the event
' it won't be raised.
Dim tool As StateButtonTool

tool = Me.ultraToolbarsManager1.Tools("StateButtonTool1")
tool.Checked = Not tool.Checked

' Re-enable the ToolClick event
eventManager.SetEnabled(ToolbarEventIds.ToolClick, 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 Not eventManager.AllEventsEnabled Then
eventManager.AllEventsEnabled = True
End If

' The event manager also exposes an 'IsEnabled' method
' to see if an event is enabled or disbled.
If Not eventManager.IsEnabled(ToolbarEventIds.ToolClick) Then
eventManager.SetEnabled(ToolbarEventIds.ToolClick, True)
End If

' The status bar 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 Not 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(ToolbarEventIds.ToolClick) Then
' ...
End If

End Sub

using System.Diagnostics;
using Infragistics.Win.UltraWinToolbars;

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

	// Get the toolbar manager'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.
	ToolbarsEventManager eventManager = this.ultraToolbarsManager1.EventManager;

	// Disable the ToolClick event
	eventManager.SetEnabled( ToolbarEventIds.ToolClick, false );

	// Toggle the 'Checked' property of a state button tool.
	// Note: This would normally cause the ToolClick event to 
	// be raised. However, since the above code disabled the event
	// it won't be raised.
	StateButtonTool tool;

	tool = this.ultraToolbarsManager1.Tools["StateButtonTool1"] as StateButtonTool;
	tool.Checked = !tool.Checked;

	// Re-enable the ToolClick event
	eventManager.SetEnabled( ToolbarEventIds.ToolClick, 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(ToolbarEventIds.ToolClick ) )
		eventManager.SetEnabled(ToolbarEventIds.ToolClick, true );

	// The status bar 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( ToolbarEventIds.ToolClick ) )
	{
		// ... 
	}
	
}

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.UltraWinToolbars Namespace

Windows Forms | Help Topics

ToolbarEventIds Enumeration

Reference