QueryContinueDragEventArgs.EscapePressed Property

 

Gets whether the user pressed the ESC key.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public bool EscapePressed { get; }

Property Value

Type: System.Boolean

true if the ESC key was pressed; otherwise, false.

By default, the QueryContinueDrag event sets Action to DragAction.Cancel if EscapePressed is true.

The following code example demonstrates the use of the EscapePressed . In the example, an event handler reports on the occurrence of the Control.QueryContinueDrag event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing MessageBox.Show with Console.WriteLine or appending the message to a multiline TextBox.

To run the example code, paste it into a project that contains an instance of a type that inherits from Control, such as a Button or ComboBox. Then name the instance Control1 and ensure that the event handler is associated with the Control.QueryContinueDrag event.

private void Control1_QueryContinueDrag(Object sender, QueryContinueDragEventArgs e) {

System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "KeyState", e.KeyState );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "EscapePressed", e.EscapePressed );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "Action", e.Action );
messageBoxCS.AppendLine();
MessageBox.Show(messageBoxCS.ToString(), "QueryContinueDrag Event" );
}

.NET Framework
Available since 1.1
Return to top
Show: