Vcl.Controls.TWinControl.DoUnDock

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

Delphi

function DoUnDock(NewTarget: TWinControl; Client: TControl): Boolean; dynamic;

C++

DYNAMIC bool __fastcall DoUnDock(TWinControl* NewTarget, TControl* Client);

プロパティ

種類 可視性 ソース ユニット
function protected
Vcl.Controls.pas
Vcl.Controls.hpp
Vcl.Controls TWinControl

説明

ウィンドウコントロールに現在ドッキングされているコントロールをドッキング解除します。

DoUnDock メソッドは,コントロールがウィンドウコントロールからドッキング解除されたときに自動的に呼び出されます。ウィンドウコントロールに対する必要な変更を処理して,ドッキング解除を実行します。それらの処理は以下のとおりです。

1. OnUnDock イベントを生成します。

2. OnUnDock イベントハンドラがない場合や,イベントハンドラがクライアントをドッキング解除できると通知した場合は,クライアントを DockClients プロパティリストから削除します。

NewTarget パラメータは,ドッキング解除されたコントロールの移動先の新しいホストを示します。

Client パラメータは,ウィンドウコントロールからドッキング解除されるコントロールを示します。

DoUnDock メソッドは,クライアントのドッキング解除に成功した場合は true,ドッキング解除が OnUnDock イベントハンドラによってブロックされた場合は false を返します。

DoUnDock メソッドをオーバーライドすると,ウィンドウコントロールからコントロールをドッキング解除する方法を変更できます。

メモ:  DoUnDock メソッドは,ドッキング解除処理の開始時に発生します。ドッキング解除が完了したときに変更を処理するには,かわりに DoRemoveDockClient メソッドをオーバーライドします。

関連項目