Article
11/18/2011

BindableAttribute Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Specifies whether a member is typically used for binding. This class cannot be inherited.

Inheritance Hierarchy

System.Object
System.Attribute
System.ComponentModel.BindableAttribute

Namespace: System.ComponentModel
Assembly: System (in System.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.All)> _
Public NotInheritable Class BindableAttribute _
    Inherits Attribute

[AttributeUsageAttribute(AttributeTargets.All)]
public sealed class BindableAttribute : Attribute

The BindableAttribute type exposes the following members.

Constructors

	Name	Description
	BindableAttribute(BindableSupport)	Initializes a new instance of the BindableAttribute class with one of the BindableSupport values.
	BindableAttribute(Boolean)	Initializes a new instance of the BindableAttribute class with a Boolean value.
	BindableAttribute(BindableSupport, BindingDirection)	Initializes a new instance of the BindableAttribute class.
	BindableAttribute(Boolean, BindingDirection)	Initializes a new instance of the BindableAttribute class.

Top

Properties

	Name	Description
	Bindable	Gets a value indicating that a property is typically used for binding.
	Direction	Gets a value indicating the direction or directions of this property's data binding.

Top

Methods

	Name	Description
	Equals	Determines whether two BindableAttribute objects are equal. (Overrides Attribute.Equals(Object).)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for the BindableAttribute class. (Overrides Attribute.GetHashCode().)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	Default	Specifies the default value for the BindableAttribute, which is No. This field is read-only.
	No	Specifies that a property is not typically used for binding. This field is read-only.
	Yes	Specifies that a property is typically used for binding. This field is read-only.

Top

Remarks

You can specify this attribute for multiple members, typically properties, on a control.

If a property has been marked with the BindableAttribute set to true, then a property change notification should be raised for that property. This means that if the Bindable property is Yes, then two-way data binding is supported. If Bindable is No, you can still bind to the property, but it should not be shown in the default set of properties to bind to, because it might or might not raise a property change notification.

Note:
When you mark a property with BindableAttribute set to true, the value of this attribute is set to the constant member Yes. For a property marked with the BindableAttribute set to false, the value is No. Therefore, to check the value of this attribute in your code, you must specify the attribute as BindableAttribute.Yes or BindableAttribute.No.

Caution:
You can use this attribute at design time only. Nothing prevents you from binding to any property during run time.

Examples

The following code example marks a property as appropriate to bind data to.

<Bindable(True)> _
Public Property MyProperty() As Integer
    Get
        ' Insert code here.
        Return 0
    End Get
    Set(ByVal value As Integer)
        ' Insert code here.
    End Set
End Property

Private Sub button1_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)

End Sub

[Bindable(true)]
public int MyProperty
{
    get
    {
        // Insert code here.
        return 0;
    }
    set
    {
        // Insert code here.
    }
}

private void button1_Click(object sender, RoutedEventArgs e)
{

}

Version Information

Silverlight

Supported in: 5, 4

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Partager via