SubDocument.ApplySyntaxHighlight(List<SyntaxHighlightToken>) Method

Performs a batch update of text formatting for document ranges corresponding to specified tokens.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v24.1.Core.dll

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

void ApplySyntaxHighlight(
    List<SyntaxHighlightToken> tokens
)

VB.NET

Sub ApplySyntaxHighlight(
    tokens As List(Of SyntaxHighlightToken)
)

Parameters

Name	Type	Description
tokens	List<SyntaxHighlightToken>	A List<T><SyntaxHighlightToken,> collection containing tokens to apply, ordered by the SyntaxHighlightToken.Start value.

Remarks

Call the SubDocument.ApplySyntaxHighlight method within the ISyntaxHighlightService.Execute() method to enable syntax highlighting.

Refer to the How to: Highlight Document Syntax example (or How to: Highlight Document Syntax for WPF) for information on how to obtain the collection of SyntaxHighlightToken objects.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ApplySyntaxHighlight(List<SyntaxHighlightToken>) method.

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#

rich-text-editor-highlight-syntax/CS/SyntaxHighlightApp/Form1.cs#L72

{
    document.ApplySyntaxHighlight(syntaxTokens);
}

winforms-richedit-syntax-highlighting-with-devexpress-codeparser-library/CS/WindowsFormsApplication1/SyntaxHighlighting.cs#L64

    }
    document.ApplySyntaxHighlight(syntaxTokens);
}

spreadsheet-document-api-chart-examples/CS/SpreadsheetDocServerChartAPISamples/CodeUtils/SyntaxHightlight.cs#L119

}
document.ApplySyntaxHighlight(syntaxTokens);
document.EndUpdateCharacters(cp);

spreadsheet-document-api-pivot-table-examples/CS/SpreadsheetDocServerPivotAPI/CodeUtils/SyntaxHightlight.cs#L140

}
document.ApplySyntaxHighlight(syntaxTokens);
document.EndUpdateCharacters(cp);

syntax-highlighting-for-c-and-vb-code-using-devexpress-codeparser-and-syntax-highlight-tokens/CS/SyntaxHighlightSimple/MainWindow.xaml.cs#L81

}
document.ApplySyntaxHighlight(syntaxTokens);
document.EndUpdateCharacters(cp);

VB.NET

rich-text-editor-highlight-syntax/VB/SyntaxHighlightApp/Form1.vb#L71

If syntaxTokens.Count > 0 Then
    document.ApplySyntaxHighlight(syntaxTokens)
End If

winforms-richedit-syntax-highlighting-with-devexpress-codeparser-library/VB/WindowsFormsApplication1/SyntaxHighlighting.vb#L65

    document.ApplySyntaxHighlight(syntaxTokens)
End Sub

spreadsheet-document-api-chart-examples/VB/SpreadsheetDocServerChartAPISamples/CodeUtils/SyntaxHightlight.vb#L119

Next token
document.ApplySyntaxHighlight(syntaxTokens)
document.EndUpdateCharacters(cp)

spreadsheet-document-api-pivot-table-examples/VB/SpreadsheetDocServerPivotAPI/CodeUtils/SyntaxHightlight.vb#L119

Next token
document.ApplySyntaxHighlight(syntaxTokens)
document.EndUpdateCharacters(cp)

syntax-highlighting-for-c-and-vb-code-using-devexpress-codeparser-and-syntax-highlight-tokens/VB/SyntaxHighlightSimple/MainWindow.xaml.vb#L76

document.ApplySyntaxHighlight(syntaxTokens)
document.EndUpdateCharacters(cp)