NanUI文档 – 如何贯彻C#与Javascript的彼此通信

NanUI文档目录

  • NanUI简介
  • 开始采取NanUI
  • 卷入并使用内嵌式的HTML/CSS/JS资源
  • 动网页来规划总体窗口
  • 何以贯彻C#以及Javascript的相互通信
  • 争处理NanUI中的下载过程 – DonwloadHandler的应用(待更新。。。)
  • 安处理NanUI中的弹窗过程 – LifeSpanHandler的采用(待更新。。。)
  • 什么样控制Javascript对话框 – JsDialogHandler的施用(待更新。。。)
  • 自从定义资源处理程序 (待更新。。。)

怎么促成C#以及Javascript的并行通信

经事先的文章,相信您都对NanUI有矣起来的摸底。但到目前为止,我们运用NanUI仅仅只是作为呈现HTML界面的容器,并未提到CEF与C#内数的互动。那么本文将简单介绍如何当NanUI中使用C#调用Javascript的函数和怎样在Javascript注入C#的目标、属性与办法。

C#调用Javascript函数

匪欲获得返回值的情景

倘页面中若下Javascript的函数sayHello,它的用意是于DOM中创造一个分包有“Hello
NanUI!”字样的p元素。

function sayHello() {
    var p = document.createElement("p");
    p.innerText = "Hello NanUI!";

    var container = document.getElementById("hello-container");
    container.appendChild(p);
}

以身作则中,该函数并不曾在Javascript环境里调用,而是在页面加载成功后动NanUI的ExecuteJavascript措施来调动用它们。ExecuteJavascript方式执行的归来结果吧一个bool类型,它指示了这次来无发出成功执行。

于窗体的构造函数中,通过挂号Formium的LoadHandler中的OnLoadEnd事件来监测页面加载成功的情景,并以页面加载成功后调用JS环境被的函数sayHello。

namespace CommunicateBetweenJsAndCSharp
{
    using NetDimension.NanUI;
    public partial class Form1 : Formium
    {
        public Form1()
            : base("http://res.app.local/www/index.html",false)
        {
            InitializeComponent();

            LoadHandler.OnLoadEnd += LoadHandler_OnLoadEnd;
        }

        private void LoadHandler_OnLoadEnd(object sender, Chromium.Event.CfxOnLoadEndEventArgs e)
        {
            // Check if it is the main frame when page has loaded.
            if(e.Frame.IsMain)
            {
                ExecuteJavascript("sayHello()");
            }
        }
    }
}

运转后,可以望界面被展示了“Hello
NanUI!”字样,说明使用ExecuteJavascript能够调用JS函数。


需得到返回值的情况

地方的例证中经ExecuteJavascript方来成调用了JS环境面临之函数。但易窥见,这种调用方式C#凡没有收取及另外返回值的。但其实的花色里,我们是急需由JS环境得到到返回值的,这时候使用ExecuteJavascript将不能够满足需求,使用另外一个办法EvaluateJavascript可帮我们打JS环境被获取JS函数的归值。

一旦发生另外一个Javascript函数sayHelloToSomeone,它能吸纳一个字符传参数,在部数体中拼接并赶回拼接后底字符串。

function sayHelloToSomeone(who) {
    return "Hello " + who + "!";
}

相同的,在方例子LoadHandler的OnLoadEnd事件被我们来推行sayHelloToSomeone,并通过C#传送参数并获得拼接后底归来值。EvaluateJavascript法通过一个回调Action来得到JS环境中之归值。这个Action有些许单参数,第一只是返回值的聚众,第二独凡是JS环境之百般对象,如果函数正确实施,那么第二单参数为null

namespace CommunicateBetweenJsAndCSharp
{
    using NetDimension.NanUI;
    public partial class Form1 : Formium
    {
        public Form1()
            : base("http://res.app.local/www/index.html",false)
        {
            InitializeComponent();

            LoadHandler.OnLoadEnd += LoadHandler_OnLoadEnd;
        }

        private void LoadHandler_OnLoadEnd(object sender, Chromium.Event.CfxOnLoadEndEventArgs e)
        {
            // Check if it is the main frame when page has loaded.
            if(e.Frame.IsMain)
            {
                EvaluateJavascript("sayHelloToSomeone('C#')", (value, exception) =>
                {
                    if(value.IsString)
                    {
                        // Get value from Javascript.
                        var jsValue = value.StringValue;

                        MessageBox.Show(jsValue);
                    }
                });
            }
        }
    }
}

当方的言传身教中,通过我们好一目了然知晓JS函数sayHelloToSomeone的返回值一定为String类型,因此在C#的回调中一直使用Value的StringValue属性来获取JS函数的字符传返回值。但在事实上的动中,有或连无净明白返回值的档次,因此待运用Value中放到的逐一判断属性来挨家挨户筛选返回值。

亟待小心的凡,Value的好像是是ChromiumFX中的CfrV8Value种类,它是一个分外重要的品种,基本上有在C#和CEF间的通信都是由这类别来成功的。


Javascript调用C#靶与方式

简言之的使示范

点的稿子中示范了怎样用C#来调用Javascript中之函数,那么下的情以介绍如何运用Javascript来调用C#着的对象、属性与各种法子。

在此之前,需要介绍NanUI窗体基类Formium遇之要害性质GlobalObject,您得把他明白成Javascript环境遭到之window对象。如果你要在Javascript环境下使用C#屡遭的各种对象、属性与方,都用用这些目标、属性、方法注册及GlobalObject里。

下的事例,通过当Form1的构造函数中登记一个叫吧my的JS对象,并在my内置一个一味念属性name,以及showCSharpMessageBoxgetArrayFromCSharpgetObjectFromCSharp老三单函数。

//register the "my" object
var myObject = GlobalObject.AddObject("my");

//add property "name" to my, you should implemnt the getter/setter of name property by using PropertyGet/PropertySet events.
var nameProp = myObject.AddDynamicProperty("name");
nameProp.PropertyGet += (prop, args) =>
{
    // getter - if js code "my.name" executes, it'll get the string "NanUI". 
    args.Retval = CfrV8Value.CreateString("NanUI");
    args.SetReturnValue(true);
};
nameProp.PropertySet += (prop, args) =>
{
    // setter's value from js context, here we do nothing, so it will store or igrone by your mind.
    var value = args.Value;
    args.SetReturnValue(true);
};


//add a function showCSharpMessageBox
var showMessageBoxFunc = myObject.AddFunction("showCSharpMessageBox");
showMessageBoxFunc.Execute += (func, args) =>
{
    //it will be raised by js code "my.showCSharpMessageBox(`some text`)" executed.
    //get the first string argument in Arguments, it pass by js function.
    var stringArgument = args.Arguments.FirstOrDefault(p => p.IsString);

    if (stringArgument != null)
    {
        MessageBox.Show(this, stringArgument.StringValue, "C# Messagebox", MessageBoxButtons.OK, MessageBoxIcon.Information);


    }
};

//add a function getArrayFromCSharp, this function has an argument, it will combind C# string array with js array and return to js context.
var friends = new string[] { "Mr.JSON", "Mr.Lee", "Mr.BONG" };

var getArrayFromCSFunc = myObject.AddFunction("getArrayFromCSharp");

getArrayFromCSFunc.Execute += (func, args) =>
{
    var jsArray = args.Arguments.FirstOrDefault(p => p.IsArray);



    if (jsArray == null)
    {
        jsArray = CfrV8Value.CreateArray(friends.Length);
        for (int i = 0; i < friends.Length; i++)
        {
            jsArray.SetValue(i, CfrV8Value.CreateString(friends[i]));
        }
    }
    else
    {
        var newArray = CfrV8Value.CreateArray(jsArray.ArrayLength + friends.Length);

        for (int i = 0; i < jsArray.ArrayLength; i++)
        {
            newArray.SetValue(i, jsArray.GetValue(i));
        }

        var jsArrayLength = jsArray.ArrayLength;

        for (int i = 0; i < friends.Length; i++)
        {
            newArray.SetValue(i + jsArrayLength, CfrV8Value.CreateString(friends[i]));
        }


        jsArray = newArray;
    }


    //return the array to js context

    args.SetReturnValue(jsArray);

    //in js context, use code "my.getArrayFromCSharp()" will get an array like ["Mr.JSON", "Mr.Lee", "Mr.BONG"]
};

//add a function getObjectFromCSharp, this function has no arguments, but it will return a Object to js context.
var getObjectFormCSFunc = myObject.AddFunction("getObjectFromCSharp");
getObjectFormCSFunc.Execute += (func, args) =>
{
    //create the CfrV8Value object and the accssor of this Object.
    var jsObjectAccessor = new CfrV8Accessor();
    var jsObject = CfrV8Value.CreateObject(jsObjectAccessor);

    //create a CfrV8Value array
    var jsArray = CfrV8Value.CreateArray(friends.Length);

    for (int i = 0; i < friends.Length; i++)
    {
        jsArray.SetValue(i, CfrV8Value.CreateString(friends[i]));
    }

    jsObject.SetValue("libName", CfrV8Value.CreateString("NanUI"), CfxV8PropertyAttribute.ReadOnly);
    jsObject.SetValue("friends", jsArray, CfxV8PropertyAttribute.DontDelete);


    args.SetReturnValue(jsObject);

    //in js context, use code "my.getObjectFromCSharp()" will get an object like { friends:["Mr.JSON", "Mr.Lee", "Mr.BONG"], libName:"NanUI" }
};

运作品种开辟CEF的DevTools窗口,在Console中输入my,就可知收看my目标的详细信息。

房地产项目 1

执行my.showCSharpMessageBox(“SOME TEXT FROM
JS”)
命令,将调用C#的MessageBox来具体JS函数中提供的“SOME TEXT FROM
JS”字样。

执行my.getArrayFromCSharp()能够从C#遇得到我们放的字符串数组中之老三只字符串。如果当函数中指定了一个数组作为参数,那么指定的斯数组将跟C#的字符串数组合并。

> my.getArrayFromCSharp()
["Mr.JSON", "Mr.Lee", "Mr.BONG"]

> my.getArrayFromCSharp(["Js_Bison", "Js_Dick"])
["Js_Bison", "Js_Dick", "Mr.JSON", "Mr.Lee", "Mr.BONG"]

执行my.getObjectFromCSharp()能够从C#返我们拼装的对象,该对象来一个字符型的libName性,以及一个字符串数组friends

> my.getObjectFromCSharp()
Object {libName: "NanUI", friends: Array(3)}

转头调函数

反过来调函数是Javascript里面根本和常用之力量,如果你在JS环境遭受登记之法子有函数型的参数(即回调函数),通过Execute事件的Arguments可以落回调的function,并使用CfrV8Value之ExecuteFunction来实施回调。

//add a function with callback function

var callbackTestFunc = GlobalObject.AddFunction("callbackTest");
callbackTestFunc.Execute += (func,args)=> {
    var callback = args.Arguments.FirstOrDefault(p => p.IsFunction);
    if(callback != null)
    {
        var callbackArgs = CfrV8Value.CreateObject(new CfrV8Accessor());
        callbackArgs.SetValue("success", CfrV8Value.CreateBool(true), CfxV8PropertyAttribute.ReadOnly);
        callbackArgs.SetValue("text", CfrV8Value.CreateString("Message from C#"), CfxV8PropertyAttribute.ReadOnly);

        callback.ExecuteFunction(null, new CfrV8Value[] { callbackArgs });
    }
};

在Console中执行callbackTest(function(result){ console.log(result);
})
用执匿名回调,并取得到C#回传的result对象。

> callbackTest(function(result){ console.log(result); })
Object {success: true, text: "Message from C#"}

以多数场面下,在Javascript中回调都是盖实施了一些异步的操作,那么一旦这些异步的操作是以C#履行呢是行之,只是实现起来便比较复杂。下面用演示如何实现一个异步回调。

//add a function with async callback
var asyncCallbackTestFunc = GlobalObject.AddFunction("asyncCallbackTest");
asyncCallbackTestFunc.Execute += async (func, args) => {
//save current context
var v8Context = CfrV8Context.GetCurrentContext();
var callback = args.Arguments.FirstOrDefault(p => p.IsFunction);

//simulate async methods.
await Task.Delay(5000);

if (callback != null)
{
    //get render process context
    var rc = callback.CreateRemoteCallContext();

    //enter render process
    rc.Enter();

    //create render task
    var task = new CfrTask();
    task.Execute += (_, taskArgs) =>
    {
        //enter saved context
        v8Context.Enter();

        //create callback argument
        var callbackArgs = CfrV8Value.CreateObject(new CfrV8Accessor());
        callbackArgs.SetValue("success", CfrV8Value.CreateBool(true), CfxV8PropertyAttribute.ReadOnly);
        callbackArgs.SetValue("text", CfrV8Value.CreateString("Message from C#"), CfxV8PropertyAttribute.ReadOnly);

        //execute callback
        callback.ExecuteFunction(null, new CfrV8Value[] { callbackArgs });


        v8Context.Exit();

        //lock task from gc
        lock (task)
        {
            Monitor.PulseAll(task);
        }
    };

    lock (task)
    {
        //post task to render process
        v8Context.TaskRunner.PostTask(task);
    }

    rc.Exit();

    GC.KeepAlive(task);
}

在Console中执行asyncCallbackTest(function(result){
console.log(result);
})
以实行匿名回调,大约5秒后得到到C#回传的result对象。

> asyncCallbackTest(function(result){ console.log(result); })
Object {success: true, text: "Message from C#"}

以上,您已经略询问了以NanUI如何做到C#与Javascript的彼此通信。NanUI基为开源项目ChromiumFX开发,因此C#及Javascript的并行与ChomiumFX保持一致,如果急需开尤其复杂的效用,请自行检索与参考ChromiumFX的相干API及示范。

演示源码

git clone https://github.com/NetDimension/NanUI-Examples-04-Communicate-Between-CSharp-And-JS.git

社群和赞助

GitHub
https://github.com/NetDimension/NanUI/

交流群QQ群
521854872

赞助作者

如若您嗜自的工作,并且希望NanUI持续的提高,请对NanUI项目进行补助为之来鼓励和支撑自己继续NanUI的支出工作。你得下微信或者支付宝来围观下的老二维码进行补助。

房地产项目 2

相关文章