Std New/en: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
<languages/>
<languages/>
{{Docnav
{{UnfinishedDocu{{#translation:}}}}
|
|[[Std_Open|Open]]
|[[Std_File_Menu|Std File Menu]]
|IconL=
|IconR=Std_Open.svg
|IconC=Freecad.svg
}}

{{GuiCommand
{{GuiCommand
|Name=Std New
|Name=Std New
|MenuLocation={{StdMenu|[[Std_File_Menu|File]]}} → New
|MenuLocation=File → New
|Workbenches=All
|Workbenches=All
|Shortcut={{KEY|Ctrl}}+{{KEY|N}}
|Shortcut={{KEY|Ctrl}}+{{KEY|N}}
|SeeAlso=[[Std Open]], [[Std Import]]
|SeeAlso=[[Std_Open|Std Open]], [[Std_Import|Std Import]]
}}
}}


==Description==
==Description==

Creates a new empty document. FreeCAD can also be configured to automatically create a new empty document on startup. This can be done by checking the appropriate setting in {{MenuCommand|Edit → Preferences → General → Document tab}}.
The '''Std New''' command creates a new empty document and makes it the active document.


==Usage==
==Usage==

# Invoke the command several ways:
# There are several ways to invoke the command:
#* Pressing the {{KEY|[[File:Std_New.svg|16px|Std New|link=Std New]] [[Std New|Std New]]}} button in the toolbar
#* Press the {{Button|[[Image:Std_New.svg|16px]] [[Std_New|Std New]]}} button.
#* Using the {{KEY|Ctrl}}+{{KEY|N}} keyboard shortcut
#* Using the {{MenuCommand|{{StdMenu|[[Std_File_Menu|File]]}} → New}} entry in the File menu
#* Select the {{MenuCommand|File → [[Image:Std_New.svg|16px]] New}} option from the menu.
#* Use the keyboard shortcut: {{KEY|Ctrl}}+{{KEY|N}}.

==Preferences==

* FreeCAD will create a new document at start up if {{MenuCommand|Tools → Edit parameters... → BaseApp → Preferences → Document → CreateNewDoc}} is set to {{TRUE}}. This setting can also be changed in the [[Preferences_Editor#Document|Preferences Editor]].
* Some document properties: author names, company name and license information, can be preset in the [[Preferences Editor#Document|Preferences Editor]].

==Properties==

Most properties can also be changed in the dialog box of the [[Std_ProjectInfo|Std ProjectInfo]] command.

* {{PropertyData|Comment}}: Any comment that may apply.
* {{PropertyData|Company}}: Company name. {{Emphasis|Can be preset}}.
* {{PropertyData|Created By}}: Author name. {{Emphasis|Can be preset}}.
* {{PropertyData|Creation Date}}: Automatic date stamp. {{Emphasis|Not editable}}.
* {{PropertyData|File Name}}: The full path of the file. Blank if the document has not been saved. {{Emphasis|Not editable}}.
* {{PropertyData|Id}}: Not implemented yet.
* {{PropertyData|Label}}: The name that will appear in the [[Tree_view|Tree view]]. By default the name of the document.
* {{PropertyData|Last Modified By}}: Author name. {{Emphasis|Can be preset}}.
* {{PropertyData|Last Modified Date}}: Automatic date stamp. {{Emphasis|Not editable}}.
* {{PropertyData|License}}: License type. {{Emphasis|Can be preset}}.
* {{PropertyData|License URL}}: License URL. {{Emphasis|Can be preset}}.
* {{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|Tip Name}}: Not implemented yet.
* {{PropertyData|Transient Dir}}: The transient directory used for recovery data. {{Emphasis|Not editable}}.


==Scripting==
==Scripting==


{{Emphasis|See also:}} [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].
{{clear}}


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.
{{Std Base navi{{#translation:}}}}


{{Code|code=
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)
}}


{{Docnav
|
|[[Std_Open|Open]]
|[[Std_File_Menu|Std File Menu]]
|IconL=
|IconR=Std_Open.svg
|IconC=Freecad.svg
}}

{{Std Base navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Latest revision as of 03:51, 4 February 2021

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.

  • DataComment: Any comment that may apply.
  • DataCompany: Company name. Can be preset.
  • DataCreated By: Author name. Can be preset.
  • DataCreation Date: Automatic date stamp. Not editable.
  • DataFile Name: The full path of the file. Blank if the document has not been saved. Not editable.
  • DataId: Not implemented yet.
  • DataLabel: The name that will appear in the Tree view. By default the name of the document.
  • DataLast Modified By: Author name. Can be preset.
  • DataLast Modified Date: Automatic date stamp. Not editable.
  • DataLicense: License type. Can be preset.
  • DataLicense URL: License URL. Can be preset.
  • DataShow Hidden: 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: Not implemented yet.
  • DataTip Name: Not implemented yet.
  • DataTransient Dir: The transient directory used for recovery data. Not editable.

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)