WorksheetDataBindingCollection.Error Event

Occurs when a binding cannot be completed successfully.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v19.1.Core.dll

Declaration

C#

event DataBindingErrorEventHandler Error

VB.NET

Event Error As DataBindingErrorEventHandler

Event Data

The Error event's data class is DataBindingErrorEventArgs. The following properties provide information specific to this event:

Property	Description
BindingDirection	Indicates whose value is updated during binding.
ColumnIndex	Gets the index of the column in which an error occurs.
DataBinding	Gets a binding object whose binding caused an error.
ErrorType	Indicates the cause of an error.
RowIndex	Gets the index of the row in which an error occurs.

Remarks

The Error event indicates that an error occurs in cell range data binding. The DataBindingErrorEventArgs.ErrorType property details the cause of the error, the DataBindingErrorEventArgs.BindingDirection indicates whose value is being updated during binding.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/an-example-of-using-a-cell-range-as-a-data-source-t483776

Form1.cs

private void DataBindings_Error(object sender, DataBindingErrorEventArgs e) {
    string msg = String.Format("The error {0} occurs in attempt to {1} in row with index= {2}",
        e.ErrorType.ToString(), e.BindingDirection.ToString(), e.RowIndex);
    MessageBox.Show(msg, "Binding Error");
}

Form1.vb

Private Sub DataBindings_Error(ByVal sender As Object, ByVal e As DataBindingErrorEventArgs)
    Dim msg As String = String.Format("The error {0} occurs in attempt to {1} in row with index= {2}", e.ErrorType.ToString(), e.BindingDirection.ToString(), e.RowIndex)
    MessageBox.Show(msg, "Binding Error")
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Error event.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

an-example-of-using-a-cell-range-as-a-data-source-t483776/CS/RangeDataSourceForSnap/Form1.cs#L40

rangeDS = dataRange.GetDataSource(options);
sheet.DataBindings.Error += DataBindings_Error;
#endregion #RangeAsDataSource

how-to-bind-a-worksheet-to-a-generic-list-or-a-bindinglist-data-source-t480285/CS/DataBindingToListExample/Form1.cs#L13

#region #DataBindingErrorHandling
spreadsheetControl1.Document.Worksheets[0].DataBindings.Error += DataBindings_Error;
#endregion #DataBindingErrorHandling

VB.NET

an-example-of-using-a-cell-range-as-a-data-source-t483776/VB/RangeDataSourceForSnap/Form1.vb#L43

            rangeDS = dataRange.GetDataSource(options)
            AddHandler sheet.DataBindings.Error, AddressOf DataBindings_Error
'            #End Region ' #RangeAsDataSource

how-to-bind-a-worksheet-to-a-generic-list-or-a-bindinglist-data-source-t480285/VB/DataBindingToListExample/Form1.vb#L15

'            #Region "#DataBindingErrorHandling"
            AddHandler spreadsheetControl1.Document.Worksheets(0).DataBindings.Error, AddressOf DataBindings_Error
'            #End Region ' #DataBindingErrorHandling