Std DlgMacroRecord

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

Std DlgMacroRecord.svg Std DlgMacroRecord

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


Description

The Std DlgMacroRecord command starts a macro recording session during which user actions are stored in a FreeCAD macro, a file with the .FCMacro extension. A macro can later be replayed, executed, to repeat the recorded actions.

Std DlgMacroRecord dialog.png

The Macro recording dialog box


Usage

  1. There are several ways to invoke the command:
    • Press the Std DlgMacroRecord.svg Std DlgMacroRecord button.
    • Select the Macro → Std DlgMacroRecord.svg Macro recording... option from the menu.
  2. The Macro recording dialog box opens.
  3. Enter a name for the macro in the Macro name input box.
  4. Optionally change the Macro path by pressing the ... button.
  5. The Stop button does not work at this time.
  6. Press the Record button to close the dialog box and start the recording session.
  7. Perform the actions you want to record.
  8. To end the recording session do one of the following:
    • Press the Std MacroStopRecord.svg Std MacroStopRecord button.
    • Select the Macro → Std MacroStopRecord.svg Stop macro recording option from the menu.

Options

  • When the Macro recording dialog box is displayed: press Esc or the Cancel button to abort the command.

Notes

Preferences

  • The macro path can also be changed in the preferences: Edit → Preferences... → General → Macro → Macro path. See Preferences Editor.
  • In most cases it is undesirable to record actions that do not change the model: under Edit → Preferences... → General → Macro → GUI commands do one of the following:
    • To exclude these actions uncheck the CheckBoxFalse.svg Record GUI commands checkbox.
    • To include them as comments only check both the CheckBoxTrue.svg Record GUI commands and CheckBoxTrue.svg Record as comment checkboxes.