Share via


CustomPropertyDescriptor Class

DomainRelationship CustomPropertyDescriptor Relates a type descriptor to a property path, thereby defining a custom property descriptor.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Modeling.ModelElement
    Microsoft.VisualStudio.Modeling.ElementLink
      Microsoft.VisualStudio.Modeling.DslDefinition.CustomPropertyDescriptor

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

Syntax

'Declaration
<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.CustomPropertyDescriptor.DisplayName",  _
    GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.CustomPropertyDescriptor.Description",  _
    GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
<DomainModelOwnerAttribute(GetType(DslDefinitionModelDomainModel))> _
<CLSCompliantAttribute(True)> _
<DomainRelationshipAttribute(IsEmbedding := True)> _
<DomainObjectIdAttribute("7ca5645c-dca6-4128-8864-b70deacb107d")> _
Public NotInheritable Class CustomPropertyDescriptor _
    Inherits ElementLink
[DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.CustomPropertyDescriptor.DisplayName", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.CustomPropertyDescriptor.Description", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
[CLSCompliantAttribute(true)]
[DomainRelationshipAttribute(IsEmbedding = true)]
[DomainObjectIdAttribute("7ca5645c-dca6-4128-8864-b70deacb107d")]
public sealed class CustomPropertyDescriptor : ElementLink
[DisplayNameResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.CustomPropertyDescriptor.DisplayName", 
    typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DescriptionResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.CustomPropertyDescriptor.Description", 
    typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
[CLSCompliantAttribute(true)]
[DomainRelationshipAttribute(IsEmbedding = true)]
[DomainObjectIdAttribute(L"7ca5645c-dca6-4128-8864-b70deacb107d")]
public ref class CustomPropertyDescriptor sealed : public ElementLink
[<Sealed>]
[<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.CustomPropertyDescriptor.DisplayName", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.CustomPropertyDescriptor.Description", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))>]
[<CLSCompliantAttribute(true)>]
[<DomainRelationshipAttribute(IsEmbedding = true)>]
[<DomainObjectIdAttribute("7ca5645c-dca6-4128-8864-b70deacb107d")>]
type CustomPropertyDescriptor =  
    class 
        inherit ElementLink 
    end
public final class CustomPropertyDescriptor extends ElementLink

The CustomPropertyDescriptor type exposes the following members.

Constructors

  Name Description
Public method CustomPropertyDescriptor(DomainTypeDescriptor, PropertyPath) Constructor Creates a CustomPropertyDescriptor link in the same Partition as the given DomainTypeDescriptor
Public method CustomPropertyDescriptor(Partition, array<RoleAssignment[]) Constructor
Public method CustomPropertyDescriptor(Store, array<RoleAssignment[]) Constructor
Public method CustomPropertyDescriptor(Partition, array<RoleAssignment[], array<PropertyAssignment[]) Constructor
Public method CustomPropertyDescriptor(Store, array<RoleAssignment[], array<PropertyAssignment[]) Constructor

Top

Properties

  Name Description
Public property Category Gets or sets the value of Category domain property. Category under which the property appears in the properties window.
Public property DisplayName Gets or sets the value of DisplayName domain property. The name that will be displayed in the generated designer for the property.
Public property DistantPropertyPath DomainRole DistantPropertyPath
Public property GeneratesCustomPropertyDescriptor Gets or sets the value of GeneratesCustomPropertyDescriptor domain property. If True, a custom property descriptor is generated.
Public property Id Gets the ID of the element. (Inherited from ModelElement.)
Public property IsActive Gets the IsActive flag and verifies to see whether the element is active. (Inherited from ModelElement.)
Public property IsDeleted Gets the IsDeleted flag and checks to see whether the element has been deleted from the model. (Inherited from ModelElement.)
Public property IsDeleting Gets the IsDeleting flag and verifies whether the element is currently being deleted from the model. (Inherited from ModelElement.)
Public property IsUIReadOnly Gets or sets the value of IsUIReadOnly domain property. If True, the property can not be edited through the UI when browsed.
Public property LinkedElements Gets a read-only collection of elements connected by this element link. (Inherited from ElementLink.)
Public property Partition Gets or sets the Partition that contains the element. (Inherited from ModelElement.)
Public property Store Gets the Store that contains the element. (Inherited from ModelElement.)
Public property TypeDescriptor DomainRole TypeDescriptor Paths identifying properties to be included in the type descriptor.

Top

Methods

  Name Description
Public method Copy() Creates a copy of the element in the model. (Inherited from ModelElement.)
Public method Copy(IEnumerable<Guid>) Creates a copy of the element and its child links and elements. (Inherited from ModelElement.)
Public method Delete() Deletes an element from the model. (Inherited from ModelElement.)
Public method Delete(array<Guid[]) Deletes an element from the model. (Inherited from ModelElement.)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method GetDomainClass Gets the most-derived domain class for this element. (Inherited from ModelElement.)
Public method GetDomainRelationship Gets the domain relationship that this link instantiates. (Inherited from ElementLink.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public methodStatic member GetLink Get the one CustomPropertyDescriptor link between a given DomainTypeDescriptorand a PropertyPath.
Public methodStatic member GetLinks Get any CustomPropertyDescriptor links between a given DomainTypeDescriptor and a PropertyPath.
Public methodStatic member GetLinksToPathsOfCustomPropertyDescriptors Get the list of CustomPropertyDescriptor links to a DomainTypeDescriptor.
Public methodStatic member GetLinkToTypeDescriptor Get the CustomPropertyDescriptor link to a PropertyPath.
Public methodStatic member GetPathsOfCustomPropertyDescriptors Gets a list of PathsOfCustomPropertyDescriptors.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public methodStatic member GetTypeDescriptor Gets TypeDescriptor.
Public method MoveBefore Change the order of links connected to an element, moving this link before another. (Inherited from ElementLink.)
Public method MoveToIndex Move this link to a specified index position in the list. (Inherited from ElementLink.)
Protected method OnCopy Called when this element has been created as a copy of another element. (Inherited from ModelElement.)
Protected method OnDeleted Called when this element has been deleted from the model. (Inherited from ModelElement.)
Protected method OnDeleting Called when this element is about to be deleted. (Inherited from ModelElement.)
Protected method OnResurrected Called when this element has been added back to a model. (Inherited from ModelElement.)
Protected method OnRolePlayerPositionChanged Called when the position of a role has changed. (Inherited from ModelElement.)
Protected method OnRolePlayerPositionChanging Called when a role player position is about to change. (Inherited from ModelElement.)
Public methodStatic member SetTypeDescriptor Sets TypeDescriptor.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

  Name Description
Public Extension Method AddExtension(Guid) Overloaded. Extend this ModelElement with newly instantiated extension of the identified domain type. An InvalidOperationException will be thrown if the element already has an extension of that type. (Defined by ModelElementExtensionMethods.)
Public Extension Method AddExtension(Type) Overloaded. Extend this ModelElement with a newly instantiated extension of the specified type. An InvalidOperationException will be thrown if the element already has an extension of that type. (Defined by ModelElementExtensionMethods.)
Public Extension Method AddExtension(DomainClassInfo) Overloaded. Extend this ModelElement with a newly instantiated extension of the specified domain type. An InvalidOperationException will be thrown if the element already has an extension of that type. (Defined by ModelElementExtensionMethods.)
Public Extension Method AddExtension(ExtensionElement) Overloaded. Extend this ModelElement with a specific extension. An InvalidOperationException will be thrown if the element already has an extension of the same type. (Defined by ModelElementExtensionMethods.)
Public Extension Method AddExtension<T>() Overloaded. Extend this ModelElement with a newly instantiated extension of a particular type. An InvalidOperationException will be thrown if the element already has an extension of the same type. (Defined by ModelElementExtensionMethods.)
Public Extension Method CanDelete Deletes the element from the model. (Defined by ImmutabilityExtensionMethods.)
Public Extension Method GetAllExtensions Return an enumerable that performs a breadth first traversal across the tree of extension elements embedded in this ModelElement. (Defined by ModelElementExtensionMethods.)
Public Extension Method GetBaseElement Returns the root of the virtual MEL in which the specified ModelElement is participating. (Defined by ModelElementExtensionMethods.)
Public Extension Method GetExtension(Guid) Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension Method GetExtension(Type) Overloaded. Get the ExtensionElement of the specified type from the available extensions of this ModelElement. If the element has no such extension then an InvalidOperationException will be raised. (Defined by ModelElementExtensionMethods.)
Public Extension Method GetExtension(DomainClassInfo) Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension Method GetExtension<T>() Overloaded. Get the ExtensionElement of the specified type from the available extensions of this ModelElement. If the element has no such extension then an InvalidOperationException will be raised. (Defined by ModelElementExtensionMethods.)
Public Extension Method GetLocks Get the lock flags for this element. This will include any locks enabled on the Partition containing the element. (Defined by ImmutabilityExtensionMethods.)
Public Extension Method IsExtendedBy(Guid) Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method IsExtendedBy(Type) Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method IsExtendedBy(DomainClassInfo) Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method IsLocked Test whether this element has any of a specified set of locks (Defined by ImmutabilityExtensionMethods.)
Public Extension Method RemoveExtension(Type) Overloaded. Remove any extension of this ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method RemoveExtension(Guid) Overloaded. Remove any extension of the specified ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method RemoveExtension(DomainClassInfo) Overloaded. Remove any extension of the specified ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method RemoveExtension(ExtensionElement) Overloaded. Remove a specified ExtensionElement from the extensions of this ModelElement. (Defined by ModelElementExtensionMethods.)
Public Extension Method SetLocks Set the lock flags of this element (Defined by ImmutabilityExtensionMethods.)
Public Extension Method TryGetExtension(Guid) Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension Method TryGetExtension(Type) Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension Method TryGetExtension(DomainClassInfo) Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension Method TryGetExtension<T>() Overloaded. Get the ExtensionElement of the specified type from the available extensions of this ModelElement. If this element has no such extension then the result will be null. (Defined by ModelElementExtensionMethods.)

Top

Fields

  Name Description
Public fieldStatic member CategoryDomainPropertyId Category domain property Id.
Public fieldStatic member DisplayNameDomainPropertyId DisplayName domain property Id.
Public fieldStatic member DistantPropertyPathDomainRoleId DistantPropertyPath domain role Id.
Public fieldStatic member DomainClassId CustomPropertyDescriptor domain class Id.
Public fieldStatic member GeneratesCustomPropertyDescriptorDomainPropertyId GeneratesCustomPropertyDescriptor domain property Id.
Public fieldStatic member IsUIReadOnlyDomainPropertyId IsUIReadOnly domain property Id.
Public fieldStatic member TypeDescriptorDomainRoleId TypeDescriptor domain role Id.

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IMergeElements.CanMerge Returns true if this element can merge with the content of the prototype. (Inherited from ModelElement.)
Explicit interface implemetationPrivate method IMergeElements.ChooseMergeTarget(ElementGroup) (Inherited from ModelElement.)
Explicit interface implemetationPrivate method IMergeElements.ChooseMergeTarget(ElementGroupPrototype) (Inherited from ModelElement.)
Explicit interface implemetationPrivate method IMergeElements.MergeConfigure (Inherited from ModelElement.)
Explicit interface implemetationPrivate method IMergeElements.MergeDisconnect (Inherited from ModelElement.)
Explicit interface implemetationPrivate method IMergeElements.MergeRelate (Inherited from ModelElement.)

Top

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.DslDefinition Namespace