DataRow.SetColumnError Method (Int32, String)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Sets the error description for a column specified by index.

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

member SetColumnError : 
        columnIndex:int *
        error:string -> unit

Parameters

columnIndex
Type: System.Int32

The zero-based index of the column.

error
Type: System.String

The error description.

Exception Condition
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 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.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1
Return to top
Show: