HtmlElementEventArgs Class
TOC
Collapse the table of content
Expand the table of content

HtmlElementEventArgs Class

 

Provides data for the events defined on HtmlDocument and HtmlElement.

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

System.Object
  System.EventArgs
    System.Windows.Forms.HtmlElementEventArgs

public sealed class HtmlElementEventArgs : EventArgs

NameDescription
System_CAPS_pubpropertyAltKeyPressed

Indicates whether the ALT key was pressed when this event occurred.

System_CAPS_pubpropertyBubbleEvent

Gets or sets a value indicating whether the current event bubbles up through the element hierarchy of the HTML Document Object Model.

System_CAPS_pubpropertyClientMousePosition

Gets or sets the position of the mouse cursor in the document's client area.

System_CAPS_pubpropertyCtrlKeyPressed

Indicates whether the CTRL key was pressed when this event occurred.

System_CAPS_pubpropertyEventType

Gets the name of the event that was raised.

System_CAPS_pubpropertyFromElement

Gets the HtmlElement the mouse pointer is moving away from.

System_CAPS_pubpropertyKeyPressedCode

Gets the ASCII value of the keyboard character typed in a KeyPress, KeyDown, or KeyUp event.

System_CAPS_pubpropertyMouseButtonsPressed

Gets the mouse button that was clicked during a MouseDown or MouseUp event.

System_CAPS_pubpropertyMousePosition

Gets or sets the position of the mouse cursor relative to a relatively positioned parent element.

System_CAPS_pubpropertyOffsetMousePosition

Gets or sets the position of the mouse cursor relative to the element that raises the event.

System_CAPS_pubpropertyReturnValue

Gets or sets the return value of the handled event.

System_CAPS_pubpropertyShiftKeyPressed

Indicates whether the SHIFT key was pressed when this event occurred.

System_CAPS_pubpropertyToElement

Gets the HtmlElement toward which the user is moving the mouse pointer.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

HtmlElementEventArgs encapsulates the same information found on the window.event object when programming against the unmanaged HTML DOM or when writing Active Script for HTML pages.

In most cases, you can use ToElement to find the HTML element that is receiving the event action, and FromElement to find the HTML element that the current event is causing us to leave. However, not every event supplies a value for these properties; see the managed documentation for an event, or the corresponding documentation in the Internet Explorer SDK documentation, to discover if the event supplies it.

Many events in the HTML DOM are sent to their parent elements unless they are cancelled. This is known as event bubbling. If a SPAN inside of a DIV receives a click, then a click event is raised for the SPAN first, then for the DIV, and finally for the HTML page's BODY element. BubbleEvent controls whether an event will behave in this manner or not.

The following code example demonstrates the use of this type. In the example, an event handler reports on the occurrence of the Click 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 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 HtmlDocument named HtmlDocument1. Then ensure that the event handler is associated with the Click event.

private void HtmlDocument1_Click(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(), "Click Event" );
}

.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft