RolePlayerPropertyDescriptor Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Modeling.Design

Assembly:: Microsoft.VisualStudio.Modeling.Sdk.15.0.dll

Assembly:: Microsoft.VisualStudio.Modeling.Sdk.dll

Package:: Microsoft.VisualStudio.Modeling.Sdk v17.10.40171

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Property descriptor for use with ElementLinks to allow a role player to be visualized as a property in the property grid

public ref class RolePlayerPropertyDescriptor : System::ComponentModel::PropertyDescriptor

[System.Diagnostics.DebuggerDisplay("Name = {Name}, Element = {describedElement}, Role = {DomainRoleInfo.Name}")]
public class RolePlayerPropertyDescriptor : System.ComponentModel.PropertyDescriptor

[<System.Diagnostics.DebuggerDisplay("Name = {Name}, Element = {describedElement}, Role = {DomainRoleInfo.Name}")>]
type RolePlayerPropertyDescriptor = class
    inherit PropertyDescriptor

Public Class RolePlayerPropertyDescriptor
Inherits PropertyDescriptor

Inheritance: PropertyDescriptor
RolePlayerPropertyDescriptor

Attributes: DebuggerDisplayAttribute

Constructors

RolePlayerPropertyDescriptor(ModelElement, DomainRoleInfo, Attribute[])	Constructor
RolePlayerPropertyDescriptor(Store, DomainRoleInfo, Attribute[])	Constructor

Properties

AllowNull	Whether null is a valid value for this role player when set via this PropertyDescriptor
ComponentType	The type of component the framework expects for this property.
Converter	Gets the type converter of the property descriptor.
DisplayName	Gets the name that can be displayed in a window, such as a Properties window.
DomainRoleInfo	DomainPropertyInfo for this propery
ElementList	Obsolete. List of valid role players for this property value. By default, this will be all elements in the store of the types assignable to the domain role
IsInstanceBased	Test if this PropertyDescriptor is based on an instance or a static type.
IsReadOnly	Returns whether this property descriptor is read only or not.
PropertyType	Returns the property type.
RelationshipInfo	Returns the domain data for the relationship
RolePlayerMenuCommands	List of RolePlayerMenuCommand objects, which are exposed as items in the drop-down edit list, and provide a callback mechanism for specifying the role player instance when the user chooses a particular item.

Methods

AddValueChanged(Object, EventHandler)	Handle addition of an event listener
BuildElementList(Object, Boolean)	Build a list of the valid role players for this property value of the specified component.
BuildElementList(Object)	Get a list of the valid role players for this property value of the specified component.
CanResetValue(Object)	Roles can be reset to null if nulling is permitted, the property descriptor is not read-only and if any existing link is eligible for deletion.
GetDescribedElement(Object)	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.
GetSetFieldString(String)	Gets a string describing the set field action.
GetStore(Object)	Returns the Store this descriptor operates across
GetValue(Object)	Get the value of the property...
RemoveValueChanged(Object, EventHandler)	Handle removal of an event listener
ResetValue(Object)	Reset domain propertyvalue to the default based on the default of the domain.
SetValue(Object, Object)	Sets the value of the property.
ShouldSerializeValue(Object)	This property doesn't participate in code generation.

Applies to

Share via