Export (0) Print
Expand All

BindableAttribute Class

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

System::Object
  System::Attribute
    System.ComponentModel::BindableAttribute

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

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

The BindableAttribute type exposes the following members.

  NameDescription
Public methodBindableAttribute(BindableSupport)Initializes a new instance of the BindableAttribute class with one of the BindableSupport values.
Public methodBindableAttribute(Boolean)Initializes a new instance of the BindableAttribute class with a Boolean value.
Public methodBindableAttribute(BindableSupport, BindingDirection)Initializes a new instance of the BindableAttribute class.
Public methodBindableAttribute(Boolean, BindingDirection)Initializes a new instance of the BindableAttribute class.
Top

  NameDescription
Public propertyBindableGets a value indicating that a property is typically used for binding.
Public propertyDirectionGets a value indicating the direction or directions of this property's data binding.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top

  NameDescription
Public methodEqualsDetermines whether two BindableAttribute objects are equal. (Overrides Attribute::Equals(Object).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for the BindableAttribute class. (Overrides Attribute::GetHashCode().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeDetermines if this attribute is the default. (Overrides Attribute::IsDefaultAttribute().)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public fieldStatic memberDefaultSpecifies the default value for the BindableAttribute, which is No. This field is read-only.
Public fieldStatic memberNoSpecifies that a property is not typically used for binding. This field is read-only.
Public fieldStatic memberYesSpecifies that a property is typically used for binding. This field is read-only.
Top

  NameDescription
Explicit interface implemetationPrivate method_Attribute::GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute::GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute::GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute::InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

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.

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.

Caution noteCaution

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.


property int MyProperty 
{
   [System::ComponentModel::Bindable(true)]
   int get()
   {
      // Insert code here.
      return 0;
   }

   [System::ComponentModel::Bindable(true)]
   void set( int )
   {
      // 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.


using namespace System::ComponentModel;

// 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[ BindableAttribute::typeid ]->Equals( BindableAttribute::Yes ) )
{
   // Insert code here.
}

// This is another way to see whether the property is bindable.
BindableAttribute^ myAttribute = static_cast<BindableAttribute^>(attributes[ BindableAttribute::typeid ]);
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.


using namespace System::ComponentModel;
AttributeCollection^ attributes = TypeDescriptor::GetAttributes( MyProperty );
if ( attributes[ BindableAttribute::typeid ]->Equals( BindableAttribute::Yes ) )
{
   // Insert code here.
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

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

Community Additions

ADD
Show:
© 2014 Microsoft