RichEditControl.HyperlinkFormShowing Event
Occurs before the Edit Hyperlink dialog is invoked.
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.XtraRichEdit.v21.1.dll
NuGet Packages: DevExpress.Win.Design, DevExpress.Win.RichEdit
Declaration
Event Data
The HyperlinkFormShowing event's data class is HyperlinkFormShowingEventArgs. The following properties provide information specific to this event:
Property | Description |
---|---|
ControllerParameters | Gets the information for initializing the Edit Hyperlink dialog controls. |
DialogResult | Gets or sets the return value of a dialog box. Inherited from ShowFormEventArgs. |
Handled | Gets or sets whether an event was handled. If it was handled, the default actions are not required. Inherited from ShowFormEventArgs. |
Parent | Gets or sets a parent of the form being shown. Inherited from ShowFormEventArgs. |
Remarks
Handle the HyperlinkFormShowing event to perform any actions prior to the Edit Hyperlink dialog being shown. For example, you can substitute the standard dialog with a custom one and set the ShowFormEventArgs.Handled property to true, to prevent default event handling.
Example
This example demonstrates how to replace the standard Hyperlink dialog with a custom form using the RichEditControl.HyperlinkFormShowing
event.
private void richEditControl1_HyperlinkFormShowing(object sender,HyperlinkFormShowingEventArgs e)
{
MyHyperlinkForm form = new MyHyperlinkForm(e.ControllerParameters);
e.DialogResult = form.ShowDialog();
form.Dispose();
e.Handled = true;
}
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the HyperlinkFormShowing event.
Note
The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.