Vcl.ComCtrls.TCustomListView.CustomSort

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

function CustomSort(SortProc: TLVCompare; lParam: LPARAM): Boolean;

C++

bool __fastcall CustomSort(PFNLVCOMPARE SortProc, NativeInt lParam);

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
function public
Vcl.ComCtrls.pas
Vcl.ComCtrls.hpp
Vcl.ComCtrls TCustomListView

Beschreibung

Sortiert die Listenelemente unter Verwendung der angegebenen Sortierfunktion.

Mit der Methode CustomSort können Sie die Elemente der Liste mit der im Parameter SortProc festgelegten Funktion sortieren:

 TLVCompare = function(lParam1, lParam2, lParamSort: Integer): Integer stdcall;

Diese Sortierfunktion vergleicht die Listenelemente, die als lParam1 und lParam2 übergeben werden. Die Sortierfunktion gibt einen Integerwert zurück, der angibt, ob lParam1 und lParam2 gleichrangig sind (Rückgabewert 0), ob lParam1 größer als lParam2 ist (Rückgabewert größer als 0) oder ob lParam1 kleiner als lParam2 ist (Rückgabewert kleiner als 0). Der Parameter lParam von CustomSort ist ein optionaler Wert, der als dritter Parameter an die Sortierfunktion übergeben wird.

Hat der Parameter SortProc den Wert nil (Delphi) bzw. NULL (C++), generiert CustomSort das Ereignis OnCompare, um die Listenelemente zu vergleichen. Dadurch können Sie mit einer entsprechenden Ereignisbehandlungsroutine eine andere Sortierreihenfolge basierend auf dem Wert des Parameters lParam festlegen (z.B. aufsteigende oder absteigende Reihenfolge).

Wird keine Sortierfunktion oder keine Ereignisbehandlungsroutine für OnCompare bereitgestellt, sortiert CustomSort die Elemente alphabetisch nach den Werten der Eigenschaft Caption.

Konnte die Liste erfolgreich sortiert werden, gibt CustomSort true zurück.

Warnung:  Wenn die Anwendung im virtuellen Modus ausgeführt wird, arbeitet CustomSort nicht.

Siehe auch

Codebeispiele