TechDraw RichTextAnnotation: Difference between revisions

From FreeCAD Documentation
No edit summary
No edit summary
Line 30: Line 30:
<translate>
<translate>
<!--T:9-->
<!--T:9-->
{{Caption|Stand alone RichTextBlock}}
{{Caption|Stand alone RichTextAnnotation}}


==Usage== <!--T:3-->
==Usage== <!--T:3-->
Line 38: Line 38:
# A Task dialog will open. The dialog allows quick entry of text.
# A Task dialog will open. The dialog allows quick entry of text.
# The {{Button|Start Rich Text Editor}} button will open a full featured editor. Press the Save icon to record your changes.
# The {{Button|Start Rich Text Editor}} button will open a full featured editor. Press the Save icon to record your changes.
# After the block is created, it can be edited by double clicking the RichTextBlock in the Tree.
# After the block is created, it can be edited by double clicking the RichTextAnnotation in the Tree.
# To attach the block to a [[TechDraw_LeaderLine|Leaderline]], select the line before starting the RichTextBlock tool.
# To attach the block to a [[TechDraw_LeaderLine|Leaderline]], select the line before starting the RichTextBlock tool.


Line 44: Line 44:


<!--T:20-->
<!--T:20-->
* {{PropertyData|X,Y}}: The location of the block. Relative to the end of the line if attached to a [[TechDraw_LeaderLine|Leaderline]], otherwise this is the position on the page.
* {{PropertyData|X,Y}}: The location of the block. Relative to the end of the line if attached to a [[TechDraw_LeaderLine|Leaderline]], otherwise this is the position on the page.
* {{PropertyData|ShowFrame}}: Draws an outline around the block.
* {{PropertyData|ShowFrame}}: Draws an outline around the block.
* {{PropertyData|MaxWidth}}: Limits the horizontal size of the block. A value of -1 is for unlimited width.
* {{PropertyData|MaxWidth}}: Limits the horizontal size of the block. A value of -1 is for unlimited width.
Line 55: Line 55:


<!--T:13-->
<!--T:13-->
The RichTextBlock tool can be used in [[Macros|macros]] and from the [[Python|Python]] console.
The RichTextAnnotation tool can be used in [[Macros|macros]] and from the [[Python|Python]] console.

</translate>
</translate>
{{Code|code=
{{Code|code=

Revision as of 07:53, 29 May 2023

TechDraw RichTextAnnotation

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

Description

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

Stand alone RichTextAnnotation

Usage

  1. Press the 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 RichTextAnnotation in the Tree.
  5. To attach the block to a Leaderline, select the line before starting the RichTextBlock tool.

Properties

  • 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.

Scripting

See also: Autogenerated API documentation and FreeCAD Scripting Basics.

The RichTextAnnotation 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')
FreeCAD.activeDocument().myPage.addView(blockObj)
blockObj.X = 5
blockObj.Y = 5
blockObj.AnnoText = myHTMLText

Notes

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