CharacterPropertiesBase.BackColor Property

Gets or sets the background color of character(s).

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

Declaration

C#

Color? BackColor { get; set; }

VB.NET

Property BackColor As Color?

Property Value

Type	Description
Nullable<Color>	A Color value representing the background color or null for mixed colors.

Remarks

Use the CharacterProperties interface to change character formatting.

Important

The semi-transparent alpha component (i.e. the Color’s alpha parameter set to value less than 255) is reset to opaque (255) during export to all formats except PDF.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the BackColor property.

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-grid-richedit-highlight-search-results/CS/E4422/Form1.cs#L26

CharacterProperties cp = document.BeginUpdateCharacters(ranges[i]);
cp.BackColor = LookAndFeelHelper.GetHighlightSearchAppearance(UserLookAndFeel.Default, false).BackColor;
document.EndUpdateCharacters(cp);

wpf-rich-text-editor-customize-context-menu/CS/ContextMenuCustomization/MainWindow.xaml.cs#L54

CharacterProperties charProps = richEdit.Document.BeginUpdateCharacters(richEdit.Document.Selection);
charProps.BackColor = System.Drawing.Color.Yellow;
richEdit.Document.EndUpdateCharacters(charProps);

winforms-richedit-customize-popup-menu/CS/RichEditContextMenu/Form1.cs#L67

CharacterProperties charProps = richEditControl.Document.BeginUpdateCharacters(richEditControl.Document.Selection);
charProps.BackColor = System.Drawing.Color.Yellow;
richEditControl.Document.EndUpdateCharacters(charProps);

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

cp.ForeColor = Color.Blue;
cp.BackColor = Color.Snow;
cp.Underline = UnderlineType.DoubleWave;

winforms-rich-edit-iterate-through-all-sub-documents/CS/SubDocumentIterator/Form1.cs#L49

cp.ForeColor = Color.Red;
cp.BackColor = Color.Lavender;
subdoc.EndUpdateCharacters(cp);

VB.NET

winforms-grid-richedit-highlight-search-results/VB/E4422/Form1.vb#L29

Dim cp As CharacterProperties = document.BeginUpdateCharacters(ranges(i))
cp.BackColor = LookAndFeelHelper.GetHighlightSearchAppearance(UserLookAndFeel.Default, False).BackColor
document.EndUpdateCharacters(cp)

wpf-rich-text-editor-customize-context-menu/VB/ContextMenuCustomization/MainWindow.xaml.vb#L49

Dim charProps As CharacterProperties = Me.richEdit.Document.BeginUpdateCharacters(Me.richEdit.Document.Selection)
charProps.BackColor = System.Drawing.Color.Yellow
Me.richEdit.Document.EndUpdateCharacters(charProps)

winforms-richedit-customize-popup-menu/VB/RichEditContextMenu/Form1.vb#L61

Dim charProps As CharacterProperties = richEditControl.Document.BeginUpdateCharacters(richEditControl.Document.Selection)
charProps.BackColor = System.Drawing.Color.Yellow
richEditControl.Document.EndUpdateCharacters(charProps)

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

cp.ForeColor = Color.Blue
cp.BackColor = Color.Snow
cp.Underline = UnderlineType.DoubleWave

winforms-rich-edit-iterate-through-all-sub-documents/VB/SubDocumentIterator/Form1.vb#L37

cp.ForeColor = Color.Red
cp.BackColor = Color.Lavender
subdoc.EndUpdateCharacters(cp)