value | The first parameter of type EditorWindow corresponds to the window that contains the text that was clicked. The second parameter of type HyperLinkClickedEventArgs contains the hyperlink data. |
Event used to react on clicks on a text hyperlink part.
On a rich text string, a hyperlink is defined with the <a> tag.
<a href="https://docs.unity3d.com">Documentation link</a>
The hyperlink parameters are returned in the HyperLinkClickedEventArgs.
In the example above, the HyperLinkClickedEventArgs.hyperLinkData dictionary will have one element of key "href" and of value "https://docs.unity3d.com".
Do note that this parameter is already covered by default to open uri. It also handles paths and you can add the line parameter to open the file directly on a specific line.
It is possible to have only part of a string in a hyperlink or even multiple hyperlinks per string.
This is the <a href=\"https://unity.com/\">unity website</a> and this is the <a href=\"https://docs.unity3d.com\">unity documentation website</a>
The event contains information only on the hyperlink part that is clicked.
Use the window parameter in order to react only on hyperlinks that were clicked in that window. If you don't filter on the window, you might react to other hyperlinks like the ones in the Console or the Profiler.
using System; using UnityEditor; using UnityEngine; class EditorGUIHyperLinkClicked : EditorWindow { [MenuItem("Examples/EditorGUIHyperLinkClicked")] static void Init() { var window = GetWindow<EditorGUIHyperLinkClicked>(); window.Show(); } void OnGUI() { GUIStyle style = new GUIStyle() { richText = true }; EditorGUILayout.TextField("<a data=\"some data\" otherData=\"some other data\">displayed string</a>", style); } static EditorGUIHyperLinkClicked() { EditorGUI.hyperLinkClicked += EditorGUI_hyperLinkClicked; } private static void EditorGUI_hyperLinkClicked(EditorWindow window, HyperLinkClickedEventArgs args) { if (window.titleContent.text == "EditorGUIHyperLinkClicked") { var hyperLinkData = args.hyperLinkData; var data = hyperLinkData["data"]; var otherData = hyperLinkData["otherData"]; Debug.Log($"data: {data}, otherData: {otherData}"); } } }
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.