UnderlineType Enum

Lists underline styles.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

[ComVisible(true)]
public enum UnderlineType

VB.NET

<ComVisible(True)>
Public Enum UnderlineType

Members

Name	Description
None	Indicates that the text is not underlined.
Single	Specifies a single underline.
Dotted	Specifies a dotted underline.
Dashed	Specifies a dashed underline.
DashDotted	Specifies a dash-dotted underline.
DashDotDotted	Specifies a dash-dot-dotted underline.
Double	Specifies a double underline.
HeavyWave	Specifies a heavy wave underline.
LongDashed	Specifies a long-dashed underline.
ThickSingle	Specifies a thick single underline.
ThickDotted	Specifies a thick dotted underline.
ThickDashed	Specifies a thick dashed underline.
ThickDashDotted	Specifies a thick dash-dotted underline.
ThickDashDotDotted	Specifies a thick dash-dot-dotted underline.
ThickLongDashed	Specifies a thick long-dashed underline.
DoubleWave	Specifies a double wave underline.
Wave	Specifies a wave underline.
UnderlineWordsOnly	Specifies an underline that is a single line below all non-space characters. Other characters are not underlined.

Related API Members

The following properties accept/return UnderlineType values:

• CharacterPropertiesBase.Underline
• ReadOnlyTextPropertiesBase.UnderlineType
• SyntaxHighlightProperties.Underline

Remarks

Use the CharacterPropertiesBase.Underline property to specify the underline style for characters and the CharacterPropertiesBase.UnderlineColor to specify the color.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-richedit-document-api-e5219

Formatting.vb

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)

Formatting.cs

document.BeginUpdate();
document.AppendText("Normal\nFormatted\nNormal");
document.EndUpdate();
// The target range is the second paragraph 
DocumentRange range = document.Paragraphs[1].Range;

// Create and customize an object  
// that sets character formatting for the selected 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;

// Finalize modifications  
// with this method call 
document.EndUpdateCharacters(cp);