Other

_IJ_ProcessCurrentImage, _IJ_Settings, _ManageSharedMacros, _RecordMacro, _RunMacro, _RunMacroOnEvents, _StartSearchMenu, AbortMacro, AssignMacro, BackupMacroPanel, BrowseMacro, Command, CommandHistory, ECMAScript, EditMacro, ExecuteAddon, 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, SaveAsMacro, SaveCurrrentMacroAsShared, SaveMacroAsShared

AbortMacro

This function runs the Macro > Abort Macro command.

Description

 AbortMacro();

This function interrupts running macro.

AssignMacro

Description

 AssignMacro(
   char *MacroFileName,
   int  HotKey,
   int  StartUp
);

This function gives preferences to macro.

Parameters

char *MacroFileName

Name of the macro file including file path. E.g. “C:\macros\mymacro.mac”

int HotKey

< CTRL+F1-F9 > short cut key is used for executing macro. Values ranging from 1 to 5.

int StartUp

A macro with StartUp flag is executed at the application launch.

See Also
RunMacro

BackupMacroPanel

Description

 BackupMacroPanel(
   char *Filename
);

Backs up the macro panel into a .xml file.

Parameters

char *Filename

Full path to the XML file. E.g. “C:\backup\backup1.xml”

See Also

RestoreMacroPanel

BrowseMacro

This function runs the Macro > Browse command.

Description

 BrowseMacro();

This function displays the Browse Macro dialog box.

Command

This function runs the Macro > Command command.

Description

 Command();

This function displays the Execute Command dialog box.

See Also
History

CommandHistory

This function runs the Macro > Command History command.

Description

 CommandHistory();

This function opens Command History control window.

ECMAScript

Description

 ECMAScript(
   char *script
);

This function allows to enter macros using the ECMAScript (JavaScript).

Parameters

char *script

ECMAScript (JavaScript) text code.

EditMacro

This function runs the Macro > Edit command.

Description

 EditMacro();

This function displays Edit macro dialog box with the current macro.

See Also
AssignMacro

ExecuteAddon

Description

 ExecuteAddon(
   char *Addon
);

This function is for internal purposes only.

Parameters

char *Addon

For internal purposes only.

GetHistory

Description

 GetHistory(
   char *Buffer,
   int  Count
);

Returns the command history.

Parameters

char *Buffer

Address of the buffer.

int Count

Number of iterations.

Get_RunningMacroDir

Description

 Get_RunningMacroDir(
   char *Name
);

This function gets the running macro directory.

Parameters

char *Name

The path to the 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

History

Description

 History();

This function displays the Command History dialog box.

See Also
Command, GetHistory

IJ_Execute

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).

Parameters

char *ImageJMacro

ImageJ macro.

IJ_FileOpen

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).

Parameters

char *ImageJOutputFilename

ImageJ processing output file name.

IJ_FileSaveCurrent

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).

Parameters

char *ImageJIntputFilename

ImageJ processing input file name.

IJ_SaveSettings

Description

 IJ_SaveSettings(
   char *ImageJExecutable,
   char *ImageJParameters,
   char *ImageJInput,
   char *ImageJOutput
);

Saves the ImageJ parameter values.

Parameters

char *ImageJExecutable

Path to the ImageJ executable file.

char *ImageJParameters

Parameters before executing the macro.

char *ImageJInput

Folder for ImageJ input files.

char *ImageJOutput

Flder for ImageJ output files.

LoadMacro

This function runs the Macro > Untitled command.

Description

 LoadMacro(
   char *ActiveMacro
);

This function loads specified macro file.

Parameters

char *ActiveMacro

Name of the macro file including its path.

See Also
OpenMacro, RunMacro, RecordMacro

MacroPreferences

This function runs the Macro > Options command.

Description

 MacroPreferences();

This function displays the Macro Preferences dialog box.

See Also
AssignMacro, SetDrive

NewMacro

This function runs the Macro > New command.

Description

 NewMacro();

This function displays the New Macro dialog box.

See Also
RecordMacro, OpenMacro, RunMacro

OpenMacro

This function runs the Macro > Open command.

Description

 OpenMacro();

This function displays the Open Macro dialog box.

Paste_Command

Description

 Paste_Command(
   char *Command,
   char *Button,
   int  Mode
);

Shows window for selecting the command and its parameters.

Parameters

char *Command

Command to select, can include parameters (e.g. “ImageOpen”).

char *Button

Text to show on the first button in the window.

int Mode

Determines what to do when user presses the first button.

1, PASTE_COMMAND_COPY	Copies the resulting command to clipboard.
2, PASTE_COMMAND_EXECUTE	Executes the resulting command.
4, PASTE_COMMAND_REWRITE	The resulting command is written back into the Command parameter.

Return Values

Returns 0 if user cancelled the window, otherwise it returns 1.

PauseMacro

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

char *TextInCaption

This text appears in the caption followed by image, macro and objective information. Also Resume item is added to the right edge of the main menu bar.

See Also
AssignMacro

QML_ClearComponentCache

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.

RecordMacro

Interactive command to this function: Macro > Record

Description

 RecordMacro();

This function starts recording commands to macro.

RepeatLast

This function runs the Macro > Repeat Last command.

Description

 RepeatLast();

This function executes the most recent command.

RestoreMacroPanel

Description

 RestoreMacroPanel(
   char *Filename
);

Restores the macro panel using a previously backed up .xml file.

Parameters

char *Filename

Full path to the XML file. E.g. “C:\backup\backup1.xml”

See Also

BackupMacroPanel

RunCurrentMacro

This function runs the Macro > Run command.

Description

 RunCurrentMacro();

This function runs the current macro.

See Also
RunMacro

RunMacro

Interactive command to this function: Macro > Run From

Description

 RunMacro(
   char *MacroFileName
);

This function executes the MacroFileName macro.

Parameters

char *MacroFileName

Name of the macro file including file path. E.g. “C:\macros\mymacro.mac”

RunMacroOnEvent

Description

 RunMacroOnEvent(
   int  EventIndex,
   char *EventCommand
);

This function assigns a macro function to an application event. When the event occurs, the assigned macro will run automatically.

Parameters

int EventIndex

Index of the event.

0	Open an image
1	Capture an image - before
2	Capture an image - after
3	Live - before the first frame
4	Save - before
5	RAM capture - before
6	Select optical configuration
7	Application startup
8	Application finish
9	ND experiment finish

char *EventCommand

The macro command to be performed on the selected event. If left blank, no command will be performed when the selected event occurs.

SaveAsMacro

This function runs the Macro > Save As command.

Description

 SaveAsMacro();

This function saves macro as a new file.

SaveCurrrentMacroAsShared

Description

 SaveCurrrentMacroAsShared(
   char *SharedMacro
);

This function saves and sets current macro as shared.

Parameters

char *SharedMacro

Name and location of the shared macro.

SaveMacroAsShared

Description

 SaveMacroAsShared(
   char *SharedMacro,
   char *MacroFileName
);

This function saves and sets selected macro as shared.

Parameters

char *SharedMacro

Name and location of the shared macro.

char *MacroFileName

Name of the macro file including file path. E.g. “C:\macros\mymacro.mac”

_IJ_ProcessCurrentImage

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.

_IJ_Settings

Description

 _IJ_Settings();

Opens the Settings dialog window used for defining ImageJ software path, parameters and the input and output folder.

_ManageSharedMacros

This function runs the Macro > Manage Shared Macros command.

Description

 _ManageSharedMacros();

Opens the Shared Macros Manager dialog window used for sharing and managing macros.

_RecordMacro

This function runs the Macro > Record command.

Description

 _RecordMacro();

This function starts recording of all subsequent commands into current working macro.

See Also
RecordMacro

_RunMacro

This function runs the Macro > Run From command.

Description

 _RunMacro();

This function displays the Run Macro dialog box.

See Also
RunMacro

_RunMacroOnEvents

This function runs the Macro > Run Macro on Events command.

Description

 _RunMacroOnEvents();

_StartSearchMenu

Description

 _StartSearchMenu();

Starts the Search edit box in the main toolbar.

Other🔗

Note

Other