|
These settings are only applied when SetV11CompatibilityModeEnabled is set to true. |
Description
Sets any naming profile formatting for the desired file naming profile from the IPNSession object.
There are four different naming profiles to customize:
•Multipaged
•Multipaged with JobID
•Serialized
•Serialized with JobID
Which naming profile is used depends on your current settings for the SetSaveOptions method. It is the combination of the output file type (one of pnOutputFileFormat) together with the UseJobID setting passed to the SetSaveOptions method that determines which naming profile is used to build the filename.
For example:
•Creating multipaged TIFF images (pnOutputFileFormatTIFFMultipaged) with UseJobID set to FALSE will use the Multipaged naming profile.
•Creating serialized PDF files (pnOutputFileFormatAdobePDFSerialized) with UseJobID set to TRUE will use the Serialized with JobID naming profile.
•Creating JPEG images (pnOutputFileFormatJPEG) with UseJobID set to FALSE will use the Serialized naming profile.
Each naming profile has it's own settings that allow you to customize how the output files are named. See the Advanced File Naming section in the User Guide for the printer you are using for more information on using and customizing the naming profiles.
To set a single file naming format option use the SetProperty call with the appropriate arguments. See the Remarks below for a list of arguments.
For a more detailed explanation of the naming profiles and how to customize them, see the User Guide for the PEERNET Inc. printer being used.
Syntax
expression.SetNamingProfileFormat(NamingProfile, FormatString, Variables, UseDefaultExt)
where expression is an IPNSession object.
Parameters
pnNamingProfile NamingProfile
A pnNamingProfile constant for the file naming profile for which to set the formatting options.
String FormatString
A specially formatted string that combines with the Variables string to build the filename. It is built using regular text and place holders for string (%s) and numeric (%d) variables supplied by the printer. To pad numeric values with zeroes, place a number between the % and the "d" (%4d).
String Variables
Semi-colon (;) or comma (,) delimited list of variables that correspond to the placeholders (%s, %d) in FormatString. See Remarks below for a list of variables.
Boolean UseDefaultExt
Pass True if you want to save the output files using the default extension for that file type. This will be different depending on which PEERNET Inc. printer you are using. If False, no extension will be present unless you specify one as part of the format string.
Remarks
Use the following to set these options using SetProperty:
Method Parameter |
SetProperty Parameters |
||||||
|---|---|---|---|---|---|---|---|
NamingProfile |
Each naming profile format is set individually. There is a different set of property names for each naming profile. •M = pnNamingProfileMultipage •MJ = pnNamingProfileMultipageWithJobID •S = pnNamingProfileSerialized •SJ = pnNamingProfileSerializedWithJobID |
||||||
FormatString |
|
||||||
Variables |
|
||||||
UseDefaultEcxt |
|
The following variables can be used to build custom filenames:
Variable |
Type |
Format String Place Holder |
|---|---|---|
$(Day) |
Numeric |
%d |
$(DocumentPageNumber) |
Numeric |
%d |
$(FileExtension) |
String |
%s |
$(FileNumber) |
Numeric |
%d |
$(FilePageNumber) |
Numeric |
%d |
$(Hour) |
Numeric |
%d |
$(JobID) |
Numeric |
%d |
$(JobStatus) |
Numeric |
%d |
$(MachineName) |
String |
%s |
$(Minute) |
Numeric |
%d |
$(Month) |
Numeric |
%d |
$(OutputFileName) |
String |
%s |
$(Second) |
Numeric |
%d |
$(UserName) |
String |
%s |
$(Year) |
Numeric |
%d |
Supported Printers: TIFF Image Printer, PDF Image Printer, Raster Image Printer
See Also: SetSaveOptions SetV11SaveOptions ClearNamingProfileFormat ClearV11SaveOptions SetProperty pnNamingProfile pnOutputFileFormat
