IOutputLocation
The IOutputLocation interface is used to control the folder that houses the output files as well as output file names.
Properties
Used to generate output file name. It is both readable and writable.
The following macros may be used:
The following macros may be used:
Macro | Description | Example Value |
---|---|---|
&[DocName(0)] | Document Name | My Document |
&[DocName(1)] | Uppercase Document Name | MY DOCUMENT |
&[DocName(2)] | Lowercase Document Name | my document |
&[Page(0)] | Page Number | 3 |
&[Page(2)] . . . &[Page(6)] | Page number of between 2 and 6 digits | 05 000005 |
&[ImageType] | Standard extension for selected output file format | 2pdf |
&[ColorDepth] | Numeric value for the bit depth of the resulting image | 24 |
&[Year(0)] | Current 4-digit year | 2009 |
&[Year(1)] | Current 2-digit year | 09 |
&[Month(0)] | Current month as text | February |
&[Month(1)] | Current month as 2-digit number | 02 |
&[Month(2)] | Current month as Roman numerals | II |
&[MonthDay(0)] | Current date | 3 |
&[MonthDay(1)] | Current 2-digit date | 03 |
&[WeekDay(0)] | Current day of week as text | Tuesday |
&[WeekDay(1)] | Current day of week as number | 3 |
&[WeekDay(2)] | Current day of week as 2-digit number | 03 |
&[Date(0)] | Current full date | Tuesday, February 03, 2009 |
&[Date(1)] | Current full date as dd.mm.yyyy | 03.02.2009 |
&[Date(2)] | Current complete date as dd.mm.yy | 03.02.09 |
&[Hour(0)] | Current hour in 24-hour format | 21 |
&[Hour(1)] | Current hour in 12-hour format | 09 |
&[Hour(2)] | am or pm | am |
&[Min(0)] | Current minutes | 31 |
&[Sec(0)] | Current seconds | 38 |
&[Time(0)] | Current time in hh-mm-ss format | 09-31-38 |
&[Time(1)] | Current time in hh-mm (24-Hour) format | 21-31 |
&[Time(2)] | Current time in hh-mm (12-Hour) format | 09-31 |
String FolderPath
Defines the folder that output files will be saved in. The output folder may be specified as a static string and as a macro that will automatically be replaced with an actual value at runtime. Only available if the Mode property is set to OL_PREDEFINED. It is both readable and writable.
Macro | Description | Example Value |
---|---|---|
&[Desktop] | Current user’s desktop | C:\Documents and Settings\User\Desktop |
&[Documents] | Current user’s "My Documents" folder | C:\My Documents |
&[Pictures] | Current user’s "My Pictures" folder | C:\My Documents\My Pictures |
Enum Mode
Defines the way the software generates output filenames and the names of folders where files will be saved. It is both readable and writable.
Constant | Value | Description |
---|---|---|
LM_PROMPT | 0 | A standard Windows dialog is displayed prompting for filename and folder when a file is created |
LM_PREDEFINED | 1 | Filenames and target folders are generated automatically based on the values of the FileName and FolderPath properties |
Boolean OverwriteExistingFile
Determines whether the software will overwrite an existing file with the same name as a file that is being created. This property is ignored if the Multipage property of the corresponding format interface is set to MM_APPEND. It is both readable and writable.
Value | Description |
---|---|
TRUE | Program will automatically overwrite existing files of same name when saving output files. |
FALSE | If a file of the same name is found when an output file is being saved, a screen prompt will be displayed requesting instructions. |
Examples
Visual Basic 6
Dim objUDC As IUDC Dim itfPrinter As IUDCPrinter Dim itfProfile As IProfile Set objUDC = New UDC.APIWrapper Set itfPrinter = objUDC.Printers("Universal Document Converter") Set itfProfile = itfPrinter.Profile itfProfile.OutputLocation.Mode = LM_PREDEFINED itfProfile.OutputLocation.FolderPath = "C:\Out" itfProfile.OutputLocation.FileName = "&[Date(1)]-&[DocName(0)].&[ImageType]" itfProfile.OutputLocation.OverwriteExistingFile = False