FormattedText.GetUnderlineStatus(TextRange) Method

FormattedTextGetUnderlineStatus(TextRange) Method

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: 26.0.4.0 (26.0.4.0)
Syntax
public FormatStatus GetUnderlineStatus(
	TextRange textRange
)
Public Function GetUnderlineStatus ( 
	textRange As TextRange
) As FormatStatus
public:
FormatStatus GetUnderlineStatus(
	TextRange^ textRange
)
member GetUnderlineStatus : 
        textRange : TextRange -> FormatStatus

Parameters

textRange  TextRange
The given text range.

Return Value

FormatStatus
The format status of underline on characters FormatStatus.
Exceptions
ExceptionCondition
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.
ArgumentNullException A non-optional argument was null
Remarks
This function only returns All or None if the text contains one character. The given text range should not be empty.
See Also

M:Autodesk.Revit.DB.FormattedText.GetUnderlineStatus(Autodesk.Revit.DB.TextRange)