TextSettings Object Preview

Derived from: Base Object
Defined in namespace "adsk::drawing" and the header file is <Drawing/Drawing/TextSettings.h>

PreviewThis functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.

Description

Object that provides access to the Text section of the document settings for a drawing.

Methods

Name Description
classType

Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType().

getTextHeight

Returns the resolved text height for the specified text height category (Small, Medium, or Large) in the active drawing units.

setTextHeight

When textHeightGroup is CustomTextHeightGroupType, sets the custom Small, Medium, or Large text height in the drawing's active units.

Properties

Name Description
font Gets and sets the font name for the drawing.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
objectType This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object.

It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType():
textHeightGroup Gets and sets the active text height group using a value from TextHeightGroupTypes.

Accessed From

DocumentSettings.textSettings

Version

Introduced in version September 2026