TreeNode.ImageIndex 属性

定义

命名空间:

System.Windows.Forms

程序集:

System.Windows.Forms.dll

Source:

TreeNode.cs

获取或设置当树节点处于未选定状态时所显示图像的图像列表索引值。

C#

[System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.TreeViewImageIndexConverter))]
[System.Windows.Forms.RelatedImageList("TreeView.ImageList")]
public int ImageIndex { get; set; }

属性值

Int32

从零开始的索引值，表示图像在所分配的 ImageList 中的位置。

属性

TypeConverterAttribute RelatedImageListAttribute

例外

ArgumentOutOfRangeException

.NET 5 及更高版本： value 小于 -2。

示例

下面的代码示例创建 并将 分配给ImageListTreeView控件，并使用 对象填充TreeView控件TreeNode。 树节点分配的图像来自 ImageList 当树节点处于选定或未选择状态时显示的图像。 此示例要求具有一个 Form 包含 TreeView的 ，以及一个 ArrayList 包含 Customer 每个包含 Order 对象的 对象。 它还要求 Customer 定义 和 Order 对象。

C#

public class Customer
{
   public ArrayList CustomerOrders;
   public string CustomerName;
   public Customer(string myName)
   {
      CustomerName = myName;
      CustomerOrders = new ArrayList(); 
   }
}
public class Order
{
   public string OrderID;
   public Order(string myOrderID )
   {
      this.OrderID = myOrderID;
   }
}

private void FillTreeView()
{
    // Load the images in an ImageList.
    ImageList myImageList = new ImageList();
    myImageList.Images.Add(Image.FromFile("Default.gif"));
    myImageList.Images.Add(Image.FromFile("SelectedDefault.gif"));
    myImageList.Images.Add(Image.FromFile("Root.gif"));
    myImageList.Images.Add(Image.FromFile("UnselectedCustomer.gif"));
    myImageList.Images.Add(Image.FromFile("SelectedCustomer.gif"));
    myImageList.Images.Add(Image.FromFile("UnselectedOrder.gif"));
    myImageList.Images.Add(Image.FromFile("SelectedOrder.gif"));
    
    // Assign the ImageList to the TreeView.
    myTreeView.ImageList = myImageList;
    
    // Set the TreeView control's default image and selected image indexes.
    myTreeView.ImageIndex = 0;
    myTreeView.SelectedImageIndex = 1;

    /* Set the index of image from the 
    ImageList for selected and unselected tree nodes.*/
    this.rootImageIndex = 2;
    this.selectedCustomerImageIndex = 3;
    this.unselectedCustomerImageIndex = 4;
    this.selectedOrderImageIndex = 5;
    this.unselectedOrderImageIndex = 6;
    
    // Create the root tree node.
    TreeNode rootNode = new TreeNode("CustomerList");
    rootNode.ImageIndex = rootImageIndex;
    rootNode.SelectedImageIndex = rootImageIndex;
      
    // Add a main root tree node.
    myTreeView.Nodes.Add(rootNode);

    // Add a root tree node for each Customer object in the ArrayList.
    foreach(Customer myCustomer in customerArray)
    {
        // Add a child tree node for each Order object.
        int countIndex=0;
        TreeNode[] myTreeNodeArray = new TreeNode[myCustomer.CustomerOrders.Count];
        foreach(Order myOrder in myCustomer.CustomerOrders)
        {
            // Add the Order tree node to the array.
            myTreeNodeArray[countIndex] = new TreeNode(myOrder.OrderID,
              unselectedOrderImageIndex, selectedOrderImageIndex);
            countIndex++;
        }
        // Add the Customer tree node.
        TreeNode customerNode = new TreeNode(myCustomer.CustomerName,
            unselectedCustomerImageIndex, selectedCustomerImageIndex, myTreeNodeArray);
        myTreeView.Nodes[0].Nodes.Add(customerNode);
    }
}

注解

值ImageIndex是分配给 TreeView.ImageList 属性的 Image 中ImageList存储的 索引值。

备注

属性的ImageIndex默认值与 分配给 的TreeView控件TreeNode的 属性相同ImageIndex。

ImageKey 和 ImageIndex 是互斥的，这意味着如果设置了一个，另一个设置为无效值并被忽略。 如果设置 ImageKey 属性，则 ImageIndex 属性将自动设置为 -1。 或者，如果设置 ImageIndex 属性，则 ImageKey 会自动将 设置为空字符串 (“”) 。

.NET 5 及更高版本： 如果关联的 ImageList 属性值更改为 null，则 ImageIndex 属性返回其默认值 -1。 但是，分配 ImageIndex 的值在内部保留，并在将另一个 ImageList 对象分配给 ImageList 属性时使用。 如果分配给属性ImageList.ImageCollection.CountImageList的新ImageList属性值小于或等于分配给ImageIndex属性的值减去 1 (以说明集合是一个从零开始的索引) ，则ImageIndex属性值将调整为比Count属性值少一个。 例如，假设一个按钮控件具有 ImageList 三个图像，其 ImageIndex 属性设置为 2。 如果将只有两个图像的新 ImageList 分配给按钮，该值 ImageIndex 将更改为 1。

适用于

另请参阅

• ImageList
• ImageList
• SelectedImageIndex