Top   Module   Use   Manual   Index 
 INCLUDED SERVICES | EXPORTED INTERFACES | PROPERTIES' SUMMARY | PROPERTIES' DETAILS 

com :: sun :: star :: sheet ::

service SheetSortDescriptor

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


Included Services

com::sun::star::util::SortDescriptor
Description
specifies the properties which can be used to describe a sort order applied to an XSortable.

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.

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 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 is only used if UseOutputPosition is true .


Top of Page