Skip to main content

SubDocument.BeginUpdateCharacters(DocumentRange) Method

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

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

Declaration

CharacterProperties BeginUpdateCharacters(
    DocumentRange range
)

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

View Example

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

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.

See Also