如何在Xamarin.Form中使用原生控件

Xamarin.Forms提供了一種跨平臺的開發手段,使我們用一套代碼就可以運行在不同的平臺上。但Xamarin.Forms所提供的基本控件比較有限,一些比較復雜的效果不好實現,這時我們也許會想,如果可以在Xamarin.Forms上使用原生的控件就好了。那么,Xamarin.Forms可以這么做嗎?答案當然是可以啦,難道我是吃飽了撐來寫這篇文章嗎?

這里我以歲寒輸入法開發中的一個需求為例:歲寒輸入法是支持主題功能的,我需要在主程序中實現對主題包效果的展示和切換的功能。在這里交代一下,iOS版的歲寒輸入法是由Xamarin.iOS和Xamarin.Forms聯合開發的,其中主程序的部分用的是Xamarin.Forms,鍵盤的部分是用Xamarin.iOS。輸入法的主題,自然也就是鍵盤的主題,因此主題包的顯示是與原生控件緊密關聯的。如果我不能在Xamarin.Forms上調用原生的鍵盤控件,那我就只能基于Xamarin.Forms把主題功能重做一遍,那就真是完犢子了。幸好Xamarin.Forms提供了ViewRenderer類,我可以用這個類在Xamarin.Forms中實現對原生控件的渲染。

第一步

我在Form項目中新建一個類,取名叫BoardView,是Xamarin.Forms.View的子類,并聲明了一個可綁定的Theme屬性。
代碼如下:

using System;
using Xamarin.Forms;
using System.Diagnostics;
namespace SuiHanIME {
    public class BoardView : View {

        public static readonly BindableProperty ThemeProperty = BindableProperty.Create(
                                                                                        "Theme",
                                                                                         typeof(IThemePath),
                                                                                         typeof(BoardView),
                                                                                         defaultBindingMode: BindingMode.TwoWay



);



        public IThemePath Theme {
            get {
                return (IThemePath)GetValue(ThemeProperty);
            }
            set {
                SetValue(ThemeProperty, value);
            }
        }


        public BoardView() {

        }

    }
}

這里,IThemePath是我自己定義的用于查找主題文件的接口,其具體細節這里不做贅述。如何實現一個可綁定的屬性,可參閱我的另一篇文章Xamarin.From中的Data binding(數據綁定)(一)

注意,這里BoardView必須聲明為public,因為我們屆時要在iOS項目和Android項目中訪問這個類。

可以看到,BoardView中其實基本是空的,而這個時候我們已經可以在Form項目中使用它了,在代碼中使用也行,在XAML使用也行。

我用的是XAML;

<?xml version="1.0" encoding="UTF-8"?>
<ContentPage
    xmlns="http://xamarin.com/schemas/2014/forms"
    xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
    xmlns:local="clr-namespace:SuiHanIME"
    x:Class="SuiHanIME.SelfDefindUIPage">
    ......
                <local:BoardView
                    Margin="25,0,25,0"
                    x:Name="board"
                    HeightRequest="200"
                    HorizontalOptions="FillAndExpand" />
    ......
</ContentPage>

xmlns:local="clr-namespace:SuiHanIME"的聲明是必須的,這樣IDE才能找到BoardView所在的位置。

不過這個時候,如果我們運行程序的話,會發現BoardView是空的。它這會兒當然是空的,因為我們還沒有將鍵盤通過ViewRenderer渲染到BoardView上。

第二步

我們要建立BoardView與鍵盤界面的關系,這里以iOS平臺為例。

我先在iOS項目下新建一個BoardViewRender,是ViewRenderer<TView,TNativeView>的子類,并重寫他的OnElementChanged方法。

代碼如下:

using Xamarin.Forms.Platform.iOS;
using UIKit;
using Xamarin.Forms;
using SuiHanIME.iOS;
using IOSLib;
using System.Diagnostics;
using Masonry;

[assembly: ExportRenderer(typeof(SuiHanIME.BoardView), typeof(BoardViewRender))]
namespace SuiHanIME.iOS {
    public class BoardViewRender : ViewRenderer<SuiHanIME.BoardView, UIView> {
        iOS_IME_CoreHandler handler = new iOS_IME_CoreHandler();
        public BoardViewRender() {
        }

        protected override void OnElementChanged(ElementChangedEventArgs<BoardView> e) {
            base.OnElementChanged(e);

            if (this.Control == null) {
                var holdView = handler.HoldView;
                holdView.UserInteractionEnabled = false;
                SetNativeControl(holdView);
                handler.setTheme(Element.Theme);    
            }
        }
        ......
}

iOS_IME_CoreHandler是我用于生成鍵盤的類,這里我們只需知道它的HoldView屬性會返回裝有鍵盤的UIView,setTheme方法用于設置新的主題。

我們現在回過頭再看代碼的開頭,我們需要在命名空間SuiHanIME.iOS之上寫上[assembly: ExportRenderer(typeof(SuiHanIME.BoardView), typeof(BoardViewRender))]

由于上述代碼在SuiHanIME.iOS空間之外引用了BoardViewRender,所以我們得using SuiHanIME.iOS;或者使用[assembly: ExportRenderer(typeof(SuiHanIME.BoardView), typeof(SuiHanIME.iOS.BoardViewRender))]

ExportRenderer聲明了BoardView類的渲染可由一個BoardViewRender類型的對象支持。

ViewRenderer<TView,TNativeView>是一個泛型類,兩個泛型參數,顧名思義的,TView是指Form項目下的控件的類型,TNativeView是指原生的控件的類型;
當然,他們要滿足一定的約束:


這也就是為什么BoardView得是Xamarin.Forms.View的子類。

這里,我對BoardViewRender的聲明為public class BoardViewRender : ViewRenderer<SuiHanIME.BoardView, UIView>,其中BoardViewRender也必須聲明為public,因為在運行時,Xamarin.Forms也需要訪問這個類。這句話的意思就是:將SuiHanIME.BoardView作為一個UIView進行渲染。

接下來的事情是實現原生控件與Forms控件關聯的關鍵:在OnElementChanged方法中通過SetNativeControl方法設置原生控件。

protected override void OnElementChanged(ElementChangedEventArgs<BoardView> e) {
            base.OnElementChanged(e);

            if (this.Control == null) {
                var holdView = handler.HoldView;
                holdView.UserInteractionEnabled = false;
                SetNativeControl(holdView);
                handler.setTheme(Element.Theme);    
            }
        }

在運行過程中,OnElementChanged被第一次調用時,this.Control必然為null,我們必須在這時通過SetNativeControl設置好原生控件。

檢查this.Control是否為null是必須的,這是為了避免設置原生控件。

handler.setTheme(Element.Theme);是我初始化鍵盤主題的操作。

第三步

這會兒如果我們運行程序的話,就可以在Forms中看見原生控件的效果了,但,橋都馬代!我們還沒有設置與之交互的方法呢。

這里,我需要動態地改變鍵盤的主題,比如在Forms使用如下代碼切換主題:

board.Theme = themePath;

Theme就是我在最前面聲明的那個可綁定屬性。

為了將這個動作傳遞給原生控件,我需要重寫BoardViewRender的OnElementPropertyChanged:

protected override void OnElementPropertyChanged(object sender, System.ComponentModel.PropertyChangedEventArgs e) {
    base.OnElementPropertyChanged(sender, e);
    if (e.PropertyName.Equals(BoardView.ThemeProperty.PropertyName)) {
        handler.setTheme(Element.Theme);
    }
}

可以想見,如果Theme被定義普通的CLR屬性的話,是不會觸發這個方法的。

最后

我們一起看一下效果:

原生鍵盤的效果
在Forms中的顯示效果

這兩處使用的原生控件是完全一樣的,我也因此避免了用Forms重新做一次輪子的命運。

Android平臺上的實現與iOS基本上別無二致,但是由于我還沒有寫出代碼,這里就暫時不講。但是只要我把Android平臺上的鍵盤原生控件做好,剩下的事情就是編寫一個Android項目下的BoardViewRender類而已,Forms項目中的代碼不需要做絲毫的改動。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,622評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,716評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,746評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,991評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,706評論 6 413
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 56,036評論 1 329
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,029評論 3 450
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,203評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,725評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,451評論 3 361
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,677評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,161評論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,857評論 3 351
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,266評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,606評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,407評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,643評論 2 380

推薦閱讀更多精彩內容