Scripting API

Parameter Description

<<ReturnLayerProperties Main Index Ripple>> ReturnVectorObjectProperties Back
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

This is the description of the command ReturnVectorObjectProperties's parameter named Text Block Attributes:

NameScript NameType Description Supports None Default Minimum Maximum
VisibilityVisibilityEnumeration (Boolean)When true, text object is visible else invisible.YesTrue
Start positionStartPointx,y start position for the textYes(0.0,0.0)
Text TypeTextTypeEnumeration (TextType)Indicates the type of text to be created; on a path or at the selected positionYesTextBase
Auto KernAutoKernEnumeration (Boolean)Turns auto kerning on or offYesFalse
KerningKerningRealSets text kerning valueYes0.00.00.0
LeadingLeadingRealSets leading value for the text lineYes0.00.00.0
Font nameFontStringName of the font to use in displaying textYes
Point SizePointSizeRealSets point size for text displayYes0.00.00.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
Warp text on pathWarpTextEnumeration (Boolean)Warps text on path when renderingYesFalse
Set TextSetTextEnumeration (Justify)Determines how text is justified; left, right, center, justifyYesLeft
Character FillFillParameter RepositorySets the Material for the character fillYes
Character StrokeStrokeParameter RepositorySets the material for the character strokeYes
Stroke WidthLineWidthRealWidth of character strokeYes0.00.00.0
Line StyleLineStyleParameter RepositoryDefines the line style used to draw the character strokesYes
JoinJoinEnumeration (JointStyle)Defines type of join for text stroke endsYesMiter
Miter LimitMiterLimitIntegerSets the miter limit used when joining character strokesYes000
TextCharactersWide StringContains the text characters to be displayedYes