Export (0) Print
Expand All
1 out of 5 rated this helpful - Rate this topic

DataGridViewImageCell Class

Updated: September 2008

Displays a graphic in a DataGridView control.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
public class DataGridViewImageCell : DataGridViewCell

The DataGridViewImageCell class is a specialized type of DataGridViewCell used to display an Image or an Icon, depending on the value of the ValueIsIcon property. Typically, the ReadOnly property of a DataGridViewImageCell is set to true to indicate that the user cannot edit the cell contents.

The DataGridViewImageColumn is the column type specialized to hold cells of this type. To model the cells within a column after an existing DataGridViewImageCell, set the column's CellTemplate property to that cell. By default, the CellTemplate is initialized to a new DataGridViewImageCell.

The cell-related properties of the column are wrappers for the similarly-named properties of the template cell. Changing the property values of the template cell will affect only cells based on the template that are added after the change. Changing the cell-related property values of the column, however, will update the template cell and all other cells in the column, and refresh the column display if necessary.

Notes to Inheritors:

When you derive from DataGridViewImageCell and add new properties to the derived class, be sure to override the Clone method to copy the new properties during cloning operations. You should also call the base class's Clone method so that the properties of the base class are copied to the new cell.

The following code example demonstrates how to change the image in an image cell using DataGridViewCell. This code example is part of a larger example provided for the topic How to: Work with Image Columns in the Windows Forms DataGridView Control.

private void dataGridView1_CellClick(object sender,
    DataGridViewCellEventArgs e)
{

    if (turn.Text.Equals(gameOverString)) { return; }

    DataGridViewImageCell cell = (DataGridViewImageCell)
        dataGridView1.Rows[e.RowIndex].Cells[e.ColumnIndex];

    if (cell.Value == blank)
    {
        if (IsOsTurn())
        {
            cell.Value = o;
        }
        else
        {
            cell.Value = x;
        }
        ToggleTurn();
    }
    if (IsAWin())
    {
        turn.Text = gameOverString;
    }
}
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

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

Date

History

Reason

September 2008

Corrected links in Example section.

Customer feedback.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.