WebBrowser页面与WinForm交互技巧

分类:DotNet    发布时间:2013/9/11 16:09:08

话说有了WebBrowser类,终于不用自己手动封装SHDocVw的AxWebBrowser这个ActiveX控件了。这个类如果仅仅作为一个和IE一模一样浏览器,那就太没意思了(还不如直接用IE呢)。那么,无论我们是想做一个“定制版IE”,还是希望利用HTML来做用户界面(指WinApp而非WebApp。许多单机软件,包括Windows的帮助支持中心,都是HTML做的),都少不了Windows Form和包含在WebBrowser中的Web页面的交互。本文将通过几个实际的例子,初步介绍一下WinForm和WebBrowser所包含的Web页面之间的交互。

下面的代码假设你已经建立了一个Windows Form,上面有一个WebBrowser名为“webBrowser”。

Study Case 1:用WinForm的Event Handler响应Web页面的事件

现在有这样一个Windows Application,它的界面上只有一个WebBrowser,显示一个本地的HTML文件作为界面。现在的问题是,所有逻辑都可以放在HTML文件里,唯独“关闭”按钮遇到了困难——通常,Web页面是没有办法直接控制浏览器的,更不用说结束这个WinForm程序了。

但是,在.Net 2.0当中,“由Windows Form响应Web页面的事件”已经成为了现实。

在.Net 2.0中,整个HTML文档以及其包含的各个HTML元素,都和一个个HtmlDocument、HtmlElement之类的.Net对象对应。因此只要找到这个“关闭”按钮对应的HtmlElement对象,为其click事件添加Event Handler即可。
假设HTML源代码如下:

<html><body><input type="button" id="btnClose" value="关闭" /></body></html>

那么找出该按钮并为之添加Event Handler的代码如下:

 

HtmlDocument htmlDoc = webBrowser.Document; HtmlElement btnElement = htmlDoc.All["btnClose"]; if (btnElement != null) {     btnElement.click += new HtmlElementEventHandler(HtmlBtnClose_Click); }

其中HtmlBtnClose_Click是按下Web按钮时的Event Handler。

很简单吧?那么稍稍高级一点的——我们都知道一个HTML元素可能有很多各种各样的事件,而HtmlElement这个类只给出最常用、共通的几个。那么,如何响应其他事件呢?这也很简单,只需要调用HtmlElement的AttachEventHandler就可以了:

btnElement.AttachEventHandler("onclick"new EventHandler(HtmlBtnClose_Click));  //这一句等价于上面的btnElement.click += new HtmlElementEventHandler(HtmlBtnClose_Click); 

对于其他事件,把"onclick"换成该事件的名字就可以了。例如:

formElement.AttachEventHandler("onsubmit"new EventHandler(HtmlForm_Submit)); 

Study Case 2:表单(form)的自动填写和提交
要使我们的WebBrowser具有自动填表、甚至自动提交的功能,并不困难。

假设有一个最简单的登录页面,输入用户名密码,点“登录”按钮即可登录。已知用户名输入框的id(或Name,下同)是username,密码输入框的id是password,“登录”按钮的id是submitbutton,那么我们只需要在webBrowser的DocumentCompleted事件中使用下面的代码即可:

HtmlElement btnSubmit = webBrowser.Document.All["submitbutton"]; HtmlElement tbUserid = webBrowser.Document.All["username"]; HtmlElement tbPasswd = webBrowser.Document.All["password"];
if (tbUserid == null || tbPasswd == null || btnSubmit == null)     return;
tbUserid.SetAttribute(
"value""smalldust"); tbPasswd.SetAttribute("value""12345678");
btnSubmit.InvokeMember(
"click");

这里我们用SetAttribute来设置文本框的“value”属性,用InvokeMember来调用了按钮的“click”方法。因为不同的Html元素,其拥有的属性和方法也不尽相同,所以.Net 2.0提供了统一的HtmlElement来概括各种Html元素的同时,提供了这两个方法以调用元素特有的功能。关于各种Html元素的属性和方法一览,可以查阅MSDN的DHTML Reference

※关于表单的提交,的确还有另一种方法就是获取form元素而不是button,并用form元素的submit方法:

HtmlElement formLogin = webBrowser.Document.Forms["loginForm"];  //…… formLogin.InvokeMember("submit"); 

本文之所以没有推荐这种方法,是因为现在的网页,很多都在submit按钮上添加onclick事件,以对提交的内容做最基本的验证。如果直接使用form的submit方法,这些验证代码就得不到执行,有可能会引起错误。
Study Case 3:查找并选择文本
这次我们希望实现一个和IE一模一样的查找功能,以对Web页面内的文字进行查找。

文本查找要借助于TextRange对象的findText方法。但是,.Net里并没有这个对象。这是因为,.Net 2.0提供的HtmlDocument,HtmlWindow,HtmlElement等类,只不过是对原有mshtml这个COM组件的不完整封装,只提供了mshtml的部分功能。所以许多时候,我们仍旧要借助mshtml来实现我们需要的功能。好在这些.Net类都提供了DomDocument这个属性,使得我们很容易把.Net对象转换为COM对象使用。下面的代码演示了如何查找Web页面的文本。 (需要添加mshtml的引用,并加上using mshtml;)

 

    public partial class SearchDemo : Form     {         // 建立一个查找用的TextRange(IHTMLTxtRange接口)         private IHTMLTxtRange searchRange = null;         public SearchDemo()         {             InitializeComponent();         }
        
private void btnSearch_Click(object sender, EventArgs e)         {             // Document的DomDocument属性,就是该对象内部的COM对象。             IHTMLDocument2 document = (IHTMLDocument2)webBrowser.Document.DomDocument;             string keyword = txtKeyword.Text.Trim();             if (keyword == "")                 return;
            
// IE的查找逻辑就是,如果有选区,就从当前选区开头+1字符处开始查找;没有的话就从页面最初开始查找。              // 这个逻辑其实是有点不大恰当的,我们这里不用管,和IE一致即可。             if (document.selection.type.ToLower() != "none")             {                 searchRange = (IHTMLTxtRange)document.selection.createRange();                 searchRange.collapse(true);                 searchRange.moveStart("character"1);             }             else             {                 IHTMLBodyElement body = (IHTMLBodyElement)document.body;                 searchRange = (IHTMLTxtRange)body.createTextRange();             }
            
// 如果找到了,就选取(高亮显示)该关键字;否则弹出消息。             if (searchRange.findText(keyword, 10))             {                 searchRange.select();             }             else             {                 MessageBox.Show("已搜索到文档结尾。");             }         }     } 

到此为止,简单的查找就搞定了。至于替换功能,看了下一个例子,我相信你就可以触类旁通轻松搞定了。
Study Case 4:高亮显示
上一个例子中我们学会了查找文本——究跟到底,对Web页面还是只读不写。那么,如果说要把所有的搜索结果高亮显示呢?我们很快会想到把所有匹配的文字颜色、背景改一下就可以了。

首先想到的可能是直接修改HTML文本吧……但是,与SourceCode的高亮显示不同,我们需要并且只需要高亮页面中的文本部分。HTML标签、脚本代码等等是绝对不应该去改动的。因此我们不能把整个页面的Source Code读进来然后replace,那样有破坏HTML文件结构的可能;我们只能在能够分离出文本与其他内容(标签,脚本……)的前提下进行。
具体方法有很多,下面提供两个比较简单的方法。

方法一:使用TextRange(IHTMLTxtRange) 有了上一个Case的基础,相信大家立刻会想到使用TextRange。没错,TextRange除了提供查找方法之外,还提供了一个pasteHTML方法,以指定的HTML文本替换当前TextRange中的内容。代码片断如下:

    public partial class HilightDemo : Form     {         // 定义高亮显示效果的标签。        string tagBefore = "<span style=''background-color:yellow;color:black''>";         string tagAfter = "</span>";
        
// ……         private void btnHilight_Click(object sender, EventArgs e)         {             HtmlDocument htmlDoc = webBrowser.Document;             string keyword = txtKeyword.Text.Trim();             if (keyword == "")                 return;
            
object oTextRange = htmlDoc.Body.InvokeMember("createTextRange");
            mshtml.IHTMLTxtRange txtrange 
= oTextRange as mshtml.IHTMLTxtRange;
            
while (txtrange.findText(keyword, 14))             {                 try                 {                     txtrange.pasteHTML(tagBefore + keyword + tagAfter);                 }                 catch { }                 txtrange.collapse(false);             }         }     }

※这段代码里获取IHTMLTxtRange的方式和上面的例子稍稍不同,其实所谓条条大路通罗马,本质是一样的。
方法二:使用DOM(文档对象模型) 将HTML文档解析为DOM,然后遍历每个节点,在其中搜索关键字并进行相应替换处理即可。

    public partial class HilightDemo : Form     {         //……         private void btnHilight_Click(object sender, EventArgs e)         {             HTMLDocument document = (HTMLDocument)webBrowser.Document.DomDocument;             IHTMLDOMNode bodyNode = (IHTMLDOMNode)webBrowser.Document.Body.DomElement;             string keyword = txtKeyword.Text.Trim();             if (keyword == "")                 return;
            HilightText(document, bodyNode, keyword);         }
        
private void HilightText(HTMLDocument document, IHTMLDOMNode node, string keyword)         {             // nodeType = 3:text节点            if (node.nodeType == 3)             {                 string nodeText = node.nodeValue.ToString();                 // 如果找到了关键字                if (nodeText.Contains(keyword))                 {                     IHTMLDOMNode parentNode = node.parentNode;                     // 将关键字作为分隔符,将文本分离,并逐个添加到原text节点的父节点                    string[] result = nodeText.Split(new string[] { keyword }, StringSplitOptions.None);                     for (int i = 0; i < result.Length - 1; i++)                     {                         if (result[i] != "")                         {                             IHTMLDOMNode txtNode = document.createTextNode(result[i]);                             parentNode.insertBefore(txtNode, node);                         }                         IHTMLDOMNode orgNode = document.createTextNode(keyword);                         IHTMLDOMNode hilightedNode = (IHTMLDOMNode)document.createElement("SPAN");                         IHTMLStyle style = ((IHTMLElement)hilightedNode).style;                         style.color = "black";                         style.backgroundColor = "yellow";                         hilightedNode.appendChild(orgNode);
                        parentNode.insertBefore(hilightedNode, node);                     }                     
if (result[result.Length - 1!= "")                     {                             IHTMLDOMNode postNode = document.createTextNode(result[result.Length - 1]);                             parentNode.insertBefore(postNode, node);                     }                     parentNode.removeChild(node);                 } // End of nodeText.Contains(keyword)            }             else             {                 // 如果不是text节点,则递归搜索其子节点                IHTMLDOMChildrenCollection childNodes = node.childNodes as IHTMLDOMChildrenCollection;                 foreach (IHTMLDOMNode n in childNodes)                 {                     HilightText(document, n, keyword);                 }             }         }     }

上面的两段代码都是为了清晰易懂而精简得不能再简的,有很多地方很不完善。比如,没考虑到如何从高亮显示状态复原;也没有大小写匹配等等。当然,掌握了原理之后相信这些都不会太难。
这两种方法各有优缺点: 使用TextRange较轻量迅速,而且有一个特长,就是可以把跨标签(Tag)的关键字挑出来。例如,有这么一段HTML:

<b>Hel</b>lo World!

先不管作者出于什么目的让Hel三个字母成为粗体,总之显示在页面上的是一句“Hello World!”。在我们希望高亮页面中的“Hello”这个关键字时,如果用DOM分析的话,会得出含有“Hel”的<b>节点和文本节点“lo World!”两个节点,因此无法将其挑出来。而TextRange则能正确识别,将其设置为高亮。因此也可以说TextRange是只和文本有关,和HTML语法结构无关的对象。
但是,TextRange也有其致命缺点,加亮容易,反向的话就很难。换句话说,去除高亮显示的时候不能再用TextRange,而需要采用其他方法。
而DOM方法则正好相反, 由于DOM的树状结构特性,虽然不能(或者很难)跨越Tag搜索关键字,但是去除高亮显示并不繁琐。
Study Case 5:与脚本的互操作
在Case 1当中,我们已经看到,Web页面的HTML元素的事件,可以由Windows Form端来响应,可以在某种程度上看作是Web页面调用WinForm;那么反过来,WinForm除了可以直接访问Web页面的HTML元素之外,能否调用Web页面里的各种Script呢?
首先是调用Web页面的脚本中已经定义好的函数。假设HTML中有如下Javascript:

function DoAdd(a, b) {     return a + b; }

那么,我们要在WinForm调用它,只需如下代码即可:

object oSum = webBrowser.Document.InvokeScript("DoAdd"new object[] { 12 }); int sum = Convert.ToInt32(oSum);

其次,如果我们想执行一段Web页面中原本没有的脚本,该怎么做呢?这次.Net的类没有提供,看来还要依靠COM了。IHTMLWindow2可以将任意的字符串作为脚本代码来执行。

string scriptline01 = @"function ShowPageInfo() {"; string scriptline02 = @"     var numLinks = document.links.length; "; string scriptline03 = @"     var numForms = document.forms.length; "; string scriptline04 = @"     var numImages = document.images.length; "; string scriptline05 = @"     var numScripts = document.scripts.length; "; string scriptline06 = @"     alert(''网页的统计结果:\r\n链接数:'' + numLinks + "; string scriptline07 = @"        ''\r\n表单数:'' + numForms + "; string scriptline08 = @"        ''\r\n图像数:'' + numImages + "; string scriptline09 = @"        ''\r\n脚本数:'' + numScripts);}"; string scriptline10 = @"ShowPageInfo();";
string strScript = scriptline01 + scriptline02 + scriptline03 + scriptline04 + scriptline05 +                    scriptline06 + scriptline07 + scriptline08 + scriptline09 + scriptline10;
IHTMLWindow2 win 
= (IHTMLWindow2)webBrowser.Document.Window.DomWindow; win.execScript(strScript, "Javascript");

OK,今天就写到这里吧,再想起什么来再补充吧。欢迎大家多多指正,欢迎讨论。

最新评论

我要发表评论

名称:
电子邮件:
个人主页:
内容:

 博客分类