TrackingPropertyDescriptor Class

 

Provides additional run-time type information for a tracking property of a model element.

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


public ref class TrackingPropertyDescriptor : ElementPropertyDescriptor

NameDescription
System_CAPS_pubmethodTrackingPropertyDescriptor(ElementTypeDescriptor^, ModelElement^, DomainPropertyInfo^, DomainPropertyInfo^, array<Attribute^>^)

Initializes a new instance of the TrackingPropertyDescriptor class and specifies a default value provider.

System_CAPS_pubmethodTrackingPropertyDescriptor(ModelElement^, DomainPropertyInfo^, DomainPropertyInfo^, array<Attribute^>^)

Initializes a new instance of the TrackingPropertyDescriptor class.

NameDescription
System_CAPS_protpropertyAttributeArray

(Inherited from MemberDescriptor.)

System_CAPS_pubpropertyAttributes

(Inherited from MemberDescriptor.)

System_CAPS_pubpropertyCategory

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.(Inherited from ElementPropertyDescriptor.)

System_CAPS_pubpropertyComponentType

Gets the type of the model element to which this property is bound.(Inherited from ElementPropertyDescriptor.)

System_CAPS_pubpropertyConverter

Gets the converter for the described property.(Inherited from ElementPropertyDescriptor.)

System_CAPS_pubpropertyDescription

Gets the description of the described property, as specified in the DescriptionResourceAttribute.(Inherited from ElementPropertyDescriptor.)

System_CAPS_pubpropertyDesignTimeOnly

(Inherited from MemberDescriptor.)

System_CAPS_pubpropertyDisplayName

Gets the display name of the described property, as specified in the DisplayNameResourceAttribute.(Inherited from ElementPropertyDescriptor.)

System_CAPS_pubpropertyDomainPropertyInfo

Gets the property information object that was used to create this property descriptor.(Inherited from ElementPropertyDescriptor.)

System_CAPS_pubpropertyIsBrowsable

(Inherited from MemberDescriptor.)

System_CAPS_pubpropertyIsInstanceBased

Test if this PropertyDescriptor is based on an instance or a static type.(Inherited from ElementPropertyDescriptor.)

System_CAPS_pubpropertyIsLocalizable

(Inherited from PropertyDescriptor.)

System_CAPS_pubpropertyIsReadOnly

Gets a value that indicates whether the described property is read-only.(Inherited from ElementPropertyDescriptor.)

System_CAPS_pubpropertyModelElement

Gets the model element that was used to create this property descriptor.(Inherited from ElementPropertyDescriptor.)

System_CAPS_pubpropertyName

(Inherited from MemberDescriptor.)

System_CAPS_protpropertyNameHashCode

(Inherited from MemberDescriptor.)

System_CAPS_pubpropertyPropertyType

Gets the property type of the described property.(Inherited from ElementPropertyDescriptor.)

System_CAPS_pubpropertySerializationVisibility

(Inherited from PropertyDescriptor.)

System_CAPS_pubpropertySupportsChangeEvents

(Inherited from PropertyDescriptor.)

NameDescription
System_CAPS_pubmethodAddValueChanged(Object^, EventHandler^)

(Inherited from ElementPropertyDescriptor.)

System_CAPS_pubmethodCanResetValue(Object^)

Indicates whether the value of the domain property can be reset.(Overrides ElementPropertyDescriptor::CanResetValue(Object^).)

System_CAPS_protmethodCreateAttributeCollection()

(Inherited from MemberDescriptor.)

System_CAPS_protmethodCreateInstance(Type^)

(Inherited from PropertyDescriptor.)

System_CAPS_pubmethodEquals(Object^)

(Inherited from PropertyDescriptor.)

System_CAPS_protmethodFillAttributes(IList^)

(Inherited from PropertyDescriptor.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetChildProperties()

(Inherited from PropertyDescriptor.)

System_CAPS_pubmethodGetChildProperties(array<Attribute^>^)

(Inherited from PropertyDescriptor.)

System_CAPS_pubmethodGetChildProperties(Object^)

(Inherited from PropertyDescriptor.)

System_CAPS_pubmethodGetChildProperties(Object^, array<Attribute^>^)

(Inherited from PropertyDescriptor.)

System_CAPS_pubmethodGetEditor(Type^)

Returns a value editor for the described property.(Inherited from ElementPropertyDescriptor.)

System_CAPS_pubmethodGetHashCode()

(Inherited from PropertyDescriptor.)

System_CAPS_protmethodGetInvocationTarget(Type^, Object^)

(Inherited from PropertyDescriptor.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodGetTypeFromName(String^)

(Inherited from PropertyDescriptor.)

System_CAPS_pubmethodGetValue(Object^)

Gets the value of the domain property.(Inherited from ElementPropertyDescriptor.)

System_CAPS_protmethodGetValueChangedHandler(Object^)

(Inherited from PropertyDescriptor.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodOnValueChanged(Object^, EventArgs^)

(Inherited from PropertyDescriptor.)

System_CAPS_pubmethodRemoveValueChanged(Object^, EventHandler^)

(Inherited from ElementPropertyDescriptor.)

System_CAPS_pubmethodResetValue(Object^)

Resets the value of the tracking property.(Overrides ElementPropertyDescriptor::ResetValue(Object^).)

System_CAPS_pubmethodSetValue(Object^, Object^)

Sets the value of the domain property.(Inherited from ElementPropertyDescriptor.)

System_CAPS_pubmethodShouldSerializeValue(Object^)

Indicates whether the value of the tracking property should be serialized.(Overrides ElementPropertyDescriptor::ShouldSerializeValue(Object^).)

System_CAPS_pubmethodToString()

(Inherited from Object.)

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

The Domain-Specific Language Tools (DSL Tools) use this type to represent a domain class property that, until it is updated by the user, is calculated based on the value of another domain property. This type controls how a tracking property is handled by the property grid in the domain model and provides transactions for modifying the described property.

A tracking property has two states: tracking and updated by the user. This state is represented by a second, Boolean property, which is specified when the tracking property descriptor is created. By default, the value of the Boolean property should be true, which corresponds to the tracking state.

This descriptor controls whether the Reset command is enabled on the shortcut menu in the property grid for the property, and updates the value of the associated Boolean property when the tracking property is reset.

Notes to Callers:

To add a tracking property to a DSL definition, implement the following features:

  • A custom property-value-changed handler for each tracked property.

  • A custom type descriptor that returns a tracking property descriptor for each tracking property.

  • Every tracking property in such a way that its value is calculated when the associated Boolean property is true.

You also have to ensure that the value of every tracking property is set correctly whenever the store is constructed, such as during creation and loading of the DSL model.

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

Return to top
Show: