EditorPrintSetup()

Summary

Displays an extended version of the "Print" common dialog, with controls for setting up the printing format for an editor.

Syntax

result = EditorPrintSetup(integer across_first, string title, array options)

Argument Contents
across_first 1 or 0 to indicate the current preference. If 1, the Across, then Down radio button will be enabled, if 0, the Down, then Across radio button will be enabled
title Optional title; null defaults to "Print Dataview"
Option Type Contents
Header Callback String Name of header callback macro
Footer Callback String Name of footer callback macro

Returns

Null, if the user cancelled, or an array of print job setup information as follows:

Element Type Contents
1 Integer First page to print
2 Integer Last page to print
3 Array Options array as described below
Option Type Contents
Direction String "Across" or "Down"
Header Text String The text in the header
Header Font String The font for the header
Footer Text String The text in the footer
Footer Font String The font for the footer

Notes

  • If across_first is 1, and there are more columns than fit on page 1, then page 2 will be a continuation of the rows on page one, and so on until the last columns are printed, on page n. If there are more rows than fit on page 1, then pages n+1 to 2n will be printed, and so on. The reverse is true if across_first is 0.

  • The callback macros take no arguments, and must return an array of two strings, a text string with the text to use for the header or footer, and a font string that indicates the font to use (e.g., "Arial", "Arial|20", or "Arial|Bold|20").

  • If the Header Callback option is used the dialog box will have a Header button, and if the Footer Callback option is used the dialog box will have a Footer button. When the user clicks one of these buttons the appropriate callback macro will be invoked.

  • The callback macros can be dialog box with at least an edit text item, or can be macros that return values for strings for text and font.

Example

result = EditorPrintSetup(across_1st_state, , )
//return value is null if user cancelled
if options = null then Return()
PrintEditor(result[1], result[2], result[3])

See Also

Function Summary
FigurePrintSetup() Displays the "Print" common dialog
LayoutPrintSetup() Collects print settings for a layout window
MapPrintSetup() Displays an extended version of the "Print" common dialog, with check boxes to indicate whether to print at a fixed scale and whether to print fonts at fixed point size or adjusted to match the map window