LibreOffice
LibreOffice 24.2 SDK API Reference
Loading...
Searching...
No Matches
TableSortField Struct Referencepublished

describes how to sort a single field (row/column) in a tables sort descriptor. More...

import <TableSortField.idl;

Public Attributes

long Field
 index of the row or column in the table to be sorted; 0-based.
 
boolean IsAscending
 TRUE if data are sorted in ascending order, FALSE if in descending order.
 
boolean IsCaseSensitive
 specifies if the case of letters is important when comparing entries.
 
com::sun::star::table::TableSortFieldType FieldType
 type of contents in the field.
 
com::sun::star::lang::Locale CollatorLocale
 the locale used by the collator when comparing/sorting text.
 
string CollatorAlgorithm
 the algorithm used by the collator when comparing/sorting text.
 

Detailed Description

describes how to sort a single field (row/column) in a tables sort descriptor.

See also
com::sun::star::table::TableSortDescriptor2
Since
OOo 1.1.2

Member Data Documentation

◆ CollatorAlgorithm

string CollatorAlgorithm

the algorithm used by the collator when comparing/sorting text.

This property will not be used when the "FieldType" is com::sun::star::table::TableSortFieldType::NUMERIC

See also
com::sun::star::i18n::XCollator

◆ CollatorLocale

the locale used by the collator when comparing/sorting text.

This property will not be used when the "FieldType" is com::sun::star::table::TableSortFieldType::NUMERIC

See also
com::sun::star::i18n::XCollator

◆ Field

long Field

index of the row or column in the table to be sorted; 0-based.

◆ FieldType

type of contents in the field.

If the value is com::sun::star::table::TableSortFieldType::AUTOMATIC the algorithm used for sorting is application specific. Especially it may or may not use the values given by "CollatorLocale" and "CollatorAlgorithm".

◆ IsAscending

boolean IsAscending

TRUE if data are sorted in ascending order, FALSE if in descending order.

◆ IsCaseSensitive

boolean IsCaseSensitive

specifies if the case of letters is important when comparing entries.


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