Draft Text

Description
The Draft Text command inserts a multi-line textbox at a given point. It uses the Draft Linestyle set on the Draft Tray.

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



Usage

 * 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) Click a point on the 3D view, or type coordinates and press the  button.
 * 6) Enter the desired text, pressing  between each line.
 * 7) Press  twice to finish the command.

Options

 * To enter coordinates manually, simply enter the numbers, then press between each X, Y and Z component. You can press the  button when you have the desired values to insert the point.
 * Hold while placing the text to force snapping your point to the nearest snap location, independently of the distance.
 * Press or  to enter a new line of text.
 * Press to edit the previous line of text.
 * Press or  twice to finish editing the text.
 * 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.


 * : specifies the color of the lines belonging to the annotation object. Since a Draft Text does not contain linework it is not used by this object.
 * : specifies the width of the lines belonging to the annotation object. Since a Draft Text does not contain linework it is not used by this object.


 * : 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: