Std DlgMacroRecord

From FreeCAD Documentation
Revision as of 21:45, 12 February 2020 by Kunda1 (talk | contribs) (revert)

Std DlgMacroRecord

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

Description

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

Usage

  1. The Macro Record function is accessible via several ways:
    • The Macro recording button in the macro toolbar
    • 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 Stop macro recording session in the macros toolbar will turn green .
    • Stop: Stop recording the macro.
    • Cancel: Cancels and closes the window.
  3. Once completed, click 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 Execute this macro button in the macro toolbar
  2. Choose the macro
  3. Press OK

Example

  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 Cube
  5. Change the color of the box
  6. Press on to stop the macro recording

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