LibreOffice 6.4 SDK API Reference
Public Member Functions | List of all members
XDispatchHelper Interface Referencepublished

provides an easy way to dispatch functions useful at UI level. More...


Inheritance diagram for XDispatchHelper:
XInterface DispatchHelper

Public Member Functions

any executeDispatch ([in] XDispatchProvider DispatchProvider, [in] string URL, [in] string TargetFrameName, [in] long SearchFlags, [in] sequence< com::sun::star::beans::PropertyValue > Arguments)
 executes the dispatch. More...
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
void acquire ()
 increases the reference counter by one. More...
void release ()
 decreases the reference counter by one. More...

Detailed Description

provides an easy way to dispatch functions useful at UI level.

See also
OOo 1.1.2

Member Function Documentation

◆ executeDispatch()

any executeDispatch ( [in] XDispatchProvider  DispatchProvider,
[in] string  URL,
[in] string  TargetFrameName,
[in] long  SearchFlags,
[in] sequence< com::sun::star::beans::PropertyValue Arguments 

executes the dispatch.

Listeners are not supported here!

DispatchProviderpoints to the provider, which should be asked for valid dispatch objects
URLdescribes the feature which should be supported by internally used dispatch object
TargetFrameNamespecifies the frame which should be the target for this request
SearchFlagsoptional search parameter for finding the frame if no special TargetFrameName was used
Argumentsoptional arguments for this request They depend on the real implementation of the dispatch object.
A possible result of the executed internal dispatch. The information behind this any depends on the dispatch!
See also

The documentation for this interface was generated from the following file: