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

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

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

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

  1. Присвойте свойству AllowWebBrowserDrop элемента управления WebBrowser значение false, чтобы элемент управления WebBrowser не открывал файлы, которые перетаскиваются в него мышью.

    webBrowser1.AllowWebBrowserDrop = false;

  2. Присвойте свойству IsWebBrowserContextMenuEnabled значение false, чтобы элемент управления WebBrowser не выводил контекстное меню при щелчке правой кнопкой мыши.

    webBrowser1.IsWebBrowserContextMenuEnabled = false;

  3. Присвойте свойству WebBrowserShortcutsEnabled значение false, чтобы элемент управления WebBrowser не отвечал на нажатие сочетаний клавиш.

    webBrowser1.WebBrowserShortcutsEnabled = false;

  4. Задайте свойство ObjectForScripting в конструкторе формы или в обработчике событий Load.

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

    Note

    Модель COM должна иметь доступ к объекту скрипта. Чтобы сделать форму доступной для COM, добавьте в класс формы атрибут ComVisibleAttribute.

    webBrowser1.ObjectForScripting = this;

  5. Реализуйте в коде приложения открытые свойства или методы, которые будет использовать код скрипта.

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

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

  6. Используйте объект window.external в коде скрипта для доступа к открытым свойствам и методам указанного объекта.

    Во фрагменте кода HTML ниже показано, как вызвать метод объекта скрипта после нажатия на кнопку. Скопируйте этот код в элемент BODY документа HTML, загруженного с помощью метода Navigate элемента управления или назначенного свойству DocumentText.

    <button onclick="window.external.Test('called from script code')">  
    call client code from script code  
</button>

  7. Реализуйте в коде скрипта функции, которые будет использовать код приложения.

    Пример такой функции представлен в HTML-элементе SCRIPT ниже. Скопируйте этот код в элемент HEAD документа HTML, загруженного с помощью метода Navigate элемента управления или назначенного свойству DocumentText.

    <script>  
function test(message) {   
    alert(message);   
}  
</script>

  8. Используйте свойство Document для доступа к коду скрипта из кода клиентского приложения.

    Например, добавьте приведенный ниже код в обработчик событий кнопки Click.

    webBrowser1.Document.InvokeScript("test",
    new String[] { "called from client code" });

  9. По окончании отладки кода DHTML присвойте свойству ScriptErrorsSuppressed значение true, чтобы элемент управления WebBrowser не выводил сообщения об ошибках в коде скрипта.

    // Uncomment the following line when you are finished debugging.
//webBrowser1.ScriptErrorsSuppressed = true;

Пример

В примере ниже приводится полный код демонстрационного приложения, которое поможет лучше разобраться в описываемой возможности. Код HTML загружается в элемент управления WebBrowser посредством свойства DocumentText вместо загрузки из отдельного HTML-файла.

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

}

Компиляция кода

Для этого примера кода требуются:

  • ссылки на сборки System и System.Windows.Forms;

Сведения о выполнении сборки этого примера из командной строки для Visual Basic или Visual C#, см. в разделе построение из командной строки или командной строки создания с помощью csc.exe. Можно также сборке этого примера в Visual Studio путем вставки кода в новый проект.

См. также