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:Notebookbar', 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:Notebookbar
Description: This command sets the current notebook bar ('notebook bar' is an experimental new tool bar) configuration file name and redraws the notebook bar according to the configuration file. The experimental feature is enabled by selecting the 'Tools' -> 'Options...' menu item; selecting 'LibreOffice' -> 'Advanced' in the left pane in the 'Options' dialog; checking the 'Enable experimental features (may be unstable)' checkbox; selecting the 'View' -> 'Toolbar Layout' -> 'Notebookbar' menu item.
Arguments (the types are UNO datum types):
| Name | Type | Value |
|---|---|---|
| File | string | The name of the configuration file (not the full path, but just the file name), which has to exist in the 'share/config/soffice.cfg/modules/scalc/ui' directory under the LibreOffice install directory (be careful not to specify any wrong name as that makes the LibreOffice process abort and renders Calc unusable thereafter, although the setting is, in fact, stored in the '~/.config/libreoffice/4/user/registrymodifications.xcu' file, and removing the setting from the file rectifies the problem) |
The related information (the value of com.sun.star.frame.FeatureStateEvent.State) (the types are UNO datum types):
| Type | Value |
|---|---|
| boolean | 'true' (this status change occurs only at the first time that this dispatch command is successfully called after the 'Enable experimental features (may be unstable)' option is enabled) |
| boolean | 'false' if the current tool bar is not any notebook bar; 'true' if the current tool bar is a notebook bar. |
The result information (the value of com.sun.star.frame.DispatchResultEvent.Result) (the type is a UNO datum type):
| Type | Value |
|---|---|
| N/A | void |
<The previous article in this series | The table of contents of this series | The next article in this series>
