BindableProperty.Fody 0.1.3

Xamarin.BindableProperty.Fody

An assembly weaver, based on Fody, that automatically transforms plain auto-implemented properties into BindableProperties that can be used in Xamarin Forms.

Installation

Add this nuget package to your project. Then, add a file called FodyWeavers.xml in your project root (build action must be set to Content), and write the following inside:

<?xml version="1.0" encoding="utf-8"?>
<Weavers>
    <BindableProperty />
</Weavers>

See the Fody documentation for more info on the FodyWeavers.xml file.

Usage

Just decorate an auto-implemented get/set property with the Bindable attribute.

For example, this:

public class MyButton : Xamarin.Forms.Button
{
    [Bindable]
    public string FontFamily { get; set; }
}

will become like this:

public class MyButton : Xamarin.Forms.Button
{
    public static readonly BindableProperty FontFamilyProperty = BindableProperty.Create(nameof(FontFamily), typeof(string), typeof(Button), null, null);
    public string FontFamily { get { return (string)GetValue(FontFamilyProperty); } set { SetValue(FontFamilyProperty, value); } }
}

The public static readonly XxxProperty is automatically generated if not present. The getter and setter methods are automatically implemented with GetValue(...) and SetValue(...) methods, respectively. The Bindable attribute is removed from the resulting dll.

If you want some piece of code to be called whenever the property value changes, simply add a void OnXxxChanged method, where Xxx is the name of the property. It will be registered on the ValueChanged delegate in the BindableProperty.Create method:

public class MyButton : Xamarin.Forms.Button
{
    [Bindable]
    public string FontFamily { get; set; }
    
    private void OnFontFamilyChanged(string newValue) { 
        //do stuff here
        Console.WriteLine("Property value is changed");
    }
}

The OnXxxChanged method must have only one parameter (whose type must match the type of the property) that will contain the new value. The OnXxxChanged method can be private or public as well.