Fix for Application Crash When Updating ToolbarItem Icon and Navigating Between Shell Pages #26126
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fix for toolbar issue
praveenkumarkarunanithi
added
platform/macOS 🍏
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/rebase |
github-actions
bot
force-pushed
the
fix-25534
branch
from
0328b1a to
ce35de3
Compare
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
Azure Pipelines successfully started running 3 pipeline(s). |
sheiksyedm
added
the
partner/syncfusion
SuthiYuvaraj
changed the title
SuthiYuvaraj
changed the title
PureWeen
requested changes
Jan 6, 2025
| @@ -98,7 +98,7 @@ void OnPropertyChanged(object sender, PropertyChangedEventArgs e) | |||
|
|
|||
| void UpdateIconAndStyle(ToolbarItem item) | |||
| { | |||
| if (item?.IconImageSource == null) | |||
| if (item?.IconImageSource == null || item.Parent?.Handler is null) | |||
There was a problem hiding this comment.
Does it make sense to set the Image to null if the Parent Handler is null?
Maybe the check should be added to the else? Or the method should just exit out of MauiContext is null?
var mc = item.FindMauiContext()
if (mc is null) return;
There was a problem hiding this comment.
@PureWeen Thank you for the feedback. I've implemented the changes as suggested, focusing on proper MauiContext handling. The method now checks for a valid context before proceeding with image loading, addressing the concerns about potential null references. Please review and let us know if any further changes are required.
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
PureWeen
approved these changes
Jan 7, 2025
rmarinho
approved these changes
Jan 8, 2025
|
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Root Cause
OnPropertyChangedevent for theToolbarItem.IconImageSourcewas triggered before the page's handler was created during the second navigation. Initially, on the first navigation, this event fired after the page handler was initialized, allowing theUpdateIconAndStylemethod to access the MauiContext throughitem.FindMauiContext(). However, after updating theToolbarItem.IconImageSourcemultiple times, the event sequence changed. On subsequent navigations, theOnPropertyChangedevent fired before the page handler was created, leaving the ToolbarItem without a valid parent handler. As a result, attempts to accessitem.FindMauiContext()failed, leading to a null reference exception and causing the app to crash.The sample code used an
.svgfile for the toolbar icon without the correct extension or appropriate handling. Per .NET MAUI guidelines, SVG files are automatically converted to PNG files and must be referenced with a.pngextension in the project. Using the incorrect extension or without extension caused the app to fail with error.Description of Change
To address this issue, a condition was added to the
UpdateIconAndStylemethod to ensure theToolbarItem's parent handler exists before attempting to accessitem.FindMauiContext(). This additional check prevents the method from executing when the required resources are not yet initialized, avoiding any null reference exceptions. This change ensures that updates toToolbarItem.IconImageSourceare safely handled during navigation, maintaining stability and preventing crashes caused by uninitialized platform dependencies.Issues Fixed
Fixes #25534
Tested the behaviour in the following platforms
Output Video
withoutfix.mov
withfix.mov