2018-12-02

15: The UNO Dispatch Command Specifications of '.uno:PasteSpecial'

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

Description: This command pastes the already-has-been-copied datum into the current spread sheet in the specified format.

Arguments (the types are UNO datum types):

NameTypeValue
Formatunsigned longThe identification number of the format in which the has-been-already-copied datum is pasted: 1 -> plain string, 2 -> bitmap, 3 -> GDI meta file, 10 -> rich text, 11 -> drawing, 12 -> StarView bitmap/animation, 51 -> HTML, 59 -> link, 141 -> PNG, etc. When a number not supported by the datum is specified, a dialog on which the user can choose a format is showed.

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

TypeValue
longThe result status : 1 -> the pasting has been performed, 0 -> the pasting is canceled after a dialog is shown

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