.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
A newer version of this page is available. Switch to the current version.

CharacterProperties Interface

Provides access to character properties.

Namespace: DevExpress.XtraRichEdit.API.Native

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


public interface CharacterProperties :
Public Interface CharacterProperties
    Inherits CharacterPropertiesBase


The CharacterProperties interface allows you to get/set character formatting and apply styles.

Use the SubDocument.BeginUpdateCharacters and the SubDocument.EndUpdateCharacters paired methods to modify character formatting, such as the CharacterPropertiesBase.FontName, CharacterPropertiesBase.FontSize, CharacterPropertiesBase.Bold, CharacterPropertiesBase.ForeColor etc.

To accomplish this, call the SubDocument.BeginUpdateCharacters method for the specified range, use the returned CharacterProperties interface to modify the required properties and call the SubDocument.EndUpdateCharacters method to finalize the modification.


Make sure that the SubDocument.BeginUpdateCharacters method always has its corresponding SubDocument.EndUpdateCharacters method to ensure proper operation of the control.

The following code snippet changes the font and the color of the selected text.

document.AppendText("Normal" & vbLf & "Formatted" & vbLf & "Normal")
' 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 
See Also