CharacterProperties Interface
Provides access to character properties.
Namespace: DevExpress.XtraRichEdit.API.Native
Assembly: DevExpress.RichEdit.v19.1.Core.dll
Declaration
Remarks
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.
Note
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.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/winforms-richedit-document-api-e5219
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)
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the CharacterProperties interface.
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.