Returns whether All , None or a Mixed set of characters in a given text range are underlined.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 17.0.0.0 (17.0.484.0)
Since: 2017

Syntax

C#
`public FormatStatus GetUnderlineStatus( TextRange textRange )`

Visual Basic
`Public Function GetUnderlineStatus ( _ textRange As TextRange _ ) As FormatStatus`

Visual C++
`public: FormatStatus GetUnderlineStatus( TextRange^ textRange )`

The format status of underline on characters FormatStatus .

Remarks

This function only returns All or None if the text contains one character. The given text range should not be empty.

Exception	Condition
Autodesk.Revit.Exceptions ArgumentException	This text range is empty. -or- This start index of this text range is not within the text range identifying the entire text. -or- The end of this text range is not within the text range identifying the entire text.
Autodesk.Revit.Exceptions ArgumentNullException	A non-optional argument was NULL