Motive
A UNO dispatch command that sets the specified hyperlink to something that is determined by the current selection.
Topics
About: UNO (Universal Network Objects)
About: LibreOffice
About: Apache OpenOffice
About: Calc
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 and the list for Calc of the UNO dispatch commands listed so far in this series.
Main Body
1: The Specifications
URL: .uno:SetHyperlink
Description: This command sets the specified hyperlink to something that is determined by the current selection. When a string is selected, the string is the something; when the text cursor is in a text area (like inside a cell) without any string selected, the new string inserted before the text cursor is the something; when a graphic object like a shape is selected, the graphic object is the something.
Arguments (the types are UNO datum types):
| Name | Type | Value |
|---|---|---|
| Hyperlink.Text | string | The representative text of the hyperlink |
| Hyperlink.URL | string | The URL of the hyperlink |
| Hyperlink.Target | string | The name of the target frame for opening the hyperlink: the special names like '_top', '_parent', '_blank', and '_self' can be used |
| Hyperlink.Name | string | The name of the hyperlink |
| Hyperlink.Type | short | The representation type of the hyperlink: '1' -> text, '2' -> button |
The related information (the value of com.sun.star.frame.FeatureStateEvent.State) (the types are UNO datum types):
| Type | Value |
|---|---|
| N/A | void |
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>
