2019-09-08

70: The UNO Dispatch Command Specifications of '.uno:Delete'

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

Description: There are 3 different behaviors according to the editing mode of the spread sheet. When it is in the whole-cell-has-focus mode, this command deletes the specified (by the cell types) cell contents and the specified cell properties (the comments and/or the formats) of the selected cells (focus can be on only a single cell, but some multiple cells can be selected anyway). When it is in the cell-contents-are-edited mode, this command deletes the selected contents. When it is in the non-cell-objects-are-selected mode, this command deletes the selected non-cell-objects.

Arguments (the types are UNO datum types):

If the spread sheet is in the whole-cell-has-focus mode:

NameTypeValue
FlagsstringThe flags that represent what are deleted: 'A' -> all, 'S' -> the text cell contents, 'V' -> the number or boolean cell contents, 'D' -> the date, time, or datetime cell contents, 'F' -> the formulae, 'N' -> the comments, 'T' -> the formats. Multiple flags can be specified like 'SVT'.

Othewise:

Nothing.

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
N/Avoid

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