RolePlayerPropertyDescriptor Class

  • Article

Provides additional run-time type information for a role property.

Inheritance Hierarchy

System.Object
  System.ComponentModel.MemberDescriptor
    System.ComponentModel.PropertyDescriptor
      Microsoft.VisualStudio.Modeling.Design.RolePlayerPropertyDescriptor

Namespace:  Microsoft.VisualStudio.Modeling.Design
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.10.0 (in Microsoft.VisualStudio.Modeling.Sdk.10.0.dll)

Syntax

'Declaration
<HostProtectionAttribute(SecurityAction.LinkDemand, SharedState := True)> _
Public Class RolePlayerPropertyDescriptor _
    Inherits PropertyDescriptor

[HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)]
public class RolePlayerPropertyDescriptor : PropertyDescriptor

[HostProtectionAttribute(SecurityAction::LinkDemand, SharedState = true)]
public ref class RolePlayerPropertyDescriptor : public PropertyDescriptor

[<HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)>]
type RolePlayerPropertyDescriptor =  
    class
        inherit PropertyDescriptor
    end

public class RolePlayerPropertyDescriptor extends PropertyDescriptor

The RolePlayerPropertyDescriptor type exposes the following members.

Constructors

  Name Description
Public method RolePlayerPropertyDescriptor(ModelElement, DomainRoleInfo, array<Attribute[]) Initializes a new instance of the RolePlayerPropertyDescriptor class.
Public method RolePlayerPropertyDescriptor(Store, DomainRoleInfo, array<Attribute[]) Constructor

Top

Properties

  Name Description
Public property AllowNull Gets or sets a value that indicates whether null is a valid value for the described role property.
Protected property AttributeArray Gets or sets an array of attributes. (Inherited from MemberDescriptor.)
Public property Attributes Gets the collection of attributes for this member. (Inherited from MemberDescriptor.)
Public property Category Gets the name of the category to which the member belongs, as specified in the CategoryAttribute. (Inherited from MemberDescriptor.)
Public property ComponentType Gets the type of the domain element to which this property is bound. (Overrides PropertyDescriptor.ComponentType.)
Public property Converter Gets the converter for the described property. (Overrides PropertyDescriptor.Converter.)
Public property Description Gets the description of the member, as specified in the DescriptionAttribute. (Inherited from MemberDescriptor.)
Public property DesignTimeOnly Gets whether this member should be set only at design time, as specified in the DesignOnlyAttribute. (Inherited from MemberDescriptor.)
Public property DisplayName Gets the display name of the described role property. (Overrides MemberDescriptor.DisplayName.)
Public property DomainRoleInfo Gets the metadata for the role of the model element in the link.
Public property ElementList Obsolete. Gets a collection of valid values for the described role property.
Public property IsBrowsable Gets a value indicating whether the member is browsable, as specified in the BrowsableAttribute. (Inherited from MemberDescriptor.)
Public property IsInstanceBased Test if this PropertyDescriptor is based on an instance or a static type.
Public property IsLocalizable Gets a value indicating whether this property should be localized, as specified in the LocalizableAttribute. (Inherited from PropertyDescriptor.)
Public property IsReadOnly Gets a value that indicates whether the described role property is read-only. (Overrides PropertyDescriptor.IsReadOnly.)
Public property Name Gets the name of the member. (Inherited from MemberDescriptor.)
Protected property NameHashCode Gets the hash code for the name of the member, as specified in GetHashCode. (Inherited from MemberDescriptor.)
Public property PropertyType Gets the type of the property. (Overrides PropertyDescriptor.PropertyType.)
Public property RelationshipInfo Gets the metadata for the link in which the model element is a role player.
Public property RolePlayerMenuCommands Gets the collection of RolePlayerMenuCommand objects that represent the callback commands for specifying the role player instance when a user selects a particular item.
Public property SerializationVisibility Gets a value indicating whether this property should be serialized, as specified in the DesignerSerializationVisibilityAttribute. (Inherited from PropertyDescriptor.)
Public property SupportsChangeEvents Gets a value indicating whether value change notifications for this property may originate from outside the property descriptor. (Inherited from PropertyDescriptor.)

Top

Methods

  Name Description
Public method AddValueChanged Handle addition of an event listener (Overrides PropertyDescriptor.AddValueChanged(Object, EventHandler).)
Protected method BuildElementList(Object) Get a list of the valid role players for this property value of the specified component.
Protected method BuildElementList(Object, Boolean) Build a list of the valid role players for this property value of the specified component.
Public method CanResetValue Indicates whether the value of the domain property can be reset. (Overrides PropertyDescriptor.CanResetValue(Object).)
Protected method CreateAttributeCollection Creates a collection of attributes using the array of attributes passed to the constructor. (Inherited from MemberDescriptor.)
Protected method CreateInstance Creates an instance of the specified type. (Inherited from PropertyDescriptor.)
Public method Equals Compares this to another object to see if they are equivalent. (Inherited from PropertyDescriptor.)
Protected method FillAttributes Adds the attributes of the PropertyDescriptor to the specified list of attributes in the parent class. (Inherited from PropertyDescriptor.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetChildProperties() Returns the default PropertyDescriptorCollection. (Inherited from PropertyDescriptor.)
Public method GetChildProperties(array<Attribute[]) Returns a PropertyDescriptorCollection using a specified array of attributes as a filter. (Inherited from PropertyDescriptor.)
Public method GetChildProperties(Object) Returns a PropertyDescriptorCollection for a given object. (Inherited from PropertyDescriptor.)
Public method GetChildProperties(Object, array<Attribute[]) Returns a PropertyDescriptorCollection for a given object using a specified array of attributes as a filter. (Inherited from PropertyDescriptor.)
Protected method GetDescribedElement Returns the ModelElement for which this RolePlayerPropertyDescriptor is representing a role property (i.e. the host element). Note that this is not necessarily the source of the relationship.
Public method GetEditor Gets an editor of the specified type. (Inherited from PropertyDescriptor.)
Public method GetHashCode Returns the hash code for this object. (Inherited from PropertyDescriptor.)
Protected method GetInvocationTarget This method returns the object that should be used during invocation of members. (Inherited from PropertyDescriptor.)
Protected method GetSetFieldString Returns a localized string for the name of the set value transaction.
Public method GetStore Returns the Store this descriptor operates across
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method GetTypeFromName Returns a type using its name. (Inherited from PropertyDescriptor.)
Public method GetValue Gets the value of the domain role property. (Overrides PropertyDescriptor.GetValue(Object).)
Protected method GetValueChangedHandler Retrieves the current set of ValueChanged event handlers for a specific component (Inherited from PropertyDescriptor.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnValueChanged Raises the ValueChanged event that you implemented. (Inherited from PropertyDescriptor.)
Public method RemoveValueChanged Handle removal of an event listener (Overrides PropertyDescriptor.RemoveValueChanged(Object, EventHandler).)
Public method ResetValue Resets the value of the role property. (Overrides PropertyDescriptor.ResetValue(Object).)
Public method SetValue Sets the value of the domain role property. (Overrides PropertyDescriptor.SetValue(Object, Object).)
Public method ShouldSerializeValue Indicates whether the value of the role property should be serialized. (Overrides PropertyDescriptor.ShouldSerializeValue(Object).)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

This class provides dynamic custom property information for a role property.

An ElementTypeDescriptor for a model element can return a collection of property descriptors for the properties of that model element. This collection can contain property descriptors for certain of the links in which the element is a role player. These property descriptors are instances of this class. For more information, see Defining Domain Relationships and the following methods of the ElementTypeDescriptor class: CreateRolePlayerPropertyDescriptor, GetDisplayProperties, and ShouldCreateRolePlayerPropertyDescriptor.

To create a customized role property descriptor, inherit from this class and override one or more of the members.

Note

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: SharedState. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

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.

See Also

Reference

Microsoft.VisualStudio.Modeling.Design Namespace

ElementTypeDescriptor

Other Resources

Defining Domain Relationships