AutoCorrectEventArgs.AutoCorrectInfo Property

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

Namespace: DevExpress.XtraRichEdit

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

Declaration

C#

public AutoCorrectInfo AutoCorrectInfo { get; set; }

VB.NET

Public Property AutoCorrectInfo As AutoCorrectInfo

Property Value

Type	Description
AutoCorrectInfo	An AutoCorrectInfo object.

Remarks

The AutoCorrectInfo is the main source of information used in handling the AutoCorrect event.

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.

Use the AutoCorrectEventArgs.AutoCorrectInfo property to obtain the document text, then call the AutoCorrectInfo.DecrementStartPosition method to expand its left boundary until a special symbol or a word separator symbol is found. Use the AutoCorrectInfo.ReplaceWith property to pass a replacement object (a string or an image) to the document if a resulting string meets certain conditions, such as whether it is a dollar sign or a %date% string.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-handle-the-autocorrect-event-e3041

Form1.vb

Private Sub richEditControl1_AutoCorrect(ByVal sender As Object, ByVal e As DevExpress.XtraRichEdit.AutoCorrectEventArgs) Handles richEditControl1.AutoCorrect
    Dim info As AutoCorrectInfo = e.AutoCorrectInfo
    e.AutoCorrectInfo = Nothing

    If info.Text.Length <= 0 Then
        Return
    End If
    Do
        If Not info.DecrementStartPosition() Then
            Return
        End If

        If IsSeparator(info.Text(0)) Then
            Return
        End If

        If info.Text(0) = "$"c Then
            info.ReplaceWith = CreateImageFromResx("dollar_pic.png")
            e.AutoCorrectInfo = info
            Return
        End If

        If info.Text(0) = "%"c Then
            Dim replaceString As String = CalculateFunction(info.Text)
            If Not String.IsNullOrEmpty(replaceString) Then
                info.ReplaceWith = replaceString
                e.AutoCorrectInfo = info
            End If
            Return
        End If
    Loop
End Sub

Form1.cs

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

    if (info.Text.Length <= 0)
        return;
    for (; ; ) {
        if (!info.DecrementStartPosition())
            return;

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

        if (info.Text[0] == '$') {
            info.ReplaceWith = CreateImageFromResx("dollar_pic.png");
            e.AutoCorrectInfo = info;
            return;
        } 

        if (info.Text[0] == '%') {
            string replaceString = CalculateFunction(info.Text);
            if (!String.IsNullOrEmpty(replaceString)) {
                info.ReplaceWith = replaceString;
                e.AutoCorrectInfo = info;
            }
            return;
        }
    }
}

Related GitHub Examples

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

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#

richeditcontrol-event-viewer-t258534/CS/RichEditControlEventViewer/Form1.cs#L109

{
    args.AutoCorrectInfo = null;
    InitializeEventLogger(eventName, sender, args);

VB.NET

richeditcontrol-event-viewer-t258534/VB/RichEditControlEventViewer/Form1.vb#L95

Public Sub InitializeAutoCorrectEventLogger(ByVal eventName As String, ByVal sender As Object, ByVal args As AutoCorrectEventArgs)
    args.AutoCorrectInfo = Nothing
    InitializeEventLogger(eventName, sender, args)