PresentationElement Class
An element that appears in a user interface and represents a visible presentation of a domain model element.
Inheritance Hierarchy
System.Object
Microsoft.VisualStudio.Modeling.ModelElement
Microsoft.VisualStudio.Modeling.Diagrams.PresentationElement
Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement
Namespace: Microsoft.VisualStudio.Modeling.Diagrams
Assembly: Microsoft.VisualStudio.Modeling.Sdk.Diagrams.10.0 (in Microsoft.VisualStudio.Modeling.Sdk.Diagrams.10.0.dll)
Syntax
'Declaration
<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.PresentationElement.Description", _
GetType(CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")> _
<DomainModelOwnerAttribute(GetType(CoreDesignSurfaceDomainModel))> _
<CLSCompliantAttribute(True)> _
<DomainObjectIdAttribute("9321e0d1-1221-458d-834f-2dc0769ce683")> _
<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.PresentationElement.DisplayName", _
GetType(CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")> _
Public MustInherit Class PresentationElement _
Inherits ModelElement
[DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.PresentationElement.Description",
typeof(CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")]
[DomainModelOwnerAttribute(typeof(CoreDesignSurfaceDomainModel))]
[CLSCompliantAttribute(true)]
[DomainObjectIdAttribute("9321e0d1-1221-458d-834f-2dc0769ce683")]
[DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.PresentationElement.DisplayName",
typeof(CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")]
public abstract class PresentationElement : ModelElement
[DescriptionResourceAttribute(L"Microsoft.VisualStudio.Modeling.Diagrams.PresentationElement.Description",
typeof(CoreDesignSurfaceDomainModel), L"Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")]
[DomainModelOwnerAttribute(typeof(CoreDesignSurfaceDomainModel))]
[CLSCompliantAttribute(true)]
[DomainObjectIdAttribute(L"9321e0d1-1221-458d-834f-2dc0769ce683")]
[DisplayNameResourceAttribute(L"Microsoft.VisualStudio.Modeling.Diagrams.PresentationElement.DisplayName",
typeof(CoreDesignSurfaceDomainModel), L"Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")]
public ref class PresentationElement abstract : public ModelElement
[<AbstractClass>]
[<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.PresentationElement.Description",
typeof(CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")>]
[<DomainModelOwnerAttribute(typeof(CoreDesignSurfaceDomainModel))>]
[<CLSCompliantAttribute(true)>]
[<DomainObjectIdAttribute("9321e0d1-1221-458d-834f-2dc0769ce683")>]
[<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.PresentationElement.DisplayName",
typeof(CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")>]
type PresentationElement =
class
inherit ModelElement
end
public abstract class PresentationElement extends ModelElement
The PresentationElement type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Protected method") |
PresentationElement | Initializes a new instance of the PresentationElement class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
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.) |
|
ModelElement | Gets or sets the model element that is associated with the presentation element. |
|
Partition | Gets or sets the Partition that contains the element. (Inherited from ModelElement.) |
|
Store | Gets the Store that contains the element. (Inherited from ModelElement.) |
|
Subject | Gets or sets the subject for the presentation element. Defaults to the same object as ModelElement. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Associate | Assigns a model element to the presentation element. The same effect as setting ModelElement. |
|
CanMerge | Verifies whether a source element can be added to this element. (Inherited from ModelElement.) |
|
ChooseMergeTarget(ElementGroup) | Selects a target element to accept as its child an element that the user wants to copy, drag, or create. (Inherited from ModelElement.) |
|
ChooseMergeTarget(ElementGroupPrototype) | Selects a target element to accept as its child an element that the user wants to copy, drag, or create. (Inherited from ModelElement.) |
|
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.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
GetDomainClass | Gets the most-derived domain class for this element. (Inherited from ModelElement.) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetRoleCollection<TCollection, TElement>(Guid) | Gets or creates the linked element collection (Inherited from ModelElement.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
MergeConfigure | Not used for presentation elements. (Overrides ModelElement.MergeConfigure(ElementGroup).) |
|
MergeDisconnect | Disconnects a source element from a target element. (Inherited from ModelElement.) |
|
MergeRelate | Creates a relationship between a model element and a group of model elements. (Overrides ModelElement.MergeRelate(ModelElement, ElementGroup).) |
|
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.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Extension Methods
| Name | Description | |
|---|---|---|
.gif "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.) |
|
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 | |
|---|---|---|
.gif "Public field") .gif "Static member") |
DomainClassId | The ID that is assigned to the presentation element. |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
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
Remarks
A typical subclass is ShapeElement, whose instances are shapes and links on a diagram. All diagram, shape and link classes defined in a DSL Definition are PresentationElements.
In a DSL, the semantic aspects of a model are separated from their presentation to the user. One class of domain model element could have more than one alternative type of presentation in the user interface, for example as a shape, or as a line of text. In a DSL whose models are manipulated entirely through an API, the domain model elements do not need a presentation at all.
A PresentationElement is linked to the model element that it displays using the PresentationViewsSubject relationship, and the relationship can be navigated using the ModelElement property.
In a DSL Definition file, the Domain Element Mapping between a shape and a domain class determines what subclasses of domain element and presentation element are linked using PresentationViewsSubject.
Presentation elements and PresentationViewsSubject links are usually created in a separate Partitionfrom the domain model elements.
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.