TechDraw RichTextAnnotation: Difference between revisions
m (Changed section to 'Usage') |
(Usage) |
||
(16 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
<languages/> |
<languages/> |
||
<translate> |
<translate> |
||
<!--T:16--> |
<!--T:16--> |
||
{{Docnav |
{{Docnav |
||
|[[TechDraw_LeaderLine| |
|[[TechDraw_LeaderLine|LeaderLine]] |
||
|[[TechDraw_CosmeticVertex| |
|[[TechDraw_CosmeticVertex|CosmeticVertex]] |
||
|[[ |
|[[TechDraw_Workbench|TechDraw]] |
||
|IconL=TechDraw_LeaderLine.svg |
|IconL=TechDraw_LeaderLine.svg |
||
⚫ | |||
|IconR=TechDraw_CosmeticVertex.svg |
|IconR=TechDraw_CosmeticVertex.svg |
||
⚫ | |||
}} |
}} |
||
Line 15: | Line 16: | ||
|Name=TechDraw RichTextAnnotation |
|Name=TechDraw RichTextAnnotation |
||
|MenuLocation=TechDraw → Annotations → Insert Rich Text Annotations |
|MenuLocation=TechDraw → Annotations → Insert Rich Text Annotations |
||
|Workbenches=[[ |
|Workbenches=[[TechDraw_Workbench|TechDraw]] |
||
|Version=0.19 |
|Version=0.19 |
||
|SeeAlso=[[TechDraw_Annotation|TechDraw Annotation]] |
|||
|SeeAlso=[[TechDraw Templates|TechDraw Templates]], [[Draft SVG|Draft SVG]], [[TechDraw_LeaderLine|Add Leaderline to View]] |
|||
}} |
}} |
||
Line 23: | Line 24: | ||
<!--T:8--> |
<!--T:8--> |
||
The |
The '''TechDraw RichTextAnnotation''' tool adds a formatted annotation block to a [[TechDraw_LeaderLine|Leaderline]] or a View. |
||
</translate> |
</translate> |
||
[[Image:TechDraw_RichTextBlock_sample.png]] |
[[Image:TechDraw_RichTextBlock_sample.png|220px]] |
||
<translate> |
<translate> |
||
<!--T:9--> |
<!--T:9--> |
||
{{Caption|Stand alone |
{{Caption|Stand alone RichTextAnnotation}} |
||
==Usage== <!--T:3--> |
==Usage== <!--T:3--> |
||
<!--T:10--> |
<!--T:10--> |
||
# If there are multiple drawing pages in the document: optionally activate the desired page by selecting it in the [[Tree_view|Tree view]]. |
|||
⚫ | |||
⚫ | |||
⚫ | |||
# There are several ways to invoke the tool: |
|||
⚫ | |||
⚫ | |||
⚫ | |||
#* Select the {{MenuCommand|TechDraw → Annotations → [[Image:TechDraw_RichTextAnnotation.svg|16px]] Insert Rich Text Annotation}} option from the menu. |
|||
⚫ | |||
# If there are multiple drawing pages in the document and you have not yet activated a page, the {{MenuCommand|Page Chooser}} dialog box opens: {{Version|0.20}} |
|||
## Select the desired page. |
|||
## Press the {{Button|OK}} button. |
|||
# A task panel opens. |
|||
⚫ | |||
⚫ | |||
## When done, press the {{Button|[[Image:Document-save.svg|16px]]}} button to save your changes and close the editor. |
|||
# Press the {{Button|OK}} button to close the task panel. |
|||
⚫ | |||
⚫ | |||
⚫ | |||
==Properties== <!--T:19--> |
==Properties== <!--T:19--> |
||
<!--T:20--> |
<!--T:20--> |
||
* {{PropertyData|X,Y}}: The location of the block. |
* {{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 52: | Line 65: | ||
<!--T:12--> |
<!--T:12--> |
||
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]]. |
|||
<!--T:13--> |
<!--T:13--> |
||
The |
The RichTextAnnotation tool can be used in [[Macros|macros]] and from the [[Python|Python]] console. |
||
</translate> |
</translate> |
||
{{Code|code= |
{{Code|code= |
||
Line 66: | Line 80: | ||
blockObj.AnnoText = myHTMLText |
blockObj.AnnoText = myHTMLText |
||
}} |
}} |
||
<translate> |
<translate> |
||
⚫ | |||
⚫ | |||
* You can edit your RichTextBlock by double clicking on it in the tree view. Double clicking in the graphics area is not yet supported. |
|||
<!--T:17--> |
<!--T:17--> |
||
{{Docnav |
{{Docnav |
||
|[[TechDraw_LeaderLine| |
|[[TechDraw_LeaderLine|LeaderLine]] |
||
|[[TechDraw_CosmeticVertex| |
|[[TechDraw_CosmeticVertex|CosmeticVertex]] |
||
|[[ |
|[[TechDraw_Workbench|TechDraw]] |
||
|IconL=TechDraw_LeaderLine.svg |
|IconL=TechDraw_LeaderLine.svg |
||
⚫ | |||
|IconC=Workbench_TechDraw.svg |
|IconC=Workbench_TechDraw.svg |
||
⚫ | |||
}} |
}} |
||
<!--T:14--> |
|||
⚫ | |||
<!--T:15--> |
|||
⚫ | |||
</translate> |
</translate> |
||
⚫ | |||
⚫ | |||
{{clear}} |
{{clear}} |
Latest revision as of 10:07, 26 July 2023
|
Menu location |
---|
TechDraw → Annotations → Insert Rich Text Annotations |
Workbenches |
TechDraw |
Default shortcut |
None |
Introduced in version |
0.19 |
See also |
TechDraw Annotation |
Description
The TechDraw RichTextAnnotation tool adds a formatted annotation block to a Leaderline or a View.
Stand alone RichTextAnnotation
Usage
- If there are multiple drawing pages in the document: optionally activate the desired page by selecting it in the Tree view.
- To attach the RichTextAnnotation to a Leaderline, select the line in the Tree view or on the page.
- There are several ways to invoke the tool:
- Press the
Insert Rich Text Annotation button.
- Select the TechDraw → Annotations →
Insert Rich Text Annotation option from the menu.
- Press the
- If there are multiple drawing pages in the document and you have not yet activated a page, the Page Chooser dialog box opens: introduced in version 0.20
- Select the desired page.
- Press the OK button.
- A task panel opens.
- The task panel allows quick entry of text.
- The Start Rich Text Editor button opens a full featured editor:
- Press the OK button to close the task panel.
Notes
- After creation a RichTextAnnotation can be edited by double clicking it on the page.
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
- Pages: Insert Default Page, Insert Page using Template, Redraw Page, Print All Pages
- Views: Insert View, Insert Active View, Insert Projection Group, Insert Section View, Insert Complex Section View, Insert Detail View, Insert Draft Workbench Object, Insert Arch Workbench Object, Insert Spreadsheet View, Move View, Share View, Project Shape
- Stacking: Move view to top of stack, Move view to bottom of stack, Move view up one level, Move view down one level
- Clips: Insert Clip Group, Add View to Clip Group, Remove View from Clip Group
- Decorations: Hatch Face using Image File, Apply Geometric Hatch to Face, Insert SVG Symbol, Insert Bitmap Image, Turn View Frames On/Off
- Dimensions: Insert Length Dimension, Insert Horizontal Dimension, Insert Vertical Dimension, Insert Radius Dimension, Insert Diameter Dimension, Insert Angle Dimension, Insert 3-Point Angle Dimension, Insert Horizontal Extent Dimension, Insert Vertical Extent Dimension, Link Dimension to 3D Geometry, Insert Balloon Annotation, Insert Axonometric Length Dimension, Insert Landmark Dimension, Adjust Geometric References of Dimension
- Annotations: Insert Annotation, Add Leaderline to View, Insert Rich Text Annotation, Add Cosmetic Vertex, Add Midpoint Vertices, Add Quadrant Vertices, Add Centerline to Faces, Add Centerline between 2 Lines, Add Centerline between 2 Points, Add Cosmetic Line Through 2 points, Add Cosmetic Circle, Remove Cosmetic Object, Change Appearance of Lines, Show/Hide Invisible Edges, Add Welding Information to Leader, Add Surface Finish Symbol, Add Hole or Shaft Tolerances
- Extensions:
- Attributes and modifications: Select Line Attributes, Cascade Spacing and Delta Distance, Change Line Attributes, Extend Line, Shorten Line, Lock/Unlock View, Position Section View, Position Horizontal Chain Dimensions, Position Vertical Chain Dimensions, Position Oblique Chain Dimensions, Cascade Horizontal Dimensions, Cascade Vertical Dimensions, Cascade Oblique Dimensions, Calculate the area of selected faces, Calculate the arc length of selected edges, Customize format label
- Centerlines and threading: Add Circle Centerlines, Add Bolt Circle Centerlines, Add Cosmetic Thread Hole Side View, Add Cosmetic Thread Hole Bottom View, Add Cosmetic Thread Bolt Side View, Add Cosmetic Thread Bolt Bottom View, Add Cosmetic Intersection Vertex(es), Add an offset vertex, Add Cosmetic Circle, Add Cosmetic Arc, Add Cosmetic Circle 3 Points, Add Cosmetic Parallel Line, Add Cosmetic Perpendicular Line
- Dimensions: Create Horizontal Chain Dimensions, Create Vertical Chain Dimensions, Create Oblique Chain Dimensions, Create Horizontal Coordinate Dimensions, Create Vertical Coordinate Dimensions, Create Oblique Coordinate Dimensions, Create Horizontal Chamfer Dimension, Create Vertical Chamfer Dimension, Create Arc Length Dimension, Insert '⌀' Prefix, Insert '〼' Prefix, Remove Prefix, Increase Decimal Places, Decrease Decimal Places
- Export: Export Page as SVG, Export Page as DXF
- Additional: Line Groups, Templates, Hatching, Geometric dimensioning and tolerancing, Preferences
![](/images/thumb/9/94/User_hub.png/24px-User_hub.png)
- Getting started
- Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
- Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate
- Help: Tutorials, Video tutorials
- Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web
- Hubs: User hub, Power users hub, Developer hub