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 (String, String)

Sets the error description for a column specified by name.

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

Parameters

columnName
The name of the column.
error
The error description.

Remarks

The name of a column is set with the DataColumn class's ColumnName property.

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 determine if any errors exist for the columns collection, use the HasErrors method.

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.DataGridTable.DataTable
myRow = t.NewRow
Dim ErrorString As String
ErrorString = "Replace this text."
' Use DataColumn.Contains to ensure the column exists
If myRow.DataTable.Columns.Contains("id") Then
   myRow.SetColumnError "id", ErrorString
   Console.WriteLine(myRow.GetColumnError("id"))
   ' 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