printRootPanel()

Prints a particular root panel.

Synopsis

int printRootPanel(dyn_string moduleName, string spec, int options);

Parameters

Parameter Description
moduleName

Names of the modules whose root panel are to be printed. Each will be printed as a separate page in the order given in the string.

spec

Default = "" and means print with child panels (is printed like a screenshot), "panelOnly" = prints the panel without child panels (without screenshot of the child panels).

CAUTION

When using Windows, child panels cannot be printed due to technical restrictions of the operating system.

options

With the options parameter the available printing options can be defined.

The following constants (values) are available:

  • PPO_NO_DIALOGS (0) - does not open any dialogs

  • PPO_ALL_DIALOGS (1) - opens all dialogs [default]

  • PPO_PRINTER_DIALOG (2) - only the print dialog will be opened

  • PPO_BACKGROUND_DIALOG (4) - only the background options dialog will be opened

The background options dialog is used to specify whether the background color should be replaced with white or should not be changed.

CAUTION

When using Windows, child panels cannot be printed due to technical restrictions of the operating system.

Return value

In the event of errors, the function returns -1, otherwise, 0.

Description

Prints the specified root panel in the module moduleName.

Prints the root panel of the actual module without a printing dialog.

main()
{
  printRootPanel(myModuleName(),"",PPO_NO_DIALOGS);
}

This function can be used with silentMode printing. To do this, the silentMode UI must open a "main" panel containing embedded modules. Each of these modules contains one of the root panels to be printed. After these panels are loaded, the "main" panel calls this function (as printRootPanel(allModules, "panelOnly") and closes itself with PanelOff().

Note: If the option "panelOnly" is used at printRootPanel() a minimized panel is printed correctly.
CAUTION: If the panel is larger than the current module, only the visible parts of the panel are printed. If the option "panelOnly" is used the problem does not exist and the module is printed with the complete panel.

Assignment

Administration of managers, modules and panels

Availability

UI