Back to Devexpress

SubDocument.EndUpdateCharacters(CharacterProperties) Method

officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-subdocument-dot-endupdatecharacters-x28-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-characterproperties-x29.md

latest7.5 KB
Original Source

SubDocument.EndUpdateCharacters(CharacterProperties) Method

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

Namespace : DevExpress.XtraRichEdit.API.Native

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
void EndUpdateCharacters(
    CharacterProperties properties
)
vb
Sub EndUpdateCharacters(
    properties As CharacterProperties
)

Parameters

NameTypeDescription
propertiesCharacterProperties

A CharacterProperties object containing character properties.

|

Remarks

View Example

csharp
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);
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)

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

See Also

BeginUpdateCharacters

BeginUpdateParagraphs(DocumentRange)

EndUpdateParagraphs(ParagraphProperties)

SubDocument Interface

SubDocument Members

DevExpress.XtraRichEdit.API.Native Namespace