Практическое руководство. Реализация двунаправленного взаимодействия между кодом DHTML и клиентским кодом приложений

Статья
08/11/2011

Можно использовать элемент управления WebBrowser для преобразования добавления существующего динамического кода веб-приложений HTML (DHTML) в клиентские приложения Windows. Это полезно, если затрачено немало времени на разработку элементов управления DHTML и нужно воспользоваться широкими возможностями интерфейса Windows Forms, не тратя время на переписывание существующего кода.

Элемент управления WebBrowser позволяет реализовать двусторонний обмен данными между кодом приложения и кодом скрипта веб-страницы с помощью свойств ObjectForScripting и Document. Кроме того, можно настроить элемент управления WebBrowser так, чтобы веб-элементы управления выглядели точно так же, как другие элементы управления в форме приложения. Для одновременного использования элементов управления обоих типов следует отформатировать страницу так, чтобы ее фоновый цвет и стиль внешнего вида соответствовал остальной форме, и использовать свойства AllowWebBrowserDrop, IsWebBrowserContextMenuEnabled и WebBrowserShortcutsEnabled для отключения стандартных функций веб-обозревателя.

Для внедрения DHTML в приложения Windows Forms

Установите для элемента управления 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;
```
Установите свойство ObjectForScripting в конструкторе формы или в обработчике событий Load.

В приведенном ниже коде для объекта скрипта используется класс формы.

Примечание

Компонентно-объектная модель (COM) должна иметь доступ к объекту скрипта.Чтобы сделать форму видимой для 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 показано, как вызывать для объекта скрипта после нажатия на кнопку. Скопируйте этот код в элемент BODY документа HTML, загруженного с помощью метода Navigate или присвоенного свойству DocumentText.
```
<button onclick="window.external.Test('called from script code')">
    call client code from script code
</button>
```
Реализуйте в коде скрипта функции, которые будет использовать код приложения.

Пример такой функции представлен в следующем элементе HTML SCRIPT. Скопируйте этот код в элемент HEAD документа HTML, загруженного с помощью метода Navigate или присвоенного свойству DocumentText.
```
<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 загружается в элемент управления WebBrowser посредством свойства DocumentText вместо загрузки из отдельного HTML-файла.

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

}