Std TextDocument

ProjectUtil

DemoMode

Std Tools Menu

Std TextDocument
Menu location
Tools → Add text document
Workbenches
All
Default shortcut
None
Introduced in version
0.19
See also
Draft ShapeString, Draft Text

Description

The Std TextDocument command creates an object capable of holding arbitrary text. This element can be used to write general information or documentation about the model.

Usage

1. Select the Tools → Add text document option from the menu.
2. Double-click the newly created object in the Tree view to open a tab in which to write text.
3. Add text.
4. Close the tab and save the file when asked.

Properties

View

Editor

• ViewFont Name (Font): a font name, for example, Ubuntu Mono.
• ViewFont Size (Float): a font size in points, for example, 11.
• ViewRead Only (Bool): it defaults to false. If set to true the text cannot be edited.
• ViewSyntax Highlighter (Enumeration): it defaults to None. If set to Python, the text will be highlighted like the Python console.

Scripting

See also: Autogenerated API documentation and FreeCAD Scripting Basics.

See Part Feature for the general information on adding objects to a document.

An App::TextDocument object is created with the addObject() method of the document. Once a TextDocument exists, its textual information is stored in its Text attribute. This attribute can be used in other objects, for example, as the string in a Draft ShapeString.

import FreeCAD as App
import Draft

doc = App.newDocument()
obj = doc.addObject("App::TextDocument", "Text_document")
obj.Text = "textual information"
doc.recompute()

obj2 = Draft.makeShapeString(obj.Text, "/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf", 10)
doc.recompute()

ProjectUtil

DemoMode

Std Tools Menu

Std Base

• File: New, Open, Open Recent, Close, Close All, Save, Save As, Save a Copy, Save All, Revert, Import, Export,Merge project, Document information, Print, Print preview, Export PDF, Exit

---

• Edit: Undo, Redo, Cut, Copy, Paste, Duplicate selection, Refresh, Box selection, Box element selection, Select All, Delete, Send to Python Console, Placement, Transform, Alignment, Toggle Edit mode, Properties, Edit mode, Preferences

---

• View:
  • Miscellaneous: Create new view, Orthographic view, Perspective view, Fullscreen, Bounding box, Toggle axis cross, Clipping plane, Persistent section cut, Texture mapping, Toggle navigation/Edit mode, Material, Appearance, Random color, Color per face, Toggle transparency, Workbench, Status bar
  • Standard views: Fit all, Fit selection, Align to selection, Isometric, Dimetric, Trimetric, Home, Front, Top, Right, Rear, Bottom, Left, Rotate Left, Rotate Right, Store working view, Recall working view
  • Freeze display: Save views, Load views, Freeze view, Clear views
  • Draw style: As is, Points, Wireframe, Hidden line, No shading, Shaded, Flat lines
  • Stereo: Stereo red/cyan, Stereo quad buffer, Stereo Interleaved Rows, Stereo Interleaved Columns, Stereo Off, Issue camera position
  • Zoom: Zoom In, Zoom Out, Box zoom
  • Document window: Docked, Undocked, Fullscreen
  • Visibility: Toggle visibility, Show selection, Hide selection, Select visible objects, Toggle all objects, Show all objects, Hide all objects, Toggle selectability
  • Toolbars: File, Edit, Clipboard, Workbench, Macro, View, Individual views, Structure, Help, Lock toolbars
  • Panels: Tree view, Property view, Model, Selection view, Python console, Report view, Tasks, DAG view
  • Dock window overlay: Toggle overlay for all, Toggle transparent for all, Toggle overlay, Toggle transparent, Bypass mouse events in docked overlay windows, Toggle left, Toggle right, Toggle top, Toggle bottom
  • Link navigation: Go to linked object, Go to the deepest linked object, Select all links
  • Tree view actions: Sync view, Sync selection, Sync placement, Pre-selection, Record selection, Single document, Multi document, Collapse/Expand, Initiate dragging, Go to selection, Selection back, Selection forward

---

• Tools: Edit parameters, Save image, Load image, Scene inspector, Dependency graph, Export dependency graph, Document utility, Add text document, View turntable, Units converter, Customize, Addon manager, Measure

---

• Macro: Macro recording, Macros, Recent macros, Execute macro, Attach to remote debugger, Debug macro, Stop debugging, Step over, Step into, Toggle breakpoint

---

• Windows: Next, Previous, Tile, Cascade, Windows

---

• Help: Help, FreeCAD Website, Donate, Users documentation, Python scripting documentation, Automatic Python modules documentation, FreeCAD Forum, FreeCAD FAQ, Report a bug, About FreeCAD, What's This, Start

---

• Additional:
  • Miscellaneous: Create part, Create group, Make link, Make sub-link, Replace with link, Unlink, Import links, Import all links, Make link group, Create a variable set, Select all instances, Toggle freeze
  • Expression actions: Copy selected, Copy active document, Copy all documents, Paste
  • Selection filter: Vertex selection, Edge selection, Face selection, All selection filters cleared

User documentation

• 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, Assembly, BIM, CAM, Draft, FEM, Inspection, Material, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Surface, TechDraw, Test Framework

---

• Addons: Addon Manager, External workbenches, Scripting and macros

---

• Hubs: User hub, Power users hub, Developer hub