Export (0) Print
Expand All
0 out of 1 rated this helpful - Rate this topic

MergablePropertyAttribute Class

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

Namespace:  System.ComponentModel
Assembly:  System (in System.dll)
[AttributeUsageAttribute(AttributeTargets.All)]
public sealed class MergablePropertyAttribute : Attribute

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 MergablePropertyAttribute.Yes or MergablePropertyAttribute.No.

For more information, see Attributes Overview and Extending Metadata Using Attributes.

The following example marks a property as appropriate to merge.

[MergableProperty(true)]
 public int MyProperty {
    get {
       // Insert code here. 
       return 0;
    }
    set {
       // 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.
 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.
 }

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

AttributeCollection attributes = 
    TypeDescriptor.GetAttributes(MyProperty);
 if(attributes[typeof(MergablePropertyAttribute)].Equals(MergablePropertyAttribute.Yes)) {
    // Insert code here.
 }
System.Object
  System.Attribute
    System.ComponentModel.MergablePropertyAttribute
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.