HyperlinkFormShowingEventArgs Class

Provides data for the RichEditControl.HyperlinkFormShowing event.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v18.2.Core.dll

Declaration

C#

public class HyperlinkFormShowingEventArgs :
    FormShowingEventArgs

VB.NET

Public Class HyperlinkFormShowingEventArgs
    Inherits FormShowingEventArgs

Related API Members

HyperlinkFormShowingEventArgs is the data class for the following events:

• RichEditControl.HyperlinkFormShowing

Remarks

The RichEditControl.HyperlinkFormShowing event occurs before the Edit Hyperlink dialog is invoked. The HyperlinkFormShowingEventArgs class introduces the HyperlinkFormShowingEventArgs.ControllerParameters property, that specifies the information to be displayed in the dialog.

Note, that HyperlinkFormShowingEventArgs objects are automatically created, initialized and passed to the RichEditControl.HyperlinkFormShowing event handlers.

Example

This example demonstrates how to replace the standard Hyperlink dialog with a custom form using the RichEditControl.HyperlinkFormShowing event.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-customize-dialog-forms-in-xtrarichedit-suite-e3095

Form1.cs

private void richEditControl1_HyperlinkFormShowing(object sender,HyperlinkFormShowingEventArgs e)
{
    MyHyperlinkForm form = new MyHyperlinkForm(e.ControllerParameters);
    e.DialogResult = form.ShowDialog();
    e.Handled = true;
}

MyHyperlinkForm.cs

using System;
using DevExpress.XtraRichEdit.Forms;

namespace CustomDialogs
{
    class MyHyperlinkForm : HyperlinkForm
    {
        public MyHyperlinkForm(HyperlinkFormControllerParameters controllerParameters)
            : base(controllerParameters)
        {
            btnEditAddress.EditValueChanged += new EventHandler(btnEditAddress_EditValueChanged);
            btnEditAddress.LostFocus += new EventHandler(btnEditAddress_LostFocus);
        }

        void btnEditAddress_LostFocus(object sender, EventArgs e)
        {
            this.btnEditAddress.Text = Controller.NavigateUri;
        }

        void btnEditAddress_EditValueChanged(object sender, EventArgs e)
        {
            Controller.NavigateUri = ValidateUrl(btnEditAddress.Text);
            this.btnOk.Enabled = true;
        }

        private string ValidateUrl(string p)
        {
            string s = p.Replace("devexpres.com", "devexpress.com");
            return s;
        }

    }
}

MyHyperlinkForm.vb

Imports Microsoft.VisualBasic
Imports System
Imports DevExpress.XtraRichEdit.Forms

Namespace CustomDialogs
    Friend Class MyHyperlinkForm
        Inherits HyperlinkForm
        Public Sub New(ByVal controllerParameters As HyperlinkFormControllerParameters)
            MyBase.New(controllerParameters)
            AddHandler btnEditAddress.EditValueChanged, AddressOf btnEditAddress_EditValueChanged
            AddHandler btnEditAddress.LostFocus, AddressOf btnEditAddress_LostFocus
        End Sub

        Private Sub btnEditAddress_LostFocus(ByVal sender As Object, ByVal e As EventArgs)
            Me.btnEditAddress.Text = Controller.NavigateUri
        End Sub

        Private Sub btnEditAddress_EditValueChanged(ByVal sender As Object, ByVal e As EventArgs)
            Controller.NavigateUri = ValidateUrl(btnEditAddress.Text)
            Me.btnOk.Enabled = Not String.IsNullOrEmpty(Me.btnEditAddress.Text)
        End Sub

        Private Function ValidateUrl(ByVal p As String) As String
            Dim s As String = p.Replace("devexpres.com", "devexpress.com")
            Return s
        End Function

    End Class
End Namespace

Form1.vb

Private Sub richEditControl1_HyperlinkFormShowing(ByVal sender As Object, ByVal e As HyperlinkFormShowingEventArgs) Handles richEditControl1.HyperlinkFormShowing
    Dim form As New MyHyperlinkForm(e.ControllerParameters)
    e.DialogResult = form.ShowDialog()
    e.Handled = True
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the HyperlinkFormShowingEventArgs class.

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.

C#

how-to-customize-dialog-forms-in-xtrarichedit-suite-e3095/CS/CustomDialogs/Form1.cs#L30

#region #HyperlinkFormShowing
private void richEditControl1_HyperlinkFormShowing(object sender,HyperlinkFormShowingEventArgs e)
{

VB.NET

how-to-customize-dialog-forms-in-xtrarichedit-suite-e3095/VB/CustomDialogs/Form1.vb#L28

#Region "#HyperlinkFormShowing"
Private Sub richEditControl1_HyperlinkFormShowing(ByVal sender As Object, ByVal e As HyperlinkFormShowingEventArgs) Handles richEditControl1.HyperlinkFormShowing
    Dim form As New MyHyperlinkForm(e.ControllerParameters)

Inheritance

Object

EventArgs

ShowFormEventArgs

FormShowingEventArgs

HyperlinkFormShowingEventArgs