Skip to content

Latest commit

 

History

History
78 lines (48 loc) · 2.93 KB

TechDraw_Annotation.md

File metadata and controls

78 lines (48 loc) · 2.93 KB
Raw
GuiCommand
Name MenuLocation Workbenches SeeAlso
TechDraw Annotation
TechDraw , Annotations , Insert Annotation
TechDraw_Workbench
TechDraw_RichTextAnnotation

TechDraw Annotation

Description

The TechDraw Annotation tool adds a text block to a drawing page.

*Annotation in the drawing page*

Usage

  1. If there are multiple drawing pages in the document: optionally activate the desired page by selecting it in the Tree view.
  2. There are several ways to invoke the tool:
    • Press the Insert Annotation button.
    • Select the TechDraw → Annotations → Insert Annotation option from the menu.
  3. If there are multiple drawing pages in the document and you have not yet activated a page, the Page Chooser dialog box opens: (v0.20)
    1. Select the desired page.
    2. Press the OK button.
  4. A text block containing Default Text appears on the page.
  5. Use the Property editor to change the text.
  6. Optionally drag the Annotation to the different position.


Modifying the annotation through the Property editor

Notes

  • Some characters interfere with the internal representation of the Annotation text. Specifically, these are the double quote ", less than <, and greater than > symbols; these must be replaced by HTML escape characters, &amp;quot;, &amp;lt;, and &amp;gt; respectively. See Character encodings in HTML for details.

Properties

The Annotation inherits all applicable basic View properties except Scale. Use the TextSize property instead.

  • Text: The text to be displayed.

  • Font: The name of the font to use. Annotation will use the best match of installed fonts.

  • TextColor: The color of the text.

  • TextSize: The size of the text in mm.

  • MaxWidth: The maximum width of the Annotation block. -1 indicates no maximum width.

  • LineSpace: Line spacing adjustment (%).

  • TextStyle: "Normal", "Bold", "Italic", "Bold-Italic"

Scripting

See also: Autogenerated API documentation and FreeCAD Scripting Basics.

The New Annotation tool can be used in macros and from the Python console by using the following functions:

anno = FreeCAD.ActiveDocument.addObject('TechDraw::DrawViewAnnotation','TestAnno')
anno.Text = ['Different Text']
anno.TextStyle = 'Bold'
rc = page.addView(anno)

{{TechDraw Tools navi}}

⏵ documentation index > TechDraw > TechDraw Annotation