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

From Flowcode Help
Jump to navigationJump to search
(XML import)
Line 1: Line 1:
−
<sidebar>API Contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Draws a line of text texture
 
−
 
 
−
<div style="width:25%; float:right" class="toc">
 
−
====Class hierarchy====
 
−
[[API Panel|Panel]]
 
−
:[[API Panel.Graphics|Graphics]]
 
−
::[[API Panel.Graphics|DrawText]]
 
−
</div>
 
−
__TOC__
 
−
 
 
−
==Parameters==
 
−
[[Variable Types|FLOAT]] ''X''
 
−
:Initial horizontal position of text (depends on Align)
 
−
 
 
−
[[Variable Types|FLOAT]] ''Y''
 
−
:Initial vertical position of text (depends on Align)
 
−
 
 
−
[[Variable Types|STRING]] ''Text''
 
−
:The text to draw, may be multiple lines
 
−
 
 
−
[[Variable Types|BYTE]] ''Align''
 
−
:The text alignment
 
−
:''The default value for this parameter is: '''''0'''
 
−
:''Typical values for this parameter:''
 
−
::{| class="wikitable" width="65%"
 
 
|-
 
|-
−
! width="30%" |Name
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
! width="55%" |Description
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DrawText'''
 
|-
 
|-
−
|Align_TopLeft
+
| colspan="2" | Draws a line of text texture&nbsp;
−
|Text is left aligned and drawn below the Y coordinate
 
 
|-
 
|-
−
|Align_TopCenter
 
−
|Text is center aligned and drawn below the Y coordinate
 
 
|-
 
|-
−
|Align_TopRight
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
−
|Text is right aligned and drawn below the Y coordinate
+
| width="90%" | X
 
|-
 
|-
−
|Align_CenterLeft
+
| colspan="2" | Initial horizontal position of text (depends on Align)&nbsp;
−
|Text is left aligned and vertically centered
 
 
|-
 
|-
−
|Align_Center
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
−
|Text is horizontally aligned and vertically centered
+
| width="90%" | Y
 
|-
 
|-
−
|Align_CenterRight
+
| colspan="2" | Initial vertical position of text (depends on Align)&nbsp;
−
|Text is right aligned and vertically centered
 
 
|-
 
|-
−
|Align_BottomLeft
+
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
−
|Text is left aligned and drawn above the Y coordinate
+
| width="90%" | Text
 
|-
 
|-
−
|Align_BottomCenter
+
| colspan="2" | The text to draw, may be multiple lines&nbsp;
−
|Text is center aligned drawn above the Y coordinate
 
 
|-
 
|-
−
|Align_BottomRight
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
|Text is right aligned drawn above the Y coordinate
+
| width="90%" | Align
 +
|-
 +
| colspan="2" | The text alignment&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
−
 
−
 
−
==Return value==
 
−
''This call does not return a value''
 
  
  

Revision as of 11:41, 16 January 2023

Fc9-comp-macro.png DrawText
Draws a line of text texture 
Fc9-f32-icon.png - FLOAT X
Initial horizontal position of text (depends on Align) 
Fc9-f32-icon.png - FLOAT Y
Initial vertical position of text (depends on Align) 
Fc9-string-icon.png - STRING Text
The text to draw, may be multiple lines 
Fc9-u8-icon.png - BYTE Align
The text alignment 
Fc9-void-icon.png - NONE Return


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 examples

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Panel.Graphics.DrawText&oldid=29864"