SubDocument.EndUpdateCharacters(CharacterProperties) Method

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

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

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

View Example

FormattingActions.cs

Document document = server.Document;
document.BeginUpdate();
document.AppendText("Normal\nFormatted\nNormal");
document.EndUpdate();
DocumentRange range = document.Paragraphs[1].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;
document.EndUpdateCharacters(cp);

FormattingActions.vb

Dim document As Document = server.Document
document.BeginUpdate()
document.AppendText("Normal" & vbLf & "Formatted" & vbLf & "Normal")
document.EndUpdate()
Dim range As DocumentRange = document.Paragraphs(1).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
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#

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

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

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

// Finalize to modify character formatting.
document.EndUpdateCharacters(cp);
#endregion #FormatText

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

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

word-document-api-table-examples/CS/TablesSimpleExample/Program.cs#L108

properties.FontSize = 16;
document.EndUpdateCharacters(properties);
ParagraphProperties alignment = document.BeginUpdateParagraphs(table[0, 1].ContentRange);

winforms-richedit-tables-simple-example/CS/TablesSimpleExample/Form1.cs#L132

properties.FontSize = 16;
document.EndUpdateCharacters(properties);
ParagraphProperties alignment = document.BeginUpdateParagraphs(table[0, 2].ContentRange);

VB.NET

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

            ' with this method call
            document.EndUpdateCharacters(cp)
#End Region  ' #FormatText

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

            ' Finalize to modify character formatting.
            document.EndUpdateCharacters(cp)
#End Region  ' #FormatText

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

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

word-document-api-table-examples/VB/TablesSimpleExample/Program.vb#L88

properties.FontSize = 16
document.EndUpdateCharacters(properties)
Dim alignment As ParagraphProperties = document.BeginUpdateParagraphs(table(0, 1).ContentRange)

winforms-richedit-tables-simple-example/VB/TablesSimpleExample/Form1.vb#L106

properties.FontSize = 16
document.EndUpdateCharacters(properties)
Dim alignment As ParagraphProperties = document.BeginUpdateParagraphs(table(0, 1).ContentRange)