telerik/winforms-docs

winforms-docs/richtexteditor/features/hyperlink.md lower half of document formatting needs correction.

Closed this issue · 2 comments

OtherCustomizationOptions <--- needs spaces

Note {0}{1} to follow link <--- content needed

would be better to replace image (https://docs.telerik.com/devtools/winforms/richtexteditor/features/images/richtexteditor-features-hyperlink002.png) with a textbox code example, which would be consistant with most other documentation.

The image shows the event arguments which would not be seen in code example (all code is compiled and automatically inserted in the articles). The other issues will be fixed in the upcoming release.

from a user experience, I can tell you, that having a static image of string names that tells me what hangs off an event argument isn't as useful as either a link to the event argument class itself, or a code example that would show the practical usage for those arguments. maybe link to (https://docs.telerik.com/devtools/winforms/api/html/properties_t_telerik_winforms_documents_model_hyperlinkclickedeventargs.htm) which explains what they do.

There are 2 (actually 3, see image below) other code samples on the page none using a static graphic.

Things like letting the users know this argument for URL is actually a string, and not a URL type would be helpful.

A usage example similar to, would be more helpful in my opinion.

void radRichTextEditor1_HyperLinkClicked(object sender, HyperlinkClickedEventArgs e)
{
   if(e.URL.Contains("file://") && e.HyperlinkTarget == HyperlinkTargets.Self)
   {
     //Do internal file URL processing.
     e.Handled = true;
   }
}

if you are auto generating the code images, you might consider taking it a step farther and OCR the image, and use that text as the alt text on the image, or included in a code block below it.

image