[iOS] Fixed Entry with IsPassword toggling loses previously entered text

[SubhikshaSf4851]

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:

When toggling the IsPassword property, the UpdateIsPassword method does not properly preserve and restore the current text after toggling.

Description of Change

Modified the UpdateIsPassword method in TextFieldExtensions to temporarily suppress the TextPropertySet event while clearing and reinserting the text for password fields. This ensures the text update does not trigger unintended side effects.

Issues Fixed

Fixes #30085

Tested the behaviour in the following platforms

• Windows
• Android
• iOS
• Mac

Before Issue Fix	After Issue Fix
Screen.Recording.2025-07-11.at.5.11.32.PM.mov	Screen.Recording.2025-07-11.at.5.09.20.PM.mov

[dotnet-policy-service]

Hey there @@SubhikshaSf4851! Thank you so much for your PR! Someone from the team will get assigned to your PR shortly and we'll get it reviewed.

[jsuarezruiz]

/azp run MAUI-UITests-public

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[jsuarezruiz]

Could you include a related test?

[SubhikshaSf4851]

@jsuarezruiz While testing, I used App.EnterText to type into the field. After toggling IsPassword, the entered text replaced the previous text instead of appending. In a normal Entry (without IsPassword), the text appends as expected. Could you suggest a way to write a test for this scenario?

[Copilot]

Pull Request Overview

This PR fixes an iOS-specific issue where toggling the IsPassword property on an Entry control would cause the previously entered text to be lost. The fix ensures that when switching password visibility, the current text is preserved and properly restored without triggering unwanted side effects.

• Modified UpdateIsPassword method to capture and restore text when toggling password mode
• Added text property suppression mechanism to prevent event firing during text restoration
• Implemented SuppressTextPropertySet method in MauiTextField to control event propagation

Reviewed Changes

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

File	Description
src/Core/src/Platform/iOS/TextFieldExtensions.cs	Enhanced UpdateIsPassword method to preserve text during password toggle operations
src/Core/src/Platform/iOS/MauiTextField.cs	Added suppression mechanism to prevent TextPropertySet events during controlled text updates

[ghost]

Hi @SubhikshaSf4851 I've also faced the same issue

[sheiksyedm]

/rebase

[kubaflo]

🤖 AI Summary

📊 Expand Full Review

---

🔍 Pre-Flight — Context & Validation

---

📝 Review Session — Modified Suggested Changes · b231688

---

Issue: #30085 - Entry with IsPassword toggling loses previously entered text on iOS
PR: #30572 - [iOS] Fixed Entry with IsPassword toggling loses previously entered text
Platforms Affected: iOS (platform-specific bug)
Files Changed: 2 implementation files, 0 test files

Issue Summary

true), the previously entered text is lost when the user types new characters. The issue does NOT occur on other platforms (Android, Windows, macOS). Steps to reproduce: type text, toggle IsPassword off (visible), toggle back on, type more the original text disappears.text

Root Cause (from PR description)

When setting SecureTextEntry = true, iOS internally clears the text field's content. The original UpdateIsPassword method did not preserve and restore the text after this toggle. The PR captures the current text before the toggle and re-inserts it afterward using InsertText.

Files Changed

• src/Core/src/Platform/iOS/MauiTextField.cs (+8, -1): Added _suppressTextPropertySet field and SuppressTextPropertySet(bool) method to prevent TextPropertySet event from firing during controlled text updates.
• src/Core/src/Platform/iOS/TextFieldExtensions.cs (+10, -0): Modified UpdateIsPassword to capture currentText before toggling, then suppress events, clear text, and re-insert via InsertText().

PR Discussion Summary

Reviewer	Feedback	Status
jsuarezruiz	"Could you include a related UNRESOLVED - no tests added	test?"
copilot-pr-reviewer	Suppression should use try-finally to ensure SuppressTextPropertySet(false) is always UNRESOLVED	called
copilot-pr-reviewer	Extract type check/cast before if for readability	Nitpick
copilot-pr-reviewer	Add XML doc comment to _suppressTextPropertySet field	Nitpick

Key Concerns

1. No tests The reviewer explicitly requested a test, but none were added. The author mentioned difficulty writing automated tests for this scenario.included
2. Missing try- If an exception occurs during textField.Text = string.Empty or textField.InsertText(currentText), the suppress flag will never be reset to false, leaving the TextPropertySet event permanently suppressed.finally
3. Code The pattern could be more robust (try-finally).quality

Fix Candidates

#	Source	Approach	Test Result	Files Changed	Notes
PR	PR #30572	Capture text before toggle, suppress TextPropertySet events, clear and re-insert via PENDING (Gate)	TextFieldExtensions.cs (+10), MauiTextField.cs (+8,-1)	Original missing try-finally	PR InsertText

---

🚦 Gate — Test Verification

---

📝 Review Session — Modified Suggested Changes · b231688

---

** FAILED (No Tests)Result:**
Platform: ios (selected)
Mode: Full Verification

Issue

No tests exist for issue #30085 in the PR or in the test suite.

• The reviewer (jsuarezruiz) explicitly requested a test.
• The PR author acknowledged difficulty but did not add any tests.
• Search across src/Controls/tests and src/Core/tests found zero files matching 30085 or this issue scenario.

Impact

Gate cannot verify that:

1. Tests FAIL without the fix (catches the bug)
2. Tests PASS with the fix (fix is correct)

The PR is missing test coverage for the IsPassword toggle text loss scenario.

Recommendation

Tests must be added before this PR can be approved. The write-tests-agent can help create device tests for this scenario.

A device test in src/Controls/tests/DeviceTests/Elements/Entry/EntryTests.iOS.cs that:

1. Creates an Entry with IsPassword = true
2. Types some text
3. Toggles IsPassword to false then back to true
4. Verifies text is preserved after each toggle

---

🔧 Fix — Analysis & Comparison

---

📝 Review Session — Modified Suggested Changes · b231688

---

Fix Candidates

#	Source	Approach	Test Result	Files Changed	Notes
PR	PR #30572	Capture text before toggle, suppress TextPropertySet events, clear and re-insert via InsertText PASS (Gate skipped - no tests)	TextFieldExtensions.cs, MauiTextField.cs	Missing try-finally safety

Exhausted: N/A - Phase skipped (Gate FAILED due to missing tests)
Selected Fix: PR's Not evaluated (Gate did not pass; no independent alternatives explored)fix

Notes

Gate phase failed because no tests exist for issue #30085. The try-fix exploration phase was skipped per workflow rules. The PR's fix approach is logically sound but has a code quality concern (missing try-finally) that should be addressed.

---

📋 Report — Final Recommendation

---

📝 Review Session — Modified Suggested Changes · b231688

---

Final Recommendation: REQUEST CHANGES##

Summary

PR #30572 fixes an iOS-specific bug where toggling IsPassword on an Entry control causes previously entered text to be lost. The fix approach is logically capturing and re-inserting text with event suppression. However, the PR is missing two required items: (1) tests and (2) a try-finally block to safely restore the suppression flag.correct

Root Cause

On iOS, changing SecureTextEntry (the native backing property for IsPassword) resets the text field's content. The original UpdateIsPassword code did not preserve and restore the existing text after this platform-level reset.

Fix Quality

The PR's approach is sensible:

1. Captures currentText before toggling SecureTextEntry
2. After re-enabling and becoming first responder, re-inserts currentText via InsertText()
3. Suppresses TextPropertySet events during this re-insertion to avoid cascading side effects

**Critical Missing try-finally:**Issue

// CURRENT (dangerous):
mauiTextField.SuppressTextPropertySet(true);
textField.Text = string.Empty;       // Could throw
textField.InsertText(currentText);   // Could throw
mauiTextField.SuppressTextPropertySet(false);  // Won't run on exception!

// REQUIRED (safe):
mauiTextField.SuppressTextPropertySet(true);
try
{
    textField.Text = string.Empty;
    textField.InsertText(currentText);
}
finally
{
    mauiTextField.SuppressTextPropertySet(false);  // Always runs
}

If an exception occurs during text manipulation, _suppressTextPropertySet remains true permanently, silently breaking all future TextPropertySet event delivery for that text field.

Required Changes

1. Tests are The reviewer (jsuarezruiz) explicitly requested a test. No tests were added. The write-tests-agent can help create an appropriate device test for this scenario in src/Controls/tests/DeviceTests/Elements/Entry/EntryTests.iOS.cs.missing

2. Add try-finally in TextFieldExtensions.cs to ensure SuppressTextPropertySet(false) is always called, even on exception.

Minor Suggestions (Non-blocking)

• Extract the textField as MauiTextField cast to a local variable before the if check (Copilot suggestion)
• Add an XML doc comment to _suppressTextPropertySet explaining its purpose
• Add a brief inline comment explaining why event suppression is needed

Platform Coverage

• PR tested on iOS, Android, Windows, Mac (per author's checkboxes)
• The code change only affects the iOS platform code path

Gate Status

No tests exist for issue #30085. Cannot verify the fix catches the bug automatically.FAILED Gate

---

📋 Expand PR Finalization Review

---

Title: ✅ Good

Current: [iOS] Fixed Entry with IsPassword toggling loses previously entered text

Description: ✅ Good

Description needs updates. See details below.

✨ Suggested PR Description

[!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

On iOS, when UITextField.SecureTextEntry is set to true while the field is the first responder (focused), iOS internally resets the text field's content. The existing UpdateIsPassword code did not preserve and restore the text around this platform-level reset, causing previously entered text to be lost whenever the user toggled IsPassword back to true while the field remained focused.

This bug only affects iOS because only iOS clears text on SecureTextEntry changes while focused. Android and Windows do not exhibit this behavior.

Description of Change

Modified UpdateIsPassword in TextFieldExtensions.cs to preserve and restore text when toggling to password mode while the field is focused (entry.IsPassword && textField.IsFirstResponder):

1. Capture currentText before disabling and enabling SecureTextEntry
2. After SecureTextEntry = true (which resets native content), re-insert the original text via InsertText(), which correctly positions the cursor at the end and respects the secure field's text entry model
3. Suppress TextPropertySet events during the re-insertion to avoid triggering the MAUI binding/handler layer (which would interpret the interim empty state as intentional text clearing)

Added SuppressTextPropertySet(bool) method and _suppressTextPropertySet field to MauiTextField.cs to support this suppression.

Files changed:

• src/Core/src/Platform/iOS/MauiTextField.cs — Added _suppressTextPropertySet flag and SuppressTextPropertySet(bool) method
• src/Core/src/Platform/iOS/TextFieldExtensions.cs — Modified UpdateIsPassword to capture and restore text with event suppression; also adds braces to else branch for consistency

Scope: This change only affects the iOS code path (entry.IsPassword && textField.IsFirstResponder). The non-focused path and all other platforms are unaffected.

Issues Fixed

Fixes #30085

Platforms Affected

• iOS — bug fix (only platform exhibiting this behavior)
• Android, Windows, MacCatalyst — no behavior change (platform code not modified)

Code Review: ⚠️ Issues Found

Code Review — PR #30572

Files reviewed:

• src/Core/src/Platform/iOS/MauiTextField.cs
• src/Core/src/Platform/iOS/TextFieldExtensions.cs

---

🔴 Critical Issues

1. Missing try-finally Around Event Suppression

File: src/Core/src/Platform/iOS/TextFieldExtensions.cs (lines 35–40)
Flagged by: copilot-pull-request-reviewer (unresolved)

Problem:
If an exception is thrown during textField.Text = string.Empty or textField.InsertText(currentText), the call to mauiTextField.SuppressTextPropertySet(false) will never execute. This leaves _suppressTextPropertySet = true permanently on that MauiTextField instance, silently breaking all future TextPropertySet event delivery — meaning the MAUI binding/handler layer will never be notified of user text changes again.

Current code (unsafe):

mauiTextField.SuppressTextPropertySet(true);
textField.Text = string.Empty;       // Could throw
textField.InsertText(currentText);   // Could throw
mauiTextField.SuppressTextPropertySet(false);  // Won't run on exception

Required fix:

mauiTextField.SuppressTextPropertySet(true);
try
{
    textField.Text = string.Empty;
    textField.InsertText(currentText);
}
finally
{
    mauiTextField.SuppressTextPropertySet(false);  // Always runs
}

Alternatively, implement IDisposable on a scope struct or use a local helper to make the pattern safer and more expressive.

---

2. No Tests Added

Flagged by: Reviewer jsuarezruiz (unresolved)

Problem:
The reviewer explicitly requested a test in the PR discussion. The PR author acknowledged the difficulty but no tests were added. There is zero automated verification that:

1. The bug is caught by tests (tests fail without the fix)
2. The fix is correct (tests pass with the fix)

Recommended location: src/Controls/tests/DeviceTests/Elements/Entry/EntryTests.iOS.cs
(or add to an existing file covering Entry/password behavior)

Suggested test scenario:

1. Create Entry with IsPassword = true, set text via binding/handler
2. Toggle IsPassword to false (show text)
3. Toggle IsPassword back to true (hide text)
4. Verify Entry.Text is unchanged after both toggles
5. Optionally verify the text field's native content matches

The write-tests-agent can help create this test.

---

🟡 Suggestions

3. Extract Pattern-Match Cast Before if Condition

File: src/Core/src/Platform/iOS/TextFieldExtensions.cs (line 33)
Flagged by: copilot-pull-request-reviewer (marked resolved, but suggestion was not applied)

Current:

if (!string.IsNullOrEmpty(currentText) && textField is MauiTextField mauiTextField)

Suggested:

var mauiTextField = textField as MauiTextField;
if (!string.IsNullOrEmpty(currentText) && mauiTextField != null)

Why: Mixing a null check (IsNullOrEmpty) with a pattern-match type test in a compound condition reduces readability. Extracting the cast makes the intent clearer and allows mauiTextField to be used if needed outside the if block.

---

4. Missing XML Documentation on _suppressTextPropertySet

File: src/Core/src/Platform/iOS/MauiTextField.cs (line 87)
Flagged by: copilot-pull-request-reviewer (marked resolved, but suggestion was not applied)

Current:

bool _suppressTextPropertySet;

Suggested addition:

// Temporarily suppresses TextPropertySet during programmatic text re-insertion
// (e.g., when restoring text after a SecureTextEntry toggle on iOS).
bool _suppressTextPropertySet;

An inline comment (rather than XML doc) is appropriate here since it's a private field.

---

5. Missing Newline at End of MauiTextField.cs

File: src/Core/src/Platform/iOS/MauiTextField.cs

The diff shows \ No newline at end of file. This was already the case in the original file, so the PR does not introduce a regression — but it's worth cleaning up since code is being added nearby. Most editors and dotnet format will flag this.

---

✅ Looks Good

• Fix approach is correct: Capture text before SecureTextEntry = true → suppress events → clear → re-insert via InsertText() → restore events. This correctly handles the iOS platform behavior of resetting text when enabling secure entry while focused.
• SuppressTextPropertySet scoped as internal: Not exposing this as public API is appropriate; it's an implementation detail between MauiTextField and TextFieldExtensions.
• string.IsNullOrEmpty(currentText) guard: Correctly handles null (since UITextField.Text is string?) and avoids unnecessary work for empty text.
• Only activates when field is focused and switching TO password: The fix is appropriately scoped to entry.IsPassword && textField.IsFirstResponder, which is exactly when iOS exhibits the text-clearing behavior.
• else brace addition: Adds {} braces to the previously brace-free else to match standard code style — cosmetic improvement, no functional impact.
• [iOS] title prefix: Correctly scopes the issue to iOS only.

---

[github-actions]

🚀 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://raw.githubusercontent.com/dotnet/maui/main/eng/scripts/get-maui-pr.sh | bash -s -- 30572

Or

• Run remotely in PowerShell:

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

[kubaflo]

Review Summary

Overall: The fix approach is sound — capturing text before the SecureTextEntry toggle and re-inserting it with event suppression is the correct pattern for this iOS-specific issue.

Changes applied on pr/30572 branch

I've pushed a commit addressing the review feedback:

1. 🔴 try-finally safety — Wrapped the text manipulation (textField.Text = string.Empty / InsertText) in a try-finally block to ensure SuppressTextPropertySet(false) is always called, even if an exception occurs. Without this, an exception would permanently suppress TextPropertySet events on that text field instance.

2. 🟡 XML doc comment — Added a <summary> doc comment to the _suppressTextPropertySet field explaining its purpose and when it's used.

3. 🔴 Device test added — Added IsPasswordTogglePreservesText test in EntryTests.iOS.cs that:

   • Creates an Entry with text, focuses it
   • Toggles IsPassword on and verifies text is preserved (both platform and MAUI)
   • Toggles off and back on again, verifies text survives multiple toggles
   • Verified locally: All 60 Entry category tests pass on MacCatalyst ✅

Branch: pr/30572