src/ExchangePlugin/doc/exportFeature.rst

   1 .. |export.icon|    image:: images/export.png
   2
   3 Export
   4 ======
   5
   6 The  export feature allows exporting objects from the current study to an external file.
   7
   8 It is possible to export objects to files in the following formats: BREP, STEP, IGES, XAO. To export objects to a file:
   9
  10 #. select in the Main Menu *Part - > Export* item  or
  11 #. click |export.icon| **Export** button in the toolbar.
  12
  13 The following property panel will be opened:
  14
  15 .. image:: images/Export_panel.png
  16    :align: center
  17
  18 .. centered::
  19    **Export property panel**
  20
  21 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. The file name and path can be defined in **Export file** field by direct input or browsing with **'...'** button, which opens **Export file** dialog box:
  22
  23 .. image:: images/ExportFileDlg.png
  24    :align: center
  25
  26 .. centered::
  27    **Export file dialog box**
  28
  29 Selection list in the property panel contains a list of exported objects which can be selected in a viewer or object browser.
  30
  31 **Apply** button exports the file.
  32
  33 **Cancel** button cancels the operation.
  34
  35 **TUI Command**:
  36
  37 .. py:function:: model.exportToFile(Part_doc, FileNameString, ObjectsList)
  38
  39     :param part: The current part object
  40     :param string: The file name
  41     :param list: A list of exporting objects
  42
  43 Result
  44 """"""
  45
  46 The Result of operation is an exported file.
  47
  48 **See Also** a sample TUI Script of :ref:`tui_export_file` operation.