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

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
 
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
wiki page name
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Draws a line of text texture
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DrawText'''
 +
|-
 +
| colspan="2" | Draws a line of text texture 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | X
 +
|-
 +
| colspan="2" | Initial horizontal position of text (depends on Align) 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Y
 +
|-
 +
| colspan="2" | Initial vertical position of text (depends on Align) 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Text
 +
|-
 +
| colspan="2" | The text to draw, may be multiple lines 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Align
 +
|-
 +
| colspan="2" | The text alignment 
 +
|-
 +
| 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''
 +
|}
  
  
===Parameters===
+
==Detailed description==
''[[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="20%"|Type|width="30%"|Name |width="40%"|Value|-LONG|Align_TopLeft|0
 
|-LONG|Align_TopCenter|1
 
|-LONG|Align_TopRight|2
 
|-LONG|Align_CenterLeft|4
 
|-LONG|Align_Center|5
 
|-LONG|Align_CenterRight|6
 
|-LONG|Align_BottomLeft|8
 
|-LONG|Align_BottomCenter|9
 
|-LONG|Align_BottomRight|10
 
|}
 
  
===Return value===
 
''This call does not return a value''
 
  
===Detailed description===
 
''No additional information''
 
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
* Add to a calculation icon: ::Panel.Graphics.DrawText(x, y, "text", ::Panel.Graphics.Align_TopLeft)
+
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Graphics.DrawText(x, y, "text", ::Panel.Graphics.Align_TopLeft)</pre>

Latest revision as of 11:55, 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

Examples

Calling in a calculation

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