CharacterPropertiesBase.UnderlineColor Property

Gets or sets the color of the underline for the specified characters.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

Color? UnderlineColor { get; set; }

VB.NET

Property UnderlineColor As Color?

Property Value

Type	Description
Nullable<Color>	A Color value or null, for a mixture of underline colors.

Remarks

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 UnderlineColor 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#

reporting-winforms-change-formatting-xrrichtext-rtf-content/CS/XtraReport1.cs#L59

cp.Underline = UnderlineType.Single;
cp.UnderlineColor = Color.Red;
server.Document.EndUpdateCharacters(cp);

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

cp.Underline = UnderlineType.DoubleWave;
cp.UnderlineColor = Color.Red;
document.EndUpdateCharacters(cp);

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

cp.Underline = UnderlineType.DoubleWave;
cp.UnderlineColor = Color.Red;

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

cp.Underline = UnderlineType.DoubleWave;
cp.UnderlineColor = Color.Red;

VB.NET

reporting-winforms-change-formatting-xrrichtext-rtf-content/VB/XtraReport1.vb#L63

cp.Underline = UnderlineType.Single
cp.UnderlineColor = Color.Red
server.Document.EndUpdateCharacters(cp)

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

cp.Underline = UnderlineType.DoubleWave
cp.UnderlineColor = Color.Red
document.EndUpdateCharacters(cp)

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

cp.Underline = DevExpress.XtraRichEdit.API.Native.UnderlineType.DoubleWave
cp.UnderlineColor = System.Drawing.Color.Red
' Finalize modifications

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

cp.Underline = DevExpress.XtraRichEdit.API.Native.UnderlineType.DoubleWave
cp.UnderlineColor = System.Drawing.Color.Red
' Finalize to modify character formatting.