Skip to main content
.NET Framework Class Library
MergablePropertyAttribute Class

Specifies that this property can be combined with properties belonging to other objects in a Properties window.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.ComponentModelMergablePropertyAttribute

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)
Syntax
<[%$TOPIC/s33t81b4_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/s33t81b4_en-us_VS_110_2_0_0_0_1%].All)> _
Public NotInheritable Class MergablePropertyAttribute _
	Inherits [%$TOPIC/s33t81b4_en-us_VS_110_2_0_0_0_2%]
[[%$TOPIC/s33t81b4_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/s33t81b4_en-us_VS_110_2_0_1_0_1%].All)]
public sealed class MergablePropertyAttribute : [%$TOPIC/s33t81b4_en-us_VS_110_2_0_1_0_2%]
[[%$TOPIC/s33t81b4_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/s33t81b4_en-us_VS_110_2_0_2_0_1%]::All)]
public ref class MergablePropertyAttribute sealed : public [%$TOPIC/s33t81b4_en-us_VS_110_2_0_2_0_2%]
[<[%$TOPIC/s33t81b4_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/s33t81b4_en-us_VS_110_2_0_3_0_1%]([%$TOPIC/s33t81b4_en-us_VS_110_2_0_3_0_2%].All)>]
type MergablePropertyAttribute =  
    class 
        inherit [%$TOPIC/s33t81b4_en-us_VS_110_2_0_3_0_3%] 
    end

The MergablePropertyAttribute type exposes the following members.

Constructors
  NameDescription
Public method MergablePropertyAttributeInitializes a new instance of the MergablePropertyAttribute class.
Top
Properties
  NameDescription
Public property AllowMergeGets a value indicating whether this property can be combined with properties belonging to other objects in a Properties window.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method EqualsIndicates whether this instance and a specified object are equal. (Overrides AttributeEquals(Object).)
Public method GetHashCodeReturns the hash code for this instance. (Overrides AttributeGetHashCode.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeDetermines if this attribute is the default. (Overrides AttributeIsDefaultAttribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Fields
  NameDescription
Public field Static member DefaultSpecifies the default value, which is Yes, that is a property can be combined with properties belonging to other objects in a Properties window. This static field is read-only.
Public field Static member NoSpecifies that a property cannot be combined with properties belonging to other objects in a Properties window. This static field is read-only.
Public field Static member YesSpecifies that a property can be combined with properties belonging to other objects in a Properties window. This static field is read-only.
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

Properties that are marked with the MergablePropertyAttribute set to true can be combined with properties belonging to other objects in a Properties window. Properties that are marked with the MergablePropertyAttribute set to false must be displayed separately. The default is true.

NoteNote

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

For more information, see Extending Metadata Using Attributes.

Examples

The following example marks a property as appropriate to merge.

<MergableProperty(True)> _
Public Property MyProperty() As Integer 
    Get 
        ' Insert code here. 
        Return 0
    End Get 
    Set 
        ' Insert code here. 
    End Set  
End Property
[MergableProperty(true)]
 public int MyProperty {
    get {
       // Insert code here. 
       return 0;
    }
    set {
       // Insert code here.
    }
 }
public:
   [MergableProperty(true)]
   property int MyProperty 
   {
      int get()
      {
         // Insert code here. 
         return 0;
      }
      void set( int value )
      {
         // Insert code here.
      }
   }

The next example shows how to check the value of the MergablePropertyAttribute for MyProperty. First the code gets a PropertyDescriptorCollection with all the properties for the object. Next it indexes into the PropertyDescriptorCollection to get MyProperty. Then it returns the attributes for this property and saves them in the attributes variable.

The example presents two different ways of checking the value of the MergablePropertyAttribute. In the second code fragment, the example calls the Equals method with a static value. In the last code fragment, the example uses the AllowMerge property to check the value.

' Gets the attributes for the property. 
Dim attributes As AttributeCollection = _
    TypeDescriptor.GetProperties(Me)("MyProperty").Attributes

' Checks to see if the value of the MergablePropertyAttribute is Yes. 
If attributes(GetType(MergablePropertyAttribute)).Equals(MergablePropertyAttribute.Yes) Then 
    ' Insert code here. 
End If  

' This is another way to see if the property is bindable. 
Dim myAttribute As MergablePropertyAttribute = _
    CType(attributes(GetType(MergablePropertyAttribute)), MergablePropertyAttribute)
If myAttribute.AllowMerge Then 
    ' Insert code here. 
End If
// Gets the attributes for the property.
 AttributeCollection attributes = 
    TypeDescriptor.GetProperties(this)["MyProperty"].Attributes;

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

 // This is another way to see if the property is bindable.
 MergablePropertyAttribute myAttribute = 
    (MergablePropertyAttribute)attributes[typeof(MergablePropertyAttribute)];
 if(myAttribute.AllowMerge) {
    // Insert code here.
 }
// Gets the attributes for the property.
AttributeCollection^ attributes = TypeDescriptor::GetProperties( this )[ "MyProperty" ]->Attributes;

// Checks to see if the value of the MergablePropertyAttribute is Yes. 
if ( attributes[ MergablePropertyAttribute::typeid ]->Equals( MergablePropertyAttribute::Yes ) )
{
   // Insert code here.
}

// This is another way to see if the property is bindable.
MergablePropertyAttribute^ myAttribute = dynamic_cast<MergablePropertyAttribute^>(attributes[ MergablePropertyAttribute::typeid ]);
if ( myAttribute->AllowMerge )
{
   // Insert code here.
}

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

Dim attributes As AttributeCollection = TypeDescriptor.GetAttributes(MyProperty)
If attributes(GetType(MergablePropertyAttribute)).Equals(MergablePropertyAttribute.Yes) Then 
    ' Insert code here. 
End If
AttributeCollection attributes = 
    TypeDescriptor.GetAttributes(MyProperty);
 if(attributes[typeof(MergablePropertyAttribute)].Equals(MergablePropertyAttribute.Yes)) {
    // Insert code here.
 }
AttributeCollection^ attributes = TypeDescriptor::GetAttributes( MyProperty );
if ( attributes[ MergablePropertyAttribute::typeid ]->Equals( MergablePropertyAttribute::Yes ) )
{
   // Insert code here.
}
Version Information

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

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.

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.