A UNO dispatch command that gets the sum of the allowed search option flags for the document
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.
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, the list for Writer, and the list for Calc of the UNO dispatch commands listed so far in this series.
Main Body
1: The Specifications
URL: .uno:SearchOptions
Description: This command gets the sum of the allowed search option ('search', 'search all', 'replace', 'replace all', 'regular expression search', 'backward search', etc.) flags for the document, as the related information of this command.
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):
| Type | Value |
|---|---|
| long | The sum of the allowed search option ('search', 'search all', 'replace', 'replace all', 'regular expression search', 'backward search', etc.) flags for the document; in fact, it is '8191' (meaning all the options) for any editable document or '8179' (meaning all the options except 'replace' and 'replace all') for any read-only document. |
The result information (the value of com.sun.star.frame.DispatchResultEvent.Result) (the type is a UNO datum type):
| Type | Value |
|---|---|
| N/A | null |
<The previous article in this series | The table of contents of this series | The next article in this series>
