Add_ShapeText

Top  Previous  Next

 

Add_ShapeText (Method)

 

This function adds a text. The difference from add_Text is that this text has z order

 

Syntax:

Function Add_ShapeText(sText As String, x As Single, y As Single, Height As Single, vItemProperties As Object, sAngle As Single, iFontNumber As Short, iClr As Short, iWidth As Short, iStyle As Short, iLayer As Short, fBold As Boolean, fItalic As Boolean, fUnderline As Boolean, fStrikeOut As Boolean, lCharSet As Integer, zOrder As Integer, fBorder As Boolean) As Integer

 

The Add_ShapeText method syntax consists of the following:

Parameter

Data Type

Description

sText

String

Is the text object (change text line with CrLf)

x

Single

Is the x coordinate of the text's first character bottom left point

y

Single

Is the y coordinate of the text's first character bottom left point

Height

Single

Is the text's height

vItemProperties

Object

Is a string array with properties for the new object

sAngle

Single

Is the text's angle

iFontNumber

Short

Is the font index number

iClr

Short

Is the color index number

iWidth

Short

Is the pen width

iStyle

Short

Is the line type

iLayer

Short

Is the layer number

fBold

Boolean

A Boolean expression that if it is True then the text is bold

fItalic

Boolean

A Boolean expression that if it is True then the text is italic

fUnderline

Boolean

A Boolean expression that if it is True then the text is underlined

fStrikeOut

Boolean

A Boolean expression that if it is True then the text is strikethrough

lCharSet

Integer

Is the font character set number

zOrder

Integer

Is the object's elevation in the whole drawing

fBorder

Boolean

A Boolean expression that if it is True then a border contours the text

 

Return value:

Integer - An Avax handle on success, zero on error.

 

Remarks:

For more details for the fill parameters see the example ShapeFill.vbp

 

Example