Std Open: Difference between revisions

From FreeCAD Documentation
(hidden=True option for App.openDocument())
(Migrated info from FreeCAD_API)
Line 52: Line 52:


<!--T:18-->
<!--T:18-->
To open a document use the {{incode|open}} method of the FreeCAD application or its {{incode|openDocument([hidden{{:=}}False])}} method. If {{incode|hidden{{:=}}True}} is used, the new document be displayed in the GUI and no tab will appear for that document. For a scripting example see [[Std_New|Std New]].
To open a document use the {{incode|open(filepath)}} method of the FreeCAD application or its {{incode|openDocument(filepath, [hidden{{:=}}False])}} method.

These methods create and return a document and load a project file into the document. The {{incode|filepath}} argument must be a string pointing to an existing file. If the file doesn't exist or the file cannot be loaded an I/O exception is thrown. In this case the created document is kept, but will be empty. If hidden=True is passed, the document won't be displayed by the GUI there no tab will appear for the document; this allows performing automatic operations on a document and close it without disrupting the user interface.

For a scripting example see [[Std_New|Std New]].


<!--T:19-->
<!--T:19-->

Revision as of 22:14, 20 January 2021

Std Open

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

Description

The Std Open command opens a file. If the file is not a native FreeCAD file (*.FCStd) its geometry will be imported into a new document. See Std Import for more information.

Usage

  1. There are several ways to invoke the command:
    • Press the Std Open button.
    • Select the File → Open... option from the menu.
    • Use the keyboard shortcut: Ctrl+O.
  2. Optionally select the correct file format in the dialog box.
  3. Select a file.
  4. Press the Open button.

Options

  • Press Esc or the Cancel button to abort the command.

Preferences

  • The last used file location is stored: Tools → Edit parameters... → BaseApp → Preferences → General → FileOpenSavePath.

Scripting

See also: FreeCAD Scripting Basics.

To open a document use the open(filepath) method of the FreeCAD application or its openDocument(filepath, [hidden=False]) method.

These methods create and return a document and load a project file into the document. The filepath argument must be a string pointing to an existing file. If the file doesn't exist or the file cannot be loaded an I/O exception is thrown. In this case the created document is kept, but will be empty. If hidden=True is passed, the document won't be displayed by the GUI there no tab will appear for the document; this allows performing automatic operations on a document and close it without disrupting the user interface.

For a scripting example see Std New.