TechDraw RichTextAnnotation

From FreeCAD Documentation
Jump to navigation Jump to search
Other languages:
Deutsch • ‎English • ‎français • ‎italiano • ‎polski • ‎русский

TechDraw RichTextAnnotation.svg TechDraw RichTextAnnotation

Menu location
TechDraw → Annotations → Insert Rich Text Annotations
Default shortcut
Introduced in version
See also
TechDraw Templates, Draft SVG, TechDraw Leaderline


The RichTextBlock tool adds a formatted annotation block to a Leaderline or a View.

TechDraw RichTextBlock sample.png

Stand alone RichTextBlock


  1. Press the TechDraw RichTextAnnotation.svg Rich Text Annotation button
  2. A Task dialog will open. The dialog allows quick entry of text.
  3. The Start Rich Text Editor button will open a full featured editor. Press the Save icon to record your changes.
  4. After the block is created, it can be edited by double clicking the RichTextBlock in the Tree.
  5. To attach the block to a Leaderline, select the line before starting the RichTextBlock tool.


  • DataX,Y: The location of the block. Relative to the end of the line if attached to a Leaderline, otherwise this is the position on the page.
  • DataShowFrame: Draws an outline around the block.
  • DataMaxWidth: Limits the horizontal size of the block. A value of -1 is for unlimited width.
  • DataAnnoText: The HTML text of the block.


See also: Autogenerated API documentation and FreeCAD Scripting Basics.

The RichTextBlock tool can be used in macros and from the Python console.

myPage = FreeCAD.ActiveDocument().Page
myBase = FreeCAD.ActiveDocument().View
blockObj = FreeCAD.ActiveDocument.addObject('TechDraw::DrawRichAnno','DrawRichAnno')
blockObj.X = 5
blockObj.Y = 5
blockObj.AnnoText = myHTMLText


  • You can edit your RichTextBlock by double clicking on it in the tree view. Double clicking in the graphics area is not yet supported.