Scripting API

<<TextEditInsert Main Index TextEx>>
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

TextEditPropertyChange

Script Name: TextEditPropertyChange
Name: Text Edit Property Change
Library: ToolText
Description: Change the properties on a section of text.
Status bar text: Change the properties on a portion of text
Tool tip text: Text Property Change
Undo text: Text Edit Property Change
 
Parameter Repository:
NameScript NameType Description Supports None Default Minimum Maximum
Range BeginBeginExIntegerRange begin character position to be modified.Yes000
Range EndEndExIntegerRange end character position (non-inclusive).Yes000
Text FlowTextFlowEnumeration (TextFlow)Defines direction of character and text line flow.YesHorizontalDown
Text TypeTextTypeEnumeration (TextType)Indicates the type of text to be created; on a path or at the selected positionYesTextBase
Path OffsetPathOffsetRealSet text offset from pathYes0.00.00.0
Auto KernAutoKernEnumeration (Boolean)Turns auto kerning on or offYesTrue
KerningKerningIntegerSets text kerning valueYes0-10001000
TrackingTrackingRealSets text tracking valueYes0.00.00.0
LeadingLeadingRealSets leading value for the text lineYes0.0-10000.010000.0
Font nameFontStringName of the font to use in displaying textYes
Font SizePointSizeRealSets size for text displayYes10.00.0512.0
ItalicItalicEnumeration (Boolean)Turns text italicizing on or offYesFalse
BoldBoldEnumeration (Boolean)Turns text bolding on or offYesFalse
UnderlineUnderlineEnumeration (Boolean)Set text underlining on or offYesFalse
StrikethroughStrikethruEnumeration (Boolean)Sets text strikethrough on or offYesFalse
Anti-aliasAntialiasEnumeration (Boolean)Allows anti-alias text when renderedYesFalse
AntialiasStyleAntialiasStyleEnumeration (AntialiasEx)Defines the style of text antialiasing used.YesNone
Warp text on pathWarpTextEnumeration (Boolean)Warps text on path when renderingYesTrue
Set TextSetTextEnumeration (Justify)Determines how text is justified; left, right, center YesLeft
Character FillFillParameter RepositorySets the Material for the character fillYes
Character StrokeStrokeParameter RepositorySets the material for the character strokeYes
Stroke Width (pixels)LineWidthRealWidth of area in which to set textYes1.00.0255.0
Line StyleLineStyleParameter RepositoryDefines the line style used to draw the character strokesYes
JoinJoinEnumeration (JointStyle)Defines type of join for text stroke endsYesMiter
Miter LimitMiterLimitRealSets the miter limit used when joing character strokesYes10.01.030.0
TextTextWide StringContains the text characters to be displayedYes
Navigation PathPathTuplePath 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: