Namespace: Autodesk.Revit.DB Class: FormattedText

SetUnderlineStatus

Method

Description:
Sets the characters in a given text range to be underlined or not underlined.

Remarks:

Bullets, numbers, or letters of a list can not be underlined.

The given text range should not be empty.

Syntax

public void SetUnderlineStatus(
	TextRange textRange,
	bool isUnderlined
)

Public Sub SetUnderlineStatus ( _
	textRange As TextRange, _
	isUnderlined As Boolean _
)

public:
void SetUnderlineStatus(
	TextRange^ textRange, 
	bool isUnderlined
)

Parameters

Parameter	Type	Description
textRange	Autodesk.Revit.DB.TextRange	The given text range.
isUnderlined	System.Boolean	The desired underline status of characters in the given text range. True to set underlined, false to set not underlined.

Return Value

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