SubDocument.EndUpdateCharacters(CharacterProperties) Method

Finalizes the modification of character formatting after calling the SubDocument.BeginUpdateCharacters method.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

void EndUpdateCharacters(
    CharacterProperties properties
)

VB.NET

Sub EndUpdateCharacters(
    properties As CharacterProperties
)

Parameters

Name	Type	Description
properties	CharacterProperties	A CharacterProperties object containing character properties.

Remarks

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 EndUpdateCharacters(CharacterProperties) 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#

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

cp.UnderlineColor = Color.Red;
document.EndUpdateCharacters(cp);
#endregion #FormatText

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

// with this method call
document.EndUpdateCharacters(cp);
#endregion #FormatText

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

cp.UnderlineColor = Color.Red;
document.EndUpdateCharacters(cp);
#endregion #FormatText

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

Document.EndUpdateCharacters(cp);

how-to-create-a-fixed-reference-to-an-existing-document-range-the-fixed-range-feature-e5207/CS/WindowsFormsApplication1/Form1.cs#L32

charsBold.Bold = true;
document.EndUpdateCharacters(charsBold);

VB.NET

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

            cp.UnderlineColor = Color.Red
            document.EndUpdateCharacters(cp)
'            #End Region ' #FormatText

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/Styles.vb#L26

            charProps.Style = cstyle
            document.EndUpdateCharacters(charProps)
'            #End Region ' #CreateNewCharacterStyle

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

            cp.UnderlineColor = Color.Red
            document.EndUpdateCharacters(cp)
'            #End Region ' #FormatText

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

Document.EndUpdateCharacters(cp)

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

            cp.UnderlineColor = Color.White
            doc.EndUpdateCharacters(cp)
'            #End Region ' #formatchar