BatchMacro Properties |
|
The BatchMacro type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AfterMacroFile |
Designates the module file of the macro to run after looping on all documents.
|
| AfterMacroName |
Designates the name of the macro to run after looping on all documents.
|
| BeforeMacroFile |
Designates the module file of the macro to run before looping on all documents.
|
| BeforeMacroName |
Designates the name of the macro to run before looping on all documents.
|
| CloseDocuments |
Whether or not to close the processed documents.
|
| DisplayDocuments |
Whether or not to display the documents to process.
|
| DocumentFormats |
A semi colon separated list of the document formats to process designated by their extension.
|
| FolderToProcess |
Designates the folder containing all the files to process.
|
| GroupPattern |
Identifies the part of the filenames that will be used for grouping.
When non empty, it defines the pattern used to identify each group
according to the regex syntax as implemented by Microsoft.
See http://msdn.microsoft.com/en-us/library/az24scfc.aspx. The part
of the name is identified by a regex group, for example "(\d+)"
would produce the groups: (AnImgDapi001.tif, AnImgFitc001.tif), (AnImgDapi002.tif, AnImgFitc002.tif) .
The single number special case defines the number of objects to put
in each group.
|
| GroupSortingOrder |
Defines the type of group sorting.
|
| LoopMacroFile |
Designates the module file of the macro to run for each document.
|
| LoopMacroName |
Designates the name of the macro to run for each document.
|
| MonitorFolders |
When True, folders passed as input keep being monitored for new files until the command is canceled.
|
| ProcessByLocation |
Process image sets location by location, looping on all locations except for channels which are handled together.
|
| ProcessSubfolders |
Whether or not to process subfolders of FolderToProcess.
|
| SaveModifiedDocuments |
Whether or not to automatically save the documents when they are modified.
|
| SortingOrder |
Defines the type of global sorting.
|
| SortPattern |
Identifies the part of the filenames that will be used for sorting.
If this property is empty, then the full name is used for sorting,
otherwise the syntax is the regex syntax as implemented by Microsoft.
See http://msdn.microsoft.com/en-us/library/az24scfc.aspx. The part
of the name is identified by a regex group, for example "(\d+)" would
identify the numeric end of the following strings: AnImgDapi001.tif,
AnImgFitc001.tif, AnImgDapi002.tif, AnImgFitc002.tif .
|
See Also