This documentation is archived and is not being maintained.

HtmlElementEventArgs.ClientMousePosition Property

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

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

public Point ClientMousePosition { get; }
/** @property */
public Point get_ClientMousePosition ()

public function get ClientMousePosition () : Point

Not applicable.

Property Value

The current position of the mouse cursor.

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.

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);
}

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Show: