NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

DataRow.SetColumnError (Int32, String)

Sets the error description for a column specified by index.

[Visual Basic]
Overloads Public Sub SetColumnError( _
   ByVal columnIndex As Integer, _
   ByVal error As String _
)
[C#]
public void SetColumnError(
   int columnIndex,
   string error
);
[C++]
public: void SetColumnError(
   int columnIndex,
   String* error
);
[JScript]
public function SetColumnError(
   columnIndex : int,
   error : String
);

Parameters

columnIndex
The zero-based index of the column.
error
The error description.

Exceptions

Exception Type Condition
IndexOutOfRangeException The columnIndex argument is out of range

Remarks

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, or through by other reporting mechanisms.

To examine error descriptions, use the GetColumnError method.

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

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.

Example [Visual Basic]

The following example sets and gets the error description for a new column in an existing System.WinForms.DataGrid control's DataTable.

[Visual Basic]

Dim myRow As DataRow
Dim t As DataTable
t = DataGrid1.DataSource
myRow = t.NewRow
Dim ErrorString As String
ErrorString = "Replace this text."
' Use DataColumn.Contains to ensure the column exists
If myRow.DataTable.Columns.Contains(1) Then
   myRow.SetColumnError(1, ErrorString)
   Console.WriteLine(myRow.GetColumnError(1))
   ' Add the row
   t.Rows.Add(myRow)
End If

See Also

DataRow Class | DataRow Members | System.Data Namespace | DataRow.SetColumnError Overload List | ClearErrors | ColumnsCollection | Contains | DataColumn | Error | GetColumnsInError | HasErrors | RowError