Std DlgMacroRecord: Difference between revisions

From FreeCAD Documentation
mNo edit summary
No edit summary
(30 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

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

<!--T:1-->
<!--T:1-->
{{GuiCommand
{{GuiCommand
|Name=Std DlgMacroRecord
|Name=Std DlgMacroRecord
|MenuLocation={{StdMenu|[[Std Macro Menu|Macro]]}} → Macro recording...
|MenuLocation=Macro → Macro recording...
|Workbenches=All
|Workbenches=All
|SeeAlso=[[Std_DlgMacroExecuteDirect|Execute macro]]
|SeeAlso=[[Std_MacroStopRecord|Std MacroStopRecord]]
}}
}}


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


<!--T:3-->
<!--T:3-->
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.
The [[Image:Std_DlgMacroRecord.svg|16px]] Start Macro recording function initiates a recording session of a [[macros|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 [[File:Std MacroStopRecord.svg|16px]] [[Std MacroStopRecord|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 ({{incode|.FCMacro}})), that can be executed at a later time or even transferred to another computer running FreeCAD.


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

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


<!--T:4-->
<!--T:4-->
# There are several ways to invoke the command:
#The Macro Record function is accessible via several ways:
#* The {{Button|[[Image:Std_DlgMacroRecord.svg|16px]] Macro recording}} button in the macro toolbar [[File:Macros_toolbar.jpg|96px]]
#* Press the {{Button|[[Image:Std_DlgMacroRecord.svg|16px]] [[Std_DlgMacroRecord|Std DlgMacroRecord]]}} button.
#* The menu {{MenuCommand|{{StdMenu|[[Std Macro Menu|Macro]]}} → Macro recording}},
#* Select the {{MenuCommand|Macro → [[Image:Std_DlgMacroRecord.svg|16px]] Macro recording...}} option from the menu.
# The Macro recording dialog box opens.
# '''Result:''' A dialog box will appear querying the user for the following information
# Enter a name for the macro in the '''Macro name''' input box.
#: [[Image:Menu_Std_DlgMacroRecord_it.png‎|Macro recording]]
:::* '''Macro name''': Enter the name of the new macro.
# Optionally change the '''Macro path''' by pressing the {{Button|...}} button.
# The {{Button|Stop}} button does not work at this time.
:::* '''Macro path''': Path macro library. To change the path, click {{Button| ... }}.
:::* {{KEY|Record}}: Record the macro (starts recording all actions in the [[3D view]]).
# Press the {{Button|Record}} button to close the dialog box and start the recording session.
# Perform the actions you want to record.
::::'''Note:''' The button {{Button|[[File:Std MacroStopRecord.svg|16px]] Stop macro recording session}} in the macros toolbar [[File:Macros_toolbar.jpg|96px]] will turn green [[File:Std MacroStopRecord.svg|16px]].
:::* {{Button|Stop}}: Stop recording the macro.
# To end the recording session do one of the following:
#* Press the {{Button|[[Image:Std_MacroStopRecord.svg|16px]] [[Std_MacroStopRecord|Std MacroStopRecord]]}} button.
:::* {{Button|Cancel}}: Cancels and closes the window.
# Once completed, click {{KEY|[[File:Std MacroStopRecord.svg|16px]] [[Std MacroStopRecord|Stop the macro recording session]]}} to stop recording the macro.
#* Select the {{MenuCommand|Macro → [[Image:Std_MacroStopRecord.svg|16px]] Stop macro recording}} option from the menu.


=== Executing the Macro=== <!--T:8-->
==Options== <!--T:19-->


<!--T:20-->
# The macro can be executed several ways:
* When the Macro recording dialog box is displayed: press {{KEY|Esc}} or the {{Button|Cancel}} button to abort the command.
#* Through the {{MenuCommand|Macro → Macros...}} menu
#* Pressing the {{Button|[[File:Std_DlgMacroExecuteDirect.svg|16px]] [[Std_DlgMacroExecuteDirect|Execute this macro]]}} button in the macro toolbar
# Choose the macro
# Press {{Button|OK}}


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


<!--T:13-->
<!--T:22-->
* To execute the recorded macro use the [[Std_DlgMacroExecute|Std DlgMacroExecute]] command.
Click the button [[File:Std DlgMacroRecord.png|16px]] enter a name for the macro and validate, open a document, create a cube, change the color stop the macro with the button [[File:Std MacroStopRecord.svg|16px]].
* To learn more about macros see the [[Macros]] page.


<!--T:10-->
==Preferences== <!--T:23-->
The macro is available in your macros directory.


<!--T:14-->
<!--T:24-->
* The macro path can also be changed in the preferences: {{MenuCommand|Edit → Preferences... → General → Macro → Macro path}}. See [[Preferences_Editor#Macro|Preferences Editor]].
⚫
{{Std Base navi}}
* 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
|
|[[Std_MacroStopRecord|MacroStopRecord]]
|[[Std_Macro_Menu|Std Macro Menu]]
|
|IconR=Std_MacroStopRecord.svg
|IconC=Freecad.svg
}}


⚫
{{Userdocnavi}}
</translate>
</translate>
⚫
{{Std Base navi{{#translation:}}}}
⚫
{{Userdocnavi{{#translation:}}}}
{{clear}}
{{clear}}

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"