Adjust Localize helpers#6572
Merged
david-poindexter merged 2 commits intodnnsoftware:developfrom Jun 3, 2025
Merged
Conversation
valadas
reviewed
Jun 2, 2025
Also update related markup files to use encoding bee-stings
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
PortalModuleBaseexposes two helpers,LocalizeStringandLocalizeSafeJsString. I propose that these are deprecated and replaced with three helpers,LocalizeText,LocalizeHtml, andLocalizeJsString, which use theIHtmlStringabstraction to provide proper encoding. This will allow markup to more easily transition to using the safer<%: something %>code placeholders (colloquially, bee-stings) instead of<%= something %>.Fixes #6571
This PR also adds the following static helper methods:
IHtmlString HtmlUtils.JavaScriptStringEncode(string)IHtmlString PageBase.JavaScriptStringEncode(string)IHtmlString UserControlBase.JavaScriptStringEncode(string)IHtmlString HtmlUtils.JavaScriptStringEncode(string, bool)IHtmlString PageBase.JavaScriptStringEncode(string, bool)IHtmlString UserControlBase.JavaScriptStringEncode(string, bool)Finally, due to marking some members as obsolete, this PR also replaces usages of
LocalizeStringwithLocalizeTextin projects where obsolete usage is a compilation error. In those controls, I also adjusted the frontend markup to use<%:bee stings.