Contents > Library Reference > Printing

Printing

Printing support using PalmPrint.

Objects and Structures

| PalmPrint | Serial and IR printing support.

Contents > Library Reference > Printing > PalmPrint object

PalmPrint

The PalmPrint object provides access to printing through Stevens Creek's PalmPrint. In order to use this object, you need to have PalmPrint or SCS Print Server installed. For supplemental documenation, please visit the Stevens Creek website.

The PalmPrint object is implemented in the OrbPrint native add-in. To use it, you must #include "OrbPrint.oc".

Notes:

- When using Xmit methods rather than Print methods, the text is sent directly to the printer as plain text, ignoring the user's current printer setting.
- The following properties may only be set before printing begins, and are reset when printing ends: charsPerLine, linesPerPage, leftMargin, topMargin, indent, orientation, numCopies.
- The follwoing properties may only be set while in line-by-line mode: font, fontSize, style.

Object Properties

| int charsPerLine | Gets or sets the number of characters per line. When setting this property, supply the width of the entire line. When getting this property, the width is adjusted to exclude the margins and indent.
| int linesPerPage | Gets or sets the number of lines per page. When setting this property, supply the height of the entire page. When getting this property, the height is adjusted to exclude the margins.
| int font | Sets the current font. Possible fonts are `prtFontCourier`, `prtFontTimes`, `prtFontHelvetica`, `prtFontStandard`.
| int fontSize | Sets the current font size. Possible sizes are `prtSize9`, `prtSize10`, `prtSize12`.
| int style | Sets the current font style. Possible styles are `prtStylePlain`, `prtStyleBold`.
| int leftMargin | Sets the width of the left margin.
| int topMargin | Sets the height of the top margin.
| int indent | Sets the current indent.
| int numCopies | Sets the number of copies to print. This properties does not affect printString() or xmitString().
| int orientation | Sets the paper orientation. Possible orienations are `prtOrientLandscape`, `prtOrientPortrait`.

Object Methods

| bool open() | Open the PalmPrint library.
| void printString(string str) | Print a complete string
| void xmitString(string str) | Transmit a complete string as plain text.
| void beginPrint() | Begin printing in line by line mode.
| void endPrint() | End printing in line-by-line mode.
| void beginXmit() | Begin trasmitting in line-by-line mode.
| void endXmit() | End trasmitting in line-by-line mode.
| void printLine(string line) | Print a line in line-by-line mode.
| void xmitLine(string line) | Transmit a line in line-by-line mode.
| void printLinePassThru(string line) | Print a line in line-by-line mode without transforming special characters.
| void xmitLinePassThru(string line) | Transmit a line in line-by-line mode without transforming special characters.

Contents > Library Reference > Printing > PalmPrint object > open

PalmPrint.open

`bool open()`

Return value: true if PalmPrint was opened successfully.

Open the PalmPrint library.

Contents > Library Reference > Printing > PalmPrint object > printString

PalmPrint.printString

`void printString(string str)`

Parameters:

| str | string to print

Print a complete string

Contents > Library Reference > Printing > PalmPrint object > xmitString

PalmPrint.xmitString

`void xmitString(string str)`

Parameters:

| str | string to transmit

Transmit a complete string as plain text.

Contents > Library Reference > Printing > PalmPrint object > beginPrint

PalmPrint.beginPrint

`void beginPrint()`

Begin printing in line by line mode.

Contents > Library Reference > Printing > PalmPrint object > endPrint

PalmPrint.endPrint

`void endPrint()`

End printing in line-by-line mode.

Contents > Library Reference > Printing > PalmPrint object > beginXmit

PalmPrint.beginXmit

`void beginXmit()`

Begin trasmitting in line-by-line mode.

Contents > Library Reference > Printing > PalmPrint object > endXmit

PalmPrint.endXmit

`void endXmit()`

End trasmitting in line-by-line mode.

Contents > Library Reference > Printing > PalmPrint object > printLine

PalmPrint.printLine

`void printLine(string line)`

Parameters:

| line | line to print

Print a line in line-by-line mode.

Contents > Library Reference > Printing > PalmPrint object > xmitLine

PalmPrint.xmitLine

`void xmitLine(string line)`

Parameters:

| line | line to transmit

Transmit a line in line-by-line mode.

Contents > Library Reference > Printing > PalmPrint object > printLinePassThru

PalmPrint.printLinePassThru

`void printLinePassThru(string line)`

Parameters:

| line | line to print

Print a line in line-by-line mode without transforming special characters.

Contents > Library Reference > Printing > PalmPrint object > xmitLinePassThru

PalmPrint.xmitLinePassThru

`void xmitLinePassThru(string line)`

Parameters:

| line | line to transmit

Transmit a line in line-by-line mode without transforming special characters.