Scripting API

<<BarrelCorrection Main Index BatchProcessV2>>
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

BatchProcess

Script Name: BatchProcess
Name: BatchProcess
Library: CmdFile
Description: Allows the user to select a group of files and process them.
Status bar text: Converts a group of selected files
Tool tip text: Batch Process
 
Parameter Repository:
NameScript NameType Description Supports None Default Minimum Maximum
FileListFileListListList of files to processNo0
RenameFormatRenameFormatStringString describing how to rename files.No
ProcessScriptProcessScriptStringThe script to executeNo
EncodingEncodingParameter RepositoryFile format encoding optionsYes
OutputTypeOutputTypeStringThe type to save the files to. Such as 'JPG'.No
OutputDirOutputDirStringThe path to write the new files toNo
StopOnErrorStopOnErrorEnumeration (Boolean)Stop processing when an error is encounterNoTrue
SilentModeSilentModeEnumeration (Boolean)Run the script silentlyNoTrue
InputDirInputDirStringThe directory to initilaize the file dialog withNo
InputFilterInputFilterEnumeration (FileFormat)The selected input filterNoUnknown
LogDirLogDirStringThe directory for log filesNo
PluginFormat IdxPluginFormatIntegerPlug in file format typeNo0032766
Fav Path ListFavFileListListThe list of paths to show in favoritesNo0
Fav Path ListScriptFavFileListListThe list of paths to show in favoritesNo0
BatchModeBatchModeEnumeration (BatchMode)Save mode for batch processingNoNewType
Show ProgressShowProgressEnumeration (Boolean)Always display progress dialogNoFalse
ConvertFormatConvertFormatEnumeration (Boolean)Run the script in convert format modeNoFalse
General SettingsGeneralSettingsParameter RepositoryContains parameters that control the execution of the command.No
 
Command Attributes:
IsExternal: true
NoDocumentNeeded: true
NoProtectedMode: true
NoModeToggle: true
 
Resource Attributes:
DlgHasPresets: true
DlgHasRandomize: true