Vcl.ComCtrls.TTreeNodes.CustomSort
Delphi
function CustomSort(SortProc: TTVCompare; Data: NativeInt; ARecurse: Boolean = False): Boolean;
C++
bool __fastcall CustomSort(PFNTVCOMPARE SortProc, NativeInt Data, bool ARecurse = false);
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
| function | public | Vcl.ComCtrls.pas Vcl.ComCtrls.hpp |
Vcl.ComCtrls | TTreeNodes |
説明
ツリーノードをソートします。
CustomSort メソッドは，SortProc パラメータで指定した比較ルーチンを使用して，ノードのソートまたは再ソートを行います。Data パラメータは，比較ルーチンに渡されます。オプションの ARecurse パラメータ（デフォルトは false）は，ソートがノードツリーを再帰的に展開し，各サブツリーを順番にソートするように指定します。
SortProc が nil（Delphi）または NULL（C++）の場合，デフォルト比較ルーチンが使用されます。デフォルトルーチンは，関連付けられている TCustomTreeView オブジェクトに OnCompare イベントハンドラが定義されていればそれを使用します。OnCompare イベントハンドラが定義されていない場合，デフォルトルーチンはノードキャプションの大文字と小文字を区別する単純な比較を使用します。
比較ルーチンでは，lParam1 パラメータと lParam2 パラメータは TTreeNode にキャストされたときに 2 つのノードを参照します。lParamSort パラメータは，CustomSort メソッドの Data パラメータに以前に渡された値です。比較ルーチンの戻り値は，次のように IParam1 と IParam2 の相対的なソート順を示します。
| 戻り値 | 意味 |
|---|---|
|
< 0 |
IParam1 は IParam2 の前 |
|
0 |
IParam1 と IParam2 は同等 |
|
> 0 |
IParam1 は IParam2 の後 |