HtmlElement.KeyDown Event
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Occurs when the user presses a key on the keyboard.
public:
event System::Windows::Forms::HtmlElementEventHandler ^ KeyDown;
public event System.Windows.Forms.HtmlElementEventHandler KeyDown;
public event System.Windows.Forms.HtmlElementEventHandler? KeyDown;
member this.KeyDown : System.Windows.Forms.HtmlElementEventHandler
Public Custom Event KeyDown As HtmlElementEventHandler
Event Type
Examples
The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the KeyDown 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 type HtmlElement named HtmlElement1
. Then ensure that the event handler is associated with the KeyDown event.
private void HtmlElement1_KeyDown(Object sender, HtmlElementEventArgs e) {
System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "MouseButtonsPressed", e.MouseButtonsPressed );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "ClientMousePosition", e.ClientMousePosition );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "OffsetMousePosition", e.OffsetMousePosition );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "MousePosition", e.MousePosition );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "BubbleEvent", e.BubbleEvent );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "KeyPressedCode", e.KeyPressedCode );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "AltKeyPressed", e.AltKeyPressed );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "CtrlKeyPressed", e.CtrlKeyPressed );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "ShiftKeyPressed", e.ShiftKeyPressed );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "EventType", e.EventType );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "ReturnValue", e.ReturnValue );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "FromElement", e.FromElement );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "ToElement", e.ToElement );
messageBoxCS.AppendLine();
MessageBox.Show(messageBoxCS.ToString(), "KeyDown Event" );
}
Private Sub HtmlElement1_KeyDown(sender as Object, e as HtmlElementEventArgs) _
Handles HtmlElement1.KeyDown
Dim messageBoxVB as New System.Text.StringBuilder()
messageBoxVB.AppendFormat("{0} = {1}", "MouseButtonsPressed", e.MouseButtonsPressed)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "ClientMousePosition", e.ClientMousePosition)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "OffsetMousePosition", e.OffsetMousePosition)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "MousePosition", e.MousePosition)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "BubbleEvent", e.BubbleEvent)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "KeyPressedCode", e.KeyPressedCode)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "AltKeyPressed", e.AltKeyPressed)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "CtrlKeyPressed", e.CtrlKeyPressed)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "ShiftKeyPressed", e.ShiftKeyPressed)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "EventType", e.EventType)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "ReturnValue", e.ReturnValue)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "FromElement", e.FromElement)
messageBoxVB.AppendLine()
messageBoxVB.AppendFormat("{0} = {1}", "ToElement", e.ToElement)
messageBoxVB.AppendLine()
MessageBox.Show(messageBoxVB.ToString(),"KeyDown Event")
End Sub
Remarks
KeyDown occurs before KeyPress, which in turns occurs before KeyUp.
You can cancel the default action for a KeyDown event on an element by setting the ReturnValue property of the HtmlElementEventArgs class to true
.
A KeyDown event on an element will also occur on that element's parent elements and on the HtmlDocument class itself, unless you set the BubbleEvent property of the HtmlElementEventArgs class to true
.