SketchTexts Object

Derived from: Base Object
Defined in namespace "adsk::fusion" and the header file is <Fusion/Sketch/SketchTexts.h>

Description

The collection of text blocks in a sketch. This provides access to the existing text blocks and supports creating new text blocks.

Methods

Name	Description
add	Creates a sketch text.
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().
createInput	RETIRED This method has been retired and is replaced by the createInput2 method, which supports defining multi-line text and text along a curve. Creates a SketchTextInput object that can be used to define additional settings when creating sketch text. The SketchTextInput object is equivalent to the Sketch Text dialog in that it collects all of the input required to create sketch text. Once the properties of the SketchTextInput object have been defined, use the add method to create the sketch text.
createInput2	RETIRED Creates a SketchTextInput object that is used to define the additional input to create text. The SketchTextInput object is equivalent to the Sketch Text dialog in that it collects all of the input required to create sketch text. You must call setAsFitOnPath, setAsAlongPath, or setAsMultiLine methods to define one of the three types of text. Once the properties of the SketchTextInput object have been defined, pass the SketchTextInput to the add method to create the sketch text. This method has been retired and replaced by createInput3. Use the new method to define text using an expression that can combine literal text with parameter values.
createInput3	Creates a SketchTextInput object that is used to define the additional input to create text. The SketchTextInput object is equivalent to the Sketch Text dialog in that it collects all of the input required to create sketch text. You must call setAsFitOnPath, setAsAlongPath, or setAsMultiLine methods to define one of the three types of text. Once the properties of the SketchTextInput object have been defined, pass the SketchTextInput to the add method to create the sketch text.
item	Function that returns the specified sketch text using an index into the collection.

Properties

Name	Description
count	Returns the number of texts in the sketch.
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():

Accessed From

Sketch.sketchTexts

Samples

Name	Description
SketchTextInput.setAsAlongPath	Demonstrates the SketchTextInput.setAsAlongPath method.
SketchTextInput.setAsFitOnPath	Demoonstrates the SketchTextInput.setAsFitOnPath method.
SketchTextInput.setAsMultiLine	Demonstrates the SketchTextInput.setAsMultiLine method.
Sketch Text API Sample	Demonstrates creating sketch text by creating both mult-line text and text along a curve.

Version

Introduced in version March 2015