Propagate VisualElement.IsEnabled to children #12488

mattleibow · 2023-01-07T03:53:06Z

Description of Change

There are several issues relating to the IsEnabled property because it is a relatively complex property that involves parent state and combinations of other properties.

Previous PRs:

This PR does a few things and tries to avoid major changes or new concepts.

IsEnabled

The main change to existing code is where previously if a command was "disabled" via the CanExecute method, the framework would actually SET the value of the IsEnabled property - overwriting any user value. This causes issues if you have both IsEnabled and Command set.

The new code rather takes advantage of the "coerce value" concept of the BindableProperty and "intercepts" the "user value" to make sure all the related properties are in agreement.

Previously the IButtonElement had a IsEnabledCore property that would be implemented to basically override user values when set - but that now is removed. The new version of that property is a getter-only and is virtual so that other elements can override.

The final IsEnabled value is now determined in the coerce value delegate of the property and is basically a check for IsEnabled = parent.IsEnabled && this.IsEnabledCore && userVlaue. Using the propagation system we already have, changing the parent element or the parent value triggers a re-evaluation of all the children - and thus consistency is preserved. Similarly, if the CanExecute value of a command is changed, then that also triggers a re-evaluation.

The IsEnabled property value is now propagated using the same system that Window and FlowDirection uses: IPropertyPropagationController.PropagatePropertyChanged().

Commands

Another (semi-related) change is to split the internal IButtonElement into ICommandElement and IButtonElement : ICommandEleent. The reason for this is that commands can happen with non-button controls (such as search bar, tool bar and menu bar). This separation now allows the same code to be shared instead of copied - as can be seen by the SearchBarchanges.

Tasks

Update IsEnabled to coerce values
Verify that it works with bindings and code
Add tests

Issues Fixed

src/Controls/src/Core/Internals/PropertyPropagationExtensions.cs

src/Controls/src/Core/VisualElement.cs

src/Controls/src/Core/CommandElement.cs

src/Controls/src/Core/VisualElement.cs

nefen · 2023-01-10T09:21:16Z

Will anyone approve it, because the bug is still here!

hartez · 2023-01-10T20:27:42Z

Suggested changes: dev/is-enabled...dev/is-enabled-alt

mattleibow · 2023-01-10T21:45:03Z

Very nice! Looking at that and will merge here

williambohrmann3 · 2023-01-11T01:13:56Z

Very excited for this :)

And fixed a bug :)

src/Core/src/Handlers/MenuFlyoutSubItem/MenuFlyoutSubItemHandler.cs

mattleibow · 2023-01-11T02:22:05Z

src/Controls/src/Core/MenuItem.cs

- [EditorBrowsable(EditorBrowsableState.Never)]
- set => SetValue(IsEnabledPropertyKey, value);
+ set => SetValue(IsEnabledProperty, value);


Bonus feature, this now works as a setter too!

src/Controls/src/Core/Button.cs

mattleibow · 2023-01-14T20:23:13Z

src/Controls/src/Core/BindableObjectExtensions.cs

+ var ctx = self.GetContext(property);
+ if (ctx?.Binding is not null)
+ {
+ // support bound properties
+ if (!ctx.Attributes.HasFlag(BindableObject.BindableContextAttributes.IsBeingSet))
+ ctx.Binding.Apply(false);
+ }


@StephaneDelcroix is this the correct way to ask a bindable property to "refresh" or "re-get" the value.

williambohrmann3 · 2023-02-09T23:18:16Z

Which .NET 7 version is this fix expected in?

hosamyousof · 2023-02-20T10:43:31Z

How to get this update?

hosamyousof · 2023-02-20T11:04:32Z

Hi @mattleibow @PureWeen
When this pull request #12488 will be released.
I checked the latest release 7.0.59 Service Release 3 and it's not there.

Please we need this update.

Thank you

williambohrmann3 · 2023-02-23T19:04:12Z

@aidanjbailey @hosamyousof it seems like this bug is fixed in .NET 8 but won't be backported to .NET 7

aidan-bailey · 2023-02-24T07:35:54Z

Fair enough, thanks for the update. Looking forward to trading my 8 bindings for 1 haha.

BaY1251 · 2023-02-28T03:32:34Z

非常实用,期待更新

williambohrmann3 · 2023-02-28T21:03:23Z

This seems to be fixed in my .NET 7 app actually, at least button visual states #9753

aidan-bailey · 2023-03-01T06:58:33Z

The plot thickens...

Sofiya-kumar · 2023-06-09T06:28:13Z

Still its not working. Have to give separate binding for each item

mattleibow · 2023-06-09T13:09:25Z

@Sofiya-kumar what version of maui and vs are you using? What platform? Maybe open a new issue and attach a repro so I can have a look.

Sofiya-kumar · 2023-06-14T07:04:44Z

Hi @mattleibow ,

Please check the below repo

ChildrenTesting.zip

Microsoft Visual Studio Professional 2022
Version 17.5.4
VisualStudio.17.Release/17.5.4+33530.505
Microsoft .NET Framework
Version 4.8.09032

Installed Version: Professional

Visual C++ 2022 00476-80000-00000-AA061
Microsoft Visual C++ 2022

ASP.NET and Web Tools 17.5.318.41597
ASP.NET and Web Tools

Azure App Service Tools v3.0.0 17.5.318.41597
Azure App Service Tools v3.0.0

C# Tools 4.5.2-3.23171.7+d17f741546fad2786cbd6394d08619544e53a36d
C# components used in the IDE. Depending on your project type and settings, a different version of the compiler may be used.

Extensibility Message Bus 1.4.3 (main@2a4517a)
Provides common messaging-based MEF services for loosely coupled Visual Studio extension components communication and integration.

Microsoft JVM Debugger 1.0
Provides support for connecting the Visual Studio debugger to JDWP compatible Java Virtual Machines

Mono Debugging for Visual Studio 17.5.9 (11975e6)
Support for debugging Mono processes with Visual Studio.

NuGet Package Manager 6.5.0
NuGet Package Manager in Visual Studio. For more information about NuGet, visit https://docs.nuget.org/

Razor (ASP.NET Core) 17.5.2.2316603+9f1b6856460af1e592d387ebef416eadddac453f
Provides languages services for ASP.NET Core Razor.

Syntax Visualizer 1.0
An extension for visualizing Roslyn SyntaxTrees.

TypeScript Tools 17.0.20105.2003
TypeScript Tools for Microsoft Visual Studio

Visual Basic Tools 4.5.2-3.23171.7+d17f741546fad2786cbd6394d08619544e53a36d
Visual Basic components used in the IDE. Depending on your project type and settings, a different version of the compiler may be used.

Visual F# Tools 17.5.0-beta.23053.5+794b7c259d9646a7eb685dad865aa27da7940a21
Microsoft Visual F# Tools

Visual Studio IntelliCode 2.2
AI-assisted development for Visual Studio.

VisualStudio.DeviceLog 1.0
Information about my package

VisualStudio.Mac 1.0
Mac Extension for Visual Studio

VSPackage Extension 1.0
VSPackage Visual Studio Extension Detailed Info

Xamarin 17.5.0.173 (d17-5@33e727c)
Visual Studio extension to enable development for Xamarin.iOS and Xamarin.Android.

Xamarin Designer 17.5.3.46 (remotes/origin/d17-5@e4dd80b2bb)
Visual Studio extension to enable Xamarin Designer tools in Visual Studio.

Xamarin Templates 17.5.41 (ba80d05)
Templates for building iOS, Android, and Windows apps with Xamarin and Xamarin.Forms.

Xamarin.Android SDK 13.2.0.0 (d17-5/797e2e1)
Xamarin.Android Reference Assemblies and MSBuild support.
Mono: 6dd9def
Java.Interop: xamarin/java.interop/main@149d70fe
SQLite: xamarin/sqlite@fdc1e34
Xamarin.Android Tools: xamarin/xamarin-android-tools/main@9f02d77

Xamarin.iOS and Xamarin.Mac SDK 16.2.0.5 (7738c90c9)
Xamarin.iOS and Xamarin.Mac Reference Assemblies and MSBuild support.

Propagate IsEnabled to children

e06e64c

mattleibow commented Jan 7, 2023

View reviewed changes

src/Controls/src/Core/Internals/PropertyPropagationExtensions.cs Outdated Show resolved Hide resolved

mattleibow commented Jan 7, 2023

View reviewed changes

src/Controls/src/Core/VisualElement.cs Show resolved Hide resolved

comments

270a742

mattleibow commented Jan 7, 2023

View reviewed changes

src/Controls/src/Core/VisualElement.cs Show resolved Hide resolved

Refactor the command logic to use IsEnabledCore

5a81a26

mattleibow commented Jan 9, 2023

View reviewed changes

src/Controls/src/Core/CommandElement.cs Outdated Show resolved Hide resolved

mattleibow commented Jan 9, 2023

View reviewed changes

src/Controls/src/Core/VisualElement.cs Outdated Show resolved Hide resolved

mattleibow requested review from PureWeen, StephaneDelcroix, hartez and jsuarezruiz January 9, 2023 14:52

mattleibow changed the title ~~Propagate IsEnabled to children~~ Propagate VisualElement.IsEnabled to children Jan 9, 2023

hartez added 2 commits January 9, 2023 14:03

Simplify explicit IsEnabled property

10118af

Further simplification

44f6fa4

mattleibow added 2 commits January 11, 2023 04:14

Did some more things to support menus now

0020d07

And fixed a bug :)

Merge remote-tracking branch 'origin/main' into dev/is-enabled

ad64ef9

mattleibow commented Jan 11, 2023

View reviewed changes

src/Core/src/Handlers/MenuFlyoutSubItem/MenuFlyoutSubItemHandler.cs Outdated Show resolved Hide resolved

mattleibow commented Jan 11, 2023

View reviewed changes

Merge remote-tracking branch 'origin/main' into dev/is-enabled

aaadc8c

hartez approved these changes Jan 11, 2023

View reviewed changes

Merge remote-tracking branch 'origin/main' into dev/is-enabled

6f12635

mattleibow mentioned this pull request Jan 12, 2023

[Core] Propagate IsEnabled property from Layouts to children #6892

Closed

mattleibow added 2 commits January 12, 2023 20:09

Merge remote-tracking branch 'origin/main' into dev/is-enabled

bffbcdb

Add a bunch of unit tests

d682a85

PureWeen reviewed Jan 12, 2023

View reviewed changes

src/Controls/src/Core/Button.cs Outdated Show resolved Hide resolved

Movethings according to review comments

5814679

mattleibow commented Jan 14, 2023

View reviewed changes

PureWeen approved these changes Jan 17, 2023

View reviewed changes

PureWeen merged commit 1510472 into main Jan 17, 2023

PureWeen deleted the dev/is-enabled branch January 17, 2023 21:49

mattleibow mentioned this pull request Jan 22, 2023

Add a null-guard in MenuItem to prevent NRE #12207

Closed

PureWeen added t/breaking 💥 needs-breaking-change-doc-created labels Jan 26, 2023

mattleibow mentioned this pull request Feb 2, 2023

StackLayout IsEnabled Property does not work #5287

Closed

hartez added backport/suggested The PR author or issue review has suggested that the change should be backported. backport/NO This change should not be backported. It may break customers. labels Feb 15, 2023

rachelkang mentioned this pull request Feb 17, 2023

[Android,Windows]When the parent's IsEnabled Property is set to false, the touch of the child is getting triggered. #12278

Closed

mattleibow mentioned this pull request Mar 9, 2023

Render Menuitems in the Shell as disabled if a command’s CanExecute returns false #9492

Open

This was referenced Nov 1, 2023

The command interface for buttons - Command.ChangeCanExecute() #9419

Closed

Button isenabled not working #15127

Closed

mattleibow mentioned this pull request Nov 15, 2023

Button control's IsEnabled property not works if used with Command property. #16947

Closed

limeniye mentioned this pull request Dec 6, 2023

Clicked buttons bound to ICommand using CanExecute don't show their updated status unoplatform/uno#14633

Closed

github-actions bot locked and limited conversation to collaborators Dec 14, 2023

samhouts added the fixed-in-8.0.0-preview.1.7762 Look for this fix in 8.0.0-preview.1.7762! label Aug 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Propagate VisualElement.IsEnabled to children #12488

Propagate VisualElement.IsEnabled to children #12488

mattleibow commented Jan 7, 2023 •

edited

Loading

nefen commented Jan 10, 2023

hartez commented Jan 10, 2023

mattleibow commented Jan 10, 2023

williambohrmann3 commented Jan 11, 2023

mattleibow Jan 11, 2023

mattleibow Jan 14, 2023

williambohrmann3 commented Feb 9, 2023

hosamyousof commented Feb 20, 2023

hosamyousof commented Feb 20, 2023

williambohrmann3 commented Feb 23, 2023

aidan-bailey commented Feb 24, 2023

BaY1251 commented Feb 28, 2023

williambohrmann3 commented Feb 28, 2023

aidan-bailey commented Mar 1, 2023

Sofiya-kumar commented Jun 9, 2023

mattleibow commented Jun 9, 2023

Sofiya-kumar commented Jun 14, 2023

Propagate VisualElement.IsEnabled to children #12488

Propagate VisualElement.IsEnabled to children #12488

Conversation

mattleibow commented Jan 7, 2023 • edited Loading

Description of Change

Issues Fixed

nefen commented Jan 10, 2023

hartez commented Jan 10, 2023

mattleibow commented Jan 10, 2023

williambohrmann3 commented Jan 11, 2023

mattleibow Jan 11, 2023

Choose a reason for hiding this comment

mattleibow Jan 14, 2023

Choose a reason for hiding this comment

williambohrmann3 commented Feb 9, 2023

hosamyousof commented Feb 20, 2023

hosamyousof commented Feb 20, 2023

williambohrmann3 commented Feb 23, 2023

aidan-bailey commented Feb 24, 2023

BaY1251 commented Feb 28, 2023

williambohrmann3 commented Feb 28, 2023

aidan-bailey commented Mar 1, 2023

Sofiya-kumar commented Jun 9, 2023

mattleibow commented Jun 9, 2023

Sofiya-kumar commented Jun 14, 2023

mattleibow commented Jan 7, 2023 •

edited

Loading