ReadOnlyTextPropertiesBase.UnderlineType Property

Gets the type of the underline applied for characters in the current DocumentText object.

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

Declaration

C#

UnderlineType UnderlineType { get; }

VB.NET

ReadOnly Property UnderlineType As UnderlineType

Property Value

Type	Description
UnderlineType	One of the UnderlineType enumeration values indicating the underline type.

Available values:

Show 18 items

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 GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the UnderlineType 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-spreadsheet-how-to-edit-rich-text/CS/SpreadsheetRichText/CustomDocumentVisitor.cs#L53

}
switch (tp.UnderlineType)
{

snap-convert-snx-to-repx/CS/SnxToRepx/Converter/MarkupGenerator.cs#L210

//If text is underlined, add the corresponding tag
if (properties.UnderlineType != UnderlineType.None)
    list.Add(new MarkupTag("u"));

VB.NET

winforms-spreadsheet-how-to-edit-rich-text/VB/SpreadsheetRichText/CustomDocumentVisitor.vb#L41

End Select
Select Case tp.UnderlineType
    Case DevExpress.XtraRichEdit.API.Native.UnderlineType.Single

snap-convert-snx-to-repx/VB/SnxToRepx/Converter/MarkupGenerator.vb#L198

'If text is underlined, add the corresponding tag
If properties.UnderlineType <> UnderlineType.None Then list.Add(New MarkupTag("u"))
'If text is of the strikeout style, add the corresponding tag