Back to Devexpress

SubDocument.BeginUpdateCharacters(Int32, Int32) Method

officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-subdocument-dot-beginupdatecharacters-x28-system-dot-int32-system-dot-int32-x29.md

latest6.8 KB
Original Source

SubDocument.BeginUpdateCharacters(Int32, Int32) Method

Starts modifying properties of the specified number of characters starting at the specified document position.

Namespace : DevExpress.XtraRichEdit.API.Native

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
CharacterProperties BeginUpdateCharacters(
    int start,
    int length
)
vb
Function BeginUpdateCharacters(
    start As Integer,
    length As Integer
) As CharacterProperties

Parameters

NameTypeDescription
startInt32

An integer specifying the starting document position.

| | length | Int32 |

An integer specifying the number of positions to which formatting is applied.

|

Returns

TypeDescription
CharacterProperties

A CharacterProperties object representing the character formatting of the specified range.

|

The following code snippets (auto-collected from DevExpress Examples) contain references to the BeginUpdateCharacters(Int32, Int32) 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.

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

csharp
Document document = syntaxEditor.Document;
CharacterProperties cp = document.BeginUpdateCharacters(0, 1);
List<SyntaxHighlightToken> syntaxTokens = new List<SyntaxHighlightToken>(tokens.Count);

wpf-spreadsheet-chart-api/CS/SpreadsheetWPFChartAPISamples/CodeUtils/SyntaxHightlight.cs#L113

csharp
Document document = editor.Document;
CharacterProperties cp = document.BeginUpdateCharacters(0, 1);

wpf-spreadsheet-pivot-table-api-examples/CS/SpreadsheetWPFPivotTableExamples/CodeUtils/SyntaxHightlight.cs#L133

csharp
Document document = editor.Document;
CharacterProperties cp = document.BeginUpdateCharacters(0, 1);

winforms-spreadsheet-chart-api/CS/SpreadsheetChartAPISamples/CodeUtils/SyntaxHightlight.cs#L113

csharp
Document document = editor.Document;
CharacterProperties cp = document.BeginUpdateCharacters(0, 1);

winforms-spreadsheet-pivot-table-api/CS/SpreadsheetPivotTableExamples/CodeUtils/SyntaxHightlight.cs#L133

csharp
Document document = editor.Document;
CharacterProperties cp = document.BeginUpdateCharacters(0, 1);

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

vb
Dim document As Document = syntaxEditor.Document
Dim cp As CharacterProperties = document.BeginUpdateCharacters(0, 1)
Dim syntaxTokens As List(Of SyntaxHighlightToken) = New List(Of SyntaxHighlightToken)(tokens.Count)

wpf-spreadsheet-chart-api/VB/SpreadsheetWPFChartAPISamples/CodeUtils/SyntaxHightlight.vb#L113

vb
Dim document As Document = editor.Document
Dim cp As CharacterProperties = document.BeginUpdateCharacters(0, 1)

wpf-spreadsheet-pivot-table-api-examples/VB/SpreadsheetWPFPivotTableExamples/CodeUtils/SyntaxHightlight.vb#L113

vb
Dim document As Document = editor.Document
Dim cp As CharacterProperties = document.BeginUpdateCharacters(0, 1)

winforms-spreadsheet-chart-api/VB/SpreadsheetChartAPISamples/CodeUtils/SyntaxHightlight.vb#L113

vb
Dim document As Document = editor.Document
Dim cp As CharacterProperties = document.BeginUpdateCharacters(0, 1)

winforms-spreadsheet-pivot-table-api/VB/SpreadsheetPivotTableExamples/CodeUtils/SyntaxHightlight.vb#L113

vb
Dim document As Document = editor.Document
Dim cp As CharacterProperties = document.BeginUpdateCharacters(0, 1)

See Also

SubDocument Interface

SubDocument Members

DevExpress.XtraRichEdit.API.Native Namespace