TreeNode.StateImageIndex Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Gets or sets the index of the image that is used to indicate the state of the TreeNode when the parent TreeView has its CheckBoxes property set to false.

public:
 property int StateImageIndex { int get(); void set(int value); };

[System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.NoneExcludedImageIndexConverter))]
[System.Windows.Forms.RelatedImageList("TreeView.StateImageList")]
public int StateImageIndex { get; set; }

[<System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.NoneExcludedImageIndexConverter))>]
[<System.Windows.Forms.RelatedImageList("TreeView.StateImageList")>]
member this.StateImageIndex : int with get, set

Public Property StateImageIndex As Integer

Property Value

Int32

The index of the image that is used to indicate the state of the TreeNode.

Attributes

TypeConverterAttribute RelatedImageListAttribute

Exceptions

ArgumentOutOfRangeException

The specified index is less than -1 or greater than 14.

Remarks

The image index that is returned by this property is contained in the StateImageList property of the parent TreeView control.

If the parent TreeView has check boxes enabled, the StateImageIndex is ignored and the node will display the first or second image in the StateImageList set on the parent TreeView to indicate an unchecked or checked state, respectively. Toggling the Checked property does not affect the value of the StateImageIndex.

The StateImageIndex returns -1 when not set. The StateImageKey and StateImageIndex properties are mutually exclusive, meaning if one is set, the other is ignored. If you set the StateImageKey property, the StateImageIndex property is automatically set to -1. Alternatively, if you set StateImageIndex, StateImageKey is automatically set to an empty string ("").

See also

• StateImageKey