_IJ_ProcessCurrentImage, _IJ_Settings, _ManageSharedMacros, _RecordMacro, _RunMacro, _RunMacroOnEvents, _RunMacroOnFileList, _RunMacroOnFilesInFolder, _RunMacroOnND, _RunMacroOnOpenedDocuments, _StartSearchMenu, AbortMacro, AssignMacro, BackupMacroPanel, BrowseMacro, Command, CommandHistory, ECMAScript, EditMacro, ExecuteAddon, GA3_ImportResults, GA3_ImportResultsEx, GA3_RecipeFromUndoSteps, GA3_RunAnalysis, GA3_RunAnalysisEx, GA3_SettingsClose, GA3_SettingsOpen, GA3_SettingsSave, GA3_SettingsSetParamNumber, GA3_SettingsSetParamText, Get_RunningMacroDir, GetHistory, History, IJ_Execute, IJ_FileOpen, IJ_FileSaveCurrent, IJ_SaveSettings, LoadMacro, MacroPreferences, NewMacro, OpenMacro, Paste_Command, PauseMacro, QML_ClearComponentCache, RecordMacro, RepeatLast, RestoreMacroPanel, RunCurrentMacro, RunMacro, RunMacroOnEvent, RunMacroOnFileList, RunMacroOnFilesInFolder, RunMacroOnND, RunMacroOnOpenedDocuments, SaveAsMacro, SaveCurrrentMacroAsShared, SaveMacroAsShared
This function runs the Macro > Abort Macro command.
Description
AbortMacro();
This function interrupts running macro.
Description
AssignMacro( char *MacroFileName, intHotKey, intStartUp);
This function gives preferences to macro.
Parameters
See Also
RunMacro
Description
BackupMacroPanel(
char *Filename
);Backs up the macro panel into a .xml file.
See Also
This function runs the Macro > Browse command.
Description
BrowseMacro();
This function displays the Browse Macro dialog box.
This function runs the Macro > Command command.
Description
Command();
This function displays the Execute Command dialog box.
See Also
History
This function runs the Macro > Command History command.
Description
CommandHistory();
This function opens Command History control window.
Description
ECMAScript(
char *script
);This function allows to enter macros using the ECMAScript (JavaScript).
This function runs the Macro > Edit 
command.
Description
EditMacro();
This function displays Edit macro dialog box with the current macro.
See Also
AssignMacro
Description
GA3_ImportResults( char *GA3Name, char *GA3FileName, char *Hdf5ResultFilename, char *Hdf5ResultLocation);
Imports the GA3 run into Analysis results list under an existing General Analysis 3 recipe. If there is no such recipe it creates an empty artificial one.
Description
GA3_ImportResultsEx( char *GA3RecipeFilename, char *GA3FileName, char *Hdf5ResultFilename, char *Hdf5ResultLocation);
Imports the General Analysis 3 recipe and a run into the Analysis results list.
Description
GA3_RecipeFromUndoSteps();
Creates an analysis recipe from the current document undo steps.
Description
GA3_RunAnalysis( char *GA3Name, char *GA3FileName);
Executes the General Analysis 3.
Description
GA3_RunAnalysisEx( char *GA3Name, char *GA3FileName, intIgnoreErrorMessage);
Executes the General Analysis 3 and turns the error messages on/off.
Parameters
Description
GA3_SettingsClose(
int GA3H
);Closes the General Analysis 3 specified by handle h.
This function is part of macro functions changing the parameters of General Analysis 3.
Following example shows its typical application:
int h = 0;
char error[260];
h = GA3_SettingsOpen(type, name, error);
if (h)
{
GA3_SettingsSetParamText(h, paramname, strValue);
GA3_SettingsSetParamNumber(h, paramname, dblValue);
GA3_SettingsSave(h, name);
GA3_SettingsClose(h);
}See Also
GA3_SettingsSave, GA3_SettingsSetParamNumber, GA3_SettingsSetParamText, GA3_SettingsOpen
Description
GA3_SettingsOpen( intGA3Type, char *GA3Name, char *GA3Error);
This function returns handle h to General Analysis 3 specified by its name. It also gives error messages.
Parameters
This function is part of macro functions changing the parameters of General Analysis 3.
Following example shows its typical application:
int h = 0;
char error[260];
h = GA3_SettingsOpen(type, name, error);
if (h)
{
GA3_SettingsSetParamText(h, paramname, strValue);
GA3_SettingsSetParamNumber(h, paramname, dblValue);
GA3_SettingsSave(h, name);
GA3_SettingsClose(h);
}See Also
GA3_SettingsClose, GA3_SettingsSave, GA3_SettingsSetParamNumber, GA3_SettingsSetParamText
Description
GA3_SettingsSave( intGA3H, char *GA3Name);
Saves changed General Analysis 3 (specified by handle h) in the given saving name. If parameter saving name is empty, the analysis is overwritten.
This function is part of macro functions changing the parameters of General Analysis 3.
Following example shows its typical application:
int h = 0;
char error[260];
h = GA3_SettingsOpen(type, name, error);
if (h)
{
GA3_SettingsSetParamText(h, paramname, strValue);
GA3_SettingsSetParamNumber(h, paramname, dblValue);
GA3_SettingsSave(h, name);
GA3_SettingsClose(h);
}See Also
GA3_SettingsClose, GA3_SettingsSetParamNumber, GA3_SettingsSetParamText, GA3_SettingsOpen
Description
GA3_SettingsSetParamNumber( intGA3H, char *GA3Name, doubleGA3DblValue);
Macro function which changes the number parameter (double or int) of the given name (contained in General Analysis 3 specified by handle h) to dblValue. In case of parameter stringlist it changes the index of the current member. In case of parameter range it sets its low limit.
Parameters
This function is part of macro functions changing the parameters of General Analysis 3.
Following example shows its typical application:
int h = 0;
char error[260];
h = GA3_SettingsOpen(type, name, error);
if (h)
{
GA3_SettingsSetParamText(h, paramname, strValue);
GA3_SettingsSetParamNumber(h, paramname, dblValue);
GA3_SettingsSave(h, name);
GA3_SettingsClose(h);
}See Also
GA3_SettingsClose, GA3_SettingsSave, GA3_SettingsSetParamText, GA3_SettingsOpen
Description
GA3_SettingsSetParamText( intGA3H, char *GA3Name, char *GA3StrValue);
Changes the text parameter of the given name (contained in General Analysis 3 specified by handle h) to the string value. In case of parameter stringlist it changes text of the current stringlist member.
Parameters
This function is part of macro functions changing the parameters of General Analysis 3.
Following example shows its typical application:
int h = 0;
char error[260];
h = GA3_SettingsOpen(type, name, error);
if (h)
{
GA3_SettingsSetParamText(h, paramname, strValue);
GA3_SettingsSetParamNumber(h, paramname, dblValue);
GA3_SettingsSave(h, name);
GA3_SettingsClose(h);
}See Also
GA3_SettingsClose, GA3_SettingsSave, GA3_SettingsSetParamNumber, GA3_SettingsOpen
Description
Get_RunningMacroDir(
char *Name
);This function gets the running macro directory.
Note
If there are more running macros than the last called macro directory is returned. This function is designed specially for setup macros.
See Also
RunMacro
Description
History();
This function displays the Command History dialog box.
See Also
Command, GetHistory
Description
IJ_Execute(
char *ImageJMacro
);Executes the ImageJ macro. Parameters for the macro run and path to the exe file are taken from the Settings dialog (Process Current Image window).
Description
IJ_FileOpen(
char *ImageJOutputFilename
);Opens the file specified by the folder (set as Output in the Settings dialog - Process Current Image window) and filename (defined by the ImageJOutputFilename parameter).
Description
IJ_FileSaveCurrent(
char *ImageJIntputFilename
);On the current image opened in NIS-Elements calls Save As into a folder (set as Intput in the Settings dialog - Process Current Image window) and filename (defined by the ImageJIntputFilename parameter).
Description
IJ_SaveSettings( char *ImageJExecutable, char *ImageJParameters, char *ImageJInput, char *ImageJOutput);
Saves the ImageJ parameter values.
This function runs the Macro > Untitled 
command.
Description
LoadMacro(
char *ActiveMacro
);This function loads specified macro file.
See Also
OpenMacro, RunMacro, RecordMacro
This function runs the Macro > Options 
command.
Description
MacroPreferences();
This function displays the Macro Preferences dialog box.
See Also
AssignMacro, SetDrive
This function runs the Macro > New command.
Description
NewMacro();
This function displays the New Macro dialog box.
See Also
RecordMacro, OpenMacro, RunMacro
This function runs the Macro > Open command.
Description
OpenMacro();
This function displays the Open Macro dialog box.
See Also
AssignMacro, NewMacro, RunMacro, EditMacro, RecordMacro, SaveAsMacro
Description
Paste_Command( char *Command, char *Button, intMode);
Shows window for selecting the command and its parameters.
Parameters
This function runs the Macro > Pause Macro command.
Description
PauseMacro(
char *TextInCaption
);This function temporally stops processing macro commands. Macro will continue processing when clicking on Resume menu item.
Parameters
See Also
AssignMacro
Description
QML_ClearComponentCache();
For QML code developers. This function clears cache of the QML engine so that the QML code can be reloaded without restarting the software. Just close the QML GUI, run this function and display the GUI again.
Interactive command to this function: Macro > Record
Description
RecordMacro();
This function starts recording commands to macro.
See Also
AssignMacro, NewMacro, RunMacro, EditMacro, OpenMacro, SaveAsMacro
This function runs the Macro > Repeat Last command.
Description
RepeatLast();
This function executes the most recent command.
Description
RestoreMacroPanel(
char *Filename
);Restores the macro panel using a previously backed up .xml file.
See Also
This function runs the Macro > Run 
command.
Description
RunCurrentMacro();
This function runs the current macro.
See Also
RunMacro
This function runs the Image > Batch GA3 command.
Interactive command to this function: Macro > Run Macro From File
Description
RunMacro(
char *MacroFileName
);This function executes the MacroFileName macro.
Parameters
See Also
AssignMacro, NewMacro, RecordMacro, EditMacro, OpenMacro, SaveAsMacro
Description
RunMacroOnEvent( intEventIndex, char *EventCommand);
This function assigns a macro function to an application event. When the event occurs, the assigned macro will run automatically.
Parameters
Interactive command to this function: Macro > Run on File List
Description
RunMacroOnFileList( char *EventCommand, char *FileList, intSaveModified, intCloseModified, char *Dest_Directory, intNDDimension);
This function is used to create a list of images and process them with a macro.
Parameters
EventCommand The macro command which will be executed on each file. If blank, the current macro is used.
SaveModified Specifies whether to save an opened document when it has been modified.
Asks whether to save changes or not. Ask before overwriting. | |
Changes are saved automatically. Overwrite existing file. | |
Changes are not saved. Always discard the image. Do not save (handled in macro). | |
Save into different folder. | |
Cancels the operation. |
CloseModified Specifies whether the image is closed or remains open in the application window during a macro execution.
NDDimension Frame selection of the ND document.
Runs a macro/command on a file. | |
Runs a macro and moves the frame in the time dimension until the end of the sequence. | |
Runs a macro and moves the frame in the multi-point dimension until the end of the sequence. | |
Runs a macro and moves the frame in the Z dimension until the end of the sequence. | |
Runs a macro and moves the frame in all dimensions until the end of the sequence. | |
Runs a macro and moves the frame in the selected frames until the end of the sequence. Selection - the frames/dimensions selected by mouse within the ND control bar will be affected. |
Note
Value combination is also possible (e.g.: M+T=3, Z+T=5, M+Z=6).
See Also
_RunMacroOnFileList
Interactive command to this function: Macro > Run on Files in Folder
Description
RunMacroOnFilesInFolder( intNDDimension, char *EventCommand, char *Directory, intSaveModified, intCloseModified, char *Dest_Directory, intIncludeSubfolders);
This function executes macro on specified files in a folder.
Parameters
NDDimension Frame selection of the ND document.
Runs a macro/command on a file. | |
Runs a macro and moves the frame in the time dimension until the end of the sequence. | |
Runs a macro and moves the frame in the multi-point dimension until the end of the sequence. | |
Runs a macro and moves the frame in the Z dimension until the end of the sequence. | |
Runs a macro and moves the frame in all dimensions until the end of the sequence. | |
Runs a macro and moves the frame in the selected frames until the end of the sequence. Selection - the frames/dimensions selected by mouse within the ND control bar will be affected. |
Note
Value combination is also possible (e.g.: M+T=3, Z+T=5, M+Z=6).
EventCommand The macro command which will be executed on each file. If blank, the current macro is used.
SaveModified Specifies whether to save an opened document when it has been modified.
Asks whether to save changes or not. Ask before overwriting. | |
Changes are saved automatically. Overwrite existing file. | |
Changes are not saved. Always discard the image. Do not save (handled in macro). | |
Save into different folder. | |
Cancels the operation. |
See Also
_RunMacroOnFilesInFolder
Interactive command to this function: Macro > Run on ND
Description
RunMacroOnND( intNDDimension, char *EventCommand);
This function executes a macro on a ND image.
Parameters
NDDimension Frame selection of the ND document.
Current frame | |
Time dimension | |
Multipoint dimension | |
Z dimension | |
All frames (the whole ND document). | |
Selection - the frames/dimensions selected by mouse within the ND control bar will be affected. |
Note
Value combination is also possible (e.g.: M+T=3, Z+T=5, M+Z=6).
Interactive command to this function: Macro > Run on Opened Documents
Description
RunMacroOnOpenedDocuments( intNDDimension, char *EventCommand);
This function executes a macro on all opened documents.
Parameters
NDDimension Frame selection of the ND document.
Current frame | |
Time dimension | |
Multipoint dimension | |
Z dimension | |
All frames (the whole ND document). | |
Selection - the frames/dimensions selected by mouse within the ND control bar will be affected. |
Note
Value combination is also possible (e.g.: M+T=3, Z+T=5, M+Z=6).
This function runs the Macro > Save As command.
Description
SaveAsMacro();
This function saves macro as a new file.
See Also
AssignMacro, NewMacro, RecordMacro, EditMacro, OpenMacro, RunMacro
Description
SaveCurrrentMacroAsShared(
char *SharedMacro
);This function saves and sets current macro as shared.
Description
SaveMacroAsShared( char *SharedMacro, char *MacroFileName);
This function saves and sets selected macro as shared.
This function runs the Applications > ImageJ Bridge > Process Current Image command.
Description
_IJ_ProcessCurrentImage();
Opens the Process Current Image dialog window used for defining the ImageJ executable file, parameters, macros and the input and output files.
This function runs the Applications > ImageJ Bridge > Settings command.
Description
_IJ_Settings();
Opens the Settings dialog window used for defining ImageJ software path, parameters and the input and output folder.
This function runs the Macro > Manage Shared Macros command.
Description
_ManageSharedMacros();
Opens the Shared Macros Manager dialog window used for sharing and managing macros.
This function runs the Macro > Record command.
Description
_RecordMacro();
This function starts recording of all subsequent commands into current working macro.
See Also
RecordMacro
This function runs the Macro > Run Macro From File command.
Description
_RunMacro();
This function displays the Run Macro dialog box.
See Also
RunMacro
This function runs the Macro > Run Macro on Events command.
Description
_RunMacroOnEvents();
This function runs the Macro > Run on File List command.
Description
_RunMacroOnFileList();
This function opens the Run Macro on File List dialog window.
See Also
RunMacroOnFileList
This function runs the Macro > Run on Files in Folder command.
Description
_RunMacroOnFilesInFolder();
This function opens the Run Macro on Files in Folders dialog window. You can select which macro to execute, specify the selected folder and set how to treat the modified documents - whether to save and/or close them.
See Also
RunMacroOnFilesInFolder
This function runs the Macro > Run on ND command.
Description
_RunMacroOnND();
This function displays the Macro Run on ND Image dialog box. You can select which macro to execute.
This function runs the Macro > Run on Opened Documents command.
Description
_RunMacroOnOpenedDocuments();
This function opens the Run Macro on Opened Documents dialog window. You can select which macro to execute.