RemoteBindableComponent.DataBindings Property (2007 System)

  • Article

Gets the Binding objects for the component.

Namespace:  Microsoft.VisualStudio.Tools.Office
Assembly:  Microsoft.Office.Tools.v9.0 (in Microsoft.Office.Tools.v9.0.dll)

Syntax

'Declaration
Public ReadOnly Property DataBindings As ControlBindingsCollection

'Usage
Dim instance As RemoteBindableComponent 
Dim value As ControlBindingsCollection 

value = instance.DataBindings

public ControlBindingsCollection DataBindings { get; }

public:
virtual property ControlBindingsCollection^ DataBindings {
    ControlBindingsCollection^ get () sealed;
}

public final function get DataBindings () : ControlBindingsCollection

Property Value

Type: System.Windows.Forms.ControlBindingsCollection
A ControlBindingsCollection that contains the Binding objects for the component.

Implements

IBindableComponent.DataBindings

Remarks

Use this property to access the ControlBindingsCollection. By adding Binding objects to the collection, you can bind any property of the component to a property of an object.

Examples

The following code example adds a single cell NamedRange control (which derives from RemoteBindableComponent), a DataSet with a single column of names, and a Button to the current worksheet. The example uses the DataBindings property to bind the DataSet to the Value2 property of the NamedRange. This code example is part of a larger code example provided for the RemoteBindableComponent class.

Private namedRange1 As Microsoft.Office.Tools.Excel.NamedRange
Private WithEvents button1 As Microsoft.Office.Tools.Excel.Controls.Button
Private customerNames As String() = _
    {"Reggie", "Sally", "Henry", "Christine"}
Private ds As DataSet

Private Sub SetBindingContext()
    namedRange1 = Me.Controls.AddNamedRange(Me.Range("A1", _
        System.Type.Missing), "namedRange1")

    ' Create a button that scrolls through the data  
    ' displayed in the NamedRange.
    button1 = Me.Controls.AddButton(50, 20, 100, 20, "button1")
    button1.Text = "Display next item" 

    ' Create a data table with one column.
    ds = New DataSet()
    Dim table As DataTable = ds.Tables.Add("Customers")
    Dim column1 As New DataColumn("Names", GetType(String))
    table.Columns.Add(column1)

    ' Add the names to the table. 
    Dim row As DataRow
    Dim i As Integer 
    For i = 0 To customerNames.Length - 1
        row = table.NewRow()
        row("Names") = customerNames(i)
        table.Rows.Add(row)
    Next i

    ' Create a new Binding that links the Value2 property 
    ' of the NamedRange and the Names column. 
    Dim binding1 As New Binding("Value2", ds, "Customers.Names", True)
    namedRange1.DataBindings.Add(binding1)
End Sub

private Microsoft.Office.Tools.Excel.NamedRange namedRange1;
private Microsoft.Office.Tools.Excel.Controls.Button button1;
private string[] customerNames = 
    { "Reggie", "Sally", "Henry", "Christine" };
private DataSet ds;

private void SetBindingContext()
{
    namedRange1 = this.Controls.AddNamedRange(
        this.Range["A1", missing], "namedRange1");

    // Create a button that scrolls through the data  
    // displayed in the NamedRange.
    button1 = this.Controls.AddButton(50, 20, 100, 20,
        "button1");
    button1.Text = "Display next item";
    button1.Click += new EventHandler(button1_Click);

    // Create a data table with one column.
    ds = new DataSet();
    DataTable table = ds.Tables.Add("Customers");
    DataColumn column1 = new DataColumn("Names", typeof(string));
    table.Columns.Add(column1);

    // Add the names to the table.
    DataRow row;
    for (int i = 0; i < customerNames.Length; i+)
    {
        row = table.NewRow();
        row["Names"] = customerNames[i];
        table.Rows.Add(row);
    }

    // Create a new Binding that links the Value2 property 
    // of the NamedRange and the Names column.
    Binding binding1 = new Binding("Value2", ds, "Customers.Names", true);
    namedRange1.DataBindings.Add(binding1);
}

.NET Framework Security

See Also

Reference

RemoteBindableComponent Class

RemoteBindableComponent Members

Microsoft.VisualStudio.Tools.Office Namespace