Scripting API

<<TextEditPropertyChange Main Index Texture>>
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

TextEx

Script Name: TextEx
Name: Text
Library: ToolText
Description: Start a text editing session.
Status bar text: Start a text editing session
Tool tip text: Text Tool
Undo text: Text
 
Parameter Repository:
NameScript NameType Description Supports None Default Minimum Maximum
VisibilityVisibilityEnumeration (Boolean)When true, text object is visible else invisible.YesTrue
Create asCreateAsEnumeration (CreateAs)Create the text as vector, selection or floating selectionYesVector
Start positionStartPointx,y start position for the textYes(0.0,0.0)
TextFlowTextFlowEnumeration (TextFlow)Defines direction of character and text line flow.NoHorizontalDown
Text TypeTextTypeEnumeration (TextType)Indicates the type of text to be created; on a path or at the selected positionNoTextBase
Text MatrixMatrixListText MatrixYes0
Auto KernAutoKernEnumeration (Boolean)Turns auto kerning on or offNoTrue
KerningKerningIntegerSets text kerning valueNo0-10001000
TrackingRealNo0.0-10.010.0
LeadingLeadingRealSets leading value for the text lineNo0.0-10.010.0
Font nameFontStringName of the font to use in displaying textNo
Point SizePointSizeRealSets point size for text displayNo24.01.01638.0
ItalicItalicEnumeration (Boolean)Turns text italicizing on or offNoFalse
BoldBoldEnumeration (Boolean)Turns text bolding on or offNoFalse
UnderlineUnderlineEnumeration (Boolean)Set text underlining on or offNoFalse
StrikethroughStrikethruEnumeration (Boolean)Sets text strikethrough on or offNoFalse
AntialiasStyleAntialiasStyleEnumeration (AntialiasEx)Defines the style of text antialiasing used.NoSharp
Warp text on pathWarpTextEnumeration (Boolean)Warps text on path when renderingNoTrue
Set TextSetTextEnumeration (Justify)Determines how text is justified; left, right, center, justifyNoLeft
Character FillFillParameter RepositorySets the Material for the character fillYes
Character StrokeStrokeParameter RepositorySets the material for the character strokeYes
Stroke WidthLineWidthRealWidth of character strokeNo1.00.0255.0
Line StyleLineStyleParameter RepositoryDefines the line style used to draw the character strokesYes
JoinJoinEnumeration (JointStyle)Defines type of join for text stroke endsNoMiter
Miter LimitMiterLimitRealSets the miter limit used when joining character strokesNo10.01.030.0
TextCharactersWide StringContains the text characters to be displayedYes
StringsListTempLinkYes0
Navigation PathTextTargetTuplePath to get to the new layer, expressed as going up in the object tree, across to a sibling, and then into children.Yes0
Navigation PathPathTargetTuplePath to get to the new layer, expressed as going up in the object tree, across to a sibling, and then into children.Yes0
General SettingsGeneralSettingsParameter RepositoryContains parameters that control the execution of the command.No
 
Command Attributes:
IsExternal: true
IsUndoable: true
ProcessChanges: true
FinalizeTransient: true
 
Resource Attributes:
IsPreviewable: true
IsProofable: true
DlgHasPresets: true
DlgHasRandomize: true