2019-09-15

71: The UNO Dispatch Command Specifications of '.uno:StateTableCell'

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

Description: This command gets the average and the sum of the currently selected non-string cells as the related information of this command. Any date cell is treated as a number in which '1899-12-30' is '0', '1899-12-31' is '1', and so on; any date and time cell is treated as a number in which '1899-12-30T00:00:00' is '0.0', '1899-12-31T00:00:00' is '1.0', and so on; any time cell is treated as a number in which '00:00:00' is '0.0' and '24:00:00' is '1.0'; any boolean cell is a number in which 'TRUE' is '1.0' and 'FALSE' is '0.0'; any string cell is ignored. The average and the sum in the related information are shown in the format of the current cell unless the current cell is a string cell (as an exception, if the current cell is a 'FALSE' cell and the all the other selected cells (the current cell may be selected or not be selected) are string cells, they are shown as numbers); if the current cell is a string cell, they are shown as numbers.

Arguments (the types are UNO datum types):

Nothing.

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

TypeValue
stringThe average and the sum of the currently selected non-string cells, in the form of 'Average: %the average%; Sum: %the sum%'. The average and the sum are shown in the format of the current cell unless the current cell is a string cell (as an exception, if the current cell is a 'FALSE' cell and the all the other selected cells (the current cell may be selected or not be selected) are string cells, they are shown as numbers); if the current cell is a string cell, they are shown as numbers.

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>