MergablePropertyAttribute Class
Specifies that this property can be combined with properties belonging to other objects in a Properties window.
Assembly: System (in System.dll)
The MergablePropertyAttribute type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | MergablePropertyAttribute | Initializes a new instance of the MergablePropertyAttribute class. |
| Name | Description | |
|---|---|---|
![]() | AllowMerge | Gets a value indicating whether this property can be combined with properties belonging to other objects in a Properties window. |
![]() | TypeId | When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.) |
| Name | Description | |
|---|---|---|
![]() | Equals | Indicates whether this instance and a specified object are equal. (Overrides Attribute::Equals(Object).) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetHashCode | Returns the hash code for this instance. (Overrides Attribute::GetHashCode().) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | IsDefaultAttribute | Determines if this attribute is the default. (Overrides Attribute::IsDefaultAttribute().) |
![]() | Match | When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Name | Description | |
|---|---|---|
![]() ![]() | Default | Specifies 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. |
![]() ![]() | No | Specifies that a property cannot be combined with properties belonging to other objects in a Properties window. This static field is read-only. |
![]() ![]() | Yes | Specifies that a property can be combined with properties belonging to other objects in a Properties window. This static field is read-only. |
| Name | Description | |
|---|---|---|
![]() ![]() | _Attribute::GetIDsOfNames | Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.) |
![]() ![]() | _Attribute::GetTypeInfo | Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.) |
![]() ![]() | _Attribute::GetTypeInfoCount | Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.) |
![]() ![]() | _Attribute::Invoke | Provides access to properties and methods exposed by an object. (Inherited from 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.
Note |
|---|
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.
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[ 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.
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.
