TreeView.BeforeCollapse イベント
ツリー ノードが折りたたまれる前に発生します。
Public Event BeforeCollapse As TreeViewCancelEventHandler
[C#]
public event TreeViewCancelEventHandler BeforeCollapse;
[C++]
public: __event TreeViewCancelEventHandler* BeforeCollapse;
[JScript] JScript では、このクラスで定義されているイベントを処理できます。ただし、独自に定義することはできません。
イベント データ
イベント ハンドラが、このイベントに関連するデータを含む、TreeViewCancelEventArgs 型の引数を受け取りました。次の TreeViewCancelEventArgs プロパティには、このイベントの固有の情報が記載されます。
| プロパティ | 説明 |
|---|---|
| Action | イベントを発生させた TreeViewAction の種類を取得します。 |
| Cancel (CancelEventArgs から継承されます) | イベントをキャンセルするかどうかを示す値を取得または設定します。 |
| Node | チェックされる、展開される、折りたたまれる、または選択されるツリー ノードを取得します。 |
解説
イベント処理の詳細については、「 イベントの利用 」を参照してください。
使用例
[Visual Basic, C#, C++] TreeView の折りたたみの状態を変更して、チェックされているノードを表示する方法を次の例に示します。まず、すべてのノードが展開され、 BeforeCollapse イベントのイベント ハンドラが追加されます。次に、すべてのノードが折りたたまれます。 BeforeCollapse イベント ハンドラは、指定したノードに、チェックされている子ノードがあるかどうかを確認します。チェックされている子ノードがある場合、そのノードの折りたたみはキャンセルされます。次に、ノードの横にあるマイナス記号がクリックされたときに通常のノードを折りたためるようにするため、 BeforeCollapse イベント ハンドラが削除されます。
[Visual Basic, C#, C++] BeforeExpand イベントを処理してこの動作を実装することもできます。詳細については、該当するトピックの例を参照してください。
[Visual Basic, C#, C++] 詳細については、 TreeView コンストラクタのリファレンス トピックを参照してください。
Private Sub showCheckedNodesButton_Click(ByVal sender As Object, ByVal e As EventArgs)
' Disable redrawing of treeView1 to prevent flickering
' while changes are made.
treeView1.BeginUpdate()
' Collapse all nodes of treeView1.
treeView1.ExpandAll()
' Add the CheckForCheckedChildren event handler to the BeforeExpand event.
AddHandler treeView1.BeforeCollapse, AddressOf CheckForCheckedChildren
' Expand all nodes of treeView1. Nodes without checked children are
' prevented from expanding by the checkForCheckedChildren event handler.
treeView1.CollapseAll()
' Remove the checkForCheckedChildren event handler from the BeforeExpand
' event so manual node expansion will work correctly.
RemoveHandler treeView1.BeforeCollapse, AddressOf CheckForCheckedChildren
' Enable redrawing of treeView1.
treeView1.EndUpdate()
End Sub 'showCheckedNodesButton_Click
' Prevent collapse of a node that has checked child nodes.
Private Sub CheckForCheckedChildren(ByVal sender As Object, ByVal e As TreeViewCancelEventArgs)
If HasCheckedChildNodes(e.Node) Then
e.Cancel = True
End If
End Sub 'CheckForCheckedChildren
' Returns a value indicating whether the specified
' TreeNode has checked child nodes.
Private Function HasCheckedChildNodes(ByVal node As TreeNode) As Boolean
If node.Nodes.Count = 0 Then
Return False
End If
Dim childNode As TreeNode
For Each childNode In node.Nodes
If childNode.Checked Then
Return True
End If
' Recursively check the children of the current child node.
If HasCheckedChildNodes(childNode) Then
Return True
End If
Next childNode
Return False
End Function 'HasCheckedChildNodes
[C#]
private void showCheckedNodesButton_Click(object sender, EventArgs e)
{
// Disable redrawing of treeView1 to prevent flickering
// while changes are made.
treeView1.BeginUpdate();
// Collapse all nodes of treeView1.
treeView1.ExpandAll();
// Add the checkForCheckedChildren event handler to the BeforeExpand event.
treeView1.BeforeCollapse += checkForCheckedChildren;
// Expand all nodes of treeView1. Nodes without checked children are
// prevented from expanding by the checkForCheckedChildren event handler.
treeView1.CollapseAll();
// Remove the checkForCheckedChildren event handler from the BeforeExpand
// event so manual node expansion will work correctly.
treeView1.BeforeCollapse -= checkForCheckedChildren;
// Enable redrawing of treeView1.
treeView1.EndUpdate();
}
// Prevent collapse of a node that has checked child nodes.
private void CheckForCheckedChildrenHandler(object sender,
TreeViewCancelEventArgs e)
{
if (HasCheckedChildNodes(e.Node)) e.Cancel = true;
}
// Returns a value indicating whether the specified
// TreeNode has checked child nodes.
private bool HasCheckedChildNodes(TreeNode node)
{
if (node.Nodes.Count == 0) return false;
foreach (TreeNode childNode in node.Nodes)
{
if (childNode.Checked) return true;
// Recursively check the children of the current child node.
if (HasCheckedChildNodes(childNode)) return true;
}
return false;
}
[C++]
private:
void showCheckedNodesButton_Click(Object* /*sender*/, EventArgs* /*e*/)
{
// Disable redrawing of treeView1 to prevent flickering
// while changes are made.
treeView1->BeginUpdate();
// Collapse all nodes of treeView1.
treeView1->ExpandAll();
// Add the checkForCheckedChildren event handler to the BeforeExpand event.
treeView1->BeforeCollapse += checkForCheckedChildren;
// Expand all nodes of treeView1. Nodes without checked children are
// prevented from expanding by the checkForCheckedChildren event handler.
treeView1->CollapseAll();
// Remove the checkForCheckedChildren event handler from the BeforeExpand
// event so manual node expansion will work correctly.
treeView1->BeforeCollapse -= checkForCheckedChildren;
// Enable redrawing of treeView1.
treeView1->EndUpdate();
}
// Prevent collapse of a node that has checked child nodes.
void CheckForCheckedChildrenHandler(Object* /*sender*/,
TreeViewCancelEventArgs* e)
{
if (HasCheckedChildNodes(e->Node)) e->Cancel = true;
}
// Returns a value indicating whether the specified
// TreeNode has checked child nodes.
bool HasCheckedChildNodes(TreeNode* node)
{
if (node->Nodes->Count == 0) return false;
System::Collections::IEnumerator* myEnum = node->Nodes->GetEnumerator();
while (myEnum->MoveNext())
{
TreeNode* childNode = __try_cast<TreeNode*>(myEnum->Current);
if (childNode->Checked) return true;
// Recursively check the children of the current child node.
if (HasCheckedChildNodes(childNode)) return true;
}
return false;
}
[JScript] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタ ボタン .gif)
をクリックします。
必要条件
プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ
参照
TreeView クラス | TreeView メンバ | System.Windows.Forms 名前空間 | OnBeforeCollapse | AfterCollapse | OnAfterCollapse