WorksheetDataBindingCollection.GetDataBindings(Range) Method

Obtains data bindings for the cells in the specified range.

Namespace: DevExpress.Spreadsheet

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

Declaration

C#

IList<WorksheetDataBinding> GetDataBindings(
    Range range
)

VB.NET

Function GetDataBindings(
    range As Range
) As IList(Of WorksheetDataBinding)

Parameters

Name	Type	Description
range	Range	A Range of cells in a worksheet.

Returns

Type	Description
IList<WorksheetDataBinding>	A IList<T><WorksheetDataBinding,> generic list .

Remarks

To get the data binding for a particular cell, use the WorksheetDataBindingCollection.GetDataBinding method.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-bind-a-worksheet-to-a-generic-list-or-a-bindinglist-data-source-t480285

Form1.cs

Worksheet sheet = spreadsheetControl1.Document.Worksheets.ActiveWorksheet;
var bindings = sheet.DataBindings.GetDataBindings(sheet.Selection);
string s = "No data bindings found";
if (bindings.Count != 0) { 
      s = "The selected range contains the following data bindings:\r\n";
foreach (WorksheetDataBinding binding in bindings)
    s += String.Format("Binding {0}\r\n", binding.Range);
}
MessageBox.Show(s);

Form1.vb

Dim sheet As Worksheet = spreadsheetControl1.Document.Worksheets.ActiveWorksheet
Dim bindings = sheet.DataBindings.GetDataBindings(sheet.Selection)
Dim s As String = "No data bindings found"
If bindings.Count <> 0 Then
      s = "The selected range contains the following data bindings:" & ControlChars.CrLf
For Each binding As WorksheetDataBinding In bindings
    s &= String.Format("Binding {0}" & ControlChars.CrLf, binding.Range)
Next binding
End If
MessageBox.Show(s)

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetDataBindings(Range) method.

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#

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

Worksheet sheet = spreadsheetControl1.Document.Worksheets.ActiveWorksheet;
var bindings = sheet.DataBindings.GetDataBindings(sheet.Selection);
string s = "No data bindings found";

VB.NET

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

Dim sheet As Worksheet = spreadsheetControl1.Document.Worksheets.ActiveWorksheet
Dim bindings = sheet.DataBindings.GetDataBindings(sheet.Selection)
Dim s As String = "No data bindings found"