HtmlElementEventHandler Delegate (System.Windows.Forms)

HtmlElementEventHandler Delegate

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:

.NET Framework Class Library

HtmlElementEventHandler Delegate

Represents the method that will handle the Click, MouseDown and related events on HtmlDocument, HtmlElement, and HtmlWindow.

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

Syntax

Visual Basic

Public Delegate Sub HtmlElementEventHandler ( _
    sender As Object, _
    e As HtmlElementEventArgs _
)

public delegate void HtmlElementEventHandler(
    Object sender,
    HtmlElementEventArgs e
)

Visual C++

public delegate void HtmlElementEventHandler(
    Object^ sender, 
    HtmlElementEventArgs^ e
)

type HtmlElementEventHandler = 
    delegate of 
        sender:Object * 
        e:HtmlElementEventArgs -> unit

Parameters

sender: Type: System..::.Object
The source of the event.

e: Type: System.Windows.Forms..::.HtmlElementEventArgs
An HtmlElementEventArgs that contains the event data.

Remarks

When you create a HtmlElementEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see Events and Delegates.

You must wait until an HTML document has finished loading in order to attach an event handler to the document. If you attempt to attach a handler before loading has completed, the attach operation may fail. The best place to attach event handlers in a new document is in the DocumentCompleted event handler for the WebBrowser control.

Examples

The following code attaches event handlers for the MouseDown, MouseMove, and MouseUp events on HtmlDocument. This code sample assumes your project has an instance of the WebBrowser control named WebBrowser1.

Visual Basic

Private Sub WebBrowser1_DocumentCompleted(ByVal sender As Object, ByVal e As System.Windows.Forms.WebBrowserDocumentCompletedEventArgs) Handles WebBrowser1.DocumentCompleted
    Dim Doc As HtmlDocument = WebBrowser1.Document

    AddHandler Doc.MouseDown, New HtmlElementEventHandler(AddressOf Document_MouseDown)
    AddHandler Doc.MouseMove, New HtmlElementEventHandler(AddressOf Document_MouseMove)
    AddHandler Doc.MouseUp, New HtmlElementEventHandler(AddressOf Document_MouseUp)
End Sub

Private Sub Document_MouseDown(ByVal sender As Object, ByVal e As HtmlElementEventArgs)
    ' Insert your code here.
End Sub

Private Sub Document_MouseMove(ByVal sender As Object, ByVal e As HtmlElementEventArgs)
    ' Insert your code here.
End Sub

Private Sub Document_MouseUp(ByVal sender As Object, ByVal e As HtmlElementEventArgs)
    ' Insert your code here.
End Sub

        private void webBrowser1_DocumentCompleted(object sender, System.Windows.Forms.WebBrowserDocumentCompletedEventArgs e)
        {
            WebBrowser1.Document.MouseDown += new HtmlElementEventHandler(Document_MouseDown);
            WebBrowser1.Document.MouseMove += new HtmlElementEventHandler(Document_MouseMove);
            WebBrowser1.Document.MouseUp += new HtmlElementEventHandler(Document_MouseUp);
        }

        private void Document_MouseDown(object sender, HtmlElementEventArgs e)
        {
            // Insert your code here.
        }

        private void Document_MouseMove(object sender, HtmlElementEventArgs e)
        {
            // Insert your code here.
        }

        private void Document_MouseUp(object sender, HtmlElementEventArgs e)
        {
            // Insert your code here.
        }

Visual C++

private:
   void webBrowser1_DocumentCompleted( Object^ /*sender*/, System::Windows::Forms::WebBrowserDocumentCompletedEventArgs^ /*e*/ )
   {
      WebBrowser1->Document->MouseDown += gcnew HtmlElementEventHandler( this, &Form1::Document_MouseDown );
      WebBrowser1->Document->MouseMove += gcnew HtmlElementEventHandler( this, &Form1::Document_MouseMove );
      WebBrowser1->Document->MouseUp += gcnew HtmlElementEventHandler( this, &Form1::Document_MouseUp );
   }

   void Document_MouseDown( Object^ /*sender*/, HtmlElementEventArgs^ /*e*/ )
   {
      // Insert your code here.
   }

   void Document_MouseMove( Object^ /*sender*/, HtmlElementEventArgs^ /*e*/ )
   {
      // Insert your code here.
   }

   void Document_MouseUp( Object^ /*sender*/, HtmlElementEventArgs^ /*e*/ )
   {
      // Insert your code here.
   }

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

System.Windows.Forms Namespace