Overview | Module | Use | Devguide | Index

Included Services | Exported Interfaces | Properties' Summary | Properties' Details

:: com :: sun :: star :: sheet ::
service SheetSortDescriptor2
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 version OpenOffice.org 1.1.1 Developers Guide 8.3.4 Spreadsheet Documents - Working with Spreadsheet Documents - Sorting - Table Sort Descriptor

Included Services
::com::sun::star::table::TableSortDescriptor2 | Description 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.

Properties' Summary
BindFormatsToContent | specifies if cell formats are moved with the contents they belong to.
IsUserListEnabled | specifies if a user defined sorting list is used.
UserListIndex | specifies which user defined sorting list is used.
CopyOutputData | specifies if the sorted data should be copied to another position in the document.
OutputPosition | specifies the position where sorted data are to be copied.
ContainsHeader | specifies whether the first row or column (depending on ::com::sun::star::table::TableSortDescriptor::Orientation ) is a header which should not be sorted.

Properties' Details
BindFormatsToContent
boolean BindFormatsToContent; Description specifies if cell formats are moved with the contents they belong to.
IsUserListEnabled
boolean IsUserListEnabled; Description specifies if a user defined sorting list is used.
UserListIndex
long UserListIndex; Description specifies which user defined sorting list is used. This property is only used, if SheetSortDescriptor::IsUserListEnabled is true .
CopyOutputData
boolean CopyOutputData; Description specifies if the sorted data should be copied to another position in the document.
OutputPosition
::com::sun::star::table::CellAddress OutputPosition; Description specifies the position where sorted data are to be copied. This property is only used, if SheetSortDescriptor::CopyOutputData is true .
ContainsHeader
boolean ContainsHeader; Description specifies whether the first row or column (depending on ::com::sun::star::table::TableSortDescriptor::Orientation ) is a header which should not be sorted.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.