Class DispatchPartial

class ooodev.utils.partial.dispatch_partial.DispatchPartial(lo_inst, events=None)

Parameters:

• lo_inst (LoInst) –

• events (EventsT | None) –

__init__(lo_inst, events=None)

Parameters:

• lo_inst (LoInst) –

• events (EventsT | None) –

dispatch_cmd(cmd: str) → Any

dispatch_cmd(cmd: str, props: Iterable[com.sun.star.beans.PropertyValue]) → Any

dispatch_cmd(cmd: str, props: Iterable[com.sun.star.beans.PropertyValue], frame: com.sun.star.frame.XFrame) → Any

dispatch_cmd(cmd: str, *, frame: com.sun.star.frame.XFrame) → Any

dispatch_cmd(cmd, props=None, frame=None)

Dispatches a LibreOffice command.

Parameters:

• cmd (str) – Command to dispatch such as GoToCell. Note: cmd does not contain .uno: prefix.

• props (PropertyValue, optional) – properties for dispatch.

• frame (XFrame, optional) – Frame to dispatch to.

Raises:

• CancelEventError – If Dispatching is canceled via event.

• DispatchError – If any other error occurs.

Returns:

A possible result of the executed internal dispatch. The information behind this any depends on the dispatch!

Return type:

Any

Events:

• DISPATCHING Standard Cancel Event

• DISPATCHED Standard Event

Note

There are many dispatch command constants that can be found in dispatch Namespace

DISPATCHING Event args data contains any properties passed in via props.

DISPATCHED Event args data contains any results from the dispatch commands.

See also

• 4.5 Dispatching

• LibreOffice Dispatch Commands