Edit

HtmlElementEventArgs.ClientMousePosition Property

  • Reference

Definition

Namespace:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll

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

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

Property Value

Point

The current position of the mouse cursor.

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

Remarks

ClientMousePosition gives the mouse position of the cursor relative to the upper-left corner of the document. Use MousePosition if you need the mouse coordinates relative to the element that raised the event.

Applies to

See also