Xamarin.Forms 開發(fā)過程中需要平臺特殊定制時可以同過Custom Renderer
實現(xiàn)拍柒。定義自己的Custom Renderer應(yīng)繼承ViewRenderer
類,ViewRenderer是一個泛型類借嗽。ViewRenderer單獨(dú)定義在不同平臺中柴底,Android平臺在Xamarin.Forms.Platform.Android
下,iOS平臺在Xamarin.Forms.Platform.iOS
下穷娱。ViewRenderer包含的兩個范型參數(shù)TView
和TNativeView
(UWP下為TElement和TNativeElement)谷市,TView對應(yīng)的是Xamarin.Forms中定義的視圖元素亡嫌,TNativeView則對應(yīng)的是平臺中定義的視圖元素嚎于。
通過Renderer自定義Label
借助Renderer實現(xiàn)下帶劃線、刪除線的Label挟冠。
Custom Renderer學(xué)習(xí)更多實例參靠:https://github.com/XLabs/Xamarin-Forms-Labs
在PCL項目中添加CustomLabel定義于购,如下:
public class CustomLabel:Label
{
public CustomLabel()
{
}
public static readonly BindableProperty IsUnderlineProperty =
BindableProperty.Create("IsUnderline",typeof(bool), typeof(CustomLabel), false);
public static readonly BindableProperty IsStrikeThroughProperty =
BindableProperty.Create("IsStrikeThrough", typeof(bool), typeof(CustomLabel), false);
public bool IsUnderline
{
get
{
return (bool)GetValue(IsUnderlineProperty);
}
set
{
SetValue(IsUnderlineProperty, value);
}
}
public bool IsStrikeThrough
{
get
{
return (bool)GetValue(IsStrikeThroughProperty);
}
set
{
SetValue(IsStrikeThroughProperty, value);
}
}
}
接下來就是在相應(yīng)的平臺定義Renderer。一定要為定義好的Renderer添加ExportRenderer
特性知染,ExportRenderer同Dependency特性一樣是程序集特性肋僧,需要標(biāo)記在命名空間塊之外。
When a Xamarin.Forms application starts up, Xamarin.Forms uses .NET reflection to search through the various assemblies that comprise the application, looking for assembly attributes named ExportRenderer. An ExportRenderer attribute indicates the presence of a custom renderer that can supply support for a Xamarin.Forms element.
本文示例會有如下特性定義在namespace上:
[assembly: ExportRenderer(typeof(renderer.CustomLabel), typeof(renderer.iOS.CustomLabelRenderer))]
繼承ViewRenderer的同時一定要重寫OnElementChanged
方法控淡。該方法的作用是創(chuàng)建平臺視圖元素嫌吠,會在CustomLabel初始化時調(diào)用。ViewRenderer定義了一個TNativeView類型屬性Control
掺炭,本示例中為UILabel辫诅。OnElementChanged第一次調(diào)用時Control屬性為null,應(yīng)該在OnElementChanged中初始化一個TNativeView元素竹伸,通過SetNativeControl
方法賦值給Control屬性泥栖。每一個Renderer實例都管理著一個平臺視圖對象(native object)即Control屬性。
ViewRenderer還定義了一個Element屬性勋篓,Element是我們定義的Xamarin.Forms元素儒旬,本示例中為CustomLabel類型芬为。
OnElementChanged方法傳入一個ElementChangedEventArgs
范型參數(shù),ElementChangedEventArgs<T>有兩個OldElement
和NewElement
屬性,類型由ElementChangedEventArgs傳入的T決定。如果NewElement不為null拴曲,NewElement與ViewRenderer的Element屬性表示同一對象,根據(jù)NewElement的屬性悼尾,為Control(Natice)設(shè)置相應(yīng)屬性。而OldElement屬性通常用作回收資源。
if (e.OldElement != null) {
// Unsubscribe from event handlers and cleanup any resources
}
if (e.NewElement != null) {
// Configure the native control and subscribe to event handlers
}
Android 自定義Renderer中OnElementChanged方法
CustomLabel中屬性定義為BindableProperty類型遭垛,當(dāng)BindableProperty類型屬性改變時會觸發(fā)PropertyChanged事件。Renderer對象同樣會接收到BindableProperty發(fā)生改變的通知調(diào)用OnElementPropertyChanged
方法操灿。在OnElementPropertyChanged方法中判斷e.PropertyName
的值锯仪,為Control對應(yīng)的原生視圖元素設(shè)置相應(yīng)屬性。
根據(jù)以上介紹寫出Android下自定義Renderer:
[assembly: ExportRenderer(typeof(renderer.CustomLabel), typeof(renderer.Droid.CustomLabelRenderer))]
namespace renderer.Droid
{
public class CustomLabelRenderer : ViewRenderer<CustomLabel, TextView>
{
public CustomLabelRenderer()
{
}
protected override void OnElementChanged(ElementChangedEventArgs<CustomLabel> e)
{
base.OnElementChanged(e);
if (Control == null)
{
SetNativeControl(new TextView(Context));
}
if (e.NewElement != null)
{
Control.Text = e.NewElement.Text;
if (e.NewElement.IsUnderline)
{
Control.PaintFlags = Control.PaintFlags | PaintFlags.UnderlineText;
}
if (e.NewElement.IsStrikeThrough)
{
Control.PaintFlags = Control.PaintFlags | PaintFlags.StrikeThruText;
}
}
}
protected override void OnElementPropertyChanged(object sender, System.ComponentModel.PropertyChangedEventArgs e)
{
base.OnElementPropertyChanged(sender, e);
if (e.PropertyName == CustomLabel.IsUnderlineProperty.PropertyName)
{
Control.PaintFlags = Control.PaintFlags | PaintFlags.UnderlineText;
}
else if (e.PropertyName == CustomLabel.IsStrikeThroughProperty.PropertyName)
{
Control.PaintFlags = Control.PaintFlags | PaintFlags.StrikeThruText;
}
else if (e.PropertyName == CustomLabel.TextProperty.PropertyName)
{
Control.Text = Element.Text;
}
}
}
}
iOS同理Android不再過多說明趾盐。iOS項目中自定義Renderer:
[assembly: ExportRenderer(typeof(renderer.CustomLabel), typeof(renderer.iOS.CustomLabelRenderer))]
namespace renderer.iOS
{
public class CustomLabelRenderer : ViewRenderer<CustomLabel, UILabel>
{
public CustomLabelRenderer()
{
}
protected override void OnElementChanged(ElementChangedEventArgs<CustomLabel> e)
{
base.OnElementChanged(e);
if (Control == null)
{
SetNativeControl(new UILabel());
}
if (e.NewElement != null)
{
InitView(e.NewElement);
}
}
protected override void OnElementPropertyChanged(object sender, System.ComponentModel.PropertyChangedEventArgs e)
{
base.OnElementPropertyChanged(sender, e);
if (e.PropertyName == CustomLabel.IsUnderlineProperty.PropertyName ||
e.PropertyName == CustomLabel.IsStrikeThroughProperty.PropertyName ||
e.PropertyName == CustomLabel.TextProperty.PropertyName)
{
InitView(Element);
}
}
private void InitView(CustomLabel element)
{
var underline = element.IsUnderline ? NSUnderlineStyle.Single : NSUnderlineStyle.None;
var strikethrough = element.IsStrikeThrough ? NSUnderlineStyle.Single : NSUnderlineStyle.None;
Control.AttributedText = new NSMutableAttributedString(element.Text,
Control.Font,
underlineStyle: underline,
strikethroughStyle: strikethrough);
}
}
}
XAML測試代碼庶喜,CustomLabel定義在項目內(nèi),所以直接用上文定義好的local命名空間:
Android 和iOS的運(yùn)行效果:
原本iOS和Android中很容易實現(xiàn)的功能救鲤,再Xamarin.Forms中卻變得有些復(fù)雜久窟。。本缠。斥扛。。,考慮開發(fā)成本和維護(hù)成本丹锹,這點痛算什么稀颁!三方庫支持完善起來時Xamarin.Forms開發(fā)應(yīng)該會比較樂觀吧。
Xamarin.Forms中的每個視圖(page, layout, view)都對應(yīng)一個原生視圖渲染卷仑,我們自定義時可以直接使用Xamarin.Forms提供的Renderer類峻村。
對應(yīng)關(guān)系查看:https://developer.xamarin.com/guides/xamarin-forms/custom-renderer/renderers/