ToolKeyPress Event (UltraToolbarsManager)

Occurs when a key is pressed and released when a tool has the input focus.

Syntax

Visual Basic

'Declaration
 
Public Event ToolKeyPress As ToolKeyPressEventHandler

C#

public event ToolKeyPressEventHandler ToolKeyPress

Event Data

The event handler receives an argument of type ToolKeyPressEventArgs containing data related to this event. The following ToolKeyPressEventArgs properties provide information specific to this event.

Property	Description
Handled (Inherited from System.Windows.Forms.KeyPressEventArgs)	Gets or sets a value indicating whether the System.Windows.Forms.Control.KeyPress event was handled.
KeyChar (Inherited from System.Windows.Forms.KeyPressEventArgs)	Gets or sets the character corresponding to the key pressed.
Tool	The tool.

Remarks

This event is generated when the user presses down and then releases a key when a tool has the input focus.

The ToolKeyDownevent is generated when the user presses down a key when a tool has the input focus.

The ToolKeyUpevent is generated when the user releases a key when a tool has the input focus.

Example

The following code demonstrates how to access the information passed in the event arguments of the ToolKeyPress 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.

Visual Basic

Imports System.Diagnostics
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinToolbars

	Private Sub UltraToolbarsManager1_ToolKeyPress(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinToolbars.ToolKeyPressEventArgs) Handles UltraToolbarsManager1.ToolKeyPress

		Debug.WriteLine("The Tool with key '" + e.Tool.Key + "' has recorded a keypress for key '" + e.KeyChar.ToString() + "'")

		' Note: Set e.Handled = true to indicate that the key has been handled

	End Sub

C#

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

		private void ultraToolbarsManager1_ToolKeyPress(object sender, Infragistics.Win.UltraWinToolbars.ToolKeyPressEventArgs e)
		{

			Debug.WriteLine("The Tool with key '" + e.Tool.Key + "' has recorded a keypress for key '" + e.KeyChar.ToString() + "'");

			// Note: Set e.Handled = true to indicate that the key has been handled

		}

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