2019-01-20

22: The UNO Dispatch Command Specifications of '.uno:ScenarioManager'

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

Description: This command creates a scenario (which is created with all the options ("Display border", "Copy back", "Copy entire sheet", and "Prevent changes") off) or show the scenario creation dialog, for the selected cells range (which has to consist of multiple cells) if the selected cells range is not on any scenario sheet (which is a sheet created by creating a scenario with the "copy entire sheet" option on), or extends the scenario of the scenario sheet of the selected cells range if the selected cells range (which has to consist of multiple cells) is on a scenario sheet.

Arguments (the types are UNO datum types):

NameTypeValue
NamestringThe name of the scenario to be created. If there already exists a scenario of the name, the new scenario will be created with an automatic name. In order to show the scenario creation dialog or extend a scenario, no argument (including this one) should be specified.
CommentstringThe comment of the scenario to be created. In order to show the scenario creation dialog or extend a scenario, no argument (including this one) should be specified.

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>