Summary
The URL, the description, the arguments, the result information, and the related information (which can be gotten from the command execution) of the UNO dispatch command, '.uno:CompareDocuments', are described.
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.
Introduction
'Orientation' is meant for the passersby who don't stand in 'Starting Context' and/or aren't enthusiastic about 'Target Context'. It doesn't contain any new technical information and can be skipped by anyone who doesn't need any orientation.
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 and the list for Calc of the UNO dispatch commands listed so far in this series.
Main Body
1: The Specifications
URL: .uno:CompareDocuments
Description: This command compares the current document with the specified document file and keeps recording the changes to the current document thereafter. If the current document has been being already tracked, the user will be asked whether he or she wants to end the existing tracking first and proceed with the processing, or wants to continue the existing tracking and cancel the processing.
Arguments (the types are UNO datum types):
| Name | Type | Value |
|---|---|---|
| URL | string | The URL of the document file to be compared with the current document |
| FilterName | string | The name of the filter for the document file to be compared with the current document: "DIF", "HTML (StarCalc)", "OpenDocument Spreadsheet Flat XML", "MS Excel 97", "MS Excel 97 Vorlage/Template", "SYLK", "Text - txt - csv (StarCalc)", "dBase", "calc8", "calc8_template", "Calc MS Excel 2007 XML", "Calc MS Excel 2007 VBA XML", "Calc Office Open XML". This argument usually does not need to be specified because the filter is automatically detected. |
| Password | string | The password for the document file to be compared with the current document. However, any file with any password cannot be used as for LibreOffice 6.0.6.2, because of a bug (probably). |
| FilterOptions | string | The options for the specified filter. This argument does not need to be specified for many filters including "calc8", "Calc MS Excel 2007 XML", and "MS Excel 97". Which filters require some options or exact data to be specified for those filters have not been investigated. |
| Version | short | The version in the document file to be compared with the current document. Such versions can be created by the 'File' -> 'Versions...' menu item of LibreOffice for some document formats including 'ODF Spreadsheet'. |
| NoAcceptDialog | boolean | This argument is ignored. |
The related information (the value of com.sun.star.frame.FeatureStateEvent.State) (the types are UNO datum types):
Nothing.
The result information (the value of com.sun.star.frame.DispatchResultEvent.Result) (the type is a UNO datum type):
| If | Type | Value |
|---|---|---|
| The command execution succeeded | long | The result status (always 0) |
| Otherwise | N/A | void |
<The previous article in this series | The table of contents of this series | The next article in this series>
