2020-06-21

134: The UNO Dispatch Command Specifications of '.uno:UnderlineDotted'

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

Description: This command toggles on-off the current dotted-underline status, which is about what is currently the target of the status. If a single cell is selected or the current cell without any cell selection in the whole-cell-has-focus mode, the cell is the target, but if some multiple cells are selected, the whole of the selected cells is the target (the current status is 'off' unless all the selected cells are in the 'on' status); if some characters in a cell or an object are selected, the whole of the characters is the target (the current status is 'off' unless all the selected characters are in the 'on' status); if the text cursor is in a word without any selection, the word is the target.

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
N/A or booleanif the previous status was 'off', 'void'; otherwise, the previous status ('true' -> 'on')
boolean or N/Aif the new status is 'on', the new status ('true' -> 'on'); otherwise, 'void'

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>