SSM_BEFOREUSERSORT Message
Applies To
fpSpread control
Description
Sent to the owner of the fpSpread control when one of the following occurs:
- The user clicks a column header
- The SSSetColUserSortIndicator function's ColUserSortIndicator parameter is set to either 1 (SS_COLUSERSORTINDICATOR_ASCENDING) or 2 (SS_COLUSERSORTINDICATOR_DESCENDING) for a column
and the SSSetUserColAction function's UserColAction parameter is set to either 1 (SS_USERCOLACTION_SORT) or 2 (SS_USERCOLACTION_SORTNOINDICATOR).
Parameters
The following parameters are available:
| Parameter | Description |
|---|---|
| wParam | Spread control ID |
| lParam | Pointer to SS_BEFOREUSERSORT structure |
Remarks
The SSM_BEFOREUSERSORT message uses the SS_BEFOREUSERSORT structure to return the column on which the sort will occur, the type of sort that will occur, and whether automatic or manual sorting will occur or whether sorting will be canceled.
After sorting is completed, the SSM_AFTERUSERSORT message is sent.
Return Value
None
See Also
SSSetColUserSortIndicator, SSSetUserColAction functions
SSM_AFTERUSERSORT message
SS_BEFOREUSERSORT structure