Click or drag to resize

BatchMacro Class

Batch processes a group of files or documents using selected macros.
Inheritance Hierarchy
SystemObject
  MediaCy.IQL.ApplicationMcCommand
    MediaCy.IQL.ApplicationMcCommandExtended
      MediaCy.CommandsBaseCommand
        MediaCy.CommandsOneInputCommandIList
          MediaCy.Addins.ScriptingBatchMacro

Namespace:  MediaCy.Addins.Scripting
Assembly:  MediaCy.Addins.Scripting (in MediaCy.Addins.Scripting.dll) Version: 3.1.0.0
Syntax
VB
Public Class BatchMacro
	Inherits OneInputCommand(Of IList)

The BatchMacro type exposes the following members.

Constructors
  NameDescription
Public methodBatchMacro
Initializes a new instance of the BatchMacro class
Public methodBatchMacro(McCommand)
Initializes a new instance of the BatchMacro class
Top
Properties
  NameDescription
Public propertyAfterMacroFile
Designates the module file of the macro to run after looping on all documents.
Public propertyAfterMacroName
Designates the name of the macro to run after looping on all documents.
Public propertyBeforeMacroFile
Designates the module file of the macro to run before looping on all documents.
Public propertyBeforeMacroName
Designates the name of the macro to run before looping on all documents.
Public propertyCloseDocuments
Whether or not to close the processed documents.
Public propertyDisplayDocuments
Whether or not to display the documents to process.
Public propertyDocumentFormats
A semi colon separated list of the document formats to process designated by their extension.
Public propertyFolderToProcess
Designates the folder containing all the files to process.
Public propertyGroupPattern
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.
Public propertyGroupSortingOrder
Defines the type of group sorting.
Public propertyLoopMacroFile
Designates the module file of the macro to run for each document.
Public propertyLoopMacroName
Designates the name of the macro to run for each document.
Public propertyMonitorFolders
When True, folders passed as input keep being monitored for new files until the command is canceled.
Public propertyProcessByLocation
Process image sets location by location, looping on all locations except for channels which are handled together.
Public propertyProcessSubfolders
Whether or not to process subfolders of FolderToProcess.
Public propertySaveModifiedDocuments
Whether or not to automatically save the documents when they are modified.
Public propertySortingOrder
Defines the type of global sorting.
Public propertySortPattern
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 .
Top
Methods
  NameDescription
Public methodApplyAttributes (Overrides McCommandExtended.ApplyAttributes.)
Public methodOnAfterInteraction (Overrides McCommand.OnAfterInteraction.)
Top
Remarks