WebBrowser.DocumentCompleted Event

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Occurs when the WebBrowser control finishes loading a document.

public:
 event System::Windows::Forms::WebBrowserDocumentCompletedEventHandler ^ DocumentCompleted;

public event System.Windows.Forms.WebBrowserDocumentCompletedEventHandler DocumentCompleted;

public event System.Windows.Forms.WebBrowserDocumentCompletedEventHandler? DocumentCompleted;

member this.DocumentCompleted : System.Windows.Forms.WebBrowserDocumentCompletedEventHandler

Public Custom Event DocumentCompleted As WebBrowserDocumentCompletedEventHandler

Public Event DocumentCompleted As WebBrowserDocumentCompletedEventHandler

Event Type

WebBrowserDocumentCompletedEventHandler

Examples

The following code example demonstrates the use of this event to print a document after it has fully loaded.

private void PrintHelpPage()
{
    // Create a WebBrowser instance. 
    WebBrowser webBrowserForPrinting = new WebBrowser();

    // Add an event handler that prints the document after it loads.
    webBrowserForPrinting.DocumentCompleted +=
        new WebBrowserDocumentCompletedEventHandler(PrintDocument);

    // Set the Url property to load the document.
    webBrowserForPrinting.Url = new Uri(@"\\myshare\help.html");
}

private void PrintDocument(object sender,
    WebBrowserDocumentCompletedEventArgs e)
{
    // Print the document now that it is fully loaded.
    ((WebBrowser)sender).Print();

    // Dispose the WebBrowser now that the task is complete. 
    ((WebBrowser)sender).Dispose();
}

Private Sub PrintHelpPage()

    ' Create a WebBrowser instance. 
    Dim webBrowserForPrinting As New WebBrowser()

    ' Add an event handler that prints the document after it loads.
    AddHandler webBrowserForPrinting.DocumentCompleted, New _
        WebBrowserDocumentCompletedEventHandler(AddressOf PrintDocument)

    ' Set the Url property to load the document.
    webBrowserForPrinting.Url = New Uri("\\myshare\help.html")

End Sub

Private Sub PrintDocument(ByVal sender As Object, _
    ByVal e As WebBrowserDocumentCompletedEventArgs)

    Dim webBrowserForPrinting As WebBrowser = CType(sender, WebBrowser)

    ' Print the document now that it is fully loaded.
    webBrowserForPrinting.Print()
    MessageBox.Show("print")

    ' Dispose the WebBrowser now that the task is complete. 
    webBrowserForPrinting.Dispose()

End Sub

Remarks

The WebBrowser control navigates to a new document whenever one of the following properties is set or methods is called:

Handle the DocumentCompleted event to receive notification when the new document finishes loading. When the DocumentCompleted event occurs, the new document is fully loaded, which means you can access its contents through the Document, DocumentText, or DocumentStream property.

To receive notification before navigation begins, handle the Navigating event. Handling this event lets you cancel navigation if certain conditions have not been met, for example, when the user has not completely filled out a form. Handle the Navigated event to receive notification when the WebBrowser control finishes navigation and has begun loading the document at the new location.

For more information about handling events, see Handling and Raising Events.

Applies to

Share via