This documentation is archived and is not being maintained.

DataGridViewImageCell.ValueIsIcon Property

Gets or sets a value indicating whether this cell displays an Icon value.

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

public bool ValueIsIcon { get; set; }

Property Value

Type: System.Boolean
true if this cell displays an Icon value; otherwise, false.

To ensure that the alpha channel of Icon values is painted correctly, set this property to true. When this property is true, the FormattedValueType and ValueType properties return a Type object representing the Icon type.

Setting the ValuesAreIcons property of the owning column also sets the ValueIsIcon property of every cell in the column and refreshes the column display. To override the specified value for individual cells, set the cell values after you set the column value.

When the value of this property changes for a cell in the row for new records, the image displayed in the cell is updated to the current value of the DefaultNewRowValue property.

Unlike the column ValuesAreIcons property, the cell ValueIsIcon property does not automatically update the NullValue property of the associated cell style when you change its value. When you change the cell ValueIsIcon property value to true, be sure to set the NullValue property of the object returned by the Style property to a valid Icon. When you change the ValueIsIcon property value to false, be sure to set the NullValue property to a valid Image.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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