C#的WebBrowser的操作与注意事项介绍

1.在Winform里使用WebBrowser，要对Form1.cs添加一些东西：
    1.1 在“public partial class Form1 : Form”上方，添加：

代码如下:

[PermissionSet(SecurityAction.Demand, Name = "FullTrust")]
[System.Runtime.InteropServices.ComVisibleAttribute(true)]

1.2 在Form1的Shown事件中，添加：

代码如下:

this.UI_webBrowser.ObjectForScripting = this;

2.由于WebBrowser是放在Winform界面中，由界面线程（主线程）管理，执行渲染也是主线程，因此，不能把业务逻辑放在主线程中，应该另开一个线程，执行业务逻辑。并通过Invoke来与WebBrowser交互。

例子：

代码如下:

private void Form1_Shown(object sender, EventArgs e)
 {
     this._thread_mainLogic = new Thread(this.ThreadFunction_MainLogic);
     this._thread_mainLogic.Start();
 }

private void ThreadFunction_MainLogic()
 {
     Debugger.Log(0, "", "\r\n开始执行业务逻辑\r\n");
     this.Invoke( new Action( () => { this.webBrowser.Navigate("http://www.baidu.com");} ) );//通过Invoke来与webBrowser交互
     .....
 }

3.浏览指定URL。注意，此方法为异步方法，需要手动同步。

代码如下:

//以下方法不是线程安全方法
 private AutoResetEvent _threadControlEvent_Tool_webBrowser_Navigate = null;

private void Tool_webBrowser_Navigate(string arg_URL)
 {
     this._threadControlEvent_Tool_webBrowser_Navigate = new AutoResetEvent(false);
     this.Invoke(new Action(() =>
     {
         this.webBrowser.DocumentCompleted += webBrowser_DocumentCompleted_Tool_webBrowser_Navigate;
         this.webBrowser.Navigate(arg_URL);
     }));
     this._threadControlEvent_Tool_webBrowser_Navigate.WaitOne();
     this._threadControlEvent_Tool_webBrowser_Navigate.Close();
     this._threadControlEvent_Tool_webBrowser_Navigate.Dispose();
 }

void webBrowser_DocumentCompleted_Tool_webBrowser_Navigate(object sender, WebBrowserDocumentCompletedEventArgs e)
 {
     this.webBrowser.DocumentCompleted -= webBrowser_DocumentCompleted_Tool_webBrowser_Navigate;
     this._threadControlEvent_Tool_webBrowser_Navigate.Set();
 }

4.根据ID获取按钮，并点击它：（也可作用于网页中的URL链接）

代码如下:

//假设网页里的按钮，ID为"btn"
HtmlElement element_btn = null;
this.Invoke(new Action(() => { element_btn = this.UI_webBrowser.Document.All["btn"]; }));//获取
element_btn.InvokeMember("Click");//点击，此方法为同步方法，可安全使用

5.根据ID获取输入框，并输入内容

代码如下:

//假设网页里的输入框，ID为"input"
HtmlElement input = null;
this.Invoke( new Action( () => { input = this.UI_webBrowser.Document.All["input"]; } ) );//获取
input.InnerText = "123";//输入"123"。此方法不为同步方法，需要使用下文的Wait_SafeMode方法。
Tool_Wait_SafeMode();//实现在下文

6.根据ID获取form，并提交(submit)

代码如下:

//假设网页里的form，ID为"form2"
HtmlElement form2 = null;
this.Invoke( new Action( () => { form2 = this.UI_webBrowser.Document.Forms["form2"]; } ) );//获取
form_submit.InvokeMember("submit");//提交form2里的内容。此方法为同步方法，可安全使用。

7.根据ID获取CheckBox，并设置为已选中（Checked）

代码如下:

//假设网页里的CheckBox，ID为"checkbox5"
HtmlElement checkBox5 = null;
this.Invoke( new Action( () => { checkBox5 = this.UI_webBrowser.Document.All["checkbox5"]; } ) );//获取
checkBox5.SetAttribute("Checked", "true");//设置为已选中。此方法为同步方法，可安全使用。

8.根据元素的已知属性，来查找该元素

代码如下:

//假设网页里，有且仅有这样的一个元素：它有一个名为"value"的属性，属性值为"12345"
 bool isFind = false;
 HtmlElementCollection htmlElementCollection = null;
 this.Invoke( new Action( () => { htmlElementCollection = this.webBrowser.Document.All; } ) );//获取集合
 HtmlElement resultElement = null;

foreach (HtmlElement currentElement in htmlElementCollection)//在集合中遍历所有元素来寻找
 {
     if (currentElement.GetAttribute("value") == "12345")
     {
         isFind = true;
         resultElement = currentElement;
         break;
     }
 }

if( ! isFind )
 {
     对没有找到的情况进行处理;
 }

9.对网页中的ComboBox进行设置。注意，以下代码有问题，请勿使用。由于SetAttribute是一个没有回应的API，因此建议使用js来进行设置。下文中，让WebBrowser执行js代码，可以做到有回调。

代码如下:

//假设网页中存在一个ComboBox，ID为"comboBox123"，下拉菜单有两项：
 //第一项的ID为1，value为"苹果"
 //第二项的ID为2，value为"西瓜"
 HtmlElement element_comboBox = null;
 this.Invoke( new Action( () => { element_comboBox = this.webBrowser.Document.All["comboBox123"]; } ) );//获取
 Tool_Wait_SafeMode();
 this.Invoke( new Action( () => { element_comboBox.SetAttribute("value", "2"); } ) );//设置为"西瓜"，即value = 2
 Tool_Wait_SafeMode();

10.Tool_Wait_SafeMode

代码如下:

private void Tool_Wait_SafeMode()
 {
     bool isError = false;
     bool isBusy = false;
     do
     {
         this.Invoke(new Action(() =>
         {
             try
             {
                 isBusy = this.webBrowser.IsBusy;
             }
             catch (System.Exception ex)
             {
                 isError = true;
             }
         }));
         if (isError)
         {
             Thread.Sleep(errorWaitTime);//建议为2秒以上。这个时间要根据机器性能来设置，必须设置长一些。
         }
         else
         {
             if (isBusy)
             {
                 Thread.Sleep(arg_waitTime);//建议为0.1秒以上。这个时间要根据机器性能来设置，可以设置短一些。
             }
         }
     }
     while (isError | isBusy);
 }

11.在网页中执行js代码

由于让WebBrowser执行js，是一个异步过程，并且还需要回调，因此这个功能有些复杂。对此进行了封装，把它封装为了一个同步过程，来方便使用：

代码如下:

#region private void Tool_webBrowser_ExecUserJSScript(string arg_jsCodes)
         private AutoResetEvent _threadControlEvent_Tool_webBrowser_ExecUserJSScript_Init = null;
         private AutoResetEvent _threadControlEvent_Tool_webBrowser_ExecUserJSScript_Exec = null;
         private object _returnObj_Tool_webBrowser_ExecUserJSScript = null;

/// <summary>
         /// 用WebBrowser执行JS自定义语句。
         /// 1：定义一个js方法，方法名尽量特殊些，以免与html里已存在的js方法重名。这个方法的结尾，一定要使用window.external.NotifyCSharpComplete( msg );才能实现js执行结束后，通知CSharp。把这个方法传递给参数arg_jsFunctionDefineCodes。
         /// 2：把这个方法的方法名，传递给参数arg_jsFunctionName。
         /// 3: 把这个方法，需要传递的参数，传递给arg_functionArgs。如果不需要传入参数，该字段可以不需要赋值，或赋值为null，或赋值为new object[]{}。
         /// 4: 如果js在回调C#时，不需要返回参数，请在js方法里使用window.external.NotifyCSharpComplete( null );如果有返回参数，则可以修改为window.external.NotifyCSharpComplete( 参数变量 );
         /// 例子：js方法：function jsFunctionTest( arg1, arg2 ) { var arg3 = arg1 + arg2; window.external.NotifyCSharpComplete( "运算结果：" + arg3 ); }
         /// 则 arg_jsFunctionDefineCodes = "function jsFunctionTest( arg1, arg2 ) { var arg3 = arg1 + arg2; window.external.NotifyCSharpComplete( \"运算结果：\" + arg3 ); }";
         ///    arg_jsFunctionName = jsFunctionTest
         ///    如果需要传递的参数为123、456，则arg_functionArgs = new object[] { 123, 456 }
         /// 返回值，通过object进行返回。如果object是一个其他类型，则请自行转换。比如：stirng result = (string)Tool_webBrowser_ExecUserJSScript(...);
         /// </summary>
         /// <param name="arg_jsFunctionDefineCodes">js方法，注意，总长度不能超过1991（总长不能超过2048，程序中会对字符串添加一些内容。）</param>
         /// <param name="arg_jsFunctionName">js方法的方法名</param>
         /// <param name="arg_functionArgs">js方法的参数列表。如果不需要传入参数，该字段可以不需要赋值，或赋值为null，或赋值为new object[]{}</param>
         /// <returns>返回执行结果。注意，默认为返回参数。如果没有返回，请修改js方法，把NotifyCSharpComplete( msg )改为NotifyCSharpComplete( null )</returns>
         private object Tool_webBrowser_ExecUserJSScript(string arg_jsFunctionDefineCodes, string arg_jsFunctionName, object[] arg_functionArgs = null)
         {
             this._returnObj_Tool_webBrowser_ExecUserJSScript = null;
             if (arg_jsFunctionDefineCodes.Length > 1991)
             {
                 throw new Exception("错误：js方法定义的长度超过了1991。");
             }
             //1.写入js方法。
             arg_jsFunctionDefineCodes = "javascript:" + arg_jsFunctionDefineCodes + ";window.external.NotifyCSharpCompleteInit();";
             if (arg_jsFunctionDefineCodes.Length >= 2048)
             {
                 throw new Exception("错误：js方法定义的总长度超过了2048（原始方法 + 添加的内容）。");
             }
             this._threadControlEvent_Tool_webBrowser_ExecUserJSScript_Init = new AutoResetEvent(false);
             this.Invoke(new Action(() =>
             {
                 this.webBrowser.Navigate(arg_jsFunctionDefineCodes);
             }));
             this._threadControlEvent_Tool_webBrowser_ExecUserJSScript_Init.WaitOne();
             this._threadControlEvent_Tool_webBrowser_ExecUserJSScript_Init.Close();
             this._threadControlEvent_Tool_webBrowser_ExecUserJSScript_Init.Dispose();
             //2.执行js方法
             this._threadControlEvent_Tool_webBrowser_ExecUserJSScript_Exec = new AutoResetEvent(false);
             this.Invoke(new Action(() =>
             {
                 this.webBrowser.Document.InvokeScript(arg_jsFunctionName, arg_functionArgs);
             }));
             this._threadControlEvent_Tool_webBrowser_ExecUserJSScript_Exec.WaitOne();
             this._threadControlEvent_Tool_webBrowser_ExecUserJSScript_Exec.Close();
             this._threadControlEvent_Tool_webBrowser_ExecUserJSScript_Exec.Dispose();
             //3.返回参数
             return this._returnObj_Tool_webBrowser_ExecUserJSScript;
         }

public void NotifyCSharpCompleteInit()
         {
             this._threadControlEvent_Tool_webBrowser_ExecUserJSScript_Init.Set();
         }

public void NotifyCSharpComplete(object arg_obj)
         {
             this._returnObj_Tool_webBrowser_ExecUserJSScript = arg_obj;
             this._threadControlEvent_Tool_webBrowser_ExecUserJSScript_Exec.Set();
         }
         #endregion

用法例子1：

代码如下:

string jsCmdTest = "function testFunction( msg ) { setTimeout(\"window.external.NotifyCSharpComplete(\\\"返回内容\\\");\", 5000);};";
object returnObj = this.Tool_webBrowser_ExecUserJSScript(jsCmdTest, "testFunction", new object[] {"传入参数"});
string returnStr = returnObj as string;

用法例子2：

代码如下:

string jsCmdTest = "function testFunction( ) { var a = 122; var b = 244; var c = a + b; window.external.NotifyCSharpComplete(c);};";
object returnObj = this.Tool_webBrowser_ExecUserJSScript(jsCmdTest, "testFunction", null);
int returnInt = (int)returnObj;

用法例子3：

代码如下:

string jsCmdTest = "function testFunction( ) { window.external.NotifyCSharpComplete(null);};";
object returnObj = this.Tool_webBrowser_ExecUserJSScript(jsCmdTest, "testFunction", null);
string result = "js执行完毕";

总结：使用WebBrowser的两个大问题：

1.WebBrowser是调用机器上的IE，因此版本、渲染的程序也就取决与IE的版本与渲染器的程序。

2.WebBrowser的执行js等很多操作都是异步且无事件回应的，只能自己去估算一个执行时间，来等待。并且等待时间一定要大于js实际执行时间，否则后续代码会出问题。

3.目前，执行js的方式，只能通过浏览器的地址栏。地址栏是有长度限制的。