M.BindableProperty.Generator 0.11.1

dotnet add package M.BindableProperty.Generator --version 0.11.1

NuGet\Install-Package M.BindableProperty.Generator -Version 0.11.1

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="M.BindableProperty.Generator" Version="0.11.1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add M.BindableProperty.Generator --version 0.11.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: M.BindableProperty.Generator, 0.11.1"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install M.BindableProperty.Generator as a Cake Addin
#addin nuget:?package=M.BindableProperty.Generator&version=0.11.1

// Install M.BindableProperty.Generator as a Cake Tool
#tool nuget:?package=M.BindableProperty.Generator&version=0.11.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

last commit

Maui.BindableProperty.Generator

Source generator that automatically transforms fields into BindableProperties that can be used in MAUI.
Are you looking for the Xamarin project? check this link

Installation

First, install NuGet. Then, install M.BindableProperty.Generator from the package manager console:

PM> Install-Package M.BindableProperty.Generator

Usage - Simple implementation

Just decorate the field with the Bindable attribute.

    using Maui.BindableProperty.Generator.Core;

    public partial class HeaderControl : ContentView
    {
        [AutoBindable]
        private readonly string _placeholder;
    }

the prevoius code will generate this:

    public partial class HeaderControl
    {
        public static readonly Microsoft.Maui.Controls.BindableProperty PlaceholderProperty =
                                        Microsoft.Maui.Controls.BindableProperty.Create(
                                                                nameof(Placeholder),
                                                                typeof(string),
                                                                typeof(HeaderControl),
                                                                defaultValue: default(string),
                                                                propertyChanged: __PlaceholderChanged,
                                                                propertyChanging: __PlaceholderChanging);

        public string Placeholder
        {
            get => (string)GetValue(PlaceholderProperty);
            set => SetValue(PlaceholderProperty, value);
        }

        private static void __PlaceholderChanged(Microsoft.Maui.Controls.BindableObject bindable, object oldValue, object newValue)
        {
            var ctrl = (HeaderControl)bindable;
            ctrl.OnPlaceholderChanged((string)newValue);
        }

        partial void OnPlaceholderChanged(string value);

        private static void __PlaceholderChanging(Microsoft.Maui.Controls.BindableObject bindable, object oldValue, object newValue)
        {
            var ctrl = (HeaderControl)bindable;
            ctrl.OnPlaceholderChanging((string)newValue);
        }

        partial void OnPlaceholderChanging(string value);
    }

Options

Option	Description	Type
`PropertyName`	Specifies the prefix used to create the BindableProperty, if `PropertyName` is null, then will take the name of the field removing the underscores and using PascalCase. Example: `_tex_t` will be transformed to `Text`.	`string`
`OnChanged`	Specifies the name of the method to be executed when the property changes, if not specified, will generate a partial method that will be notified when the property changed.	`string`
`OnChanging`	Specifies the name of the method to be executed when the property is changing, if not specified, will generate a partial method that will be notified when the property is changing.	`string`
`DefaultValue`	Specifies the "text/value" that will be used as default. Example: `default(string)`	`string`
`DefaultBindingMode`	Specifies the "BindingMode" as string that will be used as default. Options: `Default/TwoWay/OneWay/OneWayToSource/OneTime`. Example: `nameof(BindingMode.TwoWay)`	`string`
`HidesUnderlyingProperty`	Specifies if the BindingProperty will hide the current implementation.	`bool`
`ValidateValue`	Specifies the name of the method to be executed to validate the values.	`string`
`PropertyAccessibility`	Specifies the property accessibility, if no parameter is specified, what is defined in the class will be used, Options: `Private/ProtectedAndInternal/Protected/Internal/ProtectedOrInternal/Public`. Example: `BindablePropertyAccessibility.ProtectedOrInternal`	`BindablePropertyAccessibility`

Usage - PropertyName

Just decorate the field with the Bindable attribute.

    using Maui.BindableProperty.Generator.Core;

    public partial class HeaderControl : ContentView
    {
        [AutoBindable(PropertyName = "LastName")]
        private readonly? string _l;
    }

the prevoius code will generate this:

    public partial class HeaderControl
    {
        public static readonly Microsoft.Maui.Controls.BindableProperty LastNameProperty =
                                        Microsoft.Maui.Controls.BindableProperty.Create(
                                                                nameof(LastName),
                                                                typeof(string),
                                                                typeof(HeaderControl),
                                                                defaultValue: default(string?),
                                                                propertyChanged: __LastNameChanged,
                                                                propertyChanging: __LastNameChanging);

        public string? LastName
        {
            get => (string?)GetValue(LastNameProperty);
            set => SetValue(LastNameProperty, value);
        }

        ... 
    }

Usage - OnChanged

Example 1 - No Parameters

Just decorate the field with the Bindable attribute.

    using Maui.BindableProperty.Generator.Core;

    public partial class HeaderControl : ContentView
    {
        [AutoBindable(OnChanged = nameof(UpdateDisplayName))]
        private readonly string _firstName;

        private void UpdateDisplayName()
        { 
            // Do stuff here
        }
    }

the prevoius code will generate this:

    public partial class HeaderControl
    {
        public static readonly Microsoft.Maui.Controls.BindableProperty FirstNameProperty =
                                        Microsoft.Maui.Controls.BindableProperty.Create(
                                                                nameof(FirstName),
                                                                typeof(string),
                                                                typeof(HeaderControl),
                                                                defaultValue: default(string),
                                                                propertyChanged: __FirstNameChanged,
                                                                propertyChanging: __FirstNameChanging);

        public string FirstName
        {
            get => (string)GetValue(FirstNameProperty);
            set => SetValue(FirstNameProperty, value);
        }

        private static void __FirstNameChanged(Microsoft.Maui.Controls.BindableObject bindable, object oldValue, object newValue)
        {
            var ctrl = (HeaderControl)bindable;
            ctrl.UpdateDisplayName();
        }

        ...
    }

Example 2 - One Parameter

Just decorate the field with the Bindable attribute. The 'UpdateDisplayName' method must have only one parameter (must match the type of the field)

    using Maui.BindableProperty.Generator.Core;

    public partial class HeaderControl : ContentView
    {
        [AutoBindable(OnChanged = nameof(UpdateDisplayName))]
        private readonly string _firstName;

        private void UpdateDisplayName(string newValue)
        { 
            // Do stuff here
        }
    }

the prevoius code will generate this:

    public partial class HeaderControl
    {
        public static readonly Microsoft.Maui.Controls.BindableProperty FirstNameProperty =
                                        Microsoft.Maui.Controls.BindableProperty.Create(
                                                                nameof(FirstName),
                                                                typeof(string),
                                                                typeof(HeaderControl),
                                                                defaultValue: default(string),
                                                                propertyChanged: __FirstNameChanged,
                                                                propertyChanging: __FirstNameChanging);

        public string FirstName
        {
            get => (string)GetValue(FirstNameProperty);
            set => SetValue(FirstNameProperty, value);
        }

        private static void __FirstNameChanged(Microsoft.Maui.Controls.BindableObject bindable, object oldValue, object newValue)
        {
            var ctrl = (HeaderControl)bindable;
            ctrl.UpdateDisplayName((string)newValue);
        }

        ...
    }

Example 3 - Two Parameters

Just decorate the field with the Bindable attribute. The 'UpdateDisplayName' method must have two parameters (must match the type of the field)

    using Maui.BindableProperty.Generator.Core;

    public partial class HeaderControl : ContentView
    {
        [AutoBindable(OnChanged = nameof(UpdateDisplayName))]
        private readonly string _firstName;

        private void UpdateDisplayName(string oldValue, string newValue)
        { 
            // Do stuff here
        }
    }

the prevoius code will generate this:

    public partial class HeaderControl
    {
        public static readonly Microsoft.Maui.Controls.BindableProperty FirstNameProperty =
                                        Microsoft.Maui.Controls.BindableProperty.Create(
                                                                nameof(FirstName),
                                                                typeof(string),
                                                                typeof(HeaderControl),
                                                                defaultValue: default(string),
                                                                propertyChanged: __FirstNameChanged,
                                                                propertyChanging: __FirstNameChanging);

        public string FirstName
        {
            get => (string)GetValue(FirstNameProperty);
            set => SetValue(FirstNameProperty, value);
        }

        private static void __FirstNameChanged(Microsoft.Maui.Controls.BindableObject bindable, object oldValue, object newValue)
        {
            var ctrl = (HeaderControl)bindable;
            ctrl.UpdateDisplayName((string)oldValue, (string)newValue);
        }

        ...
    }

Example 4 - Partial method

Just decorate the field with the Bindable attribute and by default will generated a partial method

    using Maui.BindableProperty.Generator.Core;

    public partial class HeaderControl : ContentView
    {
        [AutoBindable()]
        private readonly string _firstName;

        partial void OnFirstNameChanged(string value)
        {
            // Do stuff here
        }
    }

the prevoius code will generate this:

    public partial class HeaderControl
    {
        public static readonly Microsoft.Maui.Controls.BindableProperty FirstNameProperty =
                                        Microsoft.Maui.Controls.BindableProperty.Create(
                                                                nameof(FirstName),
                                                                typeof(string),
                                                                typeof(HeaderControl),
                                                                defaultValue: default(string),
                                                                propertyChanged: __FirstNameChanged,
                                                                propertyChanging: __FirstNameChanging);

        public string FirstName
        {
            get => (string)GetValue(FirstNameProperty);
            set => SetValue(FirstNameProperty, value);
        }

        private static void __FirstNameChanged(Microsoft.Maui.Controls.BindableObject bindable, object oldValue, object newValue)
        {
            var ctrl = (HeaderControl)bindable;
            ctrl.OnFirstNameChanged((string)newValue);
        }

        partial void OnFirstNameChanged(string value);

        ...
    }

Usage - OnChanging

Example 1

Just decorate the field with the Bindable attribute.

    using Maui.BindableProperty.Generator.Core;

    public partial class HeaderControl : ContentView
    {
        [AutoBindable(OnChanging = nameof(UpdateDisplayNameBeforeChange))]
        private readonly string _firstName = string.Empty;

        private void UpdateDisplayNameBeforeChange()
        {
            // Do stuff here
        }
    }

the prevoius code will generate this:

    public partial class HeaderControl
    {
        public static readonly Microsoft.Maui.Controls.BindableProperty FirstNameProperty =
                                        Microsoft.Maui.Controls.BindableProperty.Create(
                                                                nameof(FirstName),
                                                                typeof(string),
                                                                typeof(HeaderControl),
                                                                defaultValue: default(string),
                                                                propertyChanged: __FirstNameChanged,
                                                                propertyChanging: __FirstNameChanging);

        public string FirstName
        {
            get => (string)GetValue(FirstNameProperty);
            set => SetValue(FirstNameProperty, value);
        }

        ...

        private static void __FirstNameChanging(Microsoft.Maui.Controls.BindableObject bindable, object oldValue, object newValue)
        {
            var ctrl = (HeaderControl)bindable;
            ctrl.UpdateDisplayNameBeforeChange();
        }

        ...
    }

Example 2 - Partial method

Just decorate the field with the Bindable attribute.

    using Maui.BindableProperty.Generator.Core;

    public partial class HeaderControl : ContentView
    {
        [AutoBindable()]
        private readonly string _firstName = string.Empty;

        partial void OnFirstNameChanging(string value)
        {
            // Do stuff here
        }
    }

the prevoius code will generate this:

    public partial class HeaderControl
    {
        public static readonly Microsoft.Maui.Controls.BindableProperty FirstNameProperty =
                                        Microsoft.Maui.Controls.BindableProperty.Create(
                                                                nameof(FirstName),
                                                                typeof(string),
                                                                typeof(HeaderControl),
                                                                defaultValue: default(string),
                                                                propertyChanged: __FirstNameChanged,
                                                                propertyChanging: __FirstNameChanging);

        public string FirstName
        {
            get => (string)GetValue(FirstNameProperty);
            set => SetValue(FirstNameProperty, value);
        }

        ...
        
        private static void __FirstNameChanging(Microsoft.Maui.Controls.BindableObject bindable, object oldValue, object newValue)
        {
            var ctrl = (HeaderControl)bindable;
            ctrl.OnFirstNameChanging((string)newValue);
        }

        partial void OnFirstNameChanging(string value);

        ...
    }

Usage - DefaultValue

Example 1 - DateTime

Just decorate the field with the Bindable attribute and add the "text/value" that you want to use as default value.

    using Maui.BindableProperty.Generator.Core;

    public partial class HeaderControl : ContentView
    {
        [AutoBindable(DefaultValue = "DateTime.Now")]
        private readonly DateTime _birthDate;
    }

the prevoius code will generate this:

    public partial class HeaderControl
    {
        public static readonly Microsoft.Maui.Controls.BindableProperty BirthDateProperty =
                                        Microsoft.Maui.Controls.BindableProperty.Create(
                                                                nameof(BirthDate),
                                                                typeof(DateTime?),
                                                                typeof(HeaderControl),
                                                                defaultValue: DateTime.Now,
                                                                propertyChanged: __BirthDateChanged,
                                                                propertyChanging: __BirthDateChanging);

        public System.DateTime BirthDate
        {
            get => (System.DateTime)GetValue(BirthDateProperty);
            set => SetValue(BirthDateProperty, value);
        }
        
        ...
    }

Example 2 - String

Just decorate the field with the Bindable attribute and add the "text/value" that you want to use as default value.

    using Maui.BindableProperty.Generator.Core;

    public partial class HeaderControl : ContentView
    {
        [AutoBindable(DefaultValue = "USA")]
        private readonly string _country;
    }

the prevoius code will generate this:

    public partial class HeaderControl
    {
        public static readonly Microsoft.Maui.Controls.BindableProperty CountryProperty =
                                        Microsoft.Maui.Controls.BindableProperty.Create(
                                                                nameof(Country),
                                                                typeof(string),
                                                                typeof(HeaderControl),
                                                                defaultValue: "USA",
                                                                propertyChanged: __CountryChanged,
                                                                propertyChanging: __CountryChanging);

        public string Country
        {
            get => (string)GetValue(CountryProperty);
            set => SetValue(CountryProperty, value);
        }

        ...
    }

Usage - DefaultBindingMode

Just decorate the field with the Bindable attribute and add the "BindingMode" that you want to use as default value.

    using Maui.BindableProperty.Generator.Core;

    public partial class HeaderControl : ContentView
    {
        [AutoBindable(DefaultBindingMode = nameof(BindingMode.TwoWay))]
        private readonly string _firstName;
    }

the prevoius code will generate this:

    public partial class HeaderControl
    {
        public static readonly Microsoft.Maui.Controls.BindableProperty FirstNameProperty =
                                        Microsoft.Maui.Controls.BindableProperty.Create(
                                                                nameof(FirstName),
                                                                typeof(string),
                                                                typeof(HeaderControl),
                                                                defaultValue: default(string),
                                                                propertyChanged: __FirstNameChanged,
                                                                propertyChanging: __FirstNameChanging,
                                                                defaultBindingMode: Microsoft.Maui.Controls.BindingMode.TwoWay);

        public string FirstName
        {
            get => (string)GetValue(FirstNameProperty);
            set => SetValue(FirstNameProperty, value);
        }

        ...
    }

Usage - HidesUnderlyingProperty

Just decorate the field with the Bindable attribute and set "HidesUnderlyingProperty = true".

    using Maui.BindableProperty.Generator.Core;

    public partial class HeaderControl : ContentView
    {
        [AutoBindable(HidesUnderlyingProperty = true, DefaultValue = "Color.FromArgb(\"#cc3340\")")]
        private readonly Color? _backgroundColor;
    }

the prevoius code will generate this:

    public partial class HeaderControl
    {
        public static new readonly Microsoft.Maui.Controls.BindableProperty BackgroundColorProperty =
                                        Microsoft.Maui.Controls.BindableProperty.Create(
                                                                nameof(BackgroundColor),
                                                                typeof(Color?),
                                                                typeof(HeaderControl),
                                                                defaultValue: Color.FromArgb("#cc3340"),
                                                                propertyChanged: __BackgroundColorChanged,
                                                                propertyChanging: __BackgroundColorChanging);

        public new Color? BackgroundColor
        {
            get => (Color?)GetValue(BackgroundColorProperty);
            set => SetValue(BackgroundColorProperty, value);
        }

        ...
    }

Usage - ValidateValue

Example 1 - Non-Static Method

Just decorate the field with the Bindable attribute. The 'ValidateNotNull' method must have two parameters (one of type BindableObject and the second one must be the same as the field)

    using Maui.BindableProperty.Generator.Core;

    public partial class HeaderControl : ContentView
    {
        [AutoBindable(ValidateValue = nameof(ValidateIsNullOrEmpty))]
        private readonly string? _country;

        private bool ValidateIsNullOrEmpty(BindableObject _, string? value)
        {
            // Do stuff here
            return !string.IsNullOrEmpty(value);
        }
    }

the prevoius code will generate this:

    public partial class HeaderControl
    {
        public static readonly Microsoft.Maui.Controls.BindableProperty CountryProperty =
                                        Microsoft.Maui.Controls.BindableProperty.Create(
                                                                nameof(Country),
                                                                typeof(string),
                                                                typeof(HeaderControl),
                                                                defaultValue: default(string?),
                                                                propertyChanged: __CountryChanged,
                                                                propertyChanging: __CountryChanging,
                                                                validateValue: __ValidateIsNullOrEmpty);

        public string? Country
        {
            get => (string?)GetValue(CountryProperty);
            set => SetValue(CountryProperty, value);
        }

        private static bool __ValidateIsNullOrEmpty(Microsoft.Maui.Controls.BindableObject bindable, object value)
        {
            var ctrl = (HeaderControl)bindable;
            return ctrl.ValidateIsNullOrEmpty(ctrl, (string?)value);
        }

        ...
    }

Example 2 - Static Method

Just decorate the field with the Bindable attribute. The 'ValidateNotNull' method must have two parameters (one of type BindableObject and the second one must be object type)

    using Maui.BindableProperty.Generator.Core;

    public partial class HeaderControl : ContentView
    {
        [AutoBindable(ValidateValue = nameof(ValidateNotNull))]
        private readonly string? _zipCode;

        private static bool ValidateNotNull(BindableObject _, object value) => value != null;
    }

the prevoius code will generate this:

    public partial class HeaderControl
    {
        public static readonly Microsoft.Maui.Controls.BindableProperty ZipCodeProperty =
                                        Microsoft.Maui.Controls.BindableProperty.Create(
                                                                nameof(ZipCode),
                                                                typeof(string),
                                                                typeof(HeaderControl),
                                                                defaultValue: default(string?),
                                                                propertyChanged: __ZipCodeChanged,
                                                                propertyChanging: __ZipCodeChanging,
                                                                validateValue: ValidateNotNull);

        public string? ZipCode
        {
            get => (string?)GetValue(ZipCodeProperty);
            set => SetValue(ZipCodeProperty, value);
        }
        
        ...
    }

Usage - PropertyAccessibility

Just decorate the field with the Bindable attribute and set "PropertyAccessibility = Private/ProtectedAndInternal/Protected/Internal/ProtectedOrInternal/Public".

    using Maui.BindableProperty.Generator.Core;

    public partial class HeaderControl : ContentView
    {
        [AutoBindable(PropertyAccessibility = BindablePropertyAccessibility.ProtectedOrInternal)]
        private readonly string? _age;
    }

the prevoius code will generate this:

    public partial class HeaderControl
    {
        protected internal static readonly Microsoft.Maui.Controls.BindableProperty AgeProperty =
                                        Microsoft.Maui.Controls.BindableProperty.Create(
                                                                nameof(Age),
                                                                typeof(string),
                                                                typeof(HeaderControl),
                                                                defaultValue: default(string?),
                                                                propertyChanged: __AgeChanged,
                                                                propertyChanging: __AgeChanging);

        protected internal string? Age
        {
            get => (string?)GetValue(AgeProperty);
            set => SetValue(AgeProperty, value);
        }

        ...
    }

Do you want to remove the compiler warning CS0169 ?

    using Maui.BindableProperty.Generator.Core;

    public partial class HeaderControl : ContentView
    {
        #pragma warning disable CS0169

        [AutoBindable]
        private readonly string? _country;

        #pragma warning restore CS0169
    }

Project status

✅ PropertyName - Done
✅ OnChanged - Done
✅ OnChanging - Done
✅ DefaultValue - Done
✅ DefaultBindingMode - Done
✅ HidesUnderlyingProperty - Done
✅ ValidateValue - Done
✅ PropertyAccessibility - Done
🔳 Allow nested class - In Progress
🔳 Add Attributes Property - Pending

Extra info

This repo is using part of the code of CodeWriter to generate the CSharp files, thanks to the author.

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

.NETStandard 2.0
- No dependencies.

NuGet packages (6)

Showing the top 5 NuGet packages that depend on M.BindableProperty.Generator:

Package	Downloads
The49.Maui.ContextMenu .NET MAUI library for Android and iOS to open a native context menu on long press.	6.2K
Sm.Maui.BottomSheet ModalBottomSheet view for .NET MAUI	5.9K
SimpleRatingControl.MAUI Simple Rating Control for .NET MAUI	2.2K
Yang.Maui.Helper.Controls Package Description	1.1K
tsjdevapps.MauiControlsLib Controls Library for .NET MAUI	522

GitHub repositories (3)

Showing the top 3 popular GitHub repositories that depend on M.BindableProperty.Generator:

Repository	Stars
VladislavAntonyuk/MauiSamples .NET MAUI Samples	746
the49ltd/The49.Maui.BottomSheet .NET MAUI library used to display pages as Bottom Sheets	330
nor0x/Dots the 🙂 friendly .NET SDK manager	290

Version	Downloads	Last updated
0.11.1	60,271	6/28/2023
0.11.0	203	6/28/2023
0.10.0	5,926	3/28/2023
0.9.3	8,856	12/7/2022
0.9.2	5,825	11/15/2022
0.9.1	913	9/27/2022
0.9.0	1,245	8/30/2022
0.8.3	1,341	7/27/2022
0.8.2	4,019	7/4/2022
0.8.1	550	7/1/2022
0.8.0	546	6/29/2022
0.7.0	657	4/28/2022
0.6.0	530	4/28/2022
0.5.0	517	4/21/2022
0.4.1	531	4/14/2022
0.4.0	535	4/12/2022
0.3.3	508	4/1/2022
0.3.2	501	4/1/2022
0.3.0	597	4/1/2022

Hotfix - Ambiguous call

M.BindableProperty.Generator 0.11.1

Maui.BindableProperty.Generator

Installation

Usage - Simple implementation

Options

Usage - PropertyName

Usage - OnChanged

Example 1 - No Parameters

Example 2 - One Parameter

Example 3 - Two Parameters

Example 4 - Partial method

Usage - OnChanging

Example 1

Example 2 - Partial method

Usage - DefaultValue

Example 1 - DateTime

Example 2 - String

Usage - DefaultBindingMode

Usage - HidesUnderlyingProperty

Usage - ValidateValue

Example 1 - Non-Static Method

Example 2 - Static Method

Usage - PropertyAccessibility

Do you want to remove the compiler warning CS0169 ?

Project status

Extra info

.NETStandard 2.0

NuGet packages (6)

GitHub repositories (3)