Std New: Difference between revisions

From FreeCAD Documentation
(<nowiki>=</nowiki> Instead of {{:=}})
(Properties)
Line 43: Line 43:
<!--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===

{{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|0.22}}


==Scripting== <!--T:15-->
==Scripting== <!--T:15-->

Revision as of 19:23, 20 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 Std New button.
    • Select the File → New option from the menu.
    • Use the keyboard shortcut: Ctrl+N.

Preferences

  • FreeCAD will create a new document at start up if Tools → Edit parameters... → BaseApp → Preferences → Document → CreateNewDoc is set to true. This setting can also be changed in the Preferences Editor.
  • Some document properties: author names, company name and license information, can be preset in the Preferences Editor.

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 0.22

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)