Vcl.ComCtrls.TTreeNodes.CustomSort

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

function CustomSort(SortProc: TTVCompare; Data: NativeInt; ARecurse: Boolean = False): Boolean;

C++

bool __fastcall CustomSort(PFNTVCOMPARE SortProc, NativeInt Data, bool ARecurse = false);

Propriétés

Type Visibilité  Source Unité  Parent
function public
Vcl.ComCtrls.pas
Vcl.ComCtrls.hpp
Vcl.ComCtrls TTreeNodes

Description

Trie les noeuds de l'arborescence.

CustomSort déclenche le tri des noeuds, en utilisant une routine de comparaison indiquée par le paramètre SortProc. Le paramètre Data est passé à la routine de comparaison. Le paramètre facultatif ARecurse (false par défaut) spécifie que le tri doit descendre l'arborescence de façon récursive et trier chaque sous-arborescence à son tour.

Si SortProc vaut nil (Delphi) ou NULL (C++), une routine de comparaison par défaut est utilisée. La routine par défaut utilise le gestionnaire d'événement OnCompare de l'objet TCustomTreeView associé, s'il est défini. Si le gestionnaire d'événement OnCompare n'est pas défini, la routine par défaut utilise une simple comparaison des libellés de noeuds sensible à la casse.

Dans la routine de comparaison, les paramètres IParam1 et IParam2 font référence à deux noeuds au transtypage vers TTreeNode. Le paramètre lParamSort est la valeur précédemment passée au paramètre Data de CustomSort. La valeur renvoyée par la routine de comparaison indique l'ordre de tri relatif de IParam1 et IParam2.



Valeur renvoyée Signification

< 0

IParam1 est avant IParam2

0

IParam1 et IParam2 sont équivalents

> 0

IParam2 est avant IParam1



Voir aussi