Skip to main content

DevExpress v24.1 Update — Your Feedback Matters

Our What's New in v24.1 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

RichEditControl.HyphenationFormShowing Event

Occurs before the Hyphenation dialog is invoked.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.RichEdit, DevExpress.Win.TreeMap

#Declaration

public event HyphenationFormShowingEventHandler HyphenationFormShowing

#Event Data

The HyphenationFormShowing event's data class is HyphenationFormShowingEventArgs. The following properties provide information specific to this event:

Property Description
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.
HyphenationInfo Provides access to the hyphenation information.
Parent Gets or sets a parent of the form being shown. Inherited from ShowFormEventArgs.

#Remarks

Handle the HyphenationFormShowing event to perform any actions prior to the Hyphenation 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.

The code sample below shows how to handle the HyphenationFormShowing event to change the caption of the Hyphenation dialog.

class MyHyphenationForm : HyphenationOptionsForm
{
    public MyHyphenationForm(IRichEditControl control, HyphenationInfo hyphenationInfo) : base(control, hyphenationInfo)
    {
        this.Text = "Change Hyphenation Options";
    }
}

public partial class Form1 : Form
{
    public Form1()
    {
        InitializeComponent();
        this.richEditControl.HyphenationFormShowing += RichEditControl_HyphenationFormShowing;
    }

    private void RichEditControl_HyphenationFormShowing(object sender, HyphenationFormShowingEventArgs e)
    {
        MyHyphenationForm frm = new MyHyphenationForm(this.richEditControl, e.HyphenationInfo);
        e.DialogResult = frm.ShowDialog();
        frm.Dispose();
        e.Handled = true;

    }
}
See Also