Como implementar a comunicação Two-Way entre o código DHTML e o código da aplicação do cliente

Artigo
12/18/2024

Você pode usar o controle WebBrowser para adicionar código de aplicativo Web HTML dinâmico (DHTML) existente aos seus aplicativos cliente do Windows Forms. Isso é útil quando você investiu tempo de desenvolvimento significativo na criação de controles baseados em DHTML e deseja aproveitar os recursos avançados de interface do usuário do Windows Forms sem ter que reescrever o código existente.

O controle WebBrowser permite implementar a comunicação bidirecional entre o código do aplicativo cliente e o código de script da página da Web por meio das propriedades ObjectForScripting e Document. Além disso, você pode configurar o controle de WebBrowser para que seus controles da Web se misturem perfeitamente com outros controles em seu formulário de aplicativo, ocultando sua implementação DHTML. Para combinar perfeitamente os controles, formate a página exibida para que a cor do plano de fundo e o estilo visual correspondam ao restante do formulário e use as propriedades AllowWebBrowserDrop, IsWebBrowserContextMenuEnablede WebBrowserShortcutsEnabled para desabilitar os recursos padrão do navegador.

Para incorporar DHTML em seu aplicativo Windows Forms

Defina a propriedade AllowWebBrowserDrop do controle WebBrowser como false para impedir que o controle WebBrowser abra arquivos caídos nele.
```
webBrowser1.AllowWebBrowserDrop = false;
```
```
webBrowser1.AllowWebBrowserDrop = False
```
Defina a propriedade IsWebBrowserContextMenuEnabled do controle como false para impedir que o controle WebBrowser exiba seu menu de atalho quando o usuário clica com o botão direito do mouse nele.
```
webBrowser1.IsWebBrowserContextMenuEnabled = false;
```
```
webBrowser1.IsWebBrowserContextMenuEnabled = False
```
Defina a propriedade WebBrowserShortcutsEnabled do controle como false para impedir que o controle WebBrowser responda às teclas de atalho.
```
webBrowser1.WebBrowserShortcutsEnabled = false;
```
```
webBrowser1.WebBrowserShortcutsEnabled = False
```
Defina a propriedade ObjectForScripting no construtor do formulário ou substitua o método OnLoad.

O código a seguir usa a própria classe de formulário para o objeto de script.
```
webBrowser1.ObjectForScripting = new MyScriptObject(this);
```
```
webBrowser1.ObjectForScripting = New MyScriptObject(Me)
```

Implemente seu objeto de script.

public class MyScriptObject
{
    private Form1 _form;

    public MyScriptObject(Form1 form)
    {
        _form = form;
    }

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

Public Class MyScriptObject
    Private _form As Form1

    Public Sub New(ByVal form As Form1)
        _form = form
    End Sub

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

End Class

Use o objeto window.external em seu código de script para acessar propriedades públicas e métodos do objeto especificado.

O código HTML a seguir demonstra como chamar um método no objeto de script a partir de um clique no botão. Copie esse código para o elemento BODY de um documento HTML que você carrega usando o método Navigate do controle ou que você atribui à propriedade DocumentText do controle.
```
<button onclick="window.external.Test('called from script code')">
    call client code from script code
</button>
```
Implemente funções no código de script que o código do aplicativo usará.

O seguinte elemento HTML SCRIPT fornece uma função de exemplo. Copie esse código para o elemento HEAD de um documento HTML que você carrega usando o método Navigate do controle ou que você atribui à propriedade DocumentText do controle.
```
<script>
function test(message) {
    alert(message);
}
</script>
```

Use a propriedade Document para aceder ao código de script a partir do código da aplicação cliente.

Por exemplo, adicione o seguinte código ao manipulador de eventos do botão Click.

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

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

Quando terminar de depurar o DHTML, defina a propriedade ScriptErrorsSuppressed do controle como true para impedir que o controle WebBrowser exiba mensagens de erro para problemas de código de script.

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

' Uncomment the following line when you are finished debugging.
'webBrowser1.ScriptErrorsSuppressed = True

Exemplo

O exemplo de código completo a seguir fornece um aplicativo de demonstração que você pode usar para entender esse recurso. O código HTML é carregado no controle WebBrowser através da propriedade DocumentText em vez de ser carregado de um arquivo HTML separado.

using System;
using System.Windows.Forms;

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

    protected override void OnLoad(EventArgs e)
    {
        base.OnLoad(e);

        webBrowser1.AllowWebBrowserDrop = false;
        webBrowser1.IsWebBrowserContextMenuEnabled = false;
        webBrowser1.WebBrowserShortcutsEnabled = false;
        webBrowser1.ObjectForScripting = new MyScriptObject(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>";
    }

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

public class MyScriptObject
{
    private Form1 _form;

    public MyScriptObject(Form1 form)
    {
        _form = form;
    }

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

Imports System.Windows.Forms

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

    Protected Overrides Sub OnLoad(e As EventArgs)
        MyBase.OnLoad(e)

        webBrowser1.AllowWebBrowserDrop = False
        webBrowser1.IsWebBrowserContextMenuEnabled = False
        webBrowser1.WebBrowserShortcutsEnabled = False
        webBrowser1.ObjectForScripting = New MyScriptObject(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

    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

Public Class MyScriptObject
    Private _form As Form1

    Public Sub New(ByVal form As Form1)
        _form = form
    End Sub

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

End Class

Compilando o código

Este código requer:

Referências aos assemblies System e System.Windows.Forms.

Partilhar via

Como implementar a comunicação Two-Way entre o código DHTML e o código da aplicação do cliente

Para incorporar DHTML em seu aplicativo Windows Forms

Exemplo

Compilando o código

Ver também

Recursos adicionais