Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Services' Summary Interfaces' Summary Properties' Summary Services' Details Interfaces' Details 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
OOo 1.1.2
Developers Guide
Spreadsheets - Sorting - Table Sort Descriptor
Included Services - Summary
::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.

Properties' Summary
boolean
BindFormatsToContent		 specifies if cell formats are moved with the contents they belong to.  
boolean
IsUserListEnabled		 specifies if a user defined sorting list is used.  
long
UserListIndex		 specifies which user defined sorting list is used.  
boolean
CopyOutputData		 specifies if the sorted data should be copied to another position in the document.  
::com::sun::star::table::CellAddress
OutputPosition		 specifies the position where sorted data are to be copied.  
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.  
Included Services - Details
::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' 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 © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.