Draft Text/en

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

To create a text label with a leader and an arrow use Draft Label. To create solid text or 3D letters use Draft ShapeString with Part Extrude.



Warning: The texts created with version 0.18 are not backward compatible, so backup your work if you try to open files created with 0.18 with older versions.

How to use

 * 1) Press the  button, or press  then  keys.
 * 2) Click a point on the 3D view, or type a coordinate and press the  button.
 * 3) Enter the desired text, pressing  between each line.
 * 4) Press  twice to finish the operation.

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 current command.

Data

 * : specifies the contents of the text block as a list of strings; each element on the list, separated by a comma, indicates a new line.
 * : specifies the base point of the first line of the text block.
 * : specifies the rotation of the baseline of the first line of the text block.
 * : specifies the axis to use for the rotation.

View

 * : if it is "3D text" the text will be aligned to the scene axes, initially lying on the XY plane; if it is "2D text" the text will always face the camera.
 * : specifies the font to use to draw the text. It can be a font name, such as "Arial", a default style such as "sans", "serif" or "mono", a family such as "Arial,Helvetica,sans" or a name with a style such as "Arial:Bold". If the given font is not found on the system, a generic one is used instead.
 * : specifies the size of the letters. If the text object is created in the tree view but no text is visible, increase the size of the text until it is visible.
 * : specifies if the text aligns to the left, right or at the center of the base point.
 * : specifies the space between lines of text.

Scripting
Draft API and FreeCAD Scripting Basics.

The Text tool can be used in macros and from the Python console by using the following function:


 * Creates a object, at a  defined by a.
 * is a string, or a list of strings; if it's a list, each element is displayed in its own line.
 * If is, the text always faces the camera view direction, otherwise it aligns with the scene axes, and lies on the XY plane.

The placement of the can be changed by overwriting its  attribute, or by individually overwriting its  and  attributes.

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

Example: