Export (0) Print
Expand All

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
)
public void SetColumnError (
	int columnIndex, 
	String error
)
public function SetColumnError (
	columnIndex : int, 
	error : String
)
Not applicable.

Parameters

columnIndex

The zero-based index of the column.

error

The error description.

Exception typeCondition

IndexOutOfRangeException

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 a null reference (Nothing in Visual Basic) 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.
    Console.WriteLine(row.GetColumnError(columnIndex));
}

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

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show:
© 2014 Microsoft