This documentation is archived and is not being maintained.

DataRow.SetColumnError Method (Int32, String)

Sets the error description for a column specified by index.

Namespace:  System.Data
Assembly:  System.Data (in System.Data.dll)

public void SetColumnError(
	int columnIndex,
	string error


Type: System.Int32

The zero-based index of the column.

Type: System.String

The error description.


The columnIndex argument is out of range

The method is used to set custom error descriptions on specified columns. You can use the ErrorProvider control to display the text of the error.

To examine error descriptions, use the GetColumnError method.

To determine whether any errors exist for the columns collection, use the HasErrors property. Consequently, you can use the GetColumnsInError method to retrieve all the columns with errors.

If null or an empty string is passed in as the error parameter, the DataRow behaves as if no error was set and the HasErrors property will return false.

To set a custom error description on the whole row, use the RowError property.

To clear all errors for the columns collection, use the ClearErrors method.

To set error text that applies to a whole row, set the RowError property.

The following example sets an error description for a specified DataRow.

private void SetColError(DataRow row, int columnIndex)
    string errorString = "Replace this text.";

    // Set the error for the specified column of the row.
    row.SetColumnError(columnIndex, errorString);

private void PrintColError(DataRow row, int columnIndex)
    // Print the error of a specified column.

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, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0