WebBrowser.DocumentCompleted イベントとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

WebBrowser.DocumentCompleted イベント

メモ : このイベントは、.NET Framework version 2.0 で新しく追加されたものです。

WebBrowser コントロールでドキュメントの読み込みが終了したときに発生します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Event DocumentCompleted As
 WebBrowserDocumentCompletedEventHandler

Visual Basic (使用法)

Dim instance As WebBrowser
Dim handler As WebBrowserDocumentCompletedEventHandler

AddHandler instance.DocumentCompleted, handler

public event WebBrowserDocumentCompletedEventHandler DocumentCompleted

C++

public:
event WebBrowserDocumentCompletedEventHandler^ DocumentCompleted {
    void add (WebBrowserDocumentCompletedEventHandler^ value);
    void remove (WebBrowserDocumentCompletedEventHandler^ value);
}

/** @event */
public void add_DocumentCompleted (WebBrowserDocumentCompletedEventHandler
 value)

/** @event */
public void remove_DocumentCompleted (WebBrowserDocumentCompletedEventHandler
 value)

JScript

JScript では、イベントは使用できますが、新規に宣言することはできません。

解説

次のいずれかのプロパティが設定される、またはメソッドが呼び出されると、WebBrowser コントロールは必ず新しいドキュメントに移動します。

Url
DocumentText
DocumentStream
Navigate
GoBack
GoForward
GoHome
GoSearch

DocumentCompleted イベントを処理すると、新しいドキュメントの読み込みが終了したときに通知が送られます。DocumentCompleted イベントが発生したときには、新しいドキュメントが完全に読み込まれています。つまり Document プロパティ、DocumentText プロパティ、または DocumentStream プロパティを使用してドキュメントのコンテンツにアクセスできます。

ナビゲーションを開始する前に通知を受け取るには、Navigating イベントを処理します。このイベントを処理すると、たとえばユーザーがフォームへの入力を完了していない場合など、特定の条件が満たされなかった場合にナビゲーションをキャンセルできます。Navigated イベントを処理すると、WebBrowser コントロールがナビゲーションを完了し、新しい位置でドキュメントの読み込みを開始したときに通知が送られます。

イベント処理の詳細については、「イベントの利用」を参照してください。

使用例

このイベントを使用して、ドキュメントが完全に読み込まれた後にドキュメントを印刷する方法を次のコード例に示します。

Visual Basic

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

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