CustomPropertyDescriptor Class

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

Inheritance Hierarchy

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.11.0 (in Microsoft.VisualStudio.Modeling.Sdk.DslDefinition.11.0.dll)

Syntax

'Declaration
<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.CustomPropertyDescriptor.Description",  _
    GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
<DomainRelationshipAttribute(IsEmbedding := True)> _
<CLSCompliantAttribute(True)> _
<DomainObjectIdAttribute("7ca5645c-dca6-4128-8864-b70deacb107d")> _
<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.CustomPropertyDescriptor.DisplayName",  _
    GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
<DomainModelOwnerAttribute(GetType(DslDefinitionModelDomainModel))> _
Public NotInheritable Class CustomPropertyDescriptor _
    Inherits ElementLink

[DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.CustomPropertyDescriptor.Description", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DomainRelationshipAttribute(IsEmbedding = true)]
[CLSCompliantAttribute(true)]
[DomainObjectIdAttribute("7ca5645c-dca6-4128-8864-b70deacb107d")]
[DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.CustomPropertyDescriptor.DisplayName", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
public sealed class CustomPropertyDescriptor : ElementLink

[DescriptionResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.CustomPropertyDescriptor.Description", 
    typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DomainRelationshipAttribute(IsEmbedding = true)]
[CLSCompliantAttribute(true)]
[DomainObjectIdAttribute(L"7ca5645c-dca6-4128-8864-b70deacb107d")]
[DisplayNameResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.CustomPropertyDescriptor.DisplayName", 
    typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
public ref class CustomPropertyDescriptor sealed : public ElementLink

[<Sealed>]
[<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.CustomPropertyDescriptor.Description", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<DomainRelationshipAttribute(IsEmbedding = true)>]
[<CLSCompliantAttribute(true)>]
[<DomainObjectIdAttribute("7ca5645c-dca6-4128-8864-b70deacb107d")>]
[<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.CustomPropertyDescriptor.DisplayName", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))>]
type CustomPropertyDescriptor =  
    class 
        inherit ElementLink 
    end

public final class CustomPropertyDescriptor extends ElementLink

The CustomPropertyDescriptor type exposes the following members.

Constructors

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

Top

Properties

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

Top

Methods

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

Top

Extension Methods

	Name	Description
	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.)
	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.)
	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.)
	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.)
	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.)
	CanDelete	Deletes the element from the model. (Defined by ImmutabilityExtensionMethods.)
	GetAllExtensions	Return an enumerable that performs a breadth first traversal across the tree of extension elements embedded in this ModelElement. (Defined by ModelElementExtensionMethods.)
	GetBaseElement	Returns the root of the virtual MEL in which the specified ModelElement is participating. (Defined by ModelElementExtensionMethods.)
	GetExtension(Guid)	Overloaded. (Defined by ModelElementExtensionMethods.)
	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.)
	GetExtension(DomainClassInfo)	Overloaded. (Defined by ModelElementExtensionMethods.)
	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.)
	GetLocks	Get the lock flags for this element. This will include any locks enabled on the Partition containing the element. (Defined by ImmutabilityExtensionMethods.)
	IsExtendedBy(Guid)	Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.)
	IsExtendedBy(Type)	Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.)
	IsExtendedBy(DomainClassInfo)	Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.)
	IsLocked	Test whether this element has any of a specified set of locks (Defined by ImmutabilityExtensionMethods.)
	RemoveExtension(Type)	Overloaded. Remove any extension of this ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.)
	RemoveExtension(Guid)	Overloaded. Remove any extension of the specified ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.)
	RemoveExtension(DomainClassInfo)	Overloaded. Remove any extension of the specified ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.)
	RemoveExtension(ExtensionElement)	Overloaded. Remove a specified ExtensionElement from the extensions of this ModelElement. (Defined by ModelElementExtensionMethods.)
	SetLocks	Set the lock flags of this element (Defined by ImmutabilityExtensionMethods.)
	TryGetExtension(Guid)	Overloaded. (Defined by ModelElementExtensionMethods.)
	TryGetExtension(Type)	Overloaded. (Defined by ModelElementExtensionMethods.)
	TryGetExtension(DomainClassInfo)	Overloaded. (Defined by ModelElementExtensionMethods.)
	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
	CategoryDomainPropertyId	Category domain property Id.
	DisplayNameDomainPropertyId	DisplayName domain property Id.
	DistantPropertyPathDomainRoleId	DistantPropertyPath domain role Id.
	DomainClassId	CustomPropertyDescriptor domain class Id.
	GeneratesCustomPropertyDescriptorDomainPropertyId	GeneratesCustomPropertyDescriptor domain property Id.
	IsUIReadOnlyDomainPropertyId	IsUIReadOnly domain property Id.
	TypeDescriptorDomainRoleId	TypeDescriptor domain role Id.

Top

Explicit Interface Implementations

	Name	Description
	IMergeElements.CanMerge	Returns true if this element can merge with the content of the prototype. (Inherited from ModelElement.)
	IMergeElements.ChooseMergeTarget(ElementGroup)	(Inherited from ModelElement.)
	IMergeElements.ChooseMergeTarget(ElementGroupPrototype)	(Inherited from ModelElement.)
	IMergeElements.MergeConfigure	(Inherited from ModelElement.)
	IMergeElements.MergeDisconnect	(Inherited from ModelElement.)
	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