Namespace: Autodesk.Revit.DB Class: FormattedText

SetSubscriptStatus

Method

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

Remarks:

Superscript and subscript are mutually exclusive. Applying the subscript status will automatically remove the superscript status.

The given text range should not be empty.

Syntax

public void SetSubscriptStatus(
	TextRange textRange,
	bool isSubscript
)

Public Sub SetSubscriptStatus ( _
	textRange As TextRange, _
	isSubscript As Boolean _
)

public:
void SetSubscriptStatus(
	TextRange^ textRange, 
	bool isSubscript
)

Parameters

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

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