SubDocument.BeginUpdateCharacters(DocumentRange) Method

Starts modifying properties of characters that fall within a specified document range.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

CharacterProperties BeginUpdateCharacters(
    DocumentRange range
)

VB.NET

Function BeginUpdateCharacters(
    range As DocumentRange
) As CharacterProperties

Parameters

Name	Type	Description
range	DocumentRange	A DocumentRange object specifying the DocumentRange.Start and DocumentRange.End of the text.

Returns

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

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-richedit-document-api-e5219

Formatting.vb

document.BeginUpdate()
document.AppendText("Normal" & vbLf & "Formatted" & vbLf & "Normal")
document.EndUpdate()
' The target range is the second paragraph 
Dim range As DocumentRange = document.Paragraphs(1).Range

' Create and customize an object  
' that sets character formatting for the selected range
Dim cp As CharacterProperties = document.BeginUpdateCharacters(range)
cp.FontName = "Comic Sans MS"
cp.FontSize = 18
cp.ForeColor = Color.Blue
cp.BackColor = Color.Snow
cp.Underline = UnderlineType.DoubleWave
cp.UnderlineColor = Color.Red

' Finalize modifications  
' with this method call 
document.EndUpdateCharacters(cp)

Formatting.cs

document.BeginUpdate();
document.AppendText("Normal\nFormatted\nNormal");
document.EndUpdate();
// The target range is the second paragraph 
DocumentRange range = document.Paragraphs[1].Range;

// Create and customize an object  
// that sets character formatting for the selected range
CharacterProperties cp = document.BeginUpdateCharacters(range);
cp.FontName = "Comic Sans MS";
cp.FontSize = 18;
cp.ForeColor = Color.Blue;
cp.BackColor = Color.Snow;
cp.Underline = UnderlineType.DoubleWave;
cp.UnderlineColor = Color.Red;

// Finalize modifications  
// with this method call 
document.EndUpdateCharacters(cp);

Related GitHub Examples

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

generating-table-of-contents-toc-practical-guide-e4138/CS/Form1.cs#L70

DocumentRange range = Document.CreateRange(Document.Paragraphs[i].Range.Start, 1);
CharacterProperties cp = Document.BeginUpdateCharacters(range);
int level = 0;

wpf-richedit-document-api-t213968/CS/DXRichEditControlAPISample/CodeExamples/FormattingActions.cs#L16

DocumentRange range = document.Paragraphs[1].Range;
CharacterProperties cp = document.BeginUpdateCharacters(range);
cp.FontName = "Comic Sans MS";

winforms-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/Formatting.cs#L20

// that sets character formatting for the selected range
CharacterProperties cp = document.BeginUpdateCharacters(range);
cp.FontName = "Comic Sans MS";

word-document-api-examples/CS/CodeExamples/FormattingActions.cs#L18

DocumentRange range = document.Paragraphs[1].Range;
CharacterProperties cp = document.BeginUpdateCharacters(range);
cp.FontName = "Comic Sans MS";

how-to-generate-table-of-content-automatically-based-on-some-datasource-records-e5011/CS/WindowsFormsApplication1/Form1.cs#L51

Field field = richEditControl1.Document.Fields.Add(richEditControl1.Document.Range.Start, "TOC " + switches);
CharacterProperties cp = richEditControl1.Document.BeginUpdateCharacters(field.Range);
cp.Bold = false;

VB.NET

generating-table-of-contents-toc-practical-guide-e4138/VB/Form1.vb#L84

Dim range As DocumentRange = Document.CreateRange(Document.Paragraphs(i).Range.Start, 1)
Dim cp As CharacterProperties = Document.BeginUpdateCharacters(range)
Dim level As Integer = 0

wpf-richedit-document-api-t213968/VB/DXRichEditControlAPISample/CodeExamples/FormattingActions.vb#L17

Dim range As DocumentRange = document.Paragraphs(1).Range
Dim cp As CharacterProperties = document.BeginUpdateCharacters(range)
cp.FontName = "Comic Sans MS"

how-to-change-formatting-of-text-and-paragraph-e2206/VB/HowToChangeFormatting/Form1.vb#L31

Dim range As DocumentRange = richEditControl1.Document.Paragraphs(1).Range
Dim cp As CharacterProperties = doc.BeginUpdateCharacters(range)
cp.FontName = "Comic Sans MS"

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/Formatting.vb#L21

' that sets character formatting for the selected range
Dim cp As CharacterProperties = document.BeginUpdateCharacters(range)
cp.FontName = "Comic Sans MS"

word-document-api-examples/VB/CodeExamples/FormattingActions.vb#L15

Dim range As DocumentRange = document.Paragraphs(1).Range
Dim cp As CharacterProperties = document.BeginUpdateCharacters(range)
cp.FontName = "Comic Sans MS"