WebBrowser.DetachSink Method

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

WebBrowser.cs

Releases the event-handling client attached in the CreateSink() method from the underlying ActiveX control.

C#

protected override void DetachSink();

Examples

The following code example illustrates the use of this method in a class derived from WebBrowser that supplements the standard WebBrowser events with the NavigateError event from the OLE DWebBrowserEvents2 interface.

For the complete code example, see CreateSink.

C#

AxHost.ConnectionPointCookie cookie;
WebBrowser2EventHelper helper;

protected override void CreateSink()
{
    base.CreateSink();

    // Create an instance of the client that will handle the event
    // and associate it with the underlying ActiveX control.
    helper = new WebBrowser2EventHelper(this);
    cookie = new AxHost.ConnectionPointCookie(
        this.ActiveXInstance, helper, typeof(DWebBrowserEvents2));
}

protected override void DetachSink()
{
    // Disconnect the client that handles the event
    // from the underlying ActiveX control.
    if (cookie != null)
    {
        cookie.Disconnect();
        cookie = null;
    }
    base.DetachSink();
}

Remarks

This method is useful if you are familiar with OLE development using the unmanaged WebBrowser ActiveX control and you want to extend the functionality of the Windows Forms WebBrowser control, which is a managed wrapper for the ActiveX control. You can use this extensibility to implement events from the ActiveX control that are not provided by the wrapper control.

Applies to

See also

• CreateSink()
• WebBrowser Control
• DWebBrowserEvents2 Interface