Export (0) Print
Expand All

MergablePropertyAttribute Class

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

System.Object
  System.Attribute
    System.ComponentModel.MergablePropertyAttribute

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

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

The MergablePropertyAttribute type exposes the following members.

  NameDescription
Public methodMergablePropertyAttributeInitializes a new instance of the MergablePropertyAttribute class.
Top

  NameDescription
Public propertyAllowMergeGets a value indicating whether this property can be combined with properties belonging to other objects in a Properties window.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top

  NameDescription
Public methodEqualsIndicates whether this instance and a specified object are equal. (Overrides Attribute.Equals(Object).)
Public methodGetHashCodeReturns the hash code for this instance. (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.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public fieldStatic memberDefaultSpecifies 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 fieldStatic memberNoSpecifies that a property cannot be combined with properties belonging to other objects in a Properties window. This static field is read-only.
Public fieldStatic memberYesSpecifies that a property can be combined with properties belonging to other objects in a Properties window. This static 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

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 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.
 }

.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

Windows 8.1, Windows Server 2012 R2, 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.

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