Std DlgMacroRecord

From FreeCAD Documentation
Jump to navigation Jump to search
Other languages:
Deutsch • ‎English • ‎français • ‎italiano • ‎română • ‎русский

This documentation is not finished. Please help and contribute documentation.

Gui Command explains how tools should be documented. See Draft ShapeString for an example of a well documented tool. Browse Category:UnfinishedDocu to see incomplete pages like this one. See Category:Command Reference for all commands.

See WikiPages to learn about editing the wiki pages, and go to Help FreeCAD to learn about other ways in which you can contribute.

Std DlgMacroRecord.svg Std DlgMacroRecord

Menu location
Macro → Macro recording...
Default shortcut
Introduced in version
See also
Execute macro, Std Macro Menu


The Std DlgMacroRecord.svg Start Macro recording function initiates a recording session of a macro. This means it will record all operation the user makes in the 3D view. Once the user is finished with the sequence of action, the Std MacroStopRecord.svg Stop Macro Recording functions ends the macro recording session. This is a powerful technique to record repetitive sequences of actions (in to Python code that can be saved in a FreeCAD Macro file (.FCMacro)), that can be executed at a later time or even transferred to another computer running FreeCAD.


  1. The Macro Record function is accessible via several ways:
    • The Std DlgMacroRecord.svg Macro recording button in the macro toolbar Macros toolbar.jpg
    • The menu Macro → Macro recording,
  2. Result: A dialog box will appear querying the user for the following information
    Macro recording
    • Macro name: Enter the name of the new macro.
    • Macro path: Path macro library. To change the path, click ... .
    • Record: Record the macro (starts recording all actions in the 3D view).
    Note: The button Std MacroStopRecord.svg Stop macro recording session in the macros toolbar Macros toolbar.jpg will turn green Std MacroStopRecord.svg.
    • Stop: Stop recording the macro.
    • Cancel: Cancels and closes the window.
  3. Once completed, click Std MacroStopRecord.svg Stop the macro recording session to stop recording the macro.

Executing the Macro

  1. The macro can be executed several ways:
    • Through the Macro → Macros... menu
    • Pressing the Std DlgMacroExecuteDirect.svg Execute this macro button in the macro toolbar
  2. Choose the macro
  3. Press OK


  1. Press the [File:Std DlgMacroRecord.svg|16px]] button
  2. Enter a name for the macro and press OK
  3. Open a document
  4. Create an Part Box.svg Cube
  5. Change the color of the box
  6. Press on Std MacroStopRecord.svg to stop the macro recording

Result: The macro is available in your macros directory. Execute the macro to recreate the steps you just recorded.