2021-08-15

205: The Application Foundations '.uno:ExportToPDF'

<The previous article in this series | The table of contents of this series | The next article in this series>

A UNO dispatch command that shows the dialog for exporting the document to the specified PDF file

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:ExportToPDF

Description: This command shows the dialog for exporting the document to the specified PDF file.

Arguments (the types are UNO datum types):

NameTypeValue
URLstringthe URL of the file for the document to be exported to
FilterNamestringthe 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

The related information (the value of com.sun.star.frame.FeatureStateEvent.State) (the types are UNO datum types):

TypeValue
N/Avoid
N/Avoid (this 2nd piece appears only if the export has not been canceled)

The result information (the value of com.sun.star.frame.DispatchResultEvent.Result) (the type is a UNO datum type):

IfTypeValue
the export has not been canceledboolean'true'
otherwiseN/Avoid

<The previous article in this series | The table of contents of this series | The next article in this series>