UnderlineType Enum

Lists underline styles.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v20.2.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

View Example

FormattingActions.cs

Document document = server.Document;
document.BeginUpdate();
document.AppendText("Normal\nFormatted\nNormal");
document.EndUpdate();
DocumentRange range = document.Paragraphs[1].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;
document.EndUpdateCharacters(cp);

FormattingActions.vb

Dim document As Document = server.Document
document.BeginUpdate()
document.AppendText("Normal" & vbLf & "Formatted" & vbLf & "Normal")
document.EndUpdate()
Dim range As DocumentRange = document.Paragraphs(1).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
document.EndUpdateCharacters(cp)

Related GitHub Examples

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

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#

how-to-edit-rich-text-in-spreadsheetcontrol/CS/SpreadsheetRichText/RichTextEditForm.cs#L50

case DevExpress.Spreadsheet.UnderlineType.Single:
    cp.Underline = DevExpress.XtraRichEdit.API.Native.UnderlineType.Single;
    break;

how-to-change-formatting-of-text-and-paragraph-e2206/CS/HowToChangeFormatting/Form1.cs#L38

cp.BackColor = Color.Blue;
cp.Underline = UnderlineType.DoubleWave;
cp.UnderlineColor = Color.White;

how-to-change-character-and-paragraph-formatting-e3323/CS/HowToChangeFormatting/MainWindow.xaml.cs#L26

cp.BackColor = Color.Blue;
cp.Underline = UnderlineType.DoubleWave;
cp.UnderlineColor = Color.White;

Reporting_how-to-override-rtf-formatting-in-xrrichtext-e3449/CS/XtraReport1.cs#L51

cp.ForeColor = Color.Red;
cp.Underline = UnderlineType.Single;
cp.UnderlineColor = Color.Red;

how-to-create-a-fixed-reference-to-an-existing-document-range-the-fixed-range-feature-e5207/CS/WindowsFormsApplication1/Form1.cs#L35

var charsUnderline = document.BeginUpdateCharacters(formattedRangeUnderlined);
charsUnderline.Underline = UnderlineType.Single;
charsUnderline.UnderlineColor = Color.Brown;

VB.NET

how-to-edit-rich-text-in-spreadsheetcontrol/VB/SpreadsheetRichText/RichTextEditForm.vb#L37

Case DevExpress.Spreadsheet.UnderlineType.Single
    cp.Underline = DevExpress.XtraRichEdit.API.Native.UnderlineType.Single
Case DevExpress.Spreadsheet.UnderlineType.Double

how-to-change-formatting-of-text-and-paragraph-e2206/VB/HowToChangeFormatting/Form1.vb#L36

cp.BackColor = Color.Blue
cp.Underline = UnderlineType.DoubleWave
cp.UnderlineColor = Color.White

how-to-change-character-and-paragraph-formatting-e3323/VB/HowToChangeFormatting/MainWindow.xaml.vb#L28

cp.BackColor = Color.Blue
cp.Underline = UnderlineType.DoubleWave
cp.UnderlineColor = Color.White

Reporting_how-to-override-rtf-formatting-in-xrrichtext-e3449/VB/XtraReport1.vb#L63

cp.ForeColor = Color.Red
cp.Underline = UnderlineType.Single
cp.UnderlineColor = Color.Red

how-to-create-a-fixed-reference-to-an-existing-document-range-the-fixed-range-feature-e5207/VB/WindowsFormsApplication1/Form1.vb#L32

Dim charsUnderline = document.BeginUpdateCharacters(formattedRangeUnderlined)
charsUnderline.Underline = UnderlineType.Single
charsUnderline.UnderlineColor = Color.Brown