void |
appendInfobar( |
[in] string |
id, |
| [in] string |
primaryMessage, |
| [in] string |
secondaryMessage, |
| [in] long |
infobarType, |
| [in] sequence< ::com::sun::star::beans::StringPair > |
actionButtons, |
| [in] boolean |
showCloseButton ) |
raises( |
::com::sun::star::lang::IllegalArgumentException ); |
- Description
- Creates and displays a new Infobar.
- Parameter id
- The ID by which this Infobar is recognized.
You can remove the Infobar afterwards using this ID.
- Parameter primaryMessage
- The (short) primary message.
Will appear at the start of the infobar in bold letters.
May be empty.
- Parameter secondaryMessage
- The (longer) secondary message.
Will appear in normal letters after the primaryMessage
- Parameter infobarType
- The type of the Infobar.
See com::sun::star::frame::InfobarType for possible values.
- Parameter actionButtons
- A sequence of action buttons.
The buttons will be added from Right to Left at the right side of the info bar.
Each button is represented by a com::sun::star::beans::StringPair.
StringPair::First represents the button label, while
StringPair::Second represents the button URL which will be called on button click.
The URL can be any URL, either external (http://libreoffice.org), or internal (.uno:Save),
or from your extension (service:your.example.Extension?anyAction).
- Parameter showCloseButton
- Whether the Close (x) button is shown at the end of the Infobar.
Set to false, when you don't want the user to close the Infobar.
- Throws
- com::sun::star::lang::IllegalArgumentException
If an Infobar with the same ID already exists, or infobarType contains an invalid value.
|