A UNO dispatch command that shows the dialog for exporting the document to the specified file of the specified format or directly does the export
Topics
About: UNO (Universal Network Objects)
About: LibreOffice
About: Apache OpenOffice
The table of contents of this article
Starting Context
- The reader has knowledge of what 'UNO dispatch command' is and how to call one (if the URL and the arguments of the command are clear).
Target Context
- The reader will know the specifications of the UNO dispatch command.
Orientation
There are some articles that explain how to execute any UNO dispatch commands and get the whole available information from the execution, in Java, in C++, in C#, in Python, and in LibreOffice or Apache OpenOffice Basic.
There are the list for the application foundations, the list for Writer, and the list for Calc of the UNO dispatch commands listed so far in this series.
Main Body
1: The Specifications
URL: .uno:ExportTo
Description: This command shows the dialog for exporting the document to the specified file of the specified format or directly does the export, depending on whether the format requires such a dialog to be configured with or not.
Arguments (the types are UNO datum types):
| Name | Type | Value |
|---|---|---|
| URL | string | the URL of the file for the document to be exported to |
| FilterName | string | the filter name: 'writer_pdf_Export' -> from Writer to PDF, 'calc_pdf_Export' from Calc to PDF, 'impress_pdf_Export' from Impress to PDF, 'draw_pdf_Export' -> from Draw to PDF, 'EPUB' -> to EPUB, 'XHTML Writer File' -> from Writer to XHTML, 'XHTML Calc File' -> from Calc to XHTML, 'XHTML Impress File' -> from Impress to XHTML, 'XHTML Draw File' -> from Draw to XHTML, 'writer_jpg_Export' -> from Writer to JPEG, 'calc_jpg_Export' from Calc to JPEG, 'impress_jpg_Export' from Impress to JPEG, 'draw_jpg_Export' -> from Draw to JPEG, 'writer_png_Export' -> from Writer to PNG, 'calc_png_Export' from Calc to PNG, 'impress_png_Export' from Impress to PNG, 'draw_png_Export' -> from Draw to PNG, 'writer_layout_dump' -> from Writer to Writer Layout |
| Overwrite | boolean | This argument does not seem effective. |
| FilterOptions | string | The filter options string for the specified filter |
| SaveACopy | boolean | This argument does not seem effective. |
The related information (the value of com.sun.star.frame.FeatureStateEvent.State) (the types are UNO datum types):
| Type | Value |
|---|---|
| N/A | void |
The result information (the value of com.sun.star.frame.DispatchResultEvent.Result) (the type is a UNO datum type):
| If | Type | Value |
|---|---|---|
| the export was a success | boolean | 'true' |
| otherwise | N/A | void |
<The previous article in this series | The table of contents of this series | The next article in this series>
