Export (0) Print
Expand All

TreeNode.StateImageKey Property

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

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

[TypeConverterAttribute(typeof(ImageKeyConverter))]
[RelatedImageListAttribute("TreeView.StateImageList")]
public string StateImageKey { get; set; }

Property Value

Type: System.String
The key of the image used to indicate the state of the TreeNode.

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

If the parent TreeView has check boxes enabled, the StateImageKey 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 has no effect on the value of the StateImageKey.

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 (""). You should set the StateImageKey to an image with a corresponding index between 0 and 14. You can set the StateImageKey to an image with an index value greater than 14 (an exception will not be thrown), but the image may not be displayed

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft