Std DlgMacroRecord: Difference between revisions

From FreeCAD Documentation
No edit summary
(Usage)
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<languages/>
<languages/>

{{Page in progress}}

<translate>
<translate>


<!--T:17-->
{{Docnav
{{Docnav
|
|
|[[Std_DlgMacroExecute|DlgMacroExecute]]
|[[Std_MacroStopRecord|Std MacroStopRecord]]
|[[Std_Macro_Menu|Std Macro Menu]]
|[[Std_Macro_Menu|Std Macro Menu]]
|
|
|IconR=Std_MacroStopRecord.svg
|IconR=Std_DlgMacroExecute.svg
|IconC=Freecad.svg
|IconC=Freecad.svg
}}
}}
Line 25: Line 23:


<!--T:3-->
<!--T:3-->
The '''Std DlgMacroRecord''' command starts a [[Macros|macro]] recording session during which user actions are stored in a FreeCAD macro file, a file with the {{FileName|.FCMacro}} extension. Such a file can later be replayed, executed, to repeat the recorded actions.
The '''Std DlgMacroRecord''' command starts a [[Macros|macro]] recording session during which user actions are stored in a FreeCAD macro, a file with the {{FileName|.FCMacro}} extension. A macro can later be replayed, executed, to repeat the recorded actions.


</translate>
</translate>
[[Image:Std_DlgMacroRecord_dialog.png]]
[[Image:Std_DlgMacroRecord_dialog.png]]
<translate>
<translate>
<!--T:18-->
{{Caption|The Macro recording dialog box}}
{{Caption|The Macro recording dialog box}}


Line 43: Line 42:
# The {{Button|Stop}} button does not work at this time.
# The {{Button|Stop}} button does not work at this time.
# Press the {{Button|Record}} button to close the dialog box and start the recording session.
# Press the {{Button|Record}} button to close the dialog box and start the recording session.
# The button image of the command changes to {{Button|[[Image:Std_MacroStopRecord.svg|16px]]}} and the menu text changes to {{MenuCommand|Stop macro recording}}.
# Perform the actions you want to record.
# Perform the actions you want to record.
# To end the recording session do one of the following:
# To end the recording session do one of the following:
#* Press the {{Button|[[Image:Std_MacroStopRecord.svg|16px]] [[Std_MacroStopRecord|Std MacroStopRecord]]}} button.
#* Press the {{Button|[[Image:Std_MacroStopRecord.svg|16px]] [[Std_DlgMacroRecord|Std DlgMacroRecord]]}} button.
#* Select the {{MenuCommand|Macro → [[Image:Std_MacroStopRecord.svg|16px]] Stop macro recording}} option from the menu.
#* Select the {{MenuCommand|Macro → [[Image:Std_MacroStopRecord.svg|16px]] Stop macro recording}} option from the menu.


==Options==
==Options== <!--T:19-->


<!--T:20-->
* When the Macro recording dialog box is displayed: press {{KEY|Esc}} or the {{Button|Cancel}} button to abort the command.
* When the Macro recording dialog box is displayed: press {{KEY|Esc}} or the {{Button|Close}} button to abort the command.


==Notes==
==Notes== <!--T:21-->


<!--T:22-->
* To execute the recorded macro use the [[Std_DlgMacroExecute|Std DlgMacroExecute]] command.
* To execute the recorded macro use the [[Std_DlgMacroExecute|Std DlgMacroExecute]] command.
* For more information see the [[Macros]] page.
* To learn more about macros see the [[Macros]] page.

==Preferences== <!--T:23-->


<!--T:24-->
==Preferences==
* The macro path can also be changed in the preferences: {{MenuCommand|Edit → Preferences... → Python → Macro → Macro path}}. See [[Preferences_Editor#Macro|Preferences Editor]].
* In most cases it is undesirable to record actions that do not change the model: under {{MenuCommand|Edit → Preferences... → Python → Macro → GUI commands}} do one of the following:
** To exclude these actions uncheck the {{CheckBox|FALSE|Record GUI commands}} checkbox.
** To include them as comments only check both the {{CheckBox|TRUE|Record GUI commands}} and {{CheckBox|TRUE|Record as comment}} checkboxes.


* The macro path can also be changed in the preferences: {{MenuCommand|Edit → Preferences... → General → Macro → Macro path}}. See [[Preferences_Editor#Macro|Preferences Editor]].


<!--T:25-->
{{Docnav
{{Docnav
|
|
|[[Std_DlgMacroExecute|DlgMacroExecute]]
|[[Std_MacroStopRecord|Std MacroStopRecord]]
|[[Std_Macro_Menu|Std Macro Menu]]
|[[Std_Macro_Menu|Std Macro Menu]]
|
|
|IconR=Std_MacroStopRecord.svg
|IconR=Std_DlgMacroExecute.svg
|IconC=Freecad.svg
|IconC=Freecad.svg
}}
}}
Line 73: Line 81:
{{Std Base navi{{#translation:}}}}
{{Std Base navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Latest revision as of 08:11, 10 October 2023

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.

The Macro recording dialog box

Usage

  1. There are several ways to invoke the command:
    • Press the Std DlgMacroRecord button.
    • Select the Macro → 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. The button image of the command changes to and the menu text changes to Stop macro recording.
  8. Perform the actions you want to record.
  9. To end the recording session do one of the following:
    • Press the Std DlgMacroRecord button.
    • Select the Macro → Stop macro recording option from the menu.

Options

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

Notes

Preferences

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