Skip to content

fix: RichTextBox LinkClicked event for "friendly named" hyperlinks #1745

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
RussKie merged 1 commit into from
Sep 4, 2019
Merged

fix: RichTextBox LinkClicked event for "friendly named" hyperlinks #1745

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 8 additions & 7 deletions src/System.Windows.Forms/src/System/Windows/Forms/RichTextBox.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3481,21 +3481,22 @@ private void EnLinkMsgHandler(ref Message m)
}

/// <summary>
/// Converts a CHARRANGE to a string. Note: The behavior of this is dependent on the current window
/// class name being used. We have to create a CharBuffer of the type of RichTextBox DLL we're using,
/// not based on the SystemCharWidth.
/// Converts a CHARRANGE to a string.
/// </summary>
/// <remarks>
/// The behavior of this is dependent on the current window class name being used.
/// We have to create a CharBuffer of the type of RichTextBox DLL we're using,
/// not based on the SystemCharWidth.
/// </remarks>
private string CharRangeToString(Richedit.CHARRANGE c)
{
NativeMethods.TEXTRANGE txrg = new NativeMethods.TEXTRANGE
{
chrg = c
};
Debug.Assert((c.cpMax - c.cpMin) > 0, "CHARRANGE was null or negative - can't do it!");

//Windows

if (c.cpMax > Text.Length || c.cpMax - c.cpMin <= 0)
Debug.Assert((c.cpMax - c.cpMin) > 0, "CHARRANGE was null or negative - can't do it!");
if (c.cpMax - c.cpMin <= 0)
Copy link
Copy Markdown
Contributor

@zsd4yr zsd4yr Sep 3, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this the fix?

Copy link
Copy Markdown
Contributor

@weltkante weltkante Sep 3, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it removes a workaround which was causing problems. its not known what it was working around (some comment refers to a bug id which couldn't be tracked down yet)

a long explanation can be found on stackoverflow

The point is that Text.Length can be the wrong value to compare against in presence of "friendly name links", a feature added by upgrading the RTF control. The workaround existed before the control upgrade but was never updated. Since its not know what its working around removing it makes the most sense.

Copy link
Copy Markdown
Contributor

@zsd4yr zsd4yr Sep 3, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see, so if there is a friendly name link, then Text.Length will be longer than is technically allowed (greater than cpMax), but since it is still visually allowed, this appears as a bug.

It seems odd to me that we would ever have opted to make the string empty is this circumstance. Truncation would be more appropriate, but anyways... fix looks good.

Is there any reason we would want to maintain this behavior? I cannot think of anything off the top of my head.

{
return string.Empty;
}
Expand Down
4 changes: 4 additions & 0 deletions ...s/tests/IntegrationTests/WinFormsControlsClassicTests/WinFormsControlsClassicTests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,10 @@
<Link>PropertyGrid.resx</Link>
<DependentUpon>PropertyGrid.cs</DependentUpon>
</EmbeddedResource>
<EmbeddedResource Include="..\WinformsControlsTest\RichTextBoxes.resx">
<Link>RichTextBoxes.resx</Link>
<DependentUpon>RichTextBoxes.cs</DependentUpon>
</EmbeddedResource>
<EmbeddedResource Include="..\WinformsControlsTest\ScalingBeforeChanges.resx">
<Link>ScalingBeforeChanges.resx</Link>
<DependentUpon>ScalingBeforeChanges.cs</DependentUpon>
Expand Down
25 changes: 19 additions & 6 deletions ...ystem.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/RichTextBoxes.Designer.cs
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 16 additions & 1 deletion src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/RichTextBoxes.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

using System;
using System.IO;
using System.Windows.Forms;

Expand All @@ -14,10 +15,24 @@ public RichTextBoxes()
InitializeComponent();

richTextBox1.LoadFile(File.OpenRead(@"Data\example.rtf"), RichTextBoxStreamType.RichText);
Load += Form1_Load;
}

private void Form1_Load(object sender, EventArgs e)
{
richTextBox2.Rtf = @"{\rtf1\ansi\ansicpg1252\deff0\nouicompat\deflang4105{\fonttbl{\f0\fnil\fcharset0 Calibri;}}
{\*\generator Riched20 10.0.17134}\viewkind4\uc1
{\field{\*\fldinst { HYPERLINK ""http://www.google.com"" }}{\fldrslt {Click here}}}
\pard\sa200\sl276\slmult1\f0\fs22\lang9 for more information.\par
}";
}

private void richTextBox1_LinkClicked(object sender, LinkClickedEventArgs e)
{
MessageBox.Show(this, e.LinkText, "link clicked");
}

private void RichTextBox1_LinkClicked(object sender, LinkClickedEventArgs e)
private void richTextBox2_LinkClicked(object sender, LinkClickedEventArgs e)
{
MessageBox.Show(this, e.LinkText, "link clicked");
}
Expand Down
120 changes: 120 additions & 0 deletions src/System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/RichTextBoxes.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
<?xml version="1.0" encoding="utf-8"?>
<root>
<!--
Microsoft ResX Schema

Version 2.0

The primary goals of this format is to allow a simple XML format
that is mostly human readable. The generation and parsing of the
various data types are done through the TypeConverter classes
associated with the data types.

Example:

... ado.net/XML headers & schema ...
<resheader name="resmimetype">text/microsoft-resx</resheader>
<resheader name="version">2.0</resheader>
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
<value>[base64 mime encoded serialized .NET Framework object]</value>
</data>
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
<comment>This is a comment</comment>
</data>

There are any number of "resheader" rows that contain simple
name/value pairs.

Each data row contains a name, and value. The row also contains a
type or mimetype. Type corresponds to a .NET class that support
text/value conversion through the TypeConverter architecture.
Classes that don't support this are serialized and stored with the
mimetype set.

The mimetype is used for serialized objects, and tells the
ResXResourceReader how to depersist the object. This is currently not
extensible. For a given mimetype the value must be set accordingly:

Note - application/x-microsoft.net.object.binary.base64 is the format
that the ResXResourceWriter will generate, however the reader can
read any of the formats listed below.

mimetype: application/x-microsoft.net.object.binary.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
: and then encoded with base64 encoding.

mimetype: application/x-microsoft.net.object.soap.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
: and then encoded with base64 encoding.

mimetype: application/x-microsoft.net.object.bytearray.base64
value : The object must be serialized into a byte array
: using a System.ComponentModel.TypeConverter
: and then encoded with base64 encoding.
-->
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
<xsd:element name="root" msdata:IsDataSet="true">
<xsd:complexType>
<xsd:choice maxOccurs="unbounded">
<xsd:element name="metadata">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" />
</xsd:sequence>
<xsd:attribute name="name" use="required" type="xsd:string" />
<xsd:attribute name="type" type="xsd:string" />
<xsd:attribute name="mimetype" type="xsd:string" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="assembly">
<xsd:complexType>
<xsd:attribute name="alias" type="xsd:string" />
<xsd:attribute name="name" type="xsd:string" />
</xsd:complexType>
</xsd:element>
<xsd:element name="data">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="resheader">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" />
</xsd:complexType>
</xsd:element>
</xsd:choice>
</xsd:complexType>
</xsd:element>
</xsd:schema>
<resheader name="resmimetype">
<value>text/microsoft-resx</value>
</resheader>
<resheader name="version">
<value>2.0</value>
</resheader>
<resheader name="reader">
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<resheader name="writer">
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
</root>
6 changes: 6 additions & 0 deletions ...System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/xlf/RichTextBoxes.cs.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2" xsi:schemaLocation="urn:oasis:names:tc:xliff:document:1.2 xliff-core-1.2-transitional.xsd">
<file datatype="xml" source-language="en" target-language="cs" original="../RichTextBoxes.resx">
<body />
</file>
</xliff>
6 changes: 6 additions & 0 deletions ...System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/xlf/RichTextBoxes.de.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2" xsi:schemaLocation="urn:oasis:names:tc:xliff:document:1.2 xliff-core-1.2-transitional.xsd">
<file datatype="xml" source-language="en" target-language="de" original="../RichTextBoxes.resx">
<body />
</file>
</xliff>
6 changes: 6 additions & 0 deletions ...System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/xlf/RichTextBoxes.es.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2" xsi:schemaLocation="urn:oasis:names:tc:xliff:document:1.2 xliff-core-1.2-transitional.xsd">
<file datatype="xml" source-language="en" target-language="es" original="../RichTextBoxes.resx">
<body />
</file>
</xliff>
6 changes: 6 additions & 0 deletions ...System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/xlf/RichTextBoxes.fr.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2" xsi:schemaLocation="urn:oasis:names:tc:xliff:document:1.2 xliff-core-1.2-transitional.xsd">
<file datatype="xml" source-language="en" target-language="fr" original="../RichTextBoxes.resx">
<body />
</file>
</xliff>
6 changes: 6 additions & 0 deletions ...System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/xlf/RichTextBoxes.it.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2" xsi:schemaLocation="urn:oasis:names:tc:xliff:document:1.2 xliff-core-1.2-transitional.xsd">
<file datatype="xml" source-language="en" target-language="it" original="../RichTextBoxes.resx">
<body />
</file>
</xliff>
6 changes: 6 additions & 0 deletions ...System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/xlf/RichTextBoxes.ja.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2" xsi:schemaLocation="urn:oasis:names:tc:xliff:document:1.2 xliff-core-1.2-transitional.xsd">
<file datatype="xml" source-language="en" target-language="ja" original="../RichTextBoxes.resx">
<body />
</file>
</xliff>
6 changes: 6 additions & 0 deletions ...System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/xlf/RichTextBoxes.ko.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2" xsi:schemaLocation="urn:oasis:names:tc:xliff:document:1.2 xliff-core-1.2-transitional.xsd">
<file datatype="xml" source-language="en" target-language="ko" original="../RichTextBoxes.resx">
<body />
</file>
</xliff>
6 changes: 6 additions & 0 deletions ...System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/xlf/RichTextBoxes.pl.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2" xsi:schemaLocation="urn:oasis:names:tc:xliff:document:1.2 xliff-core-1.2-transitional.xsd">
<file datatype="xml" source-language="en" target-language="pl" original="../RichTextBoxes.resx">
<body />
</file>
</xliff>
6 changes: 6 additions & 0 deletions ...tem.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/xlf/RichTextBoxes.pt-BR.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2" xsi:schemaLocation="urn:oasis:names:tc:xliff:document:1.2 xliff-core-1.2-transitional.xsd">
<file datatype="xml" source-language="en" target-language="pt-BR" original="../RichTextBoxes.resx">
<body />
</file>
</xliff>
6 changes: 6 additions & 0 deletions ...System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/xlf/RichTextBoxes.ru.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2" xsi:schemaLocation="urn:oasis:names:tc:xliff:document:1.2 xliff-core-1.2-transitional.xsd">
<file datatype="xml" source-language="en" target-language="ru" original="../RichTextBoxes.resx">
<body />
</file>
</xliff>
6 changes: 6 additions & 0 deletions ...System.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/xlf/RichTextBoxes.tr.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2" xsi:schemaLocation="urn:oasis:names:tc:xliff:document:1.2 xliff-core-1.2-transitional.xsd">
<file datatype="xml" source-language="en" target-language="tr" original="../RichTextBoxes.resx">
<body />
</file>
</xliff>
6 changes: 6 additions & 0 deletions ...m.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/xlf/RichTextBoxes.zh-Hans.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2" xsi:schemaLocation="urn:oasis:names:tc:xliff:document:1.2 xliff-core-1.2-transitional.xsd">
<file datatype="xml" source-language="en" target-language="zh-Hans" original="../RichTextBoxes.resx">
<body />
</file>
</xliff>
6 changes: 6 additions & 0 deletions ...m.Windows.Forms/tests/IntegrationTests/WinformsControlsTest/xlf/RichTextBoxes.zh-Hant.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2" xsi:schemaLocation="urn:oasis:names:tc:xliff:document:1.2 xliff-core-1.2-transitional.xsd">
<file datatype="xml" source-language="en" target-language="zh-Hant" original="../RichTextBoxes.resx">
<body />
</file>
</xliff>