Draft Text/en

Description
The Draft Text command creates a multi-line text at a given point.

To create a text element with an arrow use the Draft Label command instead.



Usage
See also: Draft Tray and Draft Snap.


 * 1) There are several ways to invoke the command:
 * 2) * Press the button.
 * 3) * Select the option from the menu.
 * 4) * Use the keyboard shortcut: then.
 * 5) The  task panel opens. See Options for more information.
 * 6) Pick a point in the 3D view, or type coordinates and press the  button.
 * 7) Enter the desired text, press  to start a new line.
 * 8) Press  twice or press the  button to finish the command.

Options
The single character keyboard shortcuts available in the task panel can be changed. See Draft Preferences. The shortcuts mentioned here are the default shortcuts.


 * To manually enter coordinates enter the X, Y and Z component, and press after each. Or you can press the  button when you have the desired values. It is advisable to move the pointer out of the 3D view before entering coordinates.
 * The checkbox has no purpose for this command.
 * Press or click the  checkbox to toggle global mode. If global mode is on, coordinates are relative to the global coordinate system, else they are relative to the working plane coordinate system.
 * Click the checkbox on the second task panel to toggle continue mode. The  keyboard shortcut does not work. If continue mode is on, the command will restart after finishing, allowing you to continue creating texts.
 * Press to switch Draft snapping on or off.
 * Press or the  button to abort the command.

Properties
See also: Property editor.

A Draft Text object is derived from an App FeaturePython object and inherits all its properties. The following properties are additional unless otherwise stated.

Data

 * : specifies the position of the text in the 3D view. See Placement.
 * : specifies the contents of the text. Each item in the list represents a new text line.

View

 * : specifies the annotation style applied to the text. See Draft AnnotationStyleEditor.
 * : specifies the general scaling factor applied to the text.


 * : specifies how the text is displayed. If it is the text will be displayed in a plane defined by its . If it is  the text will always face the camera. This is an inherited property.


 * : not used.
 * : not used.


 * : specifies the font used to draw the text. It can be a font name, such as, a default style such as , or , a family such as , or a name with a style such as . If the given font is not found on the system, a default font is used instead.
 * : specifies the size of the letters. The text can be invisible in the 3D view if this value is very small.
 * : specifies if the alignment of the text:, or.
 * : specifies the factor applied to the default line height of the text.
 * : specifies the color of the text.

Scripting
See also: Autogenerated API documentation and FreeCAD Scripting Basics.

To create a Draft Text use the method  of the Draft module. This method replaces the deprecated method.


 * Creates a object, at, which can be a , but also a  or a.
 * is a string or a list of strings. If it is a list, each element is displayed on its own line.
 * If is, the text always faces the camera, otherwise it aligns with the scene axes and lies on the XY plane.

The view properties of can be changed by overwriting its attributes; for example, overwrite  with the new size in millimeters.

Example: