NanUI文档 - 如何实现C#与Javascript的相互通信

NanUI文书档案目录

  • NanUI简介
  • 千帆竞发应用NanUI
  • 卷入并接纳内嵌式的HTML/CSS/JS能源
  • 选择网页来安插总体窗口
  • 什么兑现C#NanUI文档 - 如何实现C#与Javascript的相互通信。与Javascript的互相通讯
  • 怎样管理NanUI中的下载进程 - DonwloadHandler的施用(待更新。。。)
  • 怎么着管理NanUI中的弹窗进程 - LifeSpanHandler的应用(待更新。。。)
  • 何以决定Javascript对话框 - JsDialogHandler的行使(待更新。。。)
  • 自定义财富管理程序 (待更新。。。)

何以贯彻C#与Javascript的竞相通讯

NanUI文档 - 如何实现C#与Javascript的相互通信。透过在此之前的篇章,相信你曾经对NanUI有了早先的询问。但到如今结束,我们选择NanUI仅仅只是作为展现HTML分界面包车型地铁器皿,并未有涉嫌CEF与C#间数据的交互。那么本文将简要介绍怎么着在NanUI中使用C#调用Javascript的函数以至如何在Javascript注入C#的靶子、属性和方法。

NanUI文档 - 如何实现C#与Javascript的相互通信。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有七个参数,第多个是重回值的成团,第1个是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

交流群QQ群
521854872

援助作者

借令你喜欢自身的干活,并且期待NanUI持续的进步,请对NanUI项目展开援助以此来慰勉和支撑笔者再三再四NanUI的花费专业。你能够选拔微信或者支付宝来围观上面包车型地铁二维码进行援助。

图片 2

本文由41668金沙发布于www.4166.com,转载请注明出处:NanUI文档 - 如何实现C#与Javascript的相互通信

您可能还会对下面的文章感兴趣: