Occurs before the toolbar menu list is displayed.
The event handler receives an argument of type BeforeToolbarListDropdownEventArgs containing data related to this event. The following BeforeToolbarListDropdownEventArgs properties provide information specific to this event.
Property | Description |
---|
Cancel (Inherited from System.ComponentModel.CancelEventArgs) | |
ScreenPoint | The point at which to display the menu, expressed in screen coordinates (read-only). |
ShowCustomizeMenuItem | If True, will show an item at the bottom of the menu that will bring up the runtime customizer when clicked. |
ShowCustomizeQuickAccessToolbarMenuItem | If True, will show an item at the bottom of the menu that will bring up the QAT customizer when clicked. |
ShowCustomizeRibbonMenuItem | If True, will show an item at the bottom of the menu that will bring up the ribbon customizer when clicked. |
ShowLockToolbarsMenuItem | If True, will show an item at the bottom of the menu that will toggle the value of the LockToolbars property when clicked. |
ShowMinimizeRibbonMenuItem | If True, will show an item that allows the end user to toggle the Ribbon.IsMinimized state. If the Ribbon.Visible is false, the menu item will be disabled. |
ShowQuickAccessToolbarAddRemoveMenuItem | If True, will show an item that allows the end user to add the Tool to the QuickAccessToolbar. If Tool is null or returns a tool that cannot be added to the QAT, the menu item will be disabled. |
ShowQuickAccessToolbarPositionMenuItem | If True, will show an item that allows the end user to change the QuickAccessToolbar.Location so that it appears below or above the ribbon. If the Ribbon.Visible is false, the menu item will be disabled. |
ShowToolbarMenuItems | If True, will show an item for each UltraToolbar whose ShowInToolbarList is set to true. When clicked, the Visible property will be toggled. |
Tool | Returns the ToolBase that was right clicked upon or null if no tool was associated with the menu being displayed. |
The following code demonstrates how to access the information passed in the event arguments of the BeforeToolbarListDropdown event and conditionally cancel the event.
For an overview of how to handle events in Visual Basic or Visual C#, see
Event Handlers in Visual Basic and Visual C#. For specific information and code examples illustrating how to consume events in your application, see
Consuming Events in the
.NET Framework Developer's Guide.
Imports System.Diagnostics
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinToolbars
Private Sub UltraToolbarsManager1_BeforeToolbarListDropdown(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinToolbars.BeforeToolbarListDropdownEventArgs) Handles UltraToolbarsManager1.BeforeToolbarListDropdown
Dim dr As DialogResult = MessageBox.Show(Me, "The toolbar list is about to dropdown. Do you want to cancel the dropdown?", "Cancelable Toolbar Event", MessageBoxButtons.YesNo)
If dr = DialogResult.Yes Then
e.Cancel = True
Else
dr = MessageBox.Show(Me, "The toolbar list is about to dropdown. Do you want to show the Customize option in the list?", "Cancelable Toolbar Event", MessageBoxButtons.YesNo)
e.ShowCustomizeMenuItem = (dr = DialogResult.Yes)
dr = MessageBox.Show(Me, "The toolbar list is about to dropdown. Do you want to show the Lock Toolbars option in the list?", "Cancelable Toolbar Event", MessageBoxButtons.YesNo)
e.ShowLockToolbarsMenuItem = (dr = DialogResult.Yes)
End If
End Sub
using System.Diagnostics;
using Infragistics.Win;
using Infragistics.Win.UltraWinToolbars;
private void ultraToolbarsManager1_BeforeToolbarListDropdown(object sender, Infragistics.Win.UltraWinToolbars.BeforeToolbarListDropdownEventArgs e)
{
DialogResult dr = MessageBox.Show(this, "The toolbar list is about to dropdown. Do you want to cancel the dropdown?", "Cancelable Toolbar Event", MessageBoxButtons.YesNo);
if (dr == DialogResult.Yes)
e.Cancel = true;
else
{
dr = MessageBox.Show(this, "The toolbar list is about to dropdown. Do you want to show the Customize option in the list?", "Cancelable Toolbar Event", MessageBoxButtons.YesNo);
e.ShowCustomizeMenuItem = (dr == DialogResult.Yes);
dr = MessageBox.Show(this, "The toolbar list is about to dropdown. Do you want to show the Lock Toolbars option in the list?", "Cancelable Toolbar Event", MessageBoxButtons.YesNo);
e.ShowLockToolbarsMenuItem = (dr == DialogResult.Yes);
}
}
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