Std New: Difference between revisions

From FreeCAD Documentation
(hidden=True option for App.newDocument() and optional name.)
(Marked this version for translation)
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:7-->
<!--T:7-->
{{Docnav
{{Docnav
Line 29: Line 30:
<!--T:9-->
<!--T:9-->
# There are several ways to invoke the command:
# There are several ways to invoke the command:
#* Press the {{Button|[[Image:Std_New.svg|16px]] [[Std_New|Std New]]}} button.
#* Press the {{Button|[[Image:Std_New.svg|16px]] [[Std_New|New]]}} button.
#* Select the {{MenuCommand|File → [[Image:Std_New.svg|16px]] New}} option from the menu.
#* Select the {{MenuCommand|File → [[Image:Std_New.svg|16px]] New}} option from the menu.
#* Use the keyboard shortcut: {{KEY|Ctrl}}+{{KEY|N}}.
#* Use the keyboard shortcut: {{KEY|Ctrl}}+{{KEY|N}}.


==Preferences== <!--T:10-->
==Preferences== <!--T:10-->

<!--T:19-->
See also: [[Preferences_Editor|Preferences Editor]].


<!--T:11-->
<!--T:11-->
* FreeCAD will create a new document at start up if {{MenuCommand|ToolsEdit parameters... → BaseAppPreferencesDocument CreateNewDoc}} is set to {{TRUE}}. This setting can also be changed in the [[Preferences_Editor#Document|Preferences Editor]].
* By default FreeCAD start without a new document. Check the {{MenuCommand|EditPreferences... → GeneralDocumentCreate new document at start up}} option to change this behavior.
* Some document properties: author names, company name and license information, can be preset in the [[Preferences Editor#Document|Preferences Editor]].
* Some document properties: author name, company name and license information, can be preset: {{MenuCommand|Edit Preferences... → General → Document → Authoring and License}}.


==Properties== <!--T:12-->
==Properties== <!--T:12-->
Line 43: Line 47:
<!--T:13-->
<!--T:13-->
Most properties can also be changed in the dialog box of the [[Std_ProjectInfo|Std ProjectInfo]] command.
Most properties can also be changed in the dialog box of the [[Std_ProjectInfo|Std ProjectInfo]] command.

===Data=== <!--T:20-->

<!--T:21-->
{{TitleProperty|Base}}


<!--T:14-->
<!--T:14-->
* {{PropertyData|Comment}}: Any comment that may apply.
* {{PropertyData|Comment|String}}: Any comment that may apply.
* {{PropertyData|Company}}: Company name. {{Emphasis|Can be preset}}.
* {{PropertyData|Company|String}}: Company name.
* {{PropertyData|Created By}}: Author name. {{Emphasis|Can be preset}}.
* {{PropertyData|Created By|String}}: Author name.
* {{PropertyData|Creation Date}}: Automatic date stamp. {{Emphasis|Not editable}}.
* {{PropertyData|Creation Date|String}}: Automatic date stamp (read-only).
* {{PropertyData|File Name}}: The full path of the file. Blank if the document has not been saved. {{Emphasis|Not editable}}.
* {{PropertyData|File Name|String}}: The full path of the file. Blank if the document has not been saved (read-only).
* {{PropertyData|Id}}: Not implemented yet.
* {{PropertyData|Id|String}}: Not implemented yet.
* {{PropertyData|Label}}: The name that will appear in the [[Tree_view|Tree view]]. By default the name of the document.
* {{PropertyData|Label|String}}: The name that will appear in the [[Tree_view|Tree view]]. Replaced by the name of the document after reopening.
* {{PropertyData|Last Modified By}}: Author name. {{Emphasis|Can be preset}}.
* {{PropertyData|Last Modified By|String}}: Author name.
* {{PropertyData|Last Modified Date}}: Automatic date stamp. {{Emphasis|Not editable}}.
* {{PropertyData|Last Modified Date|String}}: Automatic date stamp (read-only).
* {{PropertyData|License}}: License type. {{Emphasis|Can be preset}}.
* {{PropertyData|License|String}}: License type.
* {{PropertyData|License URL}}: License URL. {{Emphasis|Can be preset}}.
* {{PropertyData|License URL|String}}: License URL.
* {{PropertyData|Material|Map|Hidden}}: Map with material properties.
* {{PropertyData|Show Hidden}}: If true, items that have been hidden in the [[Tree_view|Tree view]] will be displayed anyway. Hiding items in the tree can be useful when working on larger models.
* {{PropertyData|Tip}}: Not implemented yet.
* {{PropertyData|Meta|Map|Hidden}}: Map with additional meta information.
* {{PropertyData|Show Hidden|Bool}}: If true, items that have been hidden in the [[Tree_view|Tree view]] will be displayed anyway. Hiding items in the tree can be useful when working on larger models.
* {{PropertyData|Tip Name}}: Not implemented yet.
* {{PropertyData|Transient Dir}}: The transient directory used for recovery data. {{Emphasis|Not editable}}.
* {{PropertyData|Tip|Link}}: Not implemented yet.
* {{PropertyData|Tip Name|String}}: Not implemented yet.
* {{PropertyData|Transient Dir|String}}: The transient directory used for recovery data (read-only).
* {{PropertyData|Uid|UUID|Hidden}}: UUID of the document (read-only).
* {{PropertyData|Unit System|Enumeration}}: The document unit system. Initial value depends on the [[Preferences_Editor#General_2|Default unit system]]. {{Version|1.0}}


==Scripting== <!--T:15-->
==Scripting== <!--T:15-->
Line 67: Line 80:


<!--T:17-->
<!--T:17-->
To create a new document use the {{incode|newDocument([name], [hidden=False])}} method of the FreeCAD application. The {{incode|name}} of the new document can optionally be specified. If {{incode|hidden=True}} is used, the new document be displayed in the GUI and no tab will appear for that document.
To create a new document use the {{incode|newDocument([name], [hidden<nowiki>=</nowiki>False])}} method of the FreeCAD application. The document name must be unique, which is checked automatically. If no name is supplied, the document will be named "Untitled". If {{incode|hidden<nowiki>=</nowiki>True}} is used, the new document won't be displayed in the GUI and no tab will appear for it.


</translate>
</translate>
Example:

{{Code|code=
{{Code|code=
import FreeCAD
import FreeCAD
Line 94: Line 105:
}}
}}
<translate>
<translate>



<!--T:18-->
<!--T:18-->
Line 106: Line 118:


</translate>
</translate>
{{Std Base navi{{#translation:}}}}
{{Std_Base_navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Latest revision as of 11:48, 21 April 2024

Std New

Menu location
File → New
Workbenches
All
Default shortcut
Ctrl+N
Introduced in version
-
See also
Std Open, Std Import

Description

The Std New command creates a new empty document and makes it the active document.

Usage

  1. There are several ways to invoke the command:
    • Press the New button.
    • Select the File → New option from the menu.
    • Use the keyboard shortcut: Ctrl+N.

Preferences

See also: Preferences Editor.

  • By default FreeCAD start without a new document. Check the Edit → Preferences... → General → Document → Create new document at start up option to change this behavior.
  • Some document properties: author name, company name and license information, can be preset: Edit → Preferences... → General → Document → Authoring and License.

Properties

Most properties can also be changed in the dialog box of the Std ProjectInfo command.

Data

Base

  • DataComment (String): Any comment that may apply.
  • DataCompany (String): Company name.
  • DataCreated By (String): Author name.
  • DataCreation Date (String): Automatic date stamp (read-only).
  • DataFile Name (String): The full path of the file. Blank if the document has not been saved (read-only).
  • DataId (String): Not implemented yet.
  • DataLabel (String): The name that will appear in the Tree view. Replaced by the name of the document after reopening.
  • DataLast Modified By (String): Author name.
  • DataLast Modified Date (String): Automatic date stamp (read-only).
  • DataLicense (String): License type.
  • DataLicense URL (String): License URL.
  • Data (Hidden)Material (Map): Map with material properties.
  • Data (Hidden)Meta (Map): Map with additional meta information.
  • DataShow Hidden (Bool): If true, items that have been hidden in the Tree view will be displayed anyway. Hiding items in the tree can be useful when working on larger models.
  • DataTip (Link): Not implemented yet.
  • DataTip Name (String): Not implemented yet.
  • DataTransient Dir (String): The transient directory used for recovery data (read-only).
  • Data (Hidden)Uid (UUID): UUID of the document (read-only).
  • DataUnit System (Enumeration): The document unit system. Initial value depends on the Default unit system. introduced in version 1.0

Scripting

See also: FreeCAD Scripting Basics.

To create a new document use the newDocument([name], [hidden=False]) method of the FreeCAD application. The document name must be unique, which is checked automatically. If no name is supplied, the document will be named "Untitled". If hidden=True is used, the new document won't be displayed in the GUI and no tab will appear for it.

import FreeCAD
from pathlib import Path

# The folder and filename we will use:
fld = 'D:/testfiles/'
fnm = fld + 'test.FCStd'

# Make sure fld exists:
Path(fld).mkdir(parents=True, exist_ok=True)

doc = FreeCAD.newDocument()
doc.saveAs(fnm)

FreeCAD.closeDocument(doc.Name)

doc = FreeCAD.open(fnm)
doc.save()

FreeCAD.closeDocument(doc.Name)