RichEditControl.HyperlinkFormShowing Event

Occurs before the Edit Hyperlink dialog is invoked.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v20.1.dll

Declaration

public event HyperlinkFormShowingEventHandler HyperlinkFormShowing
Public Event HyperlinkFormShowing As HyperlinkFormShowingEventHandler

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.

Examples

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;
}
See Also