]> SALOME platform Git repositories - modules/shaper.git/blobdiff - src/ExchangePlugin/doc/exportFeature.rst
Salome HOME
Merge branch HELP_DOCUMENTATION_EDITING into master.
[modules/shaper.git] / src / ExchangePlugin / doc / exportFeature.rst
index a007d400b459ed9c8d92a7285606611192ebcd57..922d0d6180164de9581d5eeba894967b1b9346aa 100644 (file)
@@ -1,3 +1,49 @@
 
 Export
 ======
+
+The feature export allows to export objects from the current study to an external file.
+
+It is possible to export objects into files in following formats: BREP, STEP, IGES, XAO. To export objects to a file:
+
+#. select in the Main Menu *Part - > Export* item  or
+#. click **Export** button in the toolbar.
+
+.. image:: images/export.png
+   :align: center
+
+.. centered::
+   **Export**  button
+
+The following property panel will be opened:
+
+.. image:: images/Export_panel.png
+   :align: center
+       
+.. centered::
+   **Export property panel**
+
+In this panel it is necessary to select desirable format of export file. It can be **'BREP, STEP, IGES'** or **'XAO'**. In case of first choice the format of exported file will be defined according to file extension. File name and path can be defined in **Export file** field. It can be typed or browsed with help of **'...'** button which opens **Export file** dialog box:
+
+.. image:: images/ExportFileDlg.png
+   :align: center
+       
+.. centered::
+   **Export file dialog box**
+
+Selection list in property panel should contain a list of exporting objects which can be selected in a viewer or objects browser.
+
+**Apply** button exports the file.
+  
+**Cancel** button cancels operation.
+
+**TUI Command**: *model.exportToFile(Part_doc, FileNameString, ObjectsList)*
+
+**Arguments**: Part + file name string + list of objects.
+
+Result
+""""""
+
+The Result of operation is exported file. There are no any changes in object browser or viewer.
+
+**See Also** a sample TUI Script of a :ref:`tui_export_file` operation.