GuiCommand model: Difference between revisions

From FreeCAD Documentation
(Marked this version for translation)
(Added fields to template:GuiCommand, description, usage)
Line 1: Line 1:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{GuiCommand|Name=Base ExampleCommandModel|MenuLocation=Sample -> Command|Workbenches=Wb1,Wb2}}
{{GuiCommand|Name=Base ExampleCommandModel|MenuLocation=Sample Command|Workbenches=Wb1,Wb2|Shortcut=None|SeeAlso=[[Wb Command]]}}


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


Insert here a short description of what the command does.
Description

<br><br>
[[image:FreeCAD05.png]] image
[[image:FreeCAD05.png]] image

<br><br>
==How to use== <!--T:3-->
==How to use== <!--T:3-->


<!--T:4-->
<!--T:4-->
# Press the {{KEY|[[File:Std Close.png|24px]] '''Command name'''}} button.
# How to use
# Detailed steps as needed.
# How to use
# Set options and press {{KEY|OK}}.


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

Revision as of 04:01, 22 February 2018

Base ExampleCommandModel

Menu location
Sample → Command
Workbenches
Wb1,Wb2
Default shortcut
None
Introduced in version
-
See also
Wb Command

Description

Insert here a short description of what the command does.

image

How to use

  1. Press the File:Std Close.png Command name button.
  2. Detailed steps as needed.
  3. Set options and press OK.

Options

Create Geometry

{{TitleTasks|[[Image:Icon.png|24]] + Text}} (Code for the main title Tasks)
  • TASK Tasks : Tasks
{{PropertyTasks|Tasks}} (Code of title Tasks)
  • Options

Properties

Base

{{TitleProperty|Base}}  (Code for the main title Properties)
  • DataProperties: Properties
{{PropertyData|Properties}} (Code of title Data)
  • ViewProperties: Properties
{{PropertyView|Properties}} (Code of title View)

Example

Optional

Scripting

The ExampleCommandModel tool can by used in macros and from the python console by using the following function:

makeExampleCommandModel (Data, Data)
  • Creates a CommandModel using Data.
  • Returns the newly created object.

Example:

import FreeCAD, Base
Base.makeExampleCommandModel(FreeCAD.Data,FreeCAD.Data)

Other

Optional