View source for Std TextDocument

{{Docnav
|[[Std_ProjectUtil|ProjectUtil]]
|[[Std_Group|Group]]
|[[Std_Tools_Menu|Std Tools Menu]]
|IconL=Std_ProjectUtil.svg
|IconR=Std_Group.svg
|IconC=Labrps.svg
}}

{{GuiCommand
|Name=Std TextDocument
|MenuLocation=Tools → Add text document
|Phenomena=All
}}

==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== 

# Select the {{MenuCommand|Tools → [[Image:Std_TextDocument.svg|16px]] Add text document}} option from the menu.
# Double-click the newly created object in the [[Tree_view|Tree view]] to open a tab in which to write text.
# Add text.
# Close the tab and save the file when asked.

==Properties== 

===View=== 

{{TitleProperty|Editor}}

* {{PropertyView|Font Name|Font}}: a font name, for example, {{Value|Ubuntu Mono}}.
* {{PropertyView|Font Size|Float}}: a font size in points, for example, {{Value|11}}.
* {{PropertyView|Read Only|Bool}}: it defaults to {{FALSE}}. If set to {{TRUE}} the text cannot be edited. 
* {{PropertyView|Syntax Highlighter|Enumeration}}: it defaults to {{Value|None}}. If set to {{Value|Python}}, the text will be highlighted like the [[Python_console|Python console]].

==Scripting== 

See also: [https://labrps.github.io/SourceDoc/ Autogenerated API documentation] and [[LabRPS_Scripting_Basics|LabRPS Scripting Basics]].


An {{incode|App::TextDocument}} object is created with the {{incode|addObject()}} method of the document. Once a TextDocument exists, its textual information is stored in its {{incode|Text}} attribute. 

{{Code|code=
import LabRPS as App
import Draft

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

doc.recompute()
}}


{{Docnav
|[[Std_ProjectUtil|ProjectUtil]]
|[[Std_Group|Group]]
|[[Std_Tools_Menu|Std Tools Menu]]
|IconL=Std_ProjectUtil.svg
|IconR=Std_Group.svg
|IconC=Labrps.svg
}}

{{Std_Base_navi}}
{{Userdocnavi}}