Namespace: Autodesk.Revit.DB Class: FormattedText

SetSuperscriptStatus

Method

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

Remarks:

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

The given text range should not be empty.

Syntax

public void SetSuperscriptStatus(
	TextRange textRange,
	bool isSuperscript
)

Public Sub SetSuperscriptStatus ( _
	textRange As TextRange, _
	isSuperscript As Boolean _
)

public:
void SetSuperscriptStatus(
	TextRange^ textRange, 
	bool isSuperscript
)

Parameters

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

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