This documentation is archived and is not being maintained.

DataGridViewCellStyle.NullValue Property

Gets or sets the DataGridView cell display value corresponding to a cell value of DBNull.Value or a null reference (Nothing in Visual Basic).

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

[TypeConverterAttribute(typeof(StringConverter))] 
public Object NullValue { get; set; }
/** @property */
public Object get_NullValue ()

/** @property */
public void set_NullValue (Object value)

public function get NullValue () : Object

public function set NullValue (value : Object)

Not applicable.

Property Value

The object used to indicate a null value in a cell. The default is String.Empty.

When a DataGridView cell with this cell style has a value of DBNull.Value or a null reference (Nothing in Visual Basic) or the user edits the cell and presses CTRL+0, the DataGridView control displays the NullValue property value. When a user edits a cell with this cell style and enters the value of this property or presses CTRL+0, the control sets the cell value to the value of the DataSourceNullValue property or to a null reference (Nothing in Visual Basic) if DataSourceNullValue is DBNull.Value and the cell ValueType is a reference type. This conversion does not occur when you set the DataGridViewCell.Value property programmatically.

NoteNote:

The control does not display the NullValue property value for cell values equal to the DataSourceNullValue property value when DataSourceNullValue is set to a value other than DBNull.Value or a null reference (Nothing in Visual Basic). In this case, you can handle the DataGridView.CellFormatting event to display the NullValue property value. For more information, see the code example in this topic.

This property takes any object, which enables you to specify a value with a type appropriate to the display type of the cell. For example, you can set this property to string values for use by text box cells or images for use by image cells.

The following code example illustrates the use of this property. In this example, a DataGridView.CellFormatting event handler displays the value of the NullValue property when the cell value equals DataSourceNullValue.

// Display NullValue for cell values equal to DataSourceNullValue.
private void dataGridView1_CellFormatting(object sender,
    DataGridViewCellFormattingEventArgs e)
{
    String value = e.Value as string;
    if ((value != null) && value.Equals(e.CellStyle.DataSourceNullValue))
    {
        e.Value = e.CellStyle.NullValue;
        e.FormattingApplied = true;
    }
}

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Show: