2018-12-16

17: The UNO Dispatch Command Specifications of '.uno:MergeDocuments'

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


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:MergeDocuments', 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:MergeDocuments

Description: This command merges the specified document file, which is supposed to a derivative of the current document and has recorded the changes from the current document, into the current document and keeps recording the changes to the current document thereafter.

Arguments (the types are UNO datum types):

NameTypeValue
URLstringThe URL of the document file to be merged into the current document
VersionshortThe version in the document file to be merged into the current document. Such versions can be created by the 'File' -> 'Versions...' menu item of LibreOffice for some document formats including 'ODF Spreadsheet'.

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

IfTypeValue
The command execution succeededlongThe result status (always 0)
OtherwiseN/Avoid

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