HtmlElementEventHandler Delegate

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

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

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

public delegate void HtmlElementEventHandler(object? sender, HtmlElementEventArgs e);

type HtmlElementEventHandler = delegate of obj * HtmlElementEventArgs -> unit

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

Parameters

sender

Object

The source of the event.

e

HtmlElementEventArgs

An HtmlElementEventArgs that contains the event data.

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.

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.
   }

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.
}

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

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 Handling and Raising Events.

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.

Extension Methods