src/ExchangePlugin/doc/exportFeature.rst

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