BeginText Objects - Text 
MiniCAD

VectorScript Declaration:

PROCEDURE   BeginText
;

Python:

def  vs.BeginText():
   return None

Description:

Procedures BeginText creates a new text object in a Vectorworks document. All text specified between calls to BeginText and EndText will be part of the new text object.
Text may be specified in single quotes, or variables may be used..

To specify the insertion point of the new text object, use TextOrigin.

Example:

{ Create a multiple line text object at 0,0 }
TextFont(GetFontID('Monaco'));
TextSize(24);
TextOrigin(0,0);
BeginText;
'This multiple line text block 
is in 24pt Monaco and was created
by a VectorScript.'
EndText;



  CreateText Objects - Text 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   CreateText
( theText:DYNARRAY[] of CHAR ) ;

Python:

def  vs.CreateText(theText):
   return None

Description:

Procedure CreateText creates a new text object in a Vectorworks document. The text object is created using the current pen position and default attributes.

Parameters:

theText Text string.

Example:

PROCEDURE Example;
VAR
	Txt   :ARRAY [1..100] of STRING;
	Outpt :DYNARRAY[] of CHAR;
	i     :INTEGER;
BEGIN
	FOR i := 1 TO 5 DO txt[i] := 'asdf';
	i := 2;
	Outpt := Txt[1];
	WHILE Txt[i] <> '' DO BEGIN
		OutPt := Concat(Outpt, Chr(13), Txt[i]);
		i := i + 1;
	END;
	Layer('Text');
	CreateText(Outpt);
	Layer('Layer-1');
END;
RUN(Example);

See Also:

BeginText   EndText  



  EndText Objects - Text 
MiniCAD

VectorScript Declaration:

PROCEDURE   EndText
;

Python:

def  vs.EndText():
   return None

Description:

Procedure EndText completes creation of a new text object.

See Also:

BeginText   CreateText  



  GetFontID Objects - Text 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   GetFontID
( fontName:STRING ) :INTEGER ;

Python:

def  vs.GetFontID(fontName):
   return INTEGER

Description:

Function GetFontID converts the string name of an available font to a font ID which can be passed to other VectorScript routines.

Parameters:

fontName Name of installed font.

Example:

PROCEDURE Example;
VAR
	str :STRING;
BEGIN
	str := StrDialog('Enter the font name:', 'Arial');
	AlrtDialog(Concat('The font ID is: ', GetFontID(str)));
END;
RUN(Example);



  GetFontListSize Objects - Text 
Vectorworks 2015

VectorScript Declaration:

FUNCTION   GetFontListSize
:INTEGER ;

Python:

def  vs.GetFontListSize():
   return INTEGER

Description:

Returns the number of available fonts on the local system.

Example:

AlrtDialog(Concat('The number of available fonts is: ', GetFontListSize));



  GetFontName Objects - Text 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   GetFontName
( fontID:INTEGER ) :STRING ;

Python:

def  vs.GetFontName(fontID):
   return STRING

Description:

Function GetFontName converts a system font ID to a font name.

An integer ID with a value representing a font in the current operating system.

Parameters:

fontID Font ID value.

Example:

PROCEDURE Example;
VAR
	str :STRING;
	cnt :INTEGER;
BEGIN
	FOR cnt := 0 to 10 DO str := Concat(str, Chr(13), GetFontName(cnt));
	AlrtDialog(str);
END;
RUN(Example);



  GetText Objects - Text 
MiniCAD

VectorScript Declaration:

FUNCTION   GetText
( objectHd:HANDLE ) :DYNARRAY[] of CHAR ;

Python:

def  vs.GetText(objectHd):
   return DYNARRAY of CHAR

Description:

Function GetText returns the text contained within the referenced text object.

Parameters:

objectHd Handle to text object.

See Also:

SetText  



  GetTextFont Objects - Text 
MiniCAD6.0

VectorScript Declaration:

FUNCTION   GetTextFont
(   objectHd :HANDLE;
    Position :INTEGER
) :INTEGER ;

Python:

def  vs.GetTextFont(objectHd, Position):
   return INTEGER

Description:

Procedure GetTextFont returns the font of the referenced text object at a specified position in the string.

The position is in a range between 0 and 32767, representing a character position in the text string. An index of 0 refers to the first character in the string.

Parameters:

objectHd Handle to text object.
Position Position in text string.

Example:

fontID:=GetTextFont(handleToText,2);

See Also:

GetFontName   GetFontID  



  GetTextJust Objects - Text 
MiniCAD6.0

VectorScript Declaration:

FUNCTION   GetTextJust
( TextHd:HANDLE ) :INTEGER ;

Python:

def  vs.GetTextJust(TextHd):
   return INTEGER

Description:

Function GetTextJust returns the text justification of the referenced text object.

Table - Text Justification

Justification Constant
Left 1
Center 2
Right 3
Justify 4

Parameters:

TextHd Handle to text object.



  GetTextLeading Objects - Text 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   GetTextLeading
( theText:HANDLE ) :REAL ;

Python:

def  vs.GetTextLeading(theText):
   return REAL

Description:

Procedure GetTextLeading returns the custom leading value(in points) of the referenced text object.

Parameters:

theText Handle to text object.



  GetTextLength Objects - Text 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   GetTextLength
( TextHd:HANDLE ) :INTEGER ;

Python:

def  vs.GetTextLength(TextHd):
   return INTEGER

Description:

GetTextLength returns the string length of the referenced text object.

Parameters:

TextHd Handle to text object.



  GetTextOrientation Objects - Text 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   GetTextOrientation
(   theText :HANDLE;
  VAR  textOriginX :REAL;
  VAR  textOriginY :REAL;
  VAR  textAng :REAL;
  VAR  textIsMirrored :BOOLEAN
) ;

Python:

def  vs.GetTextOrientation(theText):
   return (textOrigin, textAng, textIsMirrored)

Description:

Procedure GetTextOrientation returns the position and orientation attributes of the referenced text object.

Parameters:

theText Handle to text object.
textOrigin Returns coordinates of text origin.
textAng Returns rotation angle of text.
textIsMirrored Returns mirror state of text.

Example:

PROCEDURE Example;
VAR
   theText :HANDLE;
   textOriginX, textOriginY, textAng :REAL;
   textIsMirrored :BOOLEAN;
BEGIN
   theText := FSActLayer;
   GetTextOrientation(theText, textOriginX, textOriginY, textAng, textIsMirrored);
   Locus(textOriginX, textOriginY);
END;
RUN(Example);



  GetTextSize Objects - Text 
MiniCAD6.0

VectorScript Declaration:

FUNCTION   GetTextSize
(   TextHd :HANDLE;
    Position :INTEGER
) :REAL ;

Python:

def  vs.GetTextSize(TextHd, Position):
   return REAL

Description:

Procedure GetTextSize returns the text point size at a specified position within the referenced text object. 1 point = 1/72".

The position is in a range between 0 and 32767, representing a character position in the text string. An index of 0 refers to the first character in the string.

Parameters:

TextHd Handle to text object.
Position Position in text string.



  GetTextSpace Objects - Text 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   GetTextSpace
( theText:HANDLE ) :INTEGER ;

Python:

def  vs.GetTextSpace(theText):
   return INTEGER

Description:

Procedure GetTextSpace returns the line spacing of the referenced text object.

Table - Text Spacing

Leading Constant
Single space 2
1 1/2 space 3
Double space 4

Parameters:

theText Handle to text object.



  GetTextStyle Objects - Text 
MiniCAD6.0

VectorScript Declaration:

FUNCTION   GetTextStyle
(   TextHd :HANDLE;
    Position :INTEGER
) :INTEGER ;

Python:

def  vs.GetTextStyle(TextHd, Position):
   return INTEGER

Description:

Procedure GetTextStyle returns the text style at a specified position within the referenced text object.

The position is in a range between 0 and 32767, representing a character position in the text string. An index of 0 refers to the first character in the string.

Table - Text Style

Style Constant
Plain 0
Bold 1
Italic 2
Underline 4
Outline 8
Shadowed 16
Superscript 32
Subscript 64

Parameters:

TextHd Handle to text object.
Position Position in text string.



  GetTextStyleRef Objects - Text 
Vectorworks 2015

VectorScript Declaration:

FUNCTION   GetTextStyleRef
( objectId:HANDLE ) :LONGINT ;

Python:

def  vs.GetTextStyleRef(objectId):
   return LONGINT

Description:

Function GetTextStyleRef returns the text style for the referenced object. The integer returned is the internal index of the text style used by this object.

If the text object is using class text style, this returns the effective style. You should use the *TextStyleByClass* functions to check and preserve by-class behavior.

Parameters:

objectId handle to object

See Also:

SetTextStyleRef   GetTextStyleRef   SetTextStyleRefN   GetTextStyleRefN   SetTextStyleByClass   SetTextStyleByClassN   IsTextStyleByClass   IsTextStyleByClassN  



  GetTextStyleRefN Objects - Text 
Vectorworks 2015

VectorScript Declaration:

FUNCTION   GetTextStyleRefN
(   objectId :HANDLE;
    position :INTEGER
) :LONGINT ;

Python:

def  vs.GetTextStyleRefN(objectId, position):
   return LONGINT

Description:

GetTextStyleRefN returns the text style reference at a specified position within the text object. Reference 0 means Un-Styled.

If the text object is using class text style, this returns the effective style. You should use the *TextStyleByClass* functions to check and preserve by-class behavior.

Parameters:

objectId handle to text object
position Position in text string, zero-based.

Result:

Returns the text style reference id for the requested character postion

See Also:

SetTextStyleRef   GetTextStyleRef   SetTextStyleRefN   GetTextStyleRefN   SetTextStyleByClass   SetTextStyleByClassN   IsTextStyleByClass   IsTextStyleByClassN  



  GetTextVerticalAlign Objects - Text 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   GetTextVerticalAlign
( TextHd:HANDLE ) :INTEGER ;

Python:

def  vs.GetTextVerticalAlign(TextHd):
   return INTEGER

Description:

Function GetTextVerticalAlign returns the vertical alignment of the referenced text object.

Table - Text Vertical Justification

Justification Constant
Top of text box 1
Top baseline 2
Text centerline 3
Bottom baseline 4
Bottom of text box 5

Parameters:

TextHd Handle to text object.



  GetTextWidth Objects - Text 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   GetTextWidth
( theText:HANDLE ) :REAL ;

Python:

def  vs.GetTextWidth(theText):
   return REAL

Description:

Procedure GetTextWidth returns the margin width of the referenced text object.

Parameters:

theText Handle to text object.

See Also:

SetTextWidth  



  GetTextWrap Objects - Text 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   GetTextWrap
( theText:HANDLE ) :BOOLEAN ;

Python:

def  vs.GetTextWrap(theText):
   return BOOLEAN

Description:

Procedure GetTextWrap returns the text wrap mode of the referenced text object.

Parameters:

theText Handle to text object.



  IsTextStyleByClassN Objects - Text 
Vectorworks 2015

VectorScript Declaration:

FUNCTION   IsTextStyleByClassN
(   objectId :HANDLE;
    position :INTEGER
) :BOOLEAN ;

Python:

def  vs.IsTextStyleByClassN(objectId, position):
   return BOOLEAN

Description:

IsTextStyleByClassN returns whether the class text style is used at a specified position within the text object.

Parameters:

objectId handle to text object
position Position in text string, zero-based.

Result:

Returns True if the requested character postion uses the class text style

See Also:

SetTextStyleRef   GetTextStyleRef   SetTextStyleRefN   GetTextStyleRefN   SetTextStyleByClass   SetTextStyleByClassN   IsTextStyleByClass   IsTextStyleByClassN  



  SetText Objects - Text 
MiniCAD

VectorScript Declaration:

PROCEDURE   SetText
(   objectHd :HANDLE;
    text :DYNARRAY[] of CHAR
) ;

Python:

def  vs.SetText(objectHd, text):
   return None

Description:

Procedure SetText sets the content of the referenced text object. The new text is assigned the font, size and style characteristics of the first character of the old text string.

Parameters:

objectHd Handle to text object.
text New text string value.

Example:

SetText(hText,'A new text string value');



  SetTextAdorner Objects - Text 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   SetTextAdorner
(   textBlock :HANDLE;
    textAdorner :HANDLE;
    pX :REAL;
    pY :REAL
) :Boolean ;

Python:

def  vs.SetTextAdorner(textBlock, textAdorner, p):
   return Boolean

Description:

This function creates a relationship between the specified text block and the text adorner such that when theText Block is scaled in a VP, the text adorner is also scaled. Several objects can be adorned to the same text object.

Parameters:

textBlock The Text object being adorned.
textAdorner The object used to adorn the specified text.
p The point by which texts will be scaled.

Result:

- 'true' if the operation was successful.
- 'false' otherwise.

Example:

PROCEDURE Example;
VAR
theText      :HANDLE;
theShape : HANDLE;
restult :      BOOLEAN;
BEGIN
TextVerticalAlign(3);
TextJust(2);
MoveTo(0,0);
RectangleN(-.5",      -.5", 1, 0, 1", 1");
theShape :=      lNewObj;
CreateText('ID1');
theText :=      lNewObj;
restult :=      SetTextAdorner(theText,theShape,0,0);
END;
RUN(Example);



  SetTextFont Objects - Text 
MiniCAD6.0

VectorScript Declaration:

PROCEDURE   SetTextFont
(   objectHd :HANDLE;
    Start :INTEGER;
    Count :INTEGER;
    FontNum :INTEGER
) ;

Python:

def  vs.SetTextFont(objectHd, Start, Count, FontNum):
   return None

Description:

Procedure SetTextFont sets the font of a substring in the referenced text object.

Parameters:

objectHd Handle to text object.
Start Start position in text string.
Count Length of substring.
FontNum Font ID for substring.

Example:

SetTextFont(handleToText,0,5,GetFontID('Helvetica'));

{sets the first five characters of the referenced text string to Helvetica}

See Also:

GetFontID  



  SetTextJust Objects - Text 
MiniCAD6.0

VectorScript Declaration:

PROCEDURE   SetTextJust
(   TextHd :HANDLE;
    JustFlag :INTEGER
) ;

Python:

def  vs.SetTextJust(TextHd, JustFlag):
   return None

Description:

Procedure SetTextJust sets the text justification of the referenced text object.

Table - Text Justification

Justification Constant
Left 1
Center 2
Right 3
Justify 4

Parameters:

TextHd Handle to text object.
JustFlag Justification setting for text.

See Also:

SetTextJustN  



  SetTextJustN Objects - Text 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   SetTextJustN
(   TextHd :HANDLE;
    JustFlag :INTEGER
) ;

Python:

def  vs.SetTextJustN(TextHd, JustFlag):
   return None

Description:

Procedure SetTextJustN sets the text justification of the referenced text object without changing its location.

Table - Text Justification

Justification Constant
Left 1
Center 2
Right 3
Justify 4

Parameters:

TextHd Handle to text object.
JustFlag Justification setting for text.

See Also:

SetTextJust  



  SetTextLeading Objects - Text 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetTextLeading
(   theText :HANDLE;
    leading :REAL
) ;

Python:

def  vs.SetTextLeading(theText, leading):
   return None

Description:

Procedure SetTextLeading sets the line spacing of the referenced text object to a custom leading value (in points).

Parameters:

theText Handle to text object.
leading Custom leading value for text.



  SetTextOrientation Objects - Text 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetTextOrientation
(   theText :HANDLE;
    textOriginX :REAL;
    textOriginY :REAL;
    textAngle :REAL;
    textIsMirrored :BOOLEAN
) ;

Python:

def  vs.SetTextOrientation(theText, textOrigin, textAngle, textIsMirrored):
   return None

Description:

Procedure SetTextOrientation sets the position and orientation attributes of the referenced text object.

Parameters:

theText Handle to text object.
textOrigin Coordinates of text object origin.
textAngle Rotation angle for text object.
textIsMirrored Mirroring setting for text object.



  SetTextSize Objects - Text 
MiniCAD6.0

VectorScript Declaration:

PROCEDURE   SetTextSize
(   objectHd :HANDLE;
    Start :INTEGER;
    Count :INTEGER;
    Size :REAL
) ;

Python:

def  vs.SetTextSize(objectHd, Start, Count, Size):
   return None

Description:

Procedure SetTextSize sets the text size of a specified substring in the referenced text object. Parameters Start and Count specify the substring start position and substring length. Parameter Size specifies the size (in points) to be assigned to the substring.

Parameters:

objectHd Handle to text object.
Start Start position in text string.
Count Length of substring.
Size Text size setting for substring.

Example:

SetTextSize(HandleToText,0,5,24);
{set the first five characters of the referenced text string to 24 point text}



  SetTextSpace Objects - Text 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetTextSpace
(   theText :HANDLE;
    spacing :INTEGER
) ;

Python:

def  vs.SetTextSpace(theText, spacing):
   return None

Description:

Procedure SetTextSpace sets the line spacing of the referenced text object.

Table - Text Spacing

Leading Constant
Single space 2
1 1/2 space 3
Double space 4

Parameters:

theText Handle to text object.
spacing Line spacing for text.



  SetTextStyle Objects - Text 
MiniCAD6.0

VectorScript Declaration:

PROCEDURE   SetTextStyle
(   objectHd :HANDLE;
    Start :INTEGER;
    Count :INTEGER;
    Style :INTEGER
) ;

Python:

def  vs.SetTextStyle(objectHd, Start, Count, Style):
   return None

Description:

Procedure SetTextStyle sets the text style of a specified substring in the referenced text object.

Table - Text Style

Style Constant
Plain 0
Bold 1
Italic 2
Underline 4
Outline 8
Shadowed 16
Superscript 32
Subscript 64

Parameters:

objectHd Handle to text object.
Start Start position in text string.
Count Length of substring.
Style Text style setting for substring.

Example:

SetTextSyle(HandleToText,0,5,34);

{set the style of the substring text to bold and shadowed}



  SetTextStyleByClassN Objects - Text 
Vectorworks 2015

VectorScript Declaration:

FUNCTION   SetTextStyleByClassN
(   objectId :HANDLE;
    start :INTEGER;
    count :INTEGER
) :BOOLEAN ;

Python:

def  vs.SetTextStyleByClassN(objectId, start, count):
   return BOOLEAN

Description:

SetTextStyleByClassN sets a specified substring of a text object to use the class text style. To undo this, use SetTextStyleRef or SetTextStyleRefN on the text.

Parameters:

objectId handle to text object
start Start position in text string, zero-based.
count Length of substring.

Result:

Returns False if object is not a text object, or if part of the substring is past the end of existing text. Otherwise returns true.

See Also:

SetTextStyleRef   GetTextStyleRef   SetTextStyleRefN   GetTextStyleRefN   SetTextStyleByClass   SetTextStyleByClassN   IsTextStyleByClass   IsTextStyleByClassN  



  SetTextStyleRef Objects - Text 
Vectorworks 2015

VectorScript Declaration:

PROCEDURE   SetTextStyleRef
(   objectId :HANDLE;
    textStyleRef :LONGINT
) ;

Python:

def  vs.SetTextStyleRef(objectId, textStyleRef):
   return None

Description:

Procedure SetTextStyleRef sets the text style of an object to the referenced style. Reference 0 means Un-Styled. This procedure will replace by-class styling.

Parameters:

objectId handle to object
textStyleRef text style reference id

See Also:

SetTextStyleRef   GetTextStyleRef   SetTextStyleRefN   GetTextStyleRefN   SetTextStyleByClass   SetTextStyleByClassN   IsTextStyleByClass   IsTextStyleByClassN  



  SetTextStyleRefN Objects - Text 
Vectorworks 2015

VectorScript Declaration:

FUNCTION   SetTextStyleRefN
(   objectId :HANDLE;
    start :INTEGER;
    count :INTEGER;
    textStyleRef :LONGINT
) :BOOLEAN ;

Python:

def  vs.SetTextStyleRefN(objectId, start, count, textStyleRef):
   return BOOLEAN

Description:

SetTextStyleRefN sets the text style of a specified substring of a text object to the referenced style. Reference 0 means Un-Styled. This procedure will replace by-class styling.

Parameters:

objectId handle to text object
start Start position in text string, zero-based.
count Length of substring.
textStyleRef text style reference id

Result:

Returns False if object is not a text object, or if part of the substring is past the end of existing text. Otherwise returns true.

See Also:

SetTextStyleRef   GetTextStyleRef   GetTextStyleRefN   SetTextStyleByClass   SetTextStyleByClassN   IsTextStyleByClass   IsTextStyleByClassN  



  SetTextVertAlignN Objects - Text 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   SetTextVertAlignN
(   TextHd :HANDLE;
    verticalAlignment :INTEGER
) ;

Python:

def  vs.SetTextVertAlignN(TextHd, verticalAlignment):
   return None

Description:

Procedure SetTextVertAlignN sets the vertical alignment of the referenced text object without changing its location.

Table - Text Vertical Justification

Justification Constant
Top of text box 1
Top baseline 2
Text centerline 3
Bottom baseline 4
Bottom of text box 5


Parameters:

TextHd Handle to the text object.
verticalAlignment Vertical alignment setting for text.

See Also:

SetTextVerticalAlign  



  SetTextVerticalAlign Objects - Text 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetTextVerticalAlign
(   TextHd :HANDLE;
    verticalAlignment :INTEGER
) ;

Python:

def  vs.SetTextVerticalAlign(TextHd, verticalAlignment):
   return None

Description:

Procedure SetTextVerticalAlign sets the vertical alignment of the referenced text object.

Table - Text Vertical Justification

Justification Constant
Top of text box 1
Top baseline 2
Text centerline 3
Bottom baseline 4
Bottom of text box 5


Parameters:

TextHd Handle to text object.
verticalAlignment Vertical alignment setting for text.

See Also:

SetTextVertAlignN  



  SetTextWidth Objects - Text 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetTextWidth
(   theText :HANDLE;
    widthDistance :REAL (Coordinate)
) ;

Python:

def  vs.SetTextWidth(theText, widthDistance):
   return None

Description:

Procedure SetTextWidth Sets the text wrapping margin width of the referenced text object.

A call to SetTextWidth automatically activates text wrapping.

Parameters:

theText Handle to text object.
widthDistance Text wrapping margin setting for text.

Example:

PROCEDURE Example;

FUNCTION IncreaseTextWidth(h :HANDLE) :BOOLEAN;
BEGIN
   SetTextWidth(h, GetTextWidth(h) * 1.2);
END;

BEGIN
   ForEachObjectInLayer(IncreaseTextWidth, 2, 0, 4);
END;
RUN(Example);

See Also:

GetTextWidth  



  SetTextWrap Objects - Text 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetTextWrap
(   theText :HANDLE;
    wrap :BOOLEAN
) ;

Python:

def  vs.SetTextWrap(theText, wrap):
   return None

Description:

Procedure SetTextWrap sets the text wrap mode of the referenced text object.

Parameters:

theText Handle to text object.
wrap Text wrap setting for text.



  TextFace Objects - Text 
MiniCAD

VectorScript Declaration:

PROCEDURE   TextFace
( s:TEXTSTYLE ) ;

Python:

def  vs.TextFace(s):
   return None

Description:

Procedure TextFace sets the active text style of a Vectorworks document.

The text style may be one or a combination of the available styles, and should be enclosed in brackets. To specify multiple styles, each style should be separated by a comma.

Parameters:

s Style setting for document.

Example:

TextFace([Italic]);
{set the active text style to Italic}

TextFace([Bold,Outline]);
{set the active text style to bold outline}



  TextFlip Objects - Text 
MiniCAD

VectorScript Declaration:

PROCEDURE   TextFlip
( FlipType:INTEGER ) ;

Python:

def  vs.TextFlip(FlipType):
   return None

Description:

Procedure TextFlip flips newly created text vertically or horizontally. Parameter FlipType specifies the flip effect to be applied to the text.

Table - Text Flip Style

Flip Style Constant
No reflection 0
Horizontal reflection thru origin 1
Vertical reflection thru origin 2

Parameters:

FlipType Text flip setting for text.

Example:

TextFlip(1);
CreateText('Sample text string');



  TextFont Objects - Text 
MiniCAD

VectorScript Declaration:

PROCEDURE   TextFont
( fontID:INTEGER ) ;

Python:

def  vs.TextFont(fontID):
   return None

Description:

Procedure TextFont sets the active font for the document.

Parameters:

fontID Font ID setting for document.

Example:

TextFont(GetFontID('Times'));



  TextJust Objects - Text 
MiniCAD

VectorScript Declaration:

PROCEDURE   TextJust
( justify:INTEGER ) ;

Python:

def  vs.TextJust(justify):
   return None

Description:

Procedure TextJust sets the active text justification for a Vectorworks document.

Table - Text Justification

Justification Constant
Left 1
Center 2
Right 3
Justify 4

Parameters:

justify Justification setting for document.



  TextLeading Objects - Text 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   TextLeading
( leading:REAL ) ;

Python:

def  vs.TextLeading(leading):
   return None

Description:

Procedure TextLeading sets the default line spacing of Vectorworks to a custom leading value (in points).

Parameters:

leading Custom leading value for document.



  TextOrigin Objects - Text 
MiniCAD

VectorScript Declaration:

PROCEDURE   TextOrigin
(   pX :REAL;
    pY :REAL
) ;

Python:

def  vs.TextOrigin(p):
   return None

Description:

Procedure TextOrigin is used to specify the origin point (location) of a newly created text object.

The position of the actual text with respect to the origin is determined by the current vertical and horizontal text justification modes.

Parameters:

p Coordinates of text origin.

See Also:

MoveTo  



  TextRotate Objects - Text 
MiniCAD

VectorScript Declaration:

PROCEDURE   TextRotate
( Rotation:REAL ) ;

Python:

def  vs.TextRotate(Rotation):
   return None

Description:

Procedure TextRotate sets the angle of a new text object.

Parameters:

Rotation Rotation angle, in degrees, for text.

Example:

TextRotate(45);
TextOrigin(0",0");
CreateText('Rotated string');



  TextSize Objects - Text 
MiniCAD

VectorScript Declaration:

PROCEDURE   TextSize
( size:REAL ) ;

Python:

def  vs.TextSize(size):
   return None

Description:

Procedure TextSize sets the active text size of a Vectorworks document.

Text size is specified in points (1 point = 1/72"). If 0 is specified, then the font size will default to 12 pt text.

Parameters:

size Point size of text.

Example:

TextSize(18);
{set the active text size to 18 point}



  TextSpace Objects - Text 
MiniCAD

VectorScript Declaration:

PROCEDURE   TextSpace
( spacing:INTEGER ) ;

Python:

def  vs.TextSpace(spacing):
   return None

Description:

Procedure TextSpace sets the active spacing for a Vectorworks document.

Table - Text Spacing

Leading Constant
Single space 2
1 1/2 space 3
Double space 4

Parameters:

spacing Spacing style for text.

Example:

TextSpace(4);
{set the active leading to double space}



  TextVerticalAlign Objects - Text 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   TextVerticalAlign
( verticalAlignment:INTEGER ) ;

Python:

def  vs.TextVerticalAlign(verticalAlignment):
   return None

Description:

Procedure TextVerticalAlign sets the active text vertical alignment of a Vectorworks document.

Table - Text Vertical Justification

Justification Constant
Top of text box 1
Top baseline 2
Text centerline 3
Bottom baseline 4
Bottom of text box 5


Parameters:

verticalAlignment Vertical alignment setting for document.



  TrueTypeToPoly Objects - Text 
Vectorworks 2014

VectorScript Declaration:

FUNCTION   TrueTypeToPoly
(   textHandle :HANDLE;
  VAR  polyGroupHandle :HANDLE
) :LONGINT ;

Python:

def  vs.TrueTypeToPoly(textHandle):
   return (LONGINT, polyGroupHandle)

Description:

TrueTypeToPoly converts handle to Text object into handle to Group of poly objects with similar shape.