Sheet.PrintString property

Read-Write property.

Type: BSTR string.

This allows you to obtain or set the transport printer string. The print string value is initialized by ScanTools Plus before scanning each document, but may be modified by the results of scan-time editing. It is in its final form at the XPrint event.

This print string value is independent of whether the configured scanner actually has a printer or not. If no printer is installed on the scanner, the string is simply not printed; you are not notified that a printer does not exist.

The XPrint event is the only event to use for both reading or modifying this value.

When scanning with a scanner that does not have a transport printer, Sheet.PrintString does nothing and no exceptions are thrown.

NOTE: If you change the print string at the XPrint event, the print position as defined in SessionInfo.PrintPosition property reverts back to 1 for this sheet only. If this position is not acceptable, you must include leading spaces as part of the new print string to reposition the print string.

Valid

See ScanEventArgs and ScanningManager Events Valid Combinations.

IDL

propget, HRESULT PrintString([out, retval] BSTR *pVal);

propput, HRESULT PrintString([in] BSTR pVal);

Values

String, maximum of 63 characters.

The maximum number of characters that will print on a form depends on the model of scanner you are using and, in some cases, the speed of that scanner model. If you plan to print a lot of information on the documents, be aware of the space limitations of your scanner.

See also

SessionInfo.PrintPosition property