SpreadsheetGetSortInfo (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Spreadsheet functions

Prefix syntax

SpreadsheetGetSortInfo

Presentation

Example

See also

Spreadsheet constants

Spreadsheet functions

SpreadsheetAddData

SpreadsheetAddFormula

SpreadsheetAddImage

SpreadsheetAddName

SpreadsheetAddWorksheet

SpreadsheetAllowProcedure

SpreadsheetBorderSelection

SpreadsheetClose

SpreadsheetControlFormula

SpreadsheetDeleteAll

SpreadsheetDeleteColumn

SpreadsheetDeleteImage

SpreadsheetDeleteName

SpreadsheetDeleteRow

SpreadsheetDeleteWorksheet

SpreadsheetEndModification

SpreadsheetFreeze

SpreadsheetGetFormula

SpreadsheetGetMerge

SpreadsheetGetSelection

SpreadsheetGetSortInfo

SpreadsheetInputFunction

SpreadsheetInsertColumn

SpreadsheetInsertRow

SpreadsheetInsertWorksheet

SpreadsheetListComment

SpreadsheetListImage

SpreadsheetListName

SpreadsheetListWorksheet

SpreadsheetLoad

SpreadsheetMergeCell

SpreadsheetModifyName

SpreadsheetMoveWorksheet

SpreadsheetPosition

SpreadsheetRecalculateAll

SpreadsheetReplace

SpreadsheetRestorePositionAndSelection

SpreadsheetSave

SpreadsheetSavePositionAndSelection

SpreadsheetSeek

SpreadsheetSelectComment

SpreadsheetSelectMinus

SpreadsheetSelectPlus

SpreadsheetSelectWorksheet

SpreadsheetSortSelection

SpreadsheetStartModification

SpreadsheetStyleSelection

SpreadsheetTypeAndMaskSelection

psheetSelection

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

SpreadsheetGetSortInfo (Function)

In french: TableurRécupèreInfoTri

Returns various information about the sort performed in a Spreadsheet control.

Example

// Shows the area that will be sorted
sSel is string
sSel = SpreadsheetGetSortInfo(PSHEET_Spreadsheet, psheetInfoSortSelection)
IF sSel = "" THEN
RETURN // not sortable
END
sMin is string = ExtractString(sSel, 1, ":")
sMax is string = ExtractString(sSel, 2, ":")

// Selects the area
SpreadsheetSelectPlus(PSHEET_Spreadsheet, sMin, sMax)

Syntax

<Result> = SpreadsheetGetSortInfo(<Spreadsheet control> , <Type of information>)

<Result>: Character string

Requested information.

<Spreadsheet control>: Control name

Name of the Spreadsheet control to be used.

<Type of information>: Integer constant

Sought information:
psheetInfoSortCriteria Used to find out the last sort criteria used to sort the Spreadsheet control. <Result> has the following format:

"<Name of column1>[;< Option>]" + TAB +
"<Name of column2>" + TAB + ...

where:
<Name of column> is the name of sorted column,
<Option> corresponds to one of the sort constants defined for SpreadsheetSortSelection.
Example: "A<Tab>B;3"
psheetInfoSortSelection Used to know selection that will be sorted by the AAF (Automatic Application Features) for sorting the Spreadsheet control. Example: "A2:B4".
Remark: If the selection does not allow the sort, <Result> corresponds to an empty string ("").
psheetInfoSortWithTitle Used to know whether the selection sorted by the AAF (Automatic Application Features) for sorting the Spreadsheet control contains a title. <Result> can correspond to:
1 if the selection to sort includes a title,
0 otherwise.

Component: wd280obj.dll