Difference between revisions of "API Panel.Graphics.DrawText"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 23: Line 23:
 
:The text alignment
 
:The text alignment
 
:''The default value for this parameter is: '''''0'''
 
:''The default value for this parameter is: '''''0'''
''Typical values for this parameter:''
+
:''Typical values for this parameter:''
{| class="wikitable" width="75%"
+
::{| class="wikitable" width="65%"
 
|-
 
|-
! width="20%" |Type
 
 
! width="30%" |Name
 
! width="30%" |Name
! width="50%" |Description
+
! width="55%" |Description
 
|-
 
|-
|LONG
 
 
|Align_TopLeft
 
|Align_TopLeft
 
|Text is left aligned and drawn below the Y coordinate
 
|Text is left aligned and drawn below the Y coordinate
 
|-
 
|-
|LONG
 
 
|Align_TopCenter
 
|Align_TopCenter
 
|Text is center aligned and drawn below the Y coordinate
 
|Text is center aligned and drawn below the Y coordinate
 
|-
 
|-
|LONG
 
 
|Align_TopRight
 
|Align_TopRight
 
|Text is right aligned and drawn below the Y coordinate
 
|Text is right aligned and drawn below the Y coordinate
 
|-
 
|-
|LONG
 
 
|Align_CenterLeft
 
|Align_CenterLeft
 
|Text is left aligned and vertically centered
 
|Text is left aligned and vertically centered
 
|-
 
|-
|LONG
 
 
|Align_Center
 
|Align_Center
 
|Text is horizontally aligned and vertically centered
 
|Text is horizontally aligned and vertically centered
 
|-
 
|-
|LONG
 
 
|Align_CenterRight
 
|Align_CenterRight
 
|Text is right aligned and vertically centered
 
|Text is right aligned and vertically centered
 
|-
 
|-
|LONG
 
 
|Align_BottomLeft
 
|Align_BottomLeft
 
|Text is left aligned and drawn above the Y coordinate
 
|Text is left aligned and drawn above the Y coordinate
 
|-
 
|-
|LONG
 
 
|Align_BottomCenter
 
|Align_BottomCenter
 
|Text is center aligned drawn above the Y coordinate
 
|Text is center aligned drawn above the Y coordinate
 
|-
 
|-
|LONG
 
 
|Align_BottomRight
 
|Align_BottomRight
 
|Text is right aligned drawn above the Y coordinate
 
|Text is right aligned drawn above the Y coordinate

Revision as of 21:28, 12 May 2013

<sidebar>API contents</sidebar> Draws a line of text texture

Class hierarchy

Panel

Graphics
DrawText

Parameters

FLOAT X

Initial horizontal position of text (depends on Align)

FLOAT Y

Initial vertical position of text (depends on Align)

STRING Text

The text to draw, may be multiple lines

BYTE Align

The text alignment
The default value for this parameter is: 0
Typical values for this parameter:
Name Description
Align_TopLeft Text is left aligned and drawn below the Y coordinate
Align_TopCenter Text is center aligned and drawn below the Y coordinate
Align_TopRight Text is right aligned and drawn below the Y coordinate
Align_CenterLeft Text is left aligned and vertically centered
Align_Center Text is horizontally aligned and vertically centered
Align_CenterRight Text is right aligned and vertically centered
Align_BottomLeft Text is left aligned and drawn above the Y coordinate
Align_BottomCenter Text is center aligned drawn above the Y coordinate
Align_BottomRight Text is right aligned drawn above the Y coordinate

Return value

This call does not return a value


Detailed description

No additional information


Examples

Calling in a calculation

  • Add to a calculation icon:
    ::Panel.Graphics.DrawText(x, y, "text", ::Panel.Graphics.Align_TopLeft)

No additional information