WebBrowser.DocumentText プロパティとは何？わかりやすく解説 Weblio辞書

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

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

WebBrowser.DocumentText プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

WebBrowser コントロールに表示するページの HTML コンテンツを取得または設定します。

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

Visual Basic (宣言)

Public Property DocumentText As
 String

Visual Basic (使用法)

Dim instance As WebBrowser
Dim value As String

value = instance.DocumentText

instance.DocumentText = value

public string DocumentText { get;
 set; }

C++

public:
property String^ DocumentText {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_DocumentText ()

/** @property */
public void set_DocumentText (String value)

JScript

public function get DocumentText
 () : String

public function set DocumentText
 (value : String)

プロパティ値
表示されるページの HTML テキスト。ドキュメントが読み込まれていない場合は、空の文字列 ("")。

例外

例外の種類	条件
ObjectDisposedException	この WebBrowser インスタンスは無効になっています。
InvalidOperationException	IWebBrowser2 の実装への参照を、基になる ActiveX WebBrowser から取得できませんでした。

解説

文字列処理ツールを使用して、WebBrowser コントロールに表示される HTML ページのコンテンツを操作する場合に、このプロパティを使用します。このプロパティを使用すると、たとえばデータベースからページを読み込んだり、正規表現を使用してページを分析したりできます。このプロパティを設定すると、WebBrowser コントロールは自動的に about:blank URL に移動した後、指定されたテキストを読み込みます。つまり、このプロパティを設定すると Navigating イベント、Navigated イベント、および DocumentCompleted イベントが発生します。Url プロパティの値は無効になります。

Web ページのコンテンツの Stream にアクセスするには、DocumentStream プロパティを使用します。また、Document プロパティと HTML ドキュメントオブジェクトモデル (DOM: Document Object Model) を使用して、ページのコンテンツにアクセスすることもできます。

Windows Mobile for Pocket PC、Windows Mobile for Smartphone、Windows CE プラットフォームメモ : .NET Compact Framework では、DocumentText を使用して Web ページのコンテンツを取得することはできませんが、このプロパティを使用して、リンクや単純な HTML フォームを提供するなど、ユーザーに HTML を提供することはできます。コード例については、「方法 : .NET Compact Framework で WebBrowser コントロールを使用する」を参照してください。

使用例

DocumentText プロパティを使用して、選択したドキュメントのコンテンツをプログラムで表示する方法を次のコード例に示します。この例は、フォームに webBrowser1 という WebBrowser コントロールが存在することを前提にしています。

Visual Basic

Private Sub Form1_Load(ByVal
 sender As Object, ByVal
 e As EventArgs) _
    Handles Me.Load

    webBrowser1.DocumentText = _
        "<html><body>Please enter your name:<br/>"
 & _
        "<input type='text' name='userName'/><br/>"
 & _
        "<a href='http://www.microsoft.com'>continue</a>"
 & _
        "</body></html>"

End Sub

Private Sub webBrowser1_Navigating( _
    ByVal sender As Object,
 ByVal e As WebBrowserNavigatingEventArgs)
 _
    Handles webBrowser1.Navigating

    Dim document As System.Windows.Forms.HtmlDocument
 = _
        webBrowser1.Document
    If document IsNot Nothing And
 _
        document.All("userName") IsNot Nothing
 And _
        String.IsNullOrEmpty( _
        document.All("userName").GetAttribute("value"))
 Then

        e.Cancel = True
        MsgBox("You must enter your name before you can navigate
 to " & _
            e.Url.ToString())
    End If

End Sub

private void Form1_Load(object sender, EventArgs
 e)
{
    webBrowser1.DocumentText =
        "<html><body>Please enter your name:<br/>" +
        "<input type='text' name='userName'/><br/>" +
        "<a href='http://www.microsoft.com'>continue</a>"
 +
        "</body></html>";
    webBrowser1.Navigating += 
        new WebBrowserNavigatingEventHandler(webBrowser1_Navigating);
}

private void webBrowser1_Navigating(object
 sender, 
    WebBrowserNavigatingEventArgs e)
{
    System.Windows.Forms.HtmlDocument document =
        this.webBrowser1.Document;

    if (document != null && document.All["userName"]
 != null && 
        String.IsNullOrEmpty(
        document.All["userName"].GetAttribute("value")))
    {
        e.Cancel = true;
        System.Windows.Forms.MessageBox.Show(
            "You must enter your name before you can navigate to " +
            e.Url.ToString());
    }
}