|
When migrating to PNSrv12Lib from earlier versions, use SetV11CompatibilityModeEnabled and this method to minimize code changes. |
Description
Sets file save options on the IPNSession object that are compatible with previous versions of PNSrv12Lib. Use this method with SetV11CompatibilityModeEnabled set to true to migrate automation code from previous versions and minimize code changes.
To set a single save option use the SetProperty call with the appropriate arguments. See the Remarks below for a list of arguments.
For a more advanced file naming options, use the new file name creator options in a version 12 conversion profile
Syntax
expression.SetV11SaveOptions(Directory, BaseFileName, OutputFileFormat,
Append, ColorReduction, Dithering, UseJobID,
PromptForFileName,OverwriteAlways, RemoveExt,
RemoveProdName, DeleteAtEnd)
where expression is an IPNSession object.
Parameters
String Directory
Pass the fully qualified path to the directory for storing the output your files. If this string is empty, the Documents folder of the currently logged in user is used to store the files.
String BaseFileName
This is the base filename for your output file. The base filename excludes any directory path and file extension. If you want your output files to always be saved under the same filename, enter that name here.If this field is empty the print job name the printing application uses when submitting the file to the printer is used instead.
pnOutputFileFormat OutputFileFormat
A pnOutputFileFormat constant for the possible types of files that can be created with any of the supported printer drivers. Not all file formats are valid for all drivers.
Boolean Append
Set this to True to append, or concatenate, the pages to an existing output file or, if you are creating serialized files, an existing sequence of files.
pnColorReduction ColorReduction
A pnColorReduction constant for any color reduction options to apply to the output file. There are eight color reduction options available for reducing the number of colors in true color images. In general, the fewer the colors in an image, the smaller the file size.
pnDitheringMethod Dithering
A pnDitheringMethod constant to determine the method used when reducing color images to black and white. Dithering is used to enhance the appearance of color images that have been reduced to black and white.
Boolean UseJobID
A JobID is associated with every printer and is initially set to zero. It is automatically incremented by the printer at the start of every print job.The JobID is often used to ensure that all files created have unique names. It is also used to determine which naming profile to use.
Boolean PromptForFileName
Set to True to show the printer's Save Image dialog prompt, or False to hide the prompt and use the Directroy and BaseFilename settings to create the filename.
Boolean OverwriteAlways
Set to True to overwrite existing files without prompting, or False to be prompted to confirm the overwrite action or to provide a new filename.
Boolean bRemoveExt
Set to True to automatically remove any file extension passed to the printer as part of the filename.
Boolean RemoveProdName
Set to True to automatically remove any product names that are added to the printed filename by the printing application.Product names are any text that precedes the following characters: a space, a dash and a space (" - ").
Boolean DeleteAtEnd
Set to True to automatically delete all output files at the end of the print job, after any final Run command. This option is useful if you are want to send the output by email without leaving any local copies.
Remarks
Use the following to set these options using SetProperty:
Method Parameter |
SetProperty Parameters |
||||||
|---|---|---|---|---|---|---|---|
OutputLocation |
|
||||||
OutputBaseFileName |
|
||||||
OutputFileFormat |
|
||||||
Append |
|
||||||
ColorReduction |
|
||||||
Dithering |
|
||||||
PromptForOutputLocationAndBaseFileName |
|
||||||
OverwriteActionWhenSaving |
|
||||||
RemoveExt |
|
||||||
RemoveProdName |
|
Supported Printers: TIFF Image Printer, PDF Image Printer, Raster Image Printer
See Also: SetSaveOptionsOutputLocationAndOutputFileName SetSaveOptionsOutputResolution SetSaveOptions ClearV11SaveOptions SetProperty