BindableAttribute Class

 

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

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

System.Object
  System.Attribute
    System.ComponentModel.BindableAttribute

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

NameDescription
System_CAPS_pubmethodBindableAttribute(BindableSupport)

Initializes a new instance of the BindableAttribute class with one of the BindableSupport values.

System_CAPS_pubmethodBindableAttribute(BindableSupport, BindingDirection)

Initializes a new instance of the BindableAttribute class.

System_CAPS_pubmethodBindableAttribute(Boolean)

Initializes a new instance of the BindableAttribute class with a Boolean value.

System_CAPS_pubmethodBindableAttribute(Boolean, BindingDirection)

Initializes a new instance of the BindableAttribute class.

NameDescription
System_CAPS_pubpropertyBindable

Gets a value indicating that a property is typically used for binding.

System_CAPS_pubpropertyDirection

Gets a value indicating the direction or directions of this property's data binding.

System_CAPS_pubpropertyTypeId

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether two BindableAttribute objects are equal.(Overrides Attribute.Equals(Object).)

System_CAPS_pubmethodGetHashCode()

Serves as a hash function for the BindableAttribute class.(Overrides Attribute.GetHashCode().)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIsDefaultAttribute()

Determines if this attribute is the default.(Overrides Attribute.IsDefaultAttribute().)

System_CAPS_pubmethodMatch(Object)

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticDefault

Specifies the default value for the BindableAttribute, which is No. This field is read-only.

System_CAPS_pubfieldSystem_CAPS_staticNo

Specifies that a property is not typically used for binding. This field is read-only.

System_CAPS_pubfieldSystem_CAPS_staticYes

Specifies that a property is typically used for binding. This field is read-only.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfoCount(UInt32)

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

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.

System_CAPS_noteNote

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.

System_CAPS_cautionCaution

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

For more information, see Extending Metadata Using Attributes.

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

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

The next code example shows how to check the value of the BindableAttribute for MyProperty. First, the code gets a PropertyDescriptorCollection with all the properties for the object. Next, the code indexes into the PropertyDescriptorCollection to get MyProperty. Finally, the code returns the attributes for this property and saves them in the attributes variable. The code example presents two different ways to check the value of the BindableAttribute. In the second code fragment, the example calls the Equals method. In the last code fragment, the example uses the Bindable property to check the value.

      // Gets the attributes for the property.
       AttributeCollection attributes = 
          TypeDescriptor.GetProperties(this)["MyProperty"].Attributes;

       // Checks to see if the value of the BindableAttribute is Yes.
       if(attributes[typeof(BindableAttribute)].Equals(BindableAttribute.Yes)) {
          // Insert code here.
       }

       // This is another way to see whether the property is bindable.
       BindableAttribute myAttribute = 
          (BindableAttribute)attributes[typeof(BindableAttribute)];
       if(myAttribute.Bindable) {
          // Insert code here.
       }

// Yet another way to see whether the property is bindable.
if (attributes.Contains(BindableAttribute.Yes)) {
   // Insert code here.
}

If you marked a class with the BindableAttribute, use the following code example to check the value.

AttributeCollection attributes = 
    TypeDescriptor.GetAttributes(MyProperty);
 if(attributes[typeof(BindableAttribute)].Equals(BindableAttribute.Yes)) {
    // Insert code here.
 }

.NET Framework
Available since 1.1
Silverlight
Available since 4.0

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

Return to top
Show: