Copyright: Copyright


Help Contents
Contents

Using the Report Generator

The Report Generator Main Window Layout

The Report Generator File Menu

The Report Generator Edit Menu

The Report Generator Insert Menu

The Report Generator Layout Menu

The Report Generator View Menu

The Report Generator Window Menu

The Report Generator Help Menu

The Report Generator Context Menus

Function and Command Reference


Using the Report Generator

What does Report Generator Do?


The Report Generator Main Window Layout

The Menus

The Report  Generator Tool Bar


The Report Generator File Menu

New

Open

Close

Save

Save As

Save As Template

Print

Print Preview

Print Setup

Exit


The Report Generator Edit Menu

Cut

Copy

Paste

Paste Special

Paste Link

Select All

Delete

Delete All

Delete Page

Change Icon

Links

Insert New Object

Object

Properties


The Report Generator Insert Menu

Page

Line

Text

Image

Image with Overlay

Count/Size

Histogram

Line Profile

Output Text


The Report Generator Layout Menu

Update Data

Update Selected Data

Reset Size

Resize Placeholders

Show Placeholders

Show Data

Move to Front

Move to Back


The Report Generator View Menu

Gridlines

Show Frame

Change Text

Change Font

Toolbar

Status Bar

Zoom


The Report Generator Window Menu

New Window

Cascade

Tile

Arrange Icon

1 Report


The Report Generator Help Menu

Index

Using Help

About Report Generator


The Report Generator Context Menus

Report Context Menu

Line Context Menu

Text Context Menu

Object or OLE Object Context Menus


Function and Command Reference

IpRptClose

IpRptNew

IpRptOpen

IpRptPrint

IpRptSave

IpRptShow


What does Report Generator Do?

The Report Generator allows you to create a variety of customized reports to display your information. The Report Generator supports two types of documents:

•	Templates allow you to design reports using placeholders for tables, charts, graphs, and other objects. You can save a template and use it over and over.

•	Reports insert data from your most recent session into the placeholders. These reports can be updated from session to session, archived, and printed to a printer.

The Report Generator window is an application window. The usual Windows controls can be used to switch among the Report Generator, Image-Pro Plus, any of its plug-ins, and any other applications.

You can use the Report Generator to create customized reports displaying charts, tables, graphs, or other OLE objects, such as an Excel spreadsheet.

You access the Report Generator by selecting the Report command on the Image-Pro Plus Measure menu, or by clicking on its icon in the Image-Pro Plus toolbar. You can also click on the Report Generator icon in the Image-Pro Plus program group.

The Report Generator's main window contains the tools and menus you'll use to create, open and work with a report.   The window is made up of the Title Bar, the Menu Bar, the Toolbar, the Workspace and the Status Bar.


The Menus

Menus are displayed across the top of the screen.   Each menu contains a set of related commands.

•	The File menu lets you open, create, save, or print a report; and save your current layout as a template.

•	The Edit menu contains commands to select, copy, paste, or delete the contents of a report. It also lets you insert links to other files, and insert OLE objects into your report.

•	The Insert menu contains the types of objects that you can use in designing your report.

•	The Layout menu lets you manipulate the objects in your report. You can change the size, stack them on top of each other, and update the data in each object. The Layout menu also contains the command to replace placeholders with actual data.

•	The View menu controls what you see on your screen. You can turn the gridlines, tool bar, and status bar on and off, and hide or show the frame.

•	The Window menu allows you to control the size and arrangement of the active viewing windows.

•	The Help menu allows you to access the Report Generator online help.


The Report  Generator Tool Bar

The tool bar gives you quick access to the most frequently used Report Generator commands.

	New.  This button creates a new report.  For more information about using this button, see  File : New.
	Open.  This button opens an existing report of your choice.   For more information about using this button, see  File : Open.
	Save. This button saves your report to a file. For more information about using this button, see File : Save.
	Print. This button sends your a single copy of your report to the printer without displaying the Print dialog box.  For more information about using this button, see  File : Print.
	Cut. This button cuts a selected object from the report . For more information about using this button, see Edit : Cut.
	Copy.  This button copies a selected object. For more information about using this button, see Edit : Copy.
	Paste. This button pastes an object from the clipboard into your report.  For more information about using this button, see Edit : Paste.
	Page buttons. Clicking these buttons displays the next page or the previous page of your report.
	Line. This button inserts a line in your report.
	Text. This button inserts a text box in your report.
	Insert Data. This button inserts or updates data in the placeholders.
	Move object to front. Clicking this button moves the selected object to the front.
	About.  This button displays the Report Generator About box.
	Help. This button gives you access to the Report Generator online Help.
Use the Report window's File menu to perform operations that affect both templates and reports.  This menu lets you create, open, close, save, and print a report.

Each command on the Report window's File menu is described below.


New

Select the New... command to create a new report.  When you select the New command, the New Report dialog box will appear:

Use Template

From this list box, indicate the template that you would like to base your new report on.  If you want to design a new template, choose the New Template button.

The Report Generator creates a default report called "Untitled." Your new report will be displayed in the Report Generator workspace. It is not necessary to close the working report in order to create a new one.


Open

Select the Open... command to open a report that you have already created.  It is not necessary to close the working report in order to open a new one

When you select the Open... command, the Open dialog box will appear.  Fill out the file information, then click OK.

Look in:   From this list box, select the drive or folder where your file is located.  You can browse through the folder listing area to obtain a list of file names to select from.  Report files end with the extension .rpt, and template files end with the extension  .tpl .   Opening a template opens an existing template.

Double-clicking on a file name in the folder listing area will automatically open it.

File name:  In this field, you can either type the name of the file (with its entire path, if it is not in the current folder), or use the Look in selection to browse through a list of file names.

Double-clicking on a file name in the folder listing area will automatically select and open it.

Files of type:   Select the type of file to list: report (*.rpt), or all files ( *.*).


Close

Use this command on the Report : File menu to close the active report.


Save

Use this command on the Report : File menu to save the active report in its current file. If the report has not previously been saved, (it will be called " Untitled,")  then the effect is the same as selecting the Save As command. .


Save As

Use this command on the Report : File menu to save the active report to a new or different file. Saving a preserves the data in the objects included in the report..

Save in:  In this list box, select the drive and folder where you want your object file saved  to.  You can browse through the folder listing area to browse through additional folders and sub-folders.

File name:  Enter the name of the file you want the report saved to.  Specify the file's location by either entering its entire path (drive and folder), or specifying its location using the Save in selection.

If you omit the "." and the extension .rpt,  Report Generator will automatically assign the extension that identifies the current format. If you type the ".", but omit the extension, Report Generator will save the file without an extension.

Double-clicking on a file name displayed in the folder listing under the File name box will save the object to that file  (i.e., you are requesting that the file be overwritten).  Any time you save an object to an existing file, Report Generator will request confirmation.

Save as type:   In this list box, select the format in which you want the object saved, in this case, as a report (*.rpt).

.


Save As Template

Use this command on the Report : File menu to save the active report as a template. Saving a file as a template does not preserve the data in the objects; only the format of the report and the placeholders will be saved.

File name:  Enter the name of the file you want the template saved to.  Note that only templates with the .tpl (template) extension will be displayed in the list box.

If you omit the "." and the extension .tpl,  Report Generator will automatically assign the extension that identifies the current format. If you type the ".", but omit the extension, Report Generator will save the file without an extension.

Double-clicking on a file name displayed in the folder listing under the File name box will save the object to that file  (i.e., you are requesting that the file be overwritten).  Any time you save an object to an existing file, Report Generator will request confirmation.

Note: Only templates with the .tpl extension will be listed  in the File : New dialog to be used as a basis for new reports. It is therefore recommended that you supply only the new template name, and the the Report Generator manage your templates.


Print

Use this command on the Report : File menu to print one or more copies of the active template or report to the selected output device.

(Printer) Name:   This area indicates which printer has been selected.

Properties:   Click this button to access the setup panel for the printer you have selected.  Report Generator will present a setup panel for your particular printer (this is similar to the panel you would see if you were setting up your printer from the Windows Control Panel).  Change your printer's setup to suit your needs, then click its OK button to return to Report Generator's Print dialog box.

Print range: Indicates the range of pages to be printed.

Copies:   Enter the number of printed copies you want.  If your printer supports multiple copy printing and its buffer is large enough to contain the entire object, the additional copies will be created by the printer; otherwise, Report Generator will copy the object to the device multiple times.

OK: Click the OK button when the print settings are satisfactory.  The Report Generator dialog box appears and displays the filename of the print job and its status.

Cancel:   Click the Cancel button when printing is complete or if you decide not to print.  If you click Cancel during print processing (while the progress indicator shows the job is incomplete), Report Generator may print all, none, or a portion of your object..


Print Preview

Use this command on the Report : File menu to see what your report will look like before you print it. Each of the buttons along the top bar lets you see a different aspect of your report:

Print: Click this button to print the report as it is

Next Page: Click this button to see subsequent pages of your report.

Previous Page: Click this button to see the preceding pages of your report.

Two Pages: Click this button to see a facing-pages view of the report.

Zoom In: Click this button to see an enlarged view of one item on your report.

Zoom Out:  Click this button to see a reduced view of one item on your report.

Close: Click this button to leave the Print Preview and return to the Report Generator.


Print Setup

Select this command to access the setup panel for the printer you have selected.  Report Generator will present the standard setup panel for your particular printer (this is the same panel you would receive if you were setting up your printer from the Windows Control Panel).  Change your printer's setup to suit your needs, then click its OK button to return to Report Generator's Print dialog box.


Exit

Use this command on the Report Generator : File menu to close the active report and close the Report Generator window.

The options on the Report window's Edit menu are used to perform operations that affect individual objects or placeholders within a report. This menu lets you cut, copy, and paste objects or placeholders. You can also add or delete new objects.

To select an object for an Edit menu operation, click on it with your left mouse button.  To clear (deselect) an object from the group, simply click anywhere outside the object.


Cut

Use this command to place the selected object on the Windows Clipboard.  The object is removed from the current document, and placed on the Clipboard so you can paste it into an application of your choice.


Copy

Use this command to copy the selected object to the Windows Clipboard.  The object will not be modified or removed.  The copy will be placed on the Clipboard so you can paste it into an application of your choice.


Paste

Use this command to paste the cut or copied object in place on your report.


Paste Special

Paste Special: Select the Paste Special... command to insert other OLE objects from the clipboard into your report. Clicking on this command displays the following dialog

Source: Indicates the origin of this object, if known.

As: Allows you to select the format of the object (bitmap, Windows metafile, TIFF file, etc.)

Paste:  Click this button to insert the selected object into your report.

Paste Link: Click this button to insert a link to another OLE object.

Display as Icon: Check this box to display the object or link as an icon.

OK: Click this button to insert the object and return to the Report Generator.

Cancel: Click this button to abandon the Paste Special operation and return to the Report Generator.

Help: Click this button to access the online Help files for this function.


Paste Link

Use this command to insert a link to another object or report.


Select All

Use this command on the Report : Edit menu to select (tag)  all objects in the report.  An object can be deselected by clicking it with the left mouse button while holding down the <Ctrl> key.


Delete

Use this command on the Report : Edit menu to remove the selected object from the report.


Delete All

Use this command on the Report : Edit menu to clear all the objects from the report.


Delete Page

Use this command on the Report : Edit menu to remove the current page from the report.


Change Icon

Use this command on the Report : Edit menu to replace the default placeholder in the template with a different placeholder.

Current: Displays the placeholder for the selected object currently in use.

Default: Displays the default placeholder for the selected object.

From File: Displays the location of the icon/placeholder files.

OK: Click this button to insert the new icon/placeholder and return to the Report Generator.

Cancel: Click this button to abandon the Change Icon operation and return to the Report Generator.

Browse: Click this button to search the available icon/placeholder files.

Help: Click this button to access the online Help files for this function.


Links

This command updates the linked objects.


Insert New Object

Use this command to add a new type of object to your template. You will see one of the two following dialogs:

Create New: Clicking this button inserts a new object of the type selected from the list into your template.

Object Type: Provides a list of all the types of objects supported by other applications installed on your system. Use your cursor to highlight the type of object that you wish to create.

Create from File: Clicking this button inserts an object from the selected file into your template.

File: Identifies the different files available.

Link: Checking this box creates a link between the object file and the report where it will appear. Otherwise, the new object will be inserted into the report.

OK: Click this button to insert the new object and return to the Report Generator.

Cancel: Click this button to abandon the Insert Object operation and return to the Report Generator.

Browse: Click this button to search the available object files.

Help: Click this button to access the online Help files for this function.

Display As Icon: Checking this box creates will display the selected object as an icon or placeholder.


Object

Use this command to modify the selected object. Clicking on this command, while you have an object selected, displays the following options:

Edit: Choosing this option allows you to edit the selected object without exiting the Report Generator.

Open: Choosing this option opens the selected object, such as an MS Word document, without exiting the Report Generator

Convert : Choosing this option allows you to change the selected object to another type. You will have following choices.

Convert to: Select a format to display your object from the Object Type list. The Results box will indicate how the action will affect your object.

Activate as: Select a format to use when opening your object from the the Object Type list. The Results box will indicate how the action will affect your object.

Display As Icon: Checking this box creates will display the selected object as an icon or placeholder.


Properties

Use this command to display information about the current report. You may enter the following:

Title: Indicate the title of your report in this field.

Author: Enter your name (or another author's name) in this field.

Description: Enter a description of your report in this field.

Use  the Report Generator's Insert menu to add objects to your report. Each object is may be displayed as either  a placeholder or icon. Placeholders will show the actual data they contain when they are inserted if the data is available from Image-Pro.  Placeholder data can be updated at any time using the Layout : Update Data menu selection, or the tool bar icon. Placeholders will also automatically display the data available from Image-Pro whenever a new report is created from a template with placeholders, when a report is opened, and any empty placeholders are updated with data.

The first three objects: page, line, and text, are always available since they are built-in objects supported by the Report Generator. The remaining objects are supported by Image-Pro Plus or one of its plug-in modules; if Image-Pro or the plug-in isn't open, these objects will not be available. Only the three Report Generator objects will be found on the Insert menu


Page

Use the Page command to add a new page to your report. Clicking on this command allows you to select Before Current or After Current. Indicate if you would like your new page inserted before or after the page currently displayed in your workspace.


Line

Use the Line command to add a straight line to your report.


Text

Use the Text command to add a  text box to your report. When you choose this command, Report Generator will displays an empty text box.  You must insert text into the box at this time, or the empty box will be removed from your report.


Image

Use this command to add an image placeholder to your report. This command is available when Image-Pro is open, but will disabled if no images are open.


Image with Overlay

Use this command to print an image with an overlaid objects from Image-Pro in your report. These objects include pseudo-coloring, manual measurements, and the count/size overlays. This command is available when Image-Pro is open, but will be disabled if no images are open.


Count/Size

Use this command to add information from Count/Size operations in your report. You can include the following objects:

•	Measurement Histogram

•	Scattergram Chart

•	Statistics Table

•	Classification Table

•	Population Density Table.

The individual items in this list will be disabled until the related objects are opened in Image-Pro's Counts/Size feature.


Histogram

 Use this command to add a histogram to your report. This selection is available only if a Histogram is open in Image-Pro.


Line Profile

 Use this command to add a line profile your report. This selection is available only if a Line Profile is open in Image-Pro.


Output Text

Use this command to insert text from the Macro Output Window to your report.  This selection is available only if the Macro Output Window  is open in Image-Pro

Use  the Report Generator's Layout menu to reposition or modify the objects in your report. Each object is displayed as a placeholder when the corresponding Image-Pro data is not yet available. Objects will show the actual data when they are:

•	Inserted into a report

•	Present as placeholders in a report that you open

•	Present in a template used as the basis for your report with the
File : New command.

•	Updated by the user

and the corresponding data are available in Image-Pro.


Update Data

This command updates data in all the  placeholders.


Update Selected Data

This command updates data in the selected  placeholders


Reset Size

Use this command return to the selected object to its original size.


Resize Placeholders

Use this command if you are updating your data, and the new data is larger or smaller than the current placeholder(s). Resize Placeholders changes the size of your placeholders to hold the new data.


Show Placeholders

Use this command to display placeholders without data in them.  If your system is slow, or has memory problems, you may want to use this option, especially when moving placeholders around in your report.


Show Data

Use this command to display objects with their active data. This command reverses Show Placeholders


Move to Front

Use this command move the selected object in front of all other objects in the report.


Move to Back

Use this command move the selected object behind all of the other objects in the report.

Use  the Report Generator's View menu to show or hide different features of the Report Generator Window.


Gridlines

Choose the Gridlines command to show or hide the gridlines in the Report Generator workspace. Note that the gridlines do not print on your report.


Show Frame

Use the Show Frame command to display or hide a defining frame around the selected object.


Change Text

Use the Change Text command to edit the selected text in your report  (see the Insert Text command).


Change Font

Use the Change Font command to modify the text used in your report (see the Insert Text command).


Toolbar

Use this command to show or hide the Report Generator toolbar at the top of the Window.


Status Bar

Use this command to show or hide the Report Generator status bar at the bottom of the Window.


Zoom

•	Use the Zoom command to increase or decrease the size of your report as it is displayed on the screen. The Zoom menu has fixed ratios of 25% to 400% of the original, as well as a "fit to screen" option. This option will adjust the zoom ratio so that the entire page of the report is displayed in the current report window.

Use  the Report Generator's Window menu to arrange and reposition the Report Generator windows.


New Window

Choose the New Window command to add an additional window to your desktop.


Cascade

Use the Cascade Images command to arrange your open report windows so that they are roughly equally-sized and layered, leaving only their title bar and left border visible.


Tile

Use the Tile command to arrange your open report windows so that all windows are visible and roughly equally sized across the screen.


Arrange Icon

Use this command to move the icons around within the Report Generator window.


1 Report

Displays the names of any open reports. The name of the current report will be displayed with a checkmark ( · ) next to it.


Index

Use the Index command to access the table of contents for the Report Generator on-line help facility.


Using Help

Use the Using Help command to learn how to use the Report Generator's online  help facility.  It describes the organization of the help system and the commands you can use to locate information within it.

The help system is a standard Windows help system.

As you are viewing topics you can jump to a cross reference, denoted with an underscore, by clicking on the underscored word or phrase.  You can also pop-up a definition, denoted with a dotted underscore, by clicking on the underscored term.

The Using Help command retrieves Windows Using Help topic panels from your Windows directory.


About Report Generator

Use the About Report Generator... command to access the About information box.  The About dialog box contains important version and release date information, as well as pertinent copyright information.

If you need to contact our Technical Support Center, you will need to provide the version information supplied by this box.

  When you right-click anywhere in an open report, you will see a context menu displaying options for editing the selected object.


Report Context Menu

When you right-click in a report, outside of any object, you will see the Report context menu. This menu contains two commands: Edit Properties and Zoom.

Edit Properties: Choosing this command enables you to edit the report properties. Please see the Properties command on the Edit menu for more information.

Zoom: Choosing this command lets you adjust the size of your report as it is displayed in the Report Generator window. Please see the Zoom command on the View menu for more information.


Line Context Menu

When you right-click on a line,  you will see the Line context menu. This menu contains the following commands:

•	Cut

•	Copy

•	Delete.

These commands allow you to cut or copy the selected line object to the clipboard, or delete it from the report. Please see the Cut, Copy, and Delete commands on the Edit menu for more information.


Text Context Menu

When you right-click on a text object,  you will see the Text context menu. This menu contains the following commands:

•	Cut

•	Copy

•	Delete

•	Change Text

•	Change Font

•	Transparent.

The first three commands allow you to cut or copy the selected text object to the clipboard, or delete it from the report. Please see the Cut, Copy, and Delete commands on the Edit menu for more information. The next three commands allow you to change the attributes of the text object:

Change Text:  Selecting the Change Text command allows you to edit the selected text. Please see the Change Text command on the View menu for more information.

Change Font:   Selecting the Change Font command allows you to use a different font to display the selected text. Please see the Change Font command on the View menu for more information.

Transparent: Use this command to determine whether or not the text object will have a transparent background or not. An opaque white background is especially useful when using text to annotate an image or object


Object or OLE Object Context Menus

When you right-click on an object or placeholder,  you will see the Object context menu. This menu contains the following commands:

•	Cut

•	Copy

•	Delete

•	Rename

•	Update Data

•	Reset Size

•	Convert Picture Object

•	Package Object

The first three commands allow you to cut or copy the selected object (picture, line profile graph, histogram, etc.)  to the clipboard, or delete it from the report. Please see the Cut, Copy, and Delete commands on the Edit menu for more information.

Rename: Selecting this command allows you to assign a new name to the selected object. This command is only available if the selected object is an Image-Pro object.

Update Data: Selecting this command allows you to update the information in the selected object. This command is only available if the selected object is an Image-Pro object.

Reset Size: Selecting this command allows you to return the selected object to its original size. This command is only available if the selected object is an Image-Pro object.

Convert Picture Object: Selecting this command allows you to change the format of the selected object.  Please see the Object command on the Edit menu for more information. This command is only available if the selected object is an OLE object.

Package Object: Selecting this command allows you to use the Microsoft Object Packager to modify the format and display of an OLE object. Clicking on this command displays the following options:

Activate Contents: Choosing this option allows you to run the contents of the OLE object without leaving the Report Generator.

Edit Package: Choosing this option allows you to edit the contents of the OLE object using the Microsoft Object Packager  without leaving the Report Generator.

Convert Object: Selecting this command allows you to change the format of the selected object. Please see the Object command on the Edit menu for more information.

This section describes the Auto-Pro macro language functions that have been included with the Report Generator.  It describes those new functions that are specific to the Report Generator.  If you have any further questions about the Auto-Pro macro language functions, please refer to the Auto-Pro Reference Guide.

The following new commands have been created to work specifically with the Report Generator Module:

•	IpRptClose

•	IpRptNew

•	IpRptOpen

•	IpRptPrint

•	IpRptSave

•	IpRptShow

Each of these functions is described in the following pages:


 IpRptClose

Syntax	IpRptClose ()
Description	This function closes the open report.
Return Value	1 if successful, 0 if failed.
See Also	IpRptNew, IpRptOpen, IpRptShow, IpRptSave, IpRptPrint


 IpRptNew

Syntax	IpRptNew(szFileName)
Description	This function will create a new report based on the specified template.
Parameters	szFileName	String	Name of the new report or template
Return Value	1 if successful, 0 if failed.
Comments	This command launches the report generator, if necessary. If  FileName specifies a template file (*.tpl) a new report (*.rpt) is opened from that template, and any placeholders are automatically filled with current data. If FileName specifies a report (*.rpt), that report is opened and any empty placeholders are automatically  updated with current data. Failure will be reported if specified file cannot be opened.
Example	ret = IpRptNew("C:\IPWIN3\Template\Sample.tpl")
See Also	IpRptClose, IpRptShow, IpRptOpen, ,IpRptSave, IpRptPrint,


 IpRptOpen

Syntax	IpRptOpen(szFileName)
Description	This function opens the specified template or report.
Parameters	szFileName	String	Name of the report to open
Example	ret = IpRptOpen("C:\IPWIN3\Template\TEST1.tpl")
Return Value	1 if successful, 0 if failed.
Comments	This command launches the report generator, if necessary. If  FileName specifies a template file (*.tpl) a new report (*.rpt) is opened from that template, and any placeholders are automatically filled with current data. If FileName specifies a report (*.rpt), that report is opened and any empty placeholders are automatically filled with current data. Note that objects containing saved data will not be updated. Failure will be reported if specified file cannot be opened.
See Also	IpRptShow, IpRptOpen, IpRptClose, IpRptSave, IpRptPrint


 IpRptPrint

Syntax	IpRptPrint ()
Description	This function prints the current report to the default printer.
Return Value	1 if successful, 0 if failed.
See Also	IpRptNew, IpRptOpen, IpRptShow, IpRptSave, IpRptClose


 IpRptSave

Syntax	IpRptSave (szFileName)
Description	This function saves the current report.
Parameters	szFileName	String	Name of the report to be saved.
Return Value	1 if successful, 0 if failed.
Comments	The current document is saved as a report, including all current data (if any).
See Also	IpRptNew, IpRptOpen, IpRptShow, IpRptClose, IpRptPrint


 IpRptShow

Syntax	IpRptShow ()
Description	This function  launches the report generator and/or brings the report generator to the top.
Return Value	1 if successful, 0 if failed.
See Also	IpRptNew, IpRptOpen, IpRptClose, IpRptSave, IpRptPrint