TreeView.CheckBoxes 属性
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
获取或设置一个值,用以指示是否在树视图控件中的树节点旁显示复选框。
public:
property bool CheckBoxes { bool get(); void set(bool value); };
public bool CheckBoxes { get; set; }
member this.CheckBoxes : bool with get, set
Public Property CheckBoxes As Boolean
属性值
如果在树视图控件中的每个树节点旁显示复选框,则为 true
;否则为 false
。 默认值为 false
。
示例
下面的代码示例演示如何更改 的 TreeView 折叠状态,以便所有选中的节点都可见。 首先,折叠所有节点,并为 事件添加 BeforeExpand 处理程序。 接下来,展开所有节点。 事件处理程序 BeforeExpand 确定给定节点是否具有已检查的子节点。 如果节点没有选中的子级,则会取消该节点的扩展。 为了在单击节点旁边的加号时允许标准节点扩展, BeforeExpand 然后删除事件处理程序。
还可以通过处理 BeforeCollapse 事件来实现此行为,如该主题的示例所示。
#using <System.dll>
#using <System.Windows.Forms.dll>
#using <System.Drawing.dll>
using namespace System;
using namespace System::Drawing;
using namespace System::Windows::Forms;
public ref class Form1: public Form
{
private:
TreeView^ treeView1;
Button^ showCheckedNodesButton;
TreeViewCancelEventHandler^ checkForCheckedChildren;
public:
Form1()
{
treeView1 = gcnew TreeView;
showCheckedNodesButton = gcnew Button;
checkForCheckedChildren = gcnew TreeViewCancelEventHandler( this, &Form1::CheckForCheckedChildrenHandler );
this->SuspendLayout();
// Initialize treeView1.
treeView1->Location = Point(0,25);
treeView1->Size = System::Drawing::Size( 292, 248 );
treeView1->Anchor = static_cast<AnchorStyles>(AnchorStyles::Top | AnchorStyles::Left | AnchorStyles::Bottom | AnchorStyles::Right);
treeView1->CheckBoxes = true;
// Add nodes to treeView1.
TreeNode^ node;
for ( int x = 0; x < 3; ++x )
{
// Add a root node.
node = treeView1->Nodes->Add( String::Format( "Node{0}", x * 4 ) );
for ( int y = 1; y < 4; ++y )
{
// Add a node as a child of the previously added node.
node = node->Nodes->Add( String::Format( "Node{0}", x * 4 + y ) );
}
}
// Set the checked state of one of the nodes to
// demonstrate the showCheckedNodesButton button behavior.
treeView1->Nodes[ 1 ]->Nodes[ 0 ]->Nodes[ 0 ]->Checked = true;
// Initialize showCheckedNodesButton.
showCheckedNodesButton->Size = System::Drawing::Size( 144, 24 );
showCheckedNodesButton->Text = "Show Checked Nodes";
showCheckedNodesButton->Click += gcnew EventHandler( this, &Form1::showCheckedNodesButton_Click );
// Initialize the form.
this->ClientSize = System::Drawing::Size( 292, 273 );
array<Control^>^temp0 = {showCheckedNodesButton,treeView1};
this->Controls->AddRange( temp0 );
this->ResumeLayout( false );
}
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->CollapseAll();
// Add the checkForCheckedChildren event handler to the BeforeExpand event.
treeView1->BeforeExpand += checkForCheckedChildren;
// Expand all nodes of treeView1. Nodes without checked children are
// prevented from expanding by the checkForCheckedChildren event handler.
treeView1->ExpandAll();
// Remove the checkForCheckedChildren event handler from the BeforeExpand
// event so manual node expansion will work correctly.
treeView1->BeforeExpand -= checkForCheckedChildren;
// Enable redrawing of treeView1.
treeView1->EndUpdate();
}
// Prevent expansion of a node that does not have any 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 = safe_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;
}
};
int main()
{
Application::Run( gcnew Form1 );
}
using System;
using System.Drawing;
using System.Windows.Forms;
public class Form1 : Form
{
private TreeView treeView1;
private Button showCheckedNodesButton;
private TreeViewCancelEventHandler checkForCheckedChildren;
public Form1()
{
treeView1 = new TreeView();
showCheckedNodesButton = new Button();
checkForCheckedChildren =
new TreeViewCancelEventHandler(CheckForCheckedChildrenHandler);
this.SuspendLayout();
// Initialize treeView1.
treeView1.Location = new Point(0, 25);
treeView1.Size = new Size(292, 248);
treeView1.Anchor = AnchorStyles.Top | AnchorStyles.Left |
AnchorStyles.Bottom | AnchorStyles.Right;
treeView1.CheckBoxes = true;
// Add nodes to treeView1.
TreeNode node;
for (int x = 0; x < 3; ++x)
{
// Add a root node.
node = treeView1.Nodes.Add(String.Format("Node{0}", x*4));
for (int y = 1; y < 4; ++y)
{
// Add a node as a child of the previously added node.
node = node.Nodes.Add(String.Format("Node{0}", x*4 + y));
}
}
// Set the checked state of one of the nodes to
// demonstrate the showCheckedNodesButton button behavior.
treeView1.Nodes[1].Nodes[0].Nodes[0].Checked = true;
// Initialize showCheckedNodesButton.
showCheckedNodesButton.Size = new Size(144, 24);
showCheckedNodesButton.Text = "Show Checked Nodes";
showCheckedNodesButton.Click +=
new EventHandler(showCheckedNodesButton_Click);
// Initialize the form.
this.ClientSize = new Size(292, 273);
this.Controls.AddRange(new Control[]
{ showCheckedNodesButton, treeView1 } );
this.ResumeLayout(false);
}
[STAThreadAttribute()]
static void Main()
{
Application.Run(new Form1());
}
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.CollapseAll();
// Add the checkForCheckedChildren event handler to the BeforeExpand event.
treeView1.BeforeExpand += checkForCheckedChildren;
// Expand all nodes of treeView1. Nodes without checked children are
// prevented from expanding by the checkForCheckedChildren event handler.
treeView1.ExpandAll();
// Remove the checkForCheckedChildren event handler from the BeforeExpand
// event so manual node expansion will work correctly.
treeView1.BeforeExpand -= checkForCheckedChildren;
// Enable redrawing of treeView1.
treeView1.EndUpdate();
}
// Prevent expansion of a node that does not have any 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;
}
}
Imports System.Drawing
Imports System.Windows.Forms
Public Class Form1
Inherits Form
Private treeView1 As TreeView
Private showCheckedNodesButton As Button
Public Sub New()
treeView1 = New TreeView
showCheckedNodesButton = New Button
Me.SuspendLayout()
' Initialize treeView1.
treeView1.Location = New Point(0, 25)
treeView1.Size = New Size(292, 248)
treeView1.Anchor = AnchorStyles.Top Or AnchorStyles.Left Or AnchorStyles.Bottom Or AnchorStyles.Right
treeView1.CheckBoxes = True
' Add nodes to treeView1.
Dim node As TreeNode
Dim x As Integer
For x = 0 To 3
' Add a root node.
node = treeView1.Nodes.Add(String.Format("Node{0}", x * 4))
Dim y As Integer
For y = 1 To 4
' Add a node as a child of the previously added node.
node = node.Nodes.Add(String.Format("Node{0}", x * 4 + y))
Next y
Next x
' Set the checked state of one of the nodes to
' demonstrate the showCheckedNodesButton button behavior.
treeView1.Nodes(1).Nodes(0).Nodes(0).Checked = True
' Initialize showCheckedNodesButton.
showCheckedNodesButton.Size = New Size(144, 24)
showCheckedNodesButton.Text = "Show Checked Nodes"
AddHandler showCheckedNodesButton.Click, AddressOf showCheckedNodesButton_Click
' Initialize the form.
Me.ClientSize = New Size(292, 273)
Me.Controls.AddRange(New Control() {showCheckedNodesButton, treeView1})
Me.ResumeLayout(False)
End Sub
<STAThreadAttribute()> _
Shared Sub Main()
Application.Run(New Form1)
End Sub
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.CollapseAll()
' Add the CheckForCheckedChildren event handler to the BeforeExpand event.
AddHandler treeView1.BeforeExpand, AddressOf CheckForCheckedChildren
' Expand all nodes of treeView1. Nodes without checked children are
' prevented from expanding by the checkForCheckedChildren event handler.
treeView1.ExpandAll()
' Remove the checkForCheckedChildren event handler from the BeforeExpand
' event so manual node expansion will work correctly.
RemoveHandler treeView1.BeforeExpand, AddressOf CheckForCheckedChildren
' Enable redrawing of treeView1.
treeView1.EndUpdate()
End Sub
' Prevent expansion of a node that does not have any checked child nodes.
Private Sub CheckForCheckedChildren(ByVal sender As Object, ByVal e As TreeViewCancelEventArgs)
If Not HasCheckedChildNodes(e.Node) Then
e.Cancel = True
End If
End Sub
' 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
End Class
注解
树节点标签和Image树节点 (如果有)的左侧会显示一个检查框。 复选框允许用户一次选择多个树节点。
CheckBoxes如果 的 TreeView 属性设置为 true
,并且StateImageList设置了 属性,则 中包含的TreeView每个 TreeNode 图像都分别显示 来自 StateImageList 的第一个和第二个图像,以指示未选中或已选中状态。 但是,如果出现以下情况,则显示的图像可能会有所不同:如果 SelectedImageIndex 节点的 设置为 0 或 1 以外的值,并且 CheckBoxes 父 TreeView 级的 属性设置为 false
,则 SelectedImageIndex 不会自动重置为 -1 以指示未设置它。 在这种情况下,将显示位于指定索引位置的状态图像。 如果 CheckBoxes 再次设置为 true
,则会分别显示 的第 StateImageList 一个和第二个图像,以指示选中或未选中状态。
注意
在运行时设置 CheckBoxes 属性时, TreeView 将重新创建句柄, (查看 Control.RecreateHandle 更新控件外观) 。 这会导致所有树节点折叠,选定的 TreeNode除外。