ElementPropertyDescriptor Class

  • Article

Represents a domain property in a domain-specific language (DSL) model.

Inheritance Hierarchy

System.Object
  System.ComponentModel.MemberDescriptor
    System.ComponentModel.PropertyDescriptor
      Microsoft.VisualStudio.Modeling.Design.ElementPropertyDescriptor
        Microsoft.VisualStudio.Modeling.Design.TrackingPropertyDescriptor
        Microsoft.VisualStudio.Modeling.Diagrams.LabelShapeTextPropertyDescriptor
        Microsoft.VisualStudio.Modeling.DslDefinition.Design.DslDefinitionModelElementPropertyDescriptor

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

Syntax

'Declaration
Public Class ElementPropertyDescriptor _
    Inherits PropertyDescriptor

public class ElementPropertyDescriptor : PropertyDescriptor

public ref class ElementPropertyDescriptor : public PropertyDescriptor

type ElementPropertyDescriptor =  
    class
        inherit PropertyDescriptor
    end

public class ElementPropertyDescriptor extends PropertyDescriptor

The ElementPropertyDescriptor type exposes the following members.

Constructors

  Name Description
Public method ElementPropertyDescriptor(ModelElement, DomainPropertyInfo, array<Attribute[]) Initializes a new instance of the ElementPropertyDescriptor class.
Public method ElementPropertyDescriptor(ElementTypeDescriptor, ModelElement, DomainPropertyInfo, array<Attribute[]) Initializes a new instance of the ElementPropertyDescriptor class and specifies a default value provider.

Top

Properties

  Name Description
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 category in which to group the domain property when the property is displayed in a PropertyGrid control that is set to Categorized mode. (Overrides MemberDescriptor.Category.)
Public property ComponentType Gets the type of the model 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 described property, as specified in the DescriptionResourceAttribute. (Overrides MemberDescriptor.Description.)
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 property, as specified in the DisplayNameResourceAttribute. (Overrides MemberDescriptor.DisplayName.)
Public property DomainPropertyInfo Gets the property information object that was used to create this property descriptor.
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 property is read-only. (Overrides PropertyDescriptor.IsReadOnly.)
Public property ModelElement Gets the model element that was used to create this property descriptor.
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 property type of the described property. (Overrides PropertyDescriptor.PropertyType.)
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 (Overrides PropertyDescriptor.AddValueChanged(Object, EventHandler).)
Public method CanResetValue Indicates whether the value of the domain property can be reset. (Overrides PropertyDescriptor.CanResetValue(Object).)
Public methodStatic member CanSetProperty
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.)
Public method GetEditor Returns a value editor for the described property. (Overrides PropertyDescriptor.GetEditor(Type).)
Public methodStatic member GetElementPropertyDescriptor Gets the ElementPropertyDescriptor given a ModelElement and DomainPropertyInfo.
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.)
Public methodStatic member GetSetValueTransactionName Returns a localized string for the name of the set value transaction.
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 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 (Overrides PropertyDescriptor.RemoveValueChanged(Object, EventHandler).)
Public method ResetValue Resets the value of the domain property. (Overrides PropertyDescriptor.ResetValue(Object).)
Public methodStatic member SetProperty Set the property value. Property value is generally set via an ElementPropertyDescriptor. It will be set directly via the SetValue method on propertyInfo if - IsBrowsable attribute is set to false on propertyInfo and ElementPropertyDescriptor is not found.
Public method SetValue Sets the value of the domain property. (Overrides PropertyDescriptor.SetValue(Object, Object).)
Public method ShouldSerializeValue Indicates whether the value of the domain 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 domain property of a model element.

The Domain-Specific Language Tools (DSL Tools) use this type to represent the domain class properties in a domain model. This type controls how a property is handled by the property grid in the domain model and provides transactions for modifying the described property.

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

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

RolePlayerPropertyDescriptor

TrackingPropertyDescriptor

ModelElement

PropertyDescriptor