Std DlgMacroRecord: Difference between revisions

From FreeCAD Documentation
mNo edit summary
No edit summary
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
{{UnfinishedDocu{{#translation:}}}} <!-- Needs English UI image -->
<translate>
<translate>
<!--T:1-->
<!--T:1-->
Line 21: Line 22:
#* The menu {{MenuCommand|{{StdMenu|[[Std Macro Menu|Macro]]}} → Macro recording}},
#* The menu {{MenuCommand|{{StdMenu|[[Std Macro Menu|Macro]]}} → Macro recording}},
# '''Result:''' A dialog box will appear querying the user for the following information
# '''Result:''' A dialog box will appear querying the user for the following information
#: [[Image:Menu_Std_DlgMacroRecord_it.svg‎|Macro recording]]
#: [[Image:Menu_Std_DlgMacroRecord_it.png‎|Macro recording]]
#::* '''Macro name''': Enter the name of the new macro.
#::* '''Macro name''': Enter the name of the new macro.
#::* '''Macro path''': Path macro library. To change the path, click {{Button| ... }}.
#::* '''Macro path''': Path macro library. To change the path, click {{Button| ... }}.
Line 32: Line 33:
=== Executing the Macro=== <!--T:8-->
=== Executing the Macro=== <!--T:8-->


⚫
<!--T:15-->
# The macro can be executed several ways:
# The macro can be executed several ways:
#* Through the {{MenuCommand|Macro → Macros...}} menu
#* Through the {{MenuCommand|Macro → Macros...}} menu
Line 44: Line 46:
# Enter a name for the macro and press {{Button|OK}}
# Enter a name for the macro and press {{Button|OK}}
# Open a document
# Open a document
# Create an [[Image:Part_Box.svg|24px]] [[PartBox|Cube]]
# Create an [[Image:Part_Box.svg|24px]] [[Part Box|Cube]]
# Change the color of the box
# Change the color of the box
# Press on [[File:Std MacroStopRecord.svg|16px]] to stop the macro recording
# Press on [[File:Std MacroStopRecord.svg|16px]] to stop the macro recording
Line 51: Line 53:
Result: The macro is available in your macros directory. [[#Executing the Macro|Execute]] the macro to recreate the steps you just recorded.
Result: The macro is available in your macros directory. [[#Executing the Macro|Execute]] the macro to recreate the steps you just recorded.


⚫
<!--T:14-->
⚫
{{Std Base navi}}

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

Revision as of 20:53, 13 March 2020

Other languages:

This documentation is not finished. Please help and contribute documentation.

GuiCommand model explains how commands should be documented. Browse Category:UnfinishedDocu to see more incomplete pages like this one. See Category:Command Reference for all commands.

See WikiPages to learn about editing the wiki pages, and go to Help FreeCAD to learn about other ways in which you can contribute.

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.

Std Base
User documentation
Retrieved from "http://wiki.freecad.org/index.php?title=Std_DlgMacroRecord&oldid=638689"