NanUI for Winform 使用示例【第一集】——山寨个代码编辑器

NanUI for
Winform从前几日写博客宣布到现行得到了和多朋友的关怀,首先感谢大家的关切和支撑!请看前日我的博文《NanUI
for
Winform揭橥,让Winform界面设计有着极其可能
》。

有意中人问到我是或不是考虑开源NanUI,我想应对是毫无疑问的。可是最近来看NanUI内部还有局地题材并没有得到化解,因而暂时不会绽放源代码。待这几个题材顺遂解决将来我会第一时间把NanUI的源码放到GitHub,请稍等片刻。

那就是说,从今日起我会陆续放出部分NanUI使用的部分小示例和源代码供感兴趣的情西洋参考把玩。任何有关NanUI的问题欢迎我们进群(群号:241088256)或留言与自己互换。

上面,伊始前日的以身作则

NanUI for Winform 使用示例【第一集】

山寨个代码编辑器

C++ 1

二零一八年微软破天荒的揭破了个吊炸天的开源代码编辑器VS Code,观察VS
Code的目录结构可见,其实它也是依照CEF来进行开发的,使用的是名为electron的框架。那么,上边我将用NanUI山寨一个大约的Code编辑器完结对代码文件的新建、打开和封存操作,取名为NanUI代码编辑器。

NanUI代码编辑器使用的主旨技术有:

  • Bootstrap
  • CodeMirror
  • NanUI for Winform(我领会,那句话是废话)
  • 从离其他资源程序集加载资源

Bootstrap做响应式的页面吊炸天,就算大家今天要拓展的小示例用不到响应式布局,可是引用进来就当CSS
Clear用吗。别的一个CodeMirror作为网页端最强劲的代码编辑器,本次通过NanUI,大家的Winform也将分享它带动的强大效率。上边,我将分步讲解怎样来山寨那些代码编辑器。

在VS中新建Windows
Application项目(后边称为主项目),然后在项目->属性->调试中关闭“启动VS承载进程”选项,因为通过实践,开启该选用后无法加载嵌入的网页资源。同时,开启“启用本机代码调试选项”,因为ChromiumFX使用了PInvoke的办法调用,会有无数不僧不俗的非托管错误,例如,我后面就碰着个比方开动项目就报错的问题,开启了本机代码调试后意识是QQ拼音输入法钩子的题材,点个忽略继续就足以健康调试了。设置好后引用NanUI的库NetDimenison.NanUI.dll

C++ 2

 

再新建一个类库项目(后边称为资源类型),在其间建立文件夹www,文件夹名字没有须求,随意就好,但要强调一点,html文件不可以在类库项目标根目录下,必须树立个文本夹来放置网页文档。将bootstrap和codemirror的html、css和js文件等拷贝进www目录,当然你也可以直接从nuget上下载它们,只是必要把nuget得到的文书都拖到www里面,形成上面的文本结构。

C++ 3

删除掉用不着的公文,从种类中消除或直接删除都行,剩下的内需用的品种都在性能窗口中把转变操作改成“嵌入的资源”。然后新建个静态类,名字随便取,里面新建个格局来揭发资源类型的Assembly。

namespace NanUI.Demo.CodeEditor.Resources
{
    public static class SchemeHelper
    {
        public static System.Reflection.Assembly GetSchemeAssembley()
        {
            return System.Reflection.Assembly.GetExecutingAssembly();
        }
    }
}

新建那一个类的作用是方便主项目登记资源类型里面的程序集,假设用那种措施来注册资源文件要求在主项目中援引资源类型。其余一个措施,可以一向在主项目中直接行使Assembly.LoadFile加载资源类型,要是项目需求平日更新的话用那几个主意可以达成时时更新资源文件而不用重新安装整个软件,具体的用法会在明日的言传身教中介绍,在此就不多说了。

这么,资源类型就弄好了。接下来的行事都将在主项目上举行了。在主项目标main函数里伊始化NanUI。

namespace NanUI.Demo.CodeEditor
{
    using NetDimension.NanUI;

    static class Program
    {
        /// <summary>
        /// 应用程序的主入口点。
        /// </summary>
        [STAThread]
        static void Main()
        {
            Application.EnableVisualStyles();
            Application.SetCompatibleTextRenderingDefault(false);
            UIStartupManager.UseSharedFramework = true;
            if (UIStartupManager.InitializeChromium())
            {
                //初始化成功,加载程序集内嵌的资源到运行时中
                UIStartupManager.RegisterEmbeddedScheme(Resources.SchemeHelper.GetSchemeAssembley());



                //启动主窗体
                Application.Run(new EditorForm());
            }


        }
    }
}

里头,Resources.SchemeHelper.GetSchemeAssembley()方法就是从资源类型里面把Assembly加载过来。之后新建编辑器的主窗体EditorForm。EditorForm除了不难的安装外,需此外添加多少个方法来决定文件的新建、打开、保存等操作。

namespace NanUI.Demo.CodeEditor
{
    using NetDimension.NanUI;

    public partial class EditorForm : HtmlUIForm
    {

        internal bool isClean = true;
        internal bool isNew = true;

        internal string currentFilePath = string.Empty;


        public EditorForm()
            : base("embedded://www/main.html")
        {
            InitializeComponent();

            UI.GlobalObject.Add("hostEditor", new JsCodeEditorObject(this));
        }

        void SetEditorMode()
        {
            if (!string.IsNullOrEmpty(currentFilePath))
            {
                var fileInfo = new System.IO.FileInfo(currentFilePath);

                var ext = fileInfo.Extension;

                if (ext.IndexOf('.') == 0)
                {
                    ext = ext.Substring(1);
                    UI.ExecuteJavascript($"CodeEditor.changeCodeScheme('{ext}');");
                }
            }
        }

        //设置编辑器标题逻辑
        void SetEditorTitle()
        {
            if (isNew || string.IsNullOrEmpty(currentFilePath))
            {
                UI.ExecuteJavascript($"CodeEditor.setTitle('新建');");
            }
            else
            {
                var fileInfo = new System.IO.FileInfo(currentFilePath);
                UI.ExecuteJavascript($"CodeEditor.setTitle('{fileInfo.Name}');");
            }
        }
        //保存文件逻辑
        internal bool SaveFile()
        {
            var result = false;
            UI.EvaluateJavascript(@"CodeEditor.getContent()", (value, ex) =>
            {
                if (ex == null)
                {
                    var content = value.IsString ? value.StringValue : null;

                    if (content != null)
                    {

                        if (isNew)
                        {
                            var saveFileDialog = new SaveFileDialog()
                            {
                                AddExtension = true,
                                Filter = "支持的文件|*.txt;*.js;*.cs;*.html;*.htm;*.css;*.h;*.cpp;*.php;*.xml;*.vb",
                                OverwritePrompt = true
                            };
                            if (saveFileDialog.ShowDialog(this) == DialogResult.OK)
                            {
                                currentFilePath = saveFileDialog.FileName;
                                result = true;

                            }
                        }

                        if (result)
                        {
                            System.IO.File.WriteAllText(currentFilePath, content, Encoding.UTF8);
                            isClean = true;
                            SetEditorMode();
                            SetEditorTitle();
                        }



                    }
                }
            });

            return result;
        }
        //新建文件逻辑
        internal void NewFile()
        {
            var continueFlag = true;

            if (!isClean)
            {
                var ret = MessageBox.Show(this, "文件已经更改,是否保存下先?", "提示", MessageBoxButtons.YesNoCancel, MessageBoxIcon.Question);

                if (ret == DialogResult.Yes)
                {
                    if (!SaveFile())
                    {
                        continueFlag = false;
                    }
                }
                else if (ret == DialogResult.Cancel)
                {
                    return;
                }
            }

            if (!continueFlag)
            {
                return;
            }

            isNew = true;
            isClean = true;


            UI.ExecuteJavascript(@"CodeEditor.setNew()");
            SetEditorTitle();



        }
        //打开文件逻辑
        internal string OpenFile()
        {
            var continueFlag = true;

            if (!isClean)
            {
                var ret = MessageBox.Show(this, "文件已经更改,是否保存下先?", "提示", MessageBoxButtons.YesNoCancel, MessageBoxIcon.Question);

                if (ret == DialogResult.Yes)
                {
                    if (!SaveFile())
                    {
                        continueFlag = false;
                    }
                }
                else if (ret == DialogResult.Cancel)
                {
                    return null;
                }
            }

            if (!continueFlag)
            {
                return null;
            }

            var content = string.Empty;

            var openDialog = new OpenFileDialog()
            {
                AddExtension = true,
                Filter = "支持的文件|*.txt;*.js;*.cs;*.html;*.htm;*.css;*.h;*.cpp;*.php;*.xml;*.vb"
            };

            if (openDialog.ShowDialog() == DialogResult.OK)
            {
                currentFilePath = openDialog.FileName;

                var fileInfo = new System.IO.FileInfo(currentFilePath);

                content = System.IO.File.ReadAllText(fileInfo.FullName);

                isNew = false;

                SetEditorMode();
                SetEditorTitle();
            }
            else
            {
                content = null;
            }

            return content;
        }
    }
}

 

上面重点来了,以下内容将涉及C#操作网页内JS代码以及JS调用C#的主意等等,焦点就是当中对象JsCodeEditorObject。该对象继承自ChromiumFX的JSObject对象,对JS有打探的爱侣不会对JS的Object对象感到陌生,那里的JSObject对象和JS的Object对象实际很一般,也是含有了数额和方法的一个会师。如下所示,在其中注册了多少个Function,那一个Function都是可以被网页端js调用的。

namespace NanUI.Demo.CodeEditor
{
    using Chromium.Remote;
    using NetDimension.NanUI;

    class JsCodeEditorObject : JSObject
    {

        EditorForm parentForm;

        internal JsCodeEditorObject(EditorForm parentForm)
        {
            this.parentForm = parentForm;

            AddFunction("newFile").Execute += JsCodeEditorObject_ExecuteNew;

            AddFunction("openFile").Execute += JsCodeEditorObject_ExecuteOpen;

            AddFunction("saveFile").Execute += JsCodeEditorObject_ExecuteSave;

            AddFunction("setClean").Execute += JsCodeEditorObject_ExecuteSetClean;
        }





        private void JsCodeEditorObject_ExecuteSetClean(object sender, Chromium.Remote.Event.CfrV8HandlerExecuteEventArgs e)
        {
            if (e.Arguments.Length > 0)
            {

                parentForm.isClean = e.Arguments.First(p => p.IsBool).BoolValue;
            }
        }

        private void JsCodeEditorObject_ExecuteSave(object sender, Chromium.Remote.Event.CfrV8HandlerExecuteEventArgs e)
        {
            var result  = parentForm.SaveFile();

            e.SetReturnValue(CfrV8Value.CreateBool(result));

        }

        private void JsCodeEditorObject_ExecuteOpen(object sender, Chromium.Remote.Event.CfrV8HandlerExecuteEventArgs e)
        {
            var result = parentForm.OpenFile();

            if (result != null)
            {
                e.SetReturnValue(CfrV8Value.CreateString(result));

            }
            else
            {
                e.SetReturnValue(CfrV8Value.CreateNull());
            }
        }

        private void JsCodeEditorObject_ExecuteNew(object sender, Chromium.Remote.Event.CfrV8HandlerExecuteEventArgs e)
        {
            parentForm.NewFile();
        }
    }
}

如下面代码中所显示的,那么些类注册了newFile, openFile,
saveFile和setClean多少个章程供网页端js调用。再折回来地点EditorForm的代码,有这么一行:

UI.GlobalObject.Add("hostEditor", new JsCodeEditorObject(this));

那行代码的左右就是将大家的中级对象JsCodeEditorObject实例化后传到浏览器的JS环境中,并且取了个新名字叫做“hostEditor”,那样,大家就可见在网页环境中用js执行下边的多少个措施了。

  • hostEditor.newFile
  • C++,hostEditor.openFile
  • hostEditor.saveFile
  • hostEditor.setClean

当网页端js调用地点那些方法的时候其实会举办到EditorForm中相应的操作逻辑,如此就兑现了js与c#环境的互动。C#与js环境相互与之相比较要简单得多,例如EdiorForm中的SetEditorTitle方法中,通过UI.ExecuteJavascript方法就可以实施web环境中的js代码或形式。

UI.ExecuteJavascript($"CodeEditor.setTitle('新建');");

如上那行代码,调用了js的章程CodeEditor.setTitle来设置编辑器的标题。那么,倘若须求实践js代码并赶回相应代码,就得利用UI.伊娃(Eva)luateJavascript方法。该措施首个参数为js代码,首个参数为履行js代码后的回调,它是一个有四个参数的action对象,首个参数为回调的再次回到值,第三个参数是exception对象,即便js代码有问题,那么第三个对象exception就包括了错误音讯,正确履行时,excepiton对象回来null。

UI.EvaluateJavascript(@"CodeEditor.getContent()", (value, ex) =>
{
    if (ex == null)
    {
        var content = value.IsString ? value.StringValue : null; //value对象是CfrV8Value对象,内置了各种数据转换的方法。

        //其他逻辑
    }
});

 

有了地点的代码要点,我们应该早就清楚C#和JS之间的竞相格局和JS于C#以内的相互的法子了。一句话来说,C#与NanUI的js交互,无再次回到值的用UI.ExecuteJavascript方法,有重回值的用UI.伊娃luateJavascript。除了那多个措施外,可以用UI.AddFunction方法来直接在js环境中注册C#的格局,方法大家自行钻研在此不再演讲。假使js须求与C#里面的相互,通过编制继承JSObject的中等对象注册形式或数量对象,即可兑现。

那么,NanUI的言传身教第一集就这么讲完了,若是不知底请留言给我或进群(群号:241088256)互换,感谢大家关怀。

 


NanUI for .NET Winform种类目录


经过了那么些多星期的调动与修补,NanUI for .NET
Winform的稳定版已经揭发。应广大群友的渴求,现已将NanUI的满贯代码开源。

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

Release: https://github.com/NetDimension/NanUI/releases


 

 如果您欣赏NanUI项目,你可以参与到NanUI的开发中来,当然你也可以更直接了当的扶助自己的劳作,使用支付宝或微信扫描下边二维码请我喝一杯热腾腾的咖啡。

C++ 4

支付宝转账

C++ 5

微信转载


 

除此以外,打个广告,承接NanUI界面设计与接口开发(收费)。

案例呈现

某聊天应用

C++ 6

某商厦里面办公室系统

C++ 7

C++ 8