PlaceText

image\bltlrgss.gif Editions  image\bltlrgss.gif Related Transactions  image\bltlrgss.gif Example

The PlaceText transaction places a text object in the specified document window, on the current page's active edit layer.

Type XTYP_EXECUTE

Syntax [PlaceText(docwinID, unitType, x, y, "text", <color>, <style>, <size>, <units>, <"fontName">, <angle>, <fillStyle>)]

Parameter

Data type

Values

Meaning

docwinID

DWORD

0 | docwinID

active | specific

unitType

WORD

0

proportional units

x, y

DWORD

0 to 100000 each

top-left coordinates of text. See Remarks.

text

string

text to place

color

WORD

RGB color

text color

style

WORD

0

normal

 

 

1

bold

 

 

2

italic

 

 

4

underline

 

 

8

strikeout

 

 

(can be ORed)

 

size

float

height of text

units

WORD

1 | 2

inches | cm

fontName

string

Windows font name

angle

WORD

0 | 90 | 180 | 270

angle in degrees

fillStyle

WORD

1

transparent text

 

 

2

opaque text

 

 

3

erase (background color) text

 

 

4

translucent text

 

 

5

hatch-filled text.
Example of text fill styles.

Remarks

The last seven parameters (color, . . ., fillStyle) are optional. If any of these are left blank, then the default attribute values will be used.

For the text to be visible, you must redraw the display by using the Refresh transaction or the View, Refresh command in the user interface.

Release information

Added in Release 3.70.

Modified in Release 5.13: The optional fillStyle parameter was added.

See also