Namespace: Autodesk.Revit.DB Class: FormattedText

GetUnderlineStatus

Method

Description:
Returns whether , or a set of characters in a given text range are underlined.

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

Syntax

public FormatStatus GetUnderlineStatus(
	TextRange textRange
)

Public Function GetUnderlineStatus ( _
	textRange As TextRange _
) As FormatStatus

public:
FormatStatus GetUnderlineStatus(
	TextRange^ textRange
)

Parameters

Parameter	Type	Description
textRange	Autodesk.Revit.DB.TextRange	The given text range.

Return Value

Type	Description
FormatStatus	The format status of underline on characters .

Exceptions

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