Skip to content

Add deprecation warning to Uri.UserEscaped property documentation #11467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 18, 2025
Merged

Add deprecation warning to Uri.UserEscaped property documentation #11467

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d338a06
Initial plan for issue
Copilot Jun 18, 2025
24e8161
Add deprecation warning to Uri.UserEscaped property documentation
Copilot Jun 18, 2025
22efb7f
Update xml/System/Uri.xml
gewarren Jun 18, 2025
e585436
Update xml/System/Uri.xml
gewarren Jun 18, 2025
f440f4b
Remove misleading "always false" claim from Uri.UserEscaped documenta…
Copilot Jun 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion xml/System/Uri.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6030,7 +6030,11 @@ The following examples show a URI and the results of calling <xref:System.Uri.Ge
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.Uri.UserEscaped%2A> property is set to `true` to indicate that the string used to create the <xref:System.Uri> instance was completely escaped before it was passed to the constructor; that is, the `dontEscape` parameter of the constructor call was set to `true`.

> [!CAUTION]
> The <xref:System.Uri.UserEscaped%2A> property represents deprecated functionality that will not work as expected. The `dontEscape` parameter referenced by this property has been deprecated since .NET Framework 4 and will always be `false`. As a result, this property will always return `false` and should not be used to determine URI escaping behavior.

The <xref:System.Uri.UserEscaped%2A> property was originally designed to indicate that the string used to create the <xref:System.Uri> instance was completely escaped before it was passed to the constructor; that is, the `dontEscape` parameter of the constructor call was set to `true`. However, since the `dontEscape` parameter is now obsolete and always treated as `false`, this property will always return `false`.

## Examples
The following example creates a <xref:System.Uri> instance and determines whether it was fully escaped when it was created.
Expand Down