====== TEXTBOX Set_Printer Message ======


 
==== Description ====
 
The TEXTBOX message is used to send output to the printer at a specific position with the text contained a rectangular region.

 
==== Parameters ====
 
^Parameter\\ ^Description of Fields\\ ^Comments\\ ^Default\\ ^
|Parm1 - TextString\\ |<1> TextString\\ |"Text String"\\ |""\\ |
|Parm2 - Location\\ |<1> X\\ |Starting X position\\ |0\\ |
| \\ |<2> Y\\ |Starting Y position\\ |0\\ |
| \\ |<3> CX\\ |Width\\ |0\\ |
| \\ |<4> CY\\ |Height\\ |0\\ |
|Parm3 - Font\\ |Same structure as Parm1 of the FONT message.\\ |Font structure.\\ |Current font\\ |
|Parm4 - Repeat\\ |<1> Repeat on all pages\\ |0=Current page only\\  \\ \\ Print on all pages\\ | \\ ||

 
==== Remarks ====
 
The Location parameter sets the rectangular region. If the Font parameter is not specified, then the font is set to the current font from the [[font_set_printer_message|FONT]] message. Use the Font parameter to print a specific font. This is useful when printing the TEXTBOX on every page with the same font, because the font that is set with the [[font_set_printer_message|FONT]] message may change during printing. The Repeat parameter is used to repeat the text on every page.

 

For multiple lines of text, the TEXTSTRING parameter should contain @fm delimited text.

 
==== See Also ====
 
[[font_set_printer_message|FONT]], [[text_set_printer_message|TEXT]], [[textxy_set_printer_message|TEXTXY]] Set_Printer messages
 
==== Example ====
 
<code>
/*
The following example shows how to use the TEXTBOX message to print text in a 1 inch by 1 inch box.
*/

declare function Set_Printer
stat = Set_Printer("INIT") ;* Start printing
stat = Set_Printer("TEXTBOX", "Text in a box", 1:@fm:1:@fm:1:@fm:1)
stat = Set_Printer("TERM") ;* End printing

/*
The following example shows how to use the TEXTBOX message to print text with line breaks in a 1 inch by 1 inch box.
*/

declare function Set_Printer
stat = Set_Printer("INIT") ;* Start printing

textstring = 'Text in a box':@fm:'More text in a box'
stat = Set_Printer("TEXTBOX", textstring, 1:@fm:1:@fm:1:@fm:1)
stat = Set_Printer("TERM") ;* End printing

 
 
</code>