RichEditControl.AutoCorrect Event

Fires when text is typed in the control.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v20.1.dll

Declaration

public event AutoCorrectEventHandler AutoCorrect
Public Event AutoCorrect As AutoCorrectEventHandler

Event Data

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

Property Description
AutoCorrectInfo Gets or sets the AutoCorrectInfo object that provides methods to analyze input text and contains a replacement object.

Remarks

Handle the AutoCorrect event to analyze the input text and provide a specific object for replacement.

If you handle the AutoCorrect event, and do not intend to make any replacements, set e.AutoCorrectInfo to null instead of setting the AutoCorrectInfo.ReplaceWith to an empty string.

NOTE

We do not recommend calling methods used to access a document layout (e.g.,Document.CaretPosition or RichEditControl.GetBoundsFromPosition) in this event handler. This may result in an unhandled exception.

Examples

The following code sample shows how to handle the RichEditControl.AutoCorrect event to replace the typed $ symbol with a picture of a dollar, and substitute the text enclosed in percent symbols with custom content.

private void richEditControl1_AutoCorrect(object sender, DevExpress.XtraRichEdit.AutoCorrectEventArgs e)
{
    AutoCorrectInfo info = e.AutoCorrectInfo;
    e.AutoCorrectInfo = null;

    if (info.Text.Length <= 0)
        return;

    //Find a dollar and the percent sign in the obtained text
    for (; ; )
    {
        if (!info.DecrementStartPosition())
            return;

        if (IsSeparator(info.Text[0]))
            return;

        if (info.Text[0] == '$')
        {
            //Replace the dollar sign with an image
            info.ReplaceWith = CreateImageFromResx("dollar_pic.png");
            e.AutoCorrectInfo = info;
            return;
        }

        if (info.Text[0] == '%')
        {
            //Replace a text between dollar signs with a custom content
            string replaceString = CalculateFunction(info.Text);
            if (!String.IsNullOrEmpty(replaceString))
            {
                info.ReplaceWith = replaceString;
                e.AutoCorrectInfo = info;
            }
            return;
        }
    }
}
See Also