HtmlElementEventArgs.OffsetMousePosition Property

Definition

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

public:
 property System::Drawing::Point OffsetMousePosition { System::Drawing::Point get(); };
public System.Drawing.Point OffsetMousePosition { get; }
member this.OffsetMousePosition : System.Drawing.Point
Public ReadOnly Property OffsetMousePosition As Point

Property Value

The mouse position relative to the element that raises the event.

Examples

The following HTML file demonstrates relative positioning of a TABLE inside of a BODY tag.

<HTML>  

<BODY>  

    <TABLE style="position:relative;top:100px;left:100px;">  
        <TR>  
            <TD>Text</TD>  
            <TD>More text</TD>  
        </TR>  
    </TABLE>  

</BODY>  

</HTML>  

The following code example displays the difference between MousePosition, ClientMousePosition and OffsetMousePosition when the user clicks on an element of the TABLE. ClientMousePosition will display coordinates relative to the upper-left corner of the document's client area. MousePosition will display coordinates relative to the upper-left corner of the TABLE. If you click on one of the lines of text, OffsetMousePosition will display coordinates relative to that TD element.

This example requires that you have configured Document_MouseDown as a handler for the MouseDown event on HtmlDocument.

void Document_Click(object sender, HtmlElementEventArgs e)
{
    HtmlDocument doc = webBrowser1.Document;
    string msg = "ClientMousePosition: " + e.ClientMousePosition.ToString() + "\n" +
        "MousePosition: " + e.MousePosition + "\n" +
        "OffsetMousePosition: " + e.OffsetMousePosition;
    MessageBox.Show(msg);
}
Private Sub HtmlDocument_Click(ByVal sender As Object, ByVal e As HtmlElementEventArgs)
    Dim doc As HtmlDocument = webBrowser1.Document
    Dim msg As String = "ClientMousePosition: " & e.ClientMousePosition.ToString() & vbCrLf & _
        "MousePosition: " & e.MousePosition.ToString() & vbCrLf & _
        "OffsetMousePosition: " & e.OffsetMousePosition.ToString()
    MessageBox.Show(msg)
End Sub

Applies to

See also