LibreOffice
LibreOffice 7.2 SDK API Reference
Included Services | Public Attributes | List of all members
SheetSortDescriptor2 Service Referencepublished

a description of how a cell range is to be sorted. More...

import"SheetSortDescriptor2.idl";

Inheritance diagram for SheetSortDescriptor2:
TableSortDescriptor2 SortDescriptor2

Included Services

service com::sun::star::table::TableSortDescriptor2
 provides common sorting properties. More...
 
- Included Services inherited from TableSortDescriptor2
service com::sun::star::util::SortDescriptor2
 

Public Attributes

boolean BindFormatsToContent
 specifies if cell formats are moved with the contents they belong to. More...
 
boolean IsUserListEnabled
 specifies if a user defined sorting list is used. More...
 
long UserListIndex
 specifies which user defined sorting list is used. More...
 
boolean CopyOutputData
 specifies if the sorted data should be copied to another position in the document. More...
 
com::sun::star::table::CellAddress OutputPosition
 specifies the position where sorted data are to be copied. More...
 
boolean ContainsHeader
 specifies whether the first row or column (depending on com::sun::star::table::TableSortDescriptor::Orientation) is a header which should not be sorted. More...
 
- Public Attributes inherited from TableSortDescriptor2
long MaxSortFieldsCount
 contains the maximum number of sort fields the descriptor can hold. More...
 
boolean IsSortColumns
 specifies if the columns or rows are to be sorted. More...
 

Additional Inherited Members

- Public Types inherited from TableSortDescriptor2
typedef sequence< com::sun::star::table::TableSortFieldSortFields
 specifies a list of individual sort fields. More...
 

Detailed Description

a description of how a cell range is to be sorted.

This service extends the com::sun::star::table::TableSortDescriptor2 service with spreadsheet specific properties.

Since
OOo 1.1.2
Developers Guide
Spreadsheets - Sorting - Table Sort Descriptor

Exported Interfaces

◆ com::sun::star::table::TableSortDescriptor2

provides common sorting properties.

The fields in the SortFields property are not fully supported at the moment. IsCaseSensitive, CollatorLocale and CollatorAlgorithm are only supported once and if every field contains different of this it gives undefined results.

Member Data Documentation

◆ BindFormatsToContent

boolean BindFormatsToContent
property

specifies if cell formats are moved with the contents they belong to.

◆ ContainsHeader

boolean ContainsHeader
property

specifies whether the first row or column (depending on com::sun::star::table::TableSortDescriptor::Orientation) is a header which should not be sorted.

◆ CopyOutputData

boolean CopyOutputData
property

specifies if the sorted data should be copied to another position in the document.

◆ IsUserListEnabled

boolean IsUserListEnabled
property

specifies if a user defined sorting list is used.

◆ OutputPosition

com::sun::star::table::CellAddress OutputPosition
property

specifies the position where sorted data are to be copied.

This property is only used, if SheetSortDescriptor::CopyOutputData is TRUE.

◆ UserListIndex

long UserListIndex
property

specifies which user defined sorting list is used.

This property is only used, if SheetSortDescriptor::IsUserListEnabled is TRUE.


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