Description
Modifies the file save options on the IPNSession object.
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 file name creator options in a conversion profile.
Syntax
expression.SetSaveOptions(OutputLocation, OutputBaseFileName, OutputFileFormat,
Append, ColorReduction, Dithering,
PromptForOutputLocationAndBaseFileName,
OverwriteActionWhenSaving, RemoveExt, RemoveProdName)
where expression is an IPNSession object.
Parameters
String OutputLocation
Pass the fully qualified path to the directory for storing the output your files. Pass this string as empty to use any OutputLocation setting from the conversion profile. If no location is set in the profile, the last used folder is used as the default directory when running in an interactive process on the desktop and prompting is enabled. When prompting is disabled or there is no last used folder, the My Documents folder is used. When running non-interactively, such as in the Task Scheduler or a Windows service, the My Documents folder for the running process is always used if this string is empty.
String OutputBaseFileName
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 PromptForOutputLocationAndBaseFileName
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.
pnOverwriteActionWhenSaving OverwriteActionWhenSaving
A pnOverwriteActionWhenSaving constant to determine the action to take in overwrite situations where a file of the same name already exists for the file you are creating.
Boolean RemoveExt
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 (" - ").
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 SetProperty