ZEISS Microscopy Knowledge Base
Help
ZEISS Microscopy Knowledge Base

Macro Editor

The Macro Editor is an integrated development environment that enables you to create, edit, and run macros. The editor also contains debugging functionality such as debugging line-by-line or using breakpoints.

1

Menu bar
Here you have central menus, see Macro Editor Menus.

2

Tool bar
With the icons you can quickly access the most important functions, like saving or editing macros.

3

Button bar
Here you find the buttons to control macros, see Button Bar.

4

User Documents
Displays all macros and folders. You can create new or edit existing macros via a right-click context menu, see Macro List Context Menu.

5

Code Window
The central area of the macro editor shows the program code of the selected macro. Edit and write your macros in here. Type in the program code directly. Also a multi-document view is available, meaning that you can open several code windows at once. This central editor component supports syntax highlighting for Python, which is the language used for macros in the software.

6

Watch/Message Window
The Watch tab in the bottom area enables you to type the macro functions or variables you wish to observe while debugging a macro. Enter the variable directly in the column Name. You can also mark the variable in the macro and add it using Add Watch of the right-click context menu.
The Message window displays messages when using the print command in a macro.

Macro Editor Menus

File Menu

Menu item

Description

Short cut

New Macro

Opens the New Macro in the Macro programming area.

Import

Opens a file browser to select and import a macro.

Save

Saves the selected macro.

Ctrl+S

Save As…

Saves the macro under a new name.

Rename…

Opens the Rename dialog window. Enter a new name for the macro.

Delete

Deletes the selected macro.

Close

Closes the selected macro.

Edit Menu

Menu item

Description

Short cut

Cut

Cuts the selected line out of the macro.

Ctrl+X
Shift+Del

Copy

Copies the selected line in the macro.

Ctrl+C
Ctrl+Ins

Paste

Inserts the copied line into the macro.

Ctrl+V
Shift+Ins

Find

Finds the entered text.

Ctrl+F

Replace

Replaces the detected text with the new text..

Ctrl+H

Undo

Undoes the last action.

Ctrl+Z

Redo

Redoes the last action.

Ctrl+Y

Debug Menu

Menu item

Description

Short cut

Start Debugging

Starts the debugger and executes the macro up to a breakpoint or error.

F5

Start Without Debugging

Executes the macro up to a breakpoint or error without debugging.

Ctrl+F5

Pause

Pauses debugging.

Shift+F5

*Continue (DEBUG)

Continues debugging.

Shift+F5

Stop

Stops the running macro at the active command.

Shift+F5

Step Into

Starts the debugger stepwise, command by command, without stepping into function blocks.

F11

Step Over

Starts the debugger stepwise, command by command, and steps into function blocks.

F10

Step Out

Starts the debugger stepwise, command by command, and steps out of function blocks.

Shift+F11

Toggle Breakpoint

Sets/removes a breakpoint in the active line to stop/continue the macro in debug mode.

F9

Set Line To Execute

Sets the pointer in the next active command line.

F8

Reset

Resets all variables of the Python interpreter.

 

Help Menu

Menu item

Description

Short cut

Contents...

Opens the Online Help dialog.

Ctrl+F1

Macro Object Model…

Opens the Macro Object Model Online Help dialog. This documentation includes descriptions of all objects available for the macro editor.

Forum…

Opens the OAD forum in your web browser.
Internet access required.

GitHub

Opens the ZEISS GitHub page for OAD in your web browser.
Internet access required.

Button Bar

On this bar you find the buttons to record and control macros.

Parameter

Description

New

Creates a new empty macro.

Record

Starts macro recording.

Run

Executes the active macro completely.

Debug

Starts the debugger and executes the macro up to a breakpoint or error.

Step Over

Starts the debugger stepwise, command by command, without stepping into function blocks.

Step Into

Starts the debugger stepwise, command by command, and steps into function blocks.

Step Out

Starts the debugger stepwise, command by command, and steps out of function blocks.

Pause

Pauses macro recording.

Stop

Stops the running macro at the active command.

Reset

Resets all variables of the Python interpreter.

Breakpoint

Sets/removes a breakpoint in the active line, to stop/continue the macro in debug mode, in the active line.

Set Line

Sets the pointer in the next active command line.

Run to cursor

Sets the pointer to the current cursor position.

Macro List Context Menu

This context menu is displayed if you right-click a macro in the macro list.

Parameter

Description

New

Creates a new macro.

Save

Saves the current changes.

Save as

Saves the macro with a new name.

Rename

Allows renaming the macro.

Delete

Deletes the macro.

Impressum
Carl-Zeiss-Strasse 22
73447 Oberkochen
Germany
Legal