Skip to main content
.NET Framework Class Library
FrameworkElementSetBinding Method (DependencyProperty, BindingBase)

Attaches a binding to this element, based on the provided binding object.

Namespace:   System.Windows
Assembly:  PresentationFramework (in PresentationFramework.dll)
Syntax
Public Function SetBinding ( _
	dp As [%$TOPIC/ms598273_en-us_VS_110_1_0_0_0_0%], _
	binding As [%$TOPIC/ms598273_en-us_VS_110_1_0_0_0_1%] _
) As [%$TOPIC/ms598273_en-us_VS_110_1_0_0_0_2%]
public [%$TOPIC/ms598273_en-us_VS_110_1_0_1_0_0%] SetBinding(
	[%$TOPIC/ms598273_en-us_VS_110_1_0_1_0_1%] dp,
	[%$TOPIC/ms598273_en-us_VS_110_1_0_1_0_2%] binding
)
public:
[%$TOPIC/ms598273_en-us_VS_110_1_0_2_0_0%]^ SetBinding(
	[%$TOPIC/ms598273_en-us_VS_110_1_0_2_0_1%]^ dp, 
	[%$TOPIC/ms598273_en-us_VS_110_1_0_2_0_2%]^ binding
)
member SetBinding : 
        dp:[%$TOPIC/ms598273_en-us_VS_110_1_0_3_0_0%] * 
        binding:[%$TOPIC/ms598273_en-us_VS_110_1_0_3_0_1%] -> [%$TOPIC/ms598273_en-us_VS_110_1_0_3_0_2%]

Parameters

dp
Type: System.WindowsDependencyProperty

Identifies the property where the binding should be established.

binding
Type: System.Windows.DataBindingBase

Represents the specifics of the data binding.

Return Value

Type: System.Windows.DataBindingExpressionBase
Records the conditions of the binding. This return value can be useful for error checking.
Remarks

This method is a convenience method for calling BindingOperationsSetBinding, which passes the current instance as the DependencyObject.

Examples

This example shows how to create and set a Binding in code.

The FrameworkElement class and the FrameworkContentElement class both expose a SetBinding method. If you are binding an element that inherits either of these classes, you can call the SetBinding method directly.

The following example creates a class named, MyData, which contains a property named MyDataProperty.

Public Class MyData
    Implements INotifyPropertyChanged

    ' Events 
    Public Event PropertyChanged As PropertyChangedEventHandler _
        Implements INotifyPropertyChanged.PropertyChanged

    ' Methods 
    Public Sub New()
    End Sub 

    Public Sub New(ByVal dateTime As DateTime)
        Me.MyDataProperty = ("Last bound time was " & dateTime.ToLongTimeString)
    End Sub 

    Private Sub OnPropertyChanged(ByVal info As String)
        RaiseEvent PropertyChanged(Me, New PropertyChangedEventArgs(info))
    End Sub 


    ' Properties 
    Public Property MyDataProperty As String 
        Get 
            Return Me._myDataProperty
        End Get 
        Set(ByVal value As String)
            Me._myDataProperty = value
            Me.OnPropertyChanged("MyDataProperty")
        End Set 
    End Property 


    ' Fields 
    Private _myDataProperty As String 
End Class
public class MyData : INotifyPropertyChanged
{
    private string myDataProperty;

    public MyData() { }

    public MyData(DateTime dateTime)
    {
        myDataProperty = "Last bound time was " + dateTime.ToLongTimeString();
    }

    public String MyDataProperty
    {
        get { return myDataProperty; }
        set
        {
            myDataProperty = value;
            OnPropertyChanged("MyDataProperty");
        }
    }

    public event PropertyChangedEventHandler PropertyChanged;

    private void OnPropertyChanged(string info)
    {
        PropertyChangedEventHandler handler = PropertyChanged;
        if (handler != null)
        {
            handler(this, new PropertyChangedEventArgs(info));
        }
    }
}

The following example shows how to create a binding object to set the source of the binding. The example uses SetBinding to bind the Text property of myText, which is a TextBlock control, to MyDataProperty.

Dim data1 As New MyData(DateTime.Now)
Dim binding1 As New Binding("MyDataProperty")
binding1.Source = data1
Me.myText.SetBinding(TextBlock.TextProperty, binding1)
//make a new source
  MyData myDataObject = new MyData(DateTime.Now);      
  Binding myBinding = new Binding("MyDataProperty");
  myBinding.Source = myDataObject;
  myText.SetBinding(TextBlock.TextProperty, myBinding);

For the complete code sample, see Code-only Binding Sample.

Instead of calling SetBinding, you can use the SetBinding static method of the BindingOperations class. The following example, calls BindingOperationsSetBinding instead of FrameworkElementSetBinding to bind myText to myDataProperty.

Dim myDataObject As New MyData(DateTime.Now)
Dim myBinding As New Binding("MyDataProperty")
myBinding.Source = myDataObject
BindingOperations.SetBinding(myText, TextBlock.TextProperty, myBinding)
//make a new source
MyData myDataObject = new MyData(DateTime.Now);
Binding myBinding = new Binding("MyDataProperty");
myBinding.Source = myDataObject;
BindingOperations.SetBinding(myText, TextBlock.TextProperty, myBinding);
Version Information

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.