LibreOffice: OpenCommandArgument2 Struct Reference

LibreOffice LibreOffice 5.1 SDK API Reference

Public Attributes | List of all members
OpenCommandArgument2 Struct Referencepublished

The argument for commands like "open", "update", and "synchronize". More...

`import"OpenCommandArgument2.idl";`

Inheritance diagram for OpenCommandArgument2:

## Public Attributes
sequence< com::sun::star::ucb::NumberedSortingInfo > | SortingInfo
| The sort criteria for the rows of the returned ContentResultSet. More...
Public Attributes inherited from OpenCommandArgument
long | Mode
| A mode. More...
long | Priority
| The command's priority, in the range `0` (highest) to `65535` (lowest). More...
com::sun::star::uno::XInterface | Sink
| The data sink to write the contents into (supporting either com::sun::star::io::XActiveDataSink, com::sun::star::io::XOutputStream or com::sun::star::io::XActiveDataStreamer). More...
sequence< com::sun::star::beans::Property > | Properties
| The properties, for that the values shall be provided by the DynamicResultSet returned by the command). More...

## Detailed Description

The argument for commands like "open", "update", and "synchronize".

This struct extends the original OpenCommandArgument, which must not be changed for compatibility reasons.

See also
  XCommandProcessor

Developers Guide
  UCB - Folders - Accessing the Children of a Folder

## Member Data Documentation

## § SortingInfo

sequence< com::sun::star::ucb::NumberedSortingInfo > SortingInfo

The sort criteria for the rows of the returned ContentResultSet.

The result set implementation may ignore this parameter, if it cannot sort the data by the given criteria in an efficient way (i.e. directly using the underlying data source -> SQL-database -> ORDER BY).

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

- com/sun/star/ucb/OpenCommandArgument2.idl