Vcl.ComCtrls.TCustomListView.CustomSort

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

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

C++

bool __fastcall CustomSort(PFNLVCOMPARE SortProc, NativeInt lParam);

プロパティ

種類 可視性 ソース ユニット
function public
Vcl.ComCtrls.pas
Vcl.ComCtrls.hpp
Vcl.ComCtrls TCustomListView

説明

指定された順序付け関数を使ってリストの項目をソートします。

CustomSort メソッドを呼び出すと,SortProc パラメータで定義された順序付け関数を使ってリストの項目をソートできます。

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

SortProc パラメータは,lParam1 と lParam2 として渡されたリスト項目を比較する順序付け関数を指定します。順序付け関数は lParam1 と lParam2 を比較して整数を返します。戻り値は,lParam1 が lParam2 と同じ場合は 0,lParam1 が lParam2 より大きい場合は正の値,lParam1 が lParam2 より小さい場合は負の値となります。CustomSort の lParam パラメータは順序付け関数に 3 番めのパラメータとして渡されるオプションの値です。

SortProc パラメータが nil (Delphi) または NULL (C++) ならば,CustomSort は,リスト項目を OnCompare イベントを生成することで比較します。この比較によって,OnCompare イベントハンドラは lParam パラメータの値に基づいて別の順序基準(昇順と降順など)を提供できます。

順序付け関数を指定せず OnCompare イベントハンドラも設定しない場合,CustomSortCaption の値に基づいて項目をアルファベット順でソートします。

CustomSort は,リストのソートに成功すれば true を返します。

警告:  アプリケーションが仮想モードで動作している場合,CustomSort は無効です。

関連項目

コード サンプル