The tables in this section contain information on custom object and embed tags, directives, and parameters that can be used as either object/embed tags or directives. Review the information within each table, and the sections on Creating HTML and Creating List Files before using tags or directives for Prizm Viewer customization. Examples of how to use the object/embed tag parameters and list file directives are located at the end of this section.

Custom Object/Embed Tag Parameters Table

Before coding custom configurations, you will want to review the information in at least two of the tables. The Custom Embed/Object Tag table below contains parameters that can be used to override the default actions of the Prizm Viewer. The table labeled Parameter-Directve contains tags that can be used as either object/embed tags or directives. All of the parameters in these tables are optional.

CAUTION

INITDISPLAY, ZOOMAREA, and ZOOMABSOLUTE are mutually exclusive parameters since each describes a different way of scaling and displaying the image. Do not use them together in the same <EMBED> or <OBJECT> statement.

Parameter Name	Parameter Value	Description
ebar	0 or 1	Specifies whether the embedded toolbar will be used instead of the default toolbar. Set ebar="1" to use the embedded toolbar. Set ebar="0" or omit the ebar attribute to use the default toolbar. Default: 0 (standard toolbar)
stext	"status text"	Specifies text that will be displayed in the browser’s status bar when the mouse is placed (or “hovers”) over the embedded image. Replace "status text" with the desired text. If the text you wish to display contains blank spaces you must place the text inside double quotes. Note that all HTML attribute values should be placed inside double quotes to maintain compliance with the HTML standard. The character limit is 64. If stext is not specified, the Prizm Viewer will default to a status bar that contains the name/version of the Viewer followed by the name of the image file and the page number if applicable. Default: Use the string from the standard Prizm Viewer.
zoomrect	left,top,right,bottom	Defines a rectangular area of the image that will be zoomed (as it best fits) to the defined window when the image is initially displayed. Left, top, right, and bottom are in pixel coordinates. Default: None
zoomarea	left,top,right,bottom	The same as zoomrect. Available for compatibility with other plug-ins.
zoomabsolute	zoom_value	Defines an absolute zoom amount to be applied to an image before display. If zoom_value is numeric, it is considered part of a rational number (zoom_value/1000). For example, a value of 2000 would indicate that the image should be zoomed twice as large (2000/1000). If zoom_value is a percentage, then it is treated as a percentage. For example, a value of 200% is the same as 2000 (twice as large). The zoom origin is the center of the image. Default: None
rotation	0, 90, 180, 270	Defines the number of degrees of clockwise rotation to be applied to the image on initial display. Valid values are rotation=0 (no rotation), rotation=90, rotation=180, or rotation=270. Default : 0
pagenum	page_number	Specifies the page within a multi-page image file that is to be displayed. Page numbering begins at 1. Default: 1
pictnum	page_number	Exactly the same as pagenum (just above). Available for compatibility with other plug-ins.
initdisplay	initial_display	Tells the Viewer how to initially display the image. Valid values are as follows: FULLIMAGE - Display the entire image in the window. FULLWIDTH - Display the image so that its width fits fully in the window. FULLHEIGHT - Display the image so that its height fits fully in the window. BESTFIT - Display the image as it best fits in the window. Default: FULLIMAGE.
viewimageitem	TRUE or FALSE	Tells the Viewer whether the "View this Image" menu item on the pop-up (right-click) menu should be available to the user. If it is set to FALSE, this menu item is unavailable (grayed out). Default: TRUE
bgcolor	#rrggbb	Sets the background color of the Prizm Viewer window. The background color will only be visible if the image is smaller than the embedded window. Valid values are any hexadecimal RGB value, the same as RGB values used in HTML pages. The default value is light gray (#C0C0C0). The following are examples of valid hexadecimal colors: bgcolor="#FFFFFF" (white) bgcolor="#C0C0C0" (light gray) bgcolor="#000000" (black) bgcolor="#000080" (dark purple) Default: None
print	TRUE or FALSE	Tells the Prizm Viewer to immediately print the image. The print dialog will immediately be displayed. The image will not be displayed. Default value: FALSE

Prizm Viewer Directives Table

Directives are special instructions that can be added to image list files. Directives always begin with a pound sign (#). Directives are active for any image references that sequentially follow them in a List File until a new directive replaces the current directive.

For a comprehensive listing of directives available in the Prizm Viewer, you will need to consult two tables. The following table contains valid Directives that can only be used within List Files. For additional items that can used as directives, see the table labeled Parameter-Directive Items listed in the Parameter-Directive table can be used as object/embed tags or directives.

Directive	Value	Description
#EndURL	URL	Specifies an HTML page to be loaded when printing has completed or is canceled. For Print (image/x-pzm) and Batch Download (image/x-list-export) list files.
#ExportName	filename	This is the name to be used when saving the file in the image reference that immediately follows the ExportName directive. The file is saved to the hard drive. The file name can have up to 128 characters. The file name specified cannot have any path information in it the hard drive. For Batch Download list files (image/x-list-export).
#FontSize=nn	nn	This directive defines the font size to be used when printing subsequent headers and footers. The default font size is 8 point. Valid values for the font size are 8, 9, 10, 12, 14, 16, 18 or 20. For Image (image/x-lst; image/x-list) and Print list files (image/x-pzm).
#Group		Designates the beginning of a group of files that must be downloaded as a group. If any file fails to download, no files are downloaded and an error message is issued; any files already downloaded are deleted. The Group directive applies to all image references that follow it. You can specify multiple groups in one list file. When the Viewer encounters a Group directive, it starts a new group that includes all image references until it reaches the end of the list file or encounters another Group directive. For Batch Download list files.
#n-up	command	This directive defines when the beginning and end of N-up printing should be. Valid commands are start and stop. If N-up printing is enabled, two A-size images will print on a single B-size sheet (11" x 17"). Four A-size images (as defined above) will print on a single C-size sheet (17" x 22"). Two B-size images will print on a single C-size sheet. By using start and stop commands, you can force the Prizm Viewer to print specific numbers of pages. Any orientation preferences will be ignored; the Viewer will orient the pages for best fit. Following is a list of ranges for image size: A-Size: 200-266 X 270-310 mm B-Size 270-310 X 410-440 mm C-Size 410-462 X 540-620 mm For Print list files.
#PageCNT	number of pages	Page numbering has been changed and this directive is no longer used.
#Page	page range	This directive allows you to specify a range of images within a multi-page image file to be part of a printable set of pages. Page range specifies the pages to be included in the printable pages. It can take one of these forms: "1", "1,2", "1-3", "1-3,5", "1,3,5" and so on. If this directive is used, all pages contained in the multi-page image file that are not specified in the directive are NOT considered part of the printable set. This directive is only applied to the next image in the list.

Prizm Viewer Parameter-Directive Table

The parameters in the following table can be used as either object/embed tags or directives. If you use the parameter as a directive, it must start with a pound sign (#). Depending on your project, you may need other Object/Embed tags (see the Custom Object/Embed Tag Parameters table) or Directives (see the Directives table).

Name	Values	Description
SaveAsFunction	true/false disable/enable disabled/enabled yes/no on/off 1/0	This tag enables or disables all Save As functionality as related to saving images. When disabled, related buttons and menus will still be displayed, but they will not be functional. In addition, when set to disabled, this menu item is also disabled: Save Image As-->Save Image Locally. The default is enabled.
SaveAnnSilent	true/false disable/enable disabled/enabled yes/no on/off 1/0	When enabled, this flag hides the dialogs that prompt to save annotations that have changed and changes are saved automatically. The "prompt to save" dialogs typically appear when an annotation is created or changed and then the Next/Previous page button (on the Prizm Viewer toolbar) or the Back button (on the browser toolbar) is pressed. The default is OFF.
ExportFunction	true/false disable/enable disabled/enabled yes/no on/off 1/0	This tag enables or disables all Export functionality. This includes related buttons, menus, and the menu item Save Image As-->Export Image. If this parameter is included in an object/embed tag or as a directive with no value or an unrecognized value, it will default to enabled (ON). NOTE: If both SaveAs and ExportFunction are set to disable, the Save Image As menu item is disabled.
ClipFunction	true/false disable/enable disabled/enabled yes/no on/off 1/0	This tag enables or disables all Copy-to-Clipboard functionality, including Copy Image and Copy Selection. The default is enabled or ON.
PrintFunction	true/false disable/enable disabled/enabled yes/no on/off 1/0	This tag disables all Print functionality, including related buttons and menus. This also includes the print functionality initiated by the browser, leaving white space where an image would have printed.
ViewAnnFunction	true/false disable/enable disabled/enabled yes/no on/off 1/0	This tag enables or disables all annotation viewing functionality. When disabled, annotations cannot be retrieved from the server or created. This sets the CreateAnnFunction=disable tag.
CreateAnnFunction	true/false disable/enable disabled/enabled yes/no on/off 1/0	This tag enables or disables all annotation creation functionality. When disabled, annotations will be retrieved from the server and can be viewed. If disabled, annotation tool buttons, annotation edit buttons, and Left Mouse Button menu items will be visible, but not available. In addition, this tag will enable or disable all Manage Annotation menu items except Hide annotations. The default is enabled.
OCRFunction	true/false disable/enable disabled/enabled yes/no on/off 1/0	If OCR functionality is available in the Prizm Viewer version being used, this tag will enable or disable it. If disabled, the Clean Image and OCR buttons, Clean Image and OCR to Clipboard menu items will not be functional. The default is enabled.
ImageInfoFunction	true/false disable/enable disabled/enabled yes/no on/off 1/0	This tag enables or disables the image information dialog. When disabled, related buttons and menu items will be shown, but be nonfunctional. The default is enabled.
MemCache	true/false disable/enable disabled/enabled yes/no on/off 1/0	When the value is set to true, all image data, annotation data, and temporary data will be stored in memory instead of in the local file system. In addition, SaveAs, Export, Print, and OCR functionality will be disabled due to memory limits and third-party OCR limitations. Files cached in memory will be purged if they are no longer referenced and the cache memory limit is exceeded. The default is disabled or OFF.
AnnCGI	`<<annot_server_app_location>` or <image_web_server <annotation_server_app_location>	This tag is used to add temporary default mappings for an annotation server application. The end user is not required to enter anything on the Preferences>Mapping tab. The contents of this tag will override all preference settings. The value of the AnnCGI tag/directive is a set of two values: the image web server the location and name of the annotation server application. For images stored on the image web server (specified in the first portion of the tag), the annotations server application (specified in the second portion of the tag) will be called when requesting or saving annotations. The format of the command is: `anncgi=<image_web_server<annot_server_app_location>` `[<image_web_server<annot_ server_app_location>...]` where `image_web_server` specifies a web server (host) containing images. The server name must be provided as a host name. For example, the host name of the image: `"http://www.myserver.com/images/image1.tif"` is `"www.myserver.com"`. The `annot_server_app_location` is a full or relative URL giving the location and name of the annotation server application. If the annotation server application is located at: `"http://www.myserver.com/scripts/annotserv.asp` then, you would want to enter that entire string as the `annot_server_app_location`, including the `"http"`. When using the AnnCGI tag/directive, the following rules apply: Only one annotation server application can be defined per web site. If multiple AnnCGI tags/directives are specified for the same web server, the last one encountered on the object/embed tag or in the list file will be used. The angle brackets are used as delimiters for AnnCGI. If you have a directory name that includes brackets, you must encode the brackets (i.e, %3C for "<" and %3E for ">"). If the annotation server application location is specified with a relative URL, the image_web_server (or host) will be used for the first portion of the URL. For example, if the AnnCGI tag/directive was set to "<http://www.myserver.com</scripts/annotserv.asp>" where image_web_server is "http://www.myserver.com" and annot_server_app_location is "/scripts/annotserv.asp", the Viewer will make requests to this application: "http://www.myserver.com/scripts/annotserv.asp". If image_web_server is left blank, it will default to the host name of the image. For example, if the AnnCGI tag/directive was set to "<</scripts/annserv.exe>" and the URL of the image for which annotations will be requested is: "http://www.test.com/images/image1.tif", the Viewer will make requests to this application: "http://www.test/com/scripts/annserv.exe" The preferences dialog will present a list containing only preferences that are set through the Preferences>Mapping tab. These mappings are stored in the registry. The servers specified in the AnnCGI tag will not be listed. When using AnnCGI as a list file directive, its position in the list file is important. Its position determines which images use that tag. Each AnnCGI directive will completely override all AnnCGI directives that appear above it. Setting the value of the AnnCGI directive to an empty string turns off the AnnCGI directive for the images following it. When this is the case, the user preferences will be used. Examples If the Prizm Viewer preferences contains a mapping entry with a site "Default" and mapping "/cgi-bin/imgannot.cgi", it is equivalent to "<</CGI-bin/imgannot.cgi>" in the value portion of the tag. If the preferences also contained a mapping entry with a site "http://sirusstar.pegasusimaging.com/" and a mapping "/CGI-bin/annserver.cgi", it is equivalent to "<</CGI-bin/imgannot.cgi><sirusstar.pegasusimaging.com><http://sirusstar.pegasusimaging.com/ CGI-bin/annserver.cgi>" in the value portion of the tag. The AnnCGI tag does not have a default value. The default mapping for the Viewer is "/CGI-bin/imganot.cgi" located on the server containing the image. Valid values for the image server are any properly formed host name or empty (<<...>) to override the default. The default uses the URL from the image for the image server host name. Valid values for the annotation CGI is any properly formed full URL; if the image server is empty, a relative URL may be used.
LocalCache	InternetCache[,partial_path], AppCache[,partial_path], or LocalCache, fully_qualified_path	The value of the LocalCache tag will be one of three strings: InternetCache AppCache LocalCache If InternetCache is specified, the cache location will be defined by the function call SHGetFolderPath(CSIDL_INTERNET_CACHE). If AppCache is specified, the cache location will be the Windows Temp folder. If LocalCache is specified, the cache location is undefined. InternetCache and AppCache may be followed by a comma and a partial path. If the LocalCache value is used, it must be followed by a full path, starting with either a drive letter or a UNC share. If the complete path does not exist, an attempt will be made to create it. If the complete path still doesn't exist, the internal default path will be used. The LocalCache tag does not have a default value. If this tag is not specified or it is not assigned a value, then the Windows Temp folder is used. Valid values are InternetCache[,partial_path], AppCache[,partial_path], or LocalCache, fully_qualified_path.
Security	0, 1, 2 or 3	Sets restrictions for the Viewer that override what can be set via preferences. Valid values are: 0 ( default; the Viewer will function normally) 1 (do not ask for annotations via the Internet; overrides any preference setting) 2 (do not ask for annotations via the Internet AND remove annotation buttons and menu items so the user has no access to them). 3 (use this setting to enable Internet Annotations - the Viewer will be able to request annotations from the Internet) Default: 0
Toolbar		This tag is used to define buttons for a custom toolbar. For more information, see the Toolbar Button Codes table.
PrintHeader1 PrintHeader2 PrintHeader3 PrintFooter1 PrintFooter2 PrintFooter3	header 1 string header 2 string header 3 string footer 1 string footer 2 string footer 3 string	These six directives let you specify up to three lines of text to be printed as either headers (at the top of printed pages) or footers (at the bottom of printed pages). The following is an example of a valid embed tag for an image that specifies a header and a footer: <embed src="http://myserver/mydirectory/myfile.tif" width="450" height="550" printheader1="This is a header" printfooter1="This is a footer"> For more information on Headers and Footers, see the sections below.
PDFResolution	Valid Values are between 72 and 600	This tag is used to define the resolution of PDF pages in the Viewer. Specify the desired resolution value in DPI

Headers and footers have the following characteristics:

Headers and footers are printed for both standard image files and image list files.
Headers and footers are printed by both the Viewer and the helper application.
When headers and/or footers are specified, the image is scaled to fit between the headers and footers. The amount of scaling applied depends on the number of headers and footers specified. The image will retain its aspect ration when scaled.
Headers can have 0, 1, 2 or 3 lines. The default is no headers (an empty string).
Footers can have 0, 1, 2, or 3 lines. The default is no footers (an empty string).
The top and bottom of the printed page are defined relative to the orientation of the image.

Headers and footers can also be set through the Preferences->Printing Tab.

For additional variables (%date, %time, %filename, etc.) that can be used as part of a header or footer string, review the information on the Preferences-> Printing Tab.

To see a list of directives that can be added to list files as global settings for printing, see Printing without Viewing.

When the text for headers and footers is specified or printed, the following rules apply:

PrintHeader1 is the first line at the top of the page above the image, printheader2 is the second line at the top of the page above the image, and printheader3 is the third line at the top of the page above the image.
PrintFooter1 is the first line below the image at the bottom of the page, printfooter2 is the second line below the image at the bottom of the page, and printfooter3 is the third line below the image at the bottom of the page.
Text strings may not exceed 255 characters in length. Any text beyond 255 characters is truncated.
Any text that is too long to appear on the page during printing will not wrap to the next line -- it will be truncated.
The fixed-pitch font, Courier, is used to print both headers an footers. The font cannot be changed.
The font size used to print headers and footers can be specified through the FontSize embed parameter (described below). The default font size is 8 point.
The text is printed so that the longest line of text is centered above/below the image. All other headers and footers begin printing at the same position as the longest line of text (lined up on the left side with the longest line of text).
Headers and footers are single spaced.
Headers and footers can be specified through embed tags, directives in List Files and through the printing preferences dialog. In the event that headers and/or footers are specified in more than one place, the Prizm Viewer uses this order of precedence: Image List File directives, embed tags, printer preferences.
If at least one header or footer is specified through either the embed tag or List File directives, the Prizm Viewer will not allow the user to override these headers or footers through the Viewer's preferences.

Embed tag example

<EMBED SRC="http://www.myserver.com/prizmpluginqa/images/1page.tif"
        HEIGHT="65%" WIDTH="95%" TYPE="image/TIF"
        SAVEASFUNCTION="disable"
        EXPORTFUNCTION="disable"
        ANNCGI="<www.myserver.com<http://www.myserver.com/CGI-bin/annserver.cgi><
        www.server2.com <https://www.server2.com/cgidir/annotcgi.exe>
       "LOCALCACHE="internetcache">

Object tag example

List File example

    #saveasfunction=disable
    #exportfunction=disable
    #anncgi=<www.myserver.com<http://www.myserver.com/cgi-
    bin/annserver.cgi><www.server2.com<https://www.server2.com/cgidir/annotcgi.exe>
    #memcache=true
    #localcache=localcache,c:\temp
    http://www.myserver.com/images/image.tif