Std DlgMacroRecord: Difference between revisions

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

{{Page in progress}}

<translate>
<translate>


<!--T:17-->
{{Docnav
{{Docnav
|
|
|[[Std_MacroStopRecord|Std MacroStopRecord]]
|[[Std_MacroStopRecord|MacroStopRecord]]
|[[Std_Macro_Menu|Std Macro Menu]]
|[[Std_Macro_Menu|Std Macro Menu]]
|
|
Line 14: Line 12:
}}
}}


<!--T:1-->
{{GuiCommand
{{GuiCommand
|Name=Std DlgMacroRecord
|Name=Std DlgMacroRecord
Line 21: Line 20:
}}
}}


==Description==
==Description== <!--T:2-->


<!--T:3-->
The '''Std DlgMacroRecord''' command starts a [[Macros|macro]] recording session during which all user actions are stored in a FreeCAD macro file ({{FileName|.FCMacro}}). 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>
⚫
==Usage==
[[Image:Std_DlgMacroRecord_dialog.png]]
<translate>
<!--T:18-->
{{Caption|The Macro recording dialog box}}


⚫
==Usage== <!--T:5-->

<!--T:4-->
# There are several ways to invoke the command:
# There are several ways to invoke the command:
#* Press the {{Button|[[Image:Std_DlgMacroRecord.svg|16px]] [[Std_DlgMacroRecord|Std DlgMacroRecord]]}} button.
#* Press the {{Button|[[Image:Std_DlgMacroRecord.svg|16px]] [[Std_DlgMacroRecord|Std DlgMacroRecord]]}} button.
Line 33: Line 40:
# Enter a name for the macro in the '''Macro name''' input box.
# Enter a name for the macro in the '''Macro name''' input box.
# Optionally change the '''Macro path''' by pressing the {{Button|...}} button.
# Optionally change the '''Macro path''' by pressing the {{Button|...}} button.
⚫
# Optionally press the {{Button|Cancel}} button to abort the command.
# 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.
# 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_MacroStopRecord|Std MacroStopRecord]]}} 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== <!--T:19-->
⚫
==Notes==

⚫
* For more information see the [[Macros]] page.

⚫
==Preferences==


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


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


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


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


<!--T:24-->
* Todo.
* The macro path can also be changed in the preferences: {{MenuCommand|Edit → Preferences... → General → 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... → General → 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.


<!--T:25-->
{{Docnav
{{Docnav
|
|
|[[Std_MacroStopRecord|Std MacroStopRecord]]
|[[Std_MacroStopRecord|MacroStopRecord]]
|[[Std_Macro_Menu|Std Macro Menu]]
|[[Std_Macro_Menu|Std Macro Menu]]
|
|

Revision as of 20:56, 22 December 2020

Other languages:

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. Perform the actions you want to record.
  8. To end the recording session do one of the following:
    • Press the Std MacroStopRecord button.
    • Select the Macro → 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 Record GUI commands checkbox.
    • To include them as comments only check both the Record GUI commands and Record as comment checkboxes.
Std Base
User documentation
Retrieved from "http://wiki.freecad.org/index.php?title=Std_DlgMacroRecord&oldid=821427"