ISyntaxHighlightService.Execute() Method

This method is called if the text content of the control is modified.

Namespace: DevExpress.XtraRichEdit.Services

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

Declaration

C#

void Execute()

VB.NET

Sub Execute

Remarks

Use the Execute method to parse the text into tokens and highlight the document text using the SubDocument.ApplySyntaxHighlight method.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/syntax-highlighting-for-c-and-vb-code-using-devexpress-codeparser-and-syntax-highlight-tokens-e2993

Form1.vb

Public Sub Execute() Implements ISyntaxHighlightService.Execute
    Dim newText As String = syntaxEditor.Text
    ' Determine language by file extension.
    Dim ext As String = System.IO.Path.GetExtension(syntaxEditor.Options.DocumentSaveOptions.CurrentFileName)
    Dim lang_ID As ParserLanguageID = ParserLanguage.FromFileExtension(ext)
    ' Do not parse HTML or XML.
    If lang_ID = ParserLanguageID.Html OrElse lang_ID = ParserLanguageID.Xml OrElse lang_ID = ParserLanguageID.None Then
        Return
    End If
    ' Use DevExpress.CodeParser to parse text into tokens.
    Dim tokenHelper As ITokenCategoryHelper = TokenCategoryHelperFactory.CreateHelper(lang_ID)
    Dim highlightTokens As TokenCollection
    highlightTokens = tokenHelper.GetTokens(newText)
    HighlightSyntax(highlightTokens)
End Sub

Public Sub ForceExecute() Implements  ISyntaxHighlightService.ForceExecute
    Execute()
End Sub

Form1.cs

public void Execute()
{
    string newText = syntaxEditor.Text;
    // Determine language by file extension.
    string ext = System.IO.Path.GetExtension(syntaxEditor.Options.DocumentSaveOptions.CurrentFileName);
    ParserLanguageID lang_ID = ParserLanguage.FromFileExtension(ext);
    // Do not parse HTML or XML.
    if (lang_ID == ParserLanguageID.Html || 
        lang_ID == ParserLanguageID.Xml || 
        lang_ID== ParserLanguageID.None) return;
    // Use DevExpress.CodeParser to parse text into tokens.
    ITokenCategoryHelper tokenHelper = TokenCategoryHelperFactory.CreateHelper(lang_ID);
    TokenCollection highlightTokens;
    highlightTokens = tokenHelper.GetTokens(newText);
    HighlightSyntax(highlightTokens);
}

public void ForceExecute()
{
    Execute();
}