方法 : DHTML コードとクライアントアプリケーションコード間の双方向の通信を実装する

[アーティクル]
08/16/2008

更新 : 2007 年 11 月

WebBrowser コントロールを使用すると、既存のダイナミック HTML (DHTML) Web アプリケーションのコードを、Windows フォームクライアントアプリケーションに追加できます。作成に多大な時間を費やした DHTML ベースのコントロールが既にあり、このコードを書き直すことなく Windows フォームの豊富なユーザーインターフェイス機能を使用したい場合には、このコントロールが役に立ちます。

WebBrowser コントロールを使用すると、ObjectForScripting プロパティおよび Document プロパティを使用して、クライアントアプリケーションのコードと Web ページのスクリプトコードとの双方向の通信を実装できます。また、DHTML 実装を非表示にしながら、Web コントロールをアプリケーションフォームにある他のコントロールとシームレスに組み合わせるように、WebBrowser コントロールを設定することもできます。シームレスにコントロールを組み合わせるには、表示されるページの背景色と visual スタイルをフォームの他の部分に一致させ、AllowWebBrowserDrop プロパティ、IsWebBrowserContextMenuEnabled プロパティ、および WebBrowserShortcutsEnabled プロパティを使用して、標準のブラウザ機能を無効にします。

Windows フォームアプリケーションに DHTML を埋め込むには

WebBrowser コントロールの AllowWebBrowserDrop プロパティを false に設定して、WebBrowser コントロールにファイルをドロップしたときに、そのファイルが開かないようにします。
```
webBrowser1.AllowWebBrowserDrop = False
```
```
webBrowser1.AllowWebBrowserDrop = false;
```
このコントロールの IsWebBrowserContextMenuEnabled プロパティを false に設定して、WebBrowser コントロールでユーザーが右クリックしたときに、ショートカットメニューが表示されないようにします。
```
webBrowser1.IsWebBrowserContextMenuEnabled = False
```
```
webBrowser1.IsWebBrowserContextMenuEnabled = false;
```
このコントロールの WebBrowserShortcutsEnabled プロパティを false に設定して、WebBrowser コントロールがショートカットキーに応答しないようにします。
```
webBrowser1.WebBrowserShortcutsEnabled = False
```
```
webBrowser1.WebBrowserShortcutsEnabled = false;
```

フォームのコンストラクタか Load イベントハンドラで ObjectForScripting プロパティを設定します。

次のコードでは、スクリプトオブジェクトとして、フォームクラス自体を使用しています。

メモ :
コンポーネントオブジェクトモデル (COM: Component Object Model) は、スクリプトオブジェクトにアクセスできる必要があります。COM からフォームを表示できるようにするには、ComVisibleAttribute 属性をフォームのクラスに追加します。

webBrowser1.ObjectForScripting = Me

webBrowser1.ObjectForScripting = this;

スクリプトコードで使用するパブリックプロパティまたはメソッドをアプリケーションコードに実装します。

たとえば、スクリプトオブジェクトにフォームクラスを使用する場合は、フォームクラスに次のコードを追加します。
```
Public Sub Test(ByVal message As String)
    MessageBox.Show(message, "client code")
End Sub
```
```
public void Test(String message)
{
    MessageBox.Show(message, "client code");
}
```
スクリプトコードで window.external オブジェクトを使用して、指定のオブジェクトのパブリックプロパティおよびメソッドにアクセスします。

次の HTML コードは、ボタンクリック時のスクリプトオブジェクトでメソッドを呼び出す方法を示しています。このコードを、コントロールの Navigate メソッドを使用して読み込む HTML ドキュメントまたはコントロールの DocumentText プロパティに割り当てる HTML ドキュメントの BODY 要素にコピーします。
```
<button onclick="window.external.Test('called from script code')">
    call client code from script code
</button>
```
アプリケーションコードで使用する関数をスクリプトコードに実装します。

次の HTML SCRIPT 要素に関数の例を示します。このコードを、コントロールの Navigate メソッドを使用して読み込む HTML ドキュメントまたはコントロールの DocumentText プロパティに割り当てる HTML ドキュメントの HEAD 要素に埋め込みます。
```
<script>
function test(message) { 
    alert(message); 
}
</script>
```
クライアントアプリケーションのコードからスクリプトコードにアクセスするには、Document プロパティを使用します。

たとえば、次のコードをボタンの Click イベントハンドラに追加します。
```
webBrowser1.Document.InvokeScript("test", _
    New String() {"called from client code"})
```
```
webBrowser1.Document.InvokeScript("test",
    new String[] { "called from client code" });
```
DHTML のデバッグが終了したら、コントロールの ScriptErrorsSuppressed プロパティを true に設定して、スクリプトコードの問題に対して WebBrowser コントロールでエラーメッセージが表示されないようにします。
```
' Uncomment the following line when you are finished debugging.
'webBrowser1.ScriptErrorsSuppressed = True
```
```
// Uncomment the following line when you are finished debugging.
//webBrowser1.ScriptErrorsSuppressed = true;
```

使用例

次の完成したコード例は、この機能を理解するために役立つデモアプリケーションです。HTML コードは、個別の HTML ファイルから読み込まれるのではなく、DocumentText プロパティによって WebBrowser コントロールへ読み込まれます。

Imports System
Imports System.Windows.Forms
Imports System.Security.Permissions

<PermissionSet(SecurityAction.Demand, Name:="FullTrust")> _
<System.Runtime.InteropServices.ComVisibleAttribute(True)> _
Public Class Form1
    Inherits Form

    Private webBrowser1 As New WebBrowser()
    Private WithEvents button1 As New Button()

    <STAThread()> _
    Public Shared Sub Main()
        Application.EnableVisualStyles()
        Application.Run(New Form1())
    End Sub

    Public Sub New()
        button1.Text = "call script code from client code"
        button1.Dock = DockStyle.Top
        webBrowser1.Dock = DockStyle.Fill
        Controls.Add(webBrowser1)
        Controls.Add(button1)
    End Sub

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

        webBrowser1.AllowWebBrowserDrop = False
        webBrowser1.IsWebBrowserContextMenuEnabled = False
        webBrowser1.WebBrowserShortcutsEnabled = False
        webBrowser1.ObjectForScripting = Me
        ' Uncomment the following line when you are finished debugging.
        'webBrowser1.ScriptErrorsSuppressed = True

        webBrowser1.DocumentText = _
            "<html><head><script>" & _
            "function test(message) { alert(message); }" & _
            "</script></head><body><button " & _
            "onclick=""window.external.Test('called from script code')"" > " & _
            "call client code from script code</button>" & _
            "</body></html>"
    End Sub

    Public Sub Test(ByVal message As String)
        MessageBox.Show(message, "client code")
    End Sub

    Private Sub button1_Click(ByVal sender As Object, ByVal e As EventArgs) _
        Handles button1.Click

        webBrowser1.Document.InvokeScript("test", _
            New String() {"called from client code"})

    End Sub

End Class

using System;
using System.Windows.Forms;
using System.Security.Permissions;

[PermissionSet(SecurityAction.Demand, Name="FullTrust")]
[System.Runtime.InteropServices.ComVisibleAttribute(true)]
public class Form1 : Form
{
    private WebBrowser webBrowser1 = new WebBrowser();
    private Button button1 = new Button();

    [STAThread]
    public static void Main()
    {
        Application.EnableVisualStyles();
        Application.Run(new Form1());
    }

    public Form1()
    {
        button1.Text = "call script code from client code";
        button1.Dock = DockStyle.Top;
        button1.Click += new EventHandler(button1_Click);
        webBrowser1.Dock = DockStyle.Fill;
        Controls.Add(webBrowser1);
        Controls.Add(button1);
        Load += new EventHandler(Form1_Load);
    }

    private void Form1_Load(object sender, EventArgs e)
    {
        webBrowser1.AllowWebBrowserDrop = false;
        webBrowser1.IsWebBrowserContextMenuEnabled = false;
        webBrowser1.WebBrowserShortcutsEnabled = false;
        webBrowser1.ObjectForScripting = this;
        // Uncomment the following line when you are finished debugging.
        //webBrowser1.ScriptErrorsSuppressed = true;

        webBrowser1.DocumentText =
            "<html><head><script>" +
            "function test(message) { alert(message); }" +
            "</script></head><body><button " +
            "onclick=\"window.external.Test('called from script code')\">" +
            "call client code from script code</button>" +
            "</body></html>";
    }

    public void Test(String message)
    {
        MessageBox.Show(message, "client code");
    }

    private void button1_Click(object sender, EventArgs e)
    {
        webBrowser1.Document.InvokeScript("test",
            new String[] { "called from client code" });
    }

}