PresentationElement Class

 

An element that appears in a user interface and represents a visible presentation of a domain model element.

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


[DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.PresentationElement.DisplayName", 
	typeof(CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")]
[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")]
public abstract class PresentationElement : ModelElement

NameDescription
System_CAPS_protmethodPresentationElement(Partition, PropertyAssignment[])

Initializes a new instance of the PresentationElement class.

NameDescription
System_CAPS_pubpropertyId

Gets the ID of the element.(Inherited from ModelElement.)

System_CAPS_pubpropertyIsActive

Gets the IsActive flag and verifies to see whether the element is active.(Inherited from ModelElement.)

System_CAPS_pubpropertyIsDeleted

Gets the IsDeleted flag and checks to see whether the element has been deleted from the model.(Inherited from ModelElement.)

System_CAPS_pubpropertyIsDeleting

Gets the IsDeleting flag and verifies whether the element is currently being deleted from the model.(Inherited from ModelElement.)

System_CAPS_pubpropertyModelElement

Gets or sets the model element that is associated with the presentation element.

System_CAPS_pubpropertyPartition

Gets or sets the Partition that contains the element.(Inherited from ModelElement.)

System_CAPS_pubpropertyStore

Gets the Store that contains the element.(Inherited from ModelElement.)

System_CAPS_pubpropertySubject

Gets or sets the subject for the presentation element. Defaults to the same object as ModelElement.

NameDescription
System_CAPS_pubmethodAssociate(ModelElement)

Assigns a model element to the presentation element. The same effect as setting ModelElement.

System_CAPS_protmethodCanMerge(ProtoElementBase, ElementGroupPrototype)

Verifies whether a source element can be added to this element.(Inherited from ModelElement.)

System_CAPS_protmethodChooseMergeTarget(ElementGroup)

Selects a target element to accept as its child an element that the user wants to copy, drag, or create.(Inherited from ModelElement.)

System_CAPS_protmethodChooseMergeTarget(ElementGroupPrototype)

Selects a target element to accept as its child an element that the user wants to copy, drag, or create.(Inherited from ModelElement.)

System_CAPS_pubmethodCopy()

Creates a copy of the element in the model.(Inherited from ModelElement.)

System_CAPS_pubmethodCopy(IEnumerable<Guid>)

Creates a copy of the element and its child links and elements. (Inherited from ModelElement.)

System_CAPS_pubmethodDelete()

Deletes an element from the model.(Inherited from ModelElement.)

System_CAPS_pubmethodDelete(Guid[])

Deletes an element from the model.(Inherited from ModelElement.)

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetDomainClass()

Gets the most-derived domain class for this element.(Inherited from ModelElement.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetRoleCollection<TCollection, TElement>(Guid)

Gets or creates the linked element collection(Inherited from ModelElement.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodMergeConfigure(ElementGroup)

Not used for presentation elements.(Overrides ModelElement.MergeConfigure(ElementGroup).)

System_CAPS_protmethodMergeDisconnect(ModelElement)

Disconnects a source element from a target element.(Inherited from ModelElement.)

System_CAPS_protmethodMergeRelate(ModelElement, ElementGroup)

Creates a relationship between a model element and a group of model elements.(Overrides ModelElement.MergeRelate(ModelElement, ElementGroup).)

System_CAPS_protmethodOnCopy(ModelElement)

Called when this element has been created as a copy of another element.(Inherited from ModelElement.)

System_CAPS_protmethodOnDeleted()

Called when this element has been deleted from the model.(Inherited from ModelElement.)

System_CAPS_protmethodOnDeleting()

Called when this element is about to be deleted.(Inherited from ModelElement.)

System_CAPS_protmethodOnResurrected()

Called when this element has been added back to a model.(Inherited from ModelElement.)

System_CAPS_protmethodOnRolePlayerPositionChanged(DomainRoleInfo, ElementLink, Int32, Int32)

Called when the position of a role has changed.(Inherited from ModelElement.)

System_CAPS_protmethodOnRolePlayerPositionChanging(DomainRoleInfo, ElementLink, Int32, Int32)

Called when a role player position is about to change.(Inherited from ModelElement.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticDomainClassId

The ID that is assigned to the presentation element.

NameDescription
System_CAPS_pubmethodAddExtension(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.)

System_CAPS_pubmethodAddExtension(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.)

System_CAPS_pubmethodAddExtension(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.)

System_CAPS_pubmethodAddExtension(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.)

System_CAPS_pubmethodAddExtension<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.)

System_CAPS_pubmethodCanDelete(Guid[])

Deletes the element from the model.(Defined by ImmutabilityExtensionMethods.)

System_CAPS_pubmethodGetAllExtensions()

Return an enumerable that performs a breadth first traversal across the tree of extension elements embedded in this ModelElement.(Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodGetBaseElement()

Returns the root of the virtual MEL in which the specified ModelElement is participating.(Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodGetDslDefinitionModelElement()

This method guarantees that the real model element corresponding to the PresentationElement is returned.

For DslDesigner PELs, the corresponding subject may actually be an internal TreeNode class and not the actual MEL.

This method handles those cases correctly so that the actual MEL is returned.(Defined by PresentationElementHelper.)

System_CAPS_pubmethodGetExtension(DomainClassInfo)

Overloaded. (Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodGetExtension(Guid)

Overloaded. (Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodGetExtension(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.)

System_CAPS_pubmethodGetExtension<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.)

System_CAPS_pubmethodGetLocks()

Overloaded. Get the lock flags for this element. This will include any locks enabled on the Partition containing the element.(Defined by ImmutabilityExtensionMethods.)

System_CAPS_pubmethodIsExtendedBy(DomainClassInfo)

Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type.(Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodIsExtendedBy(Guid)

Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type.(Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodIsExtendedBy(Type)

Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type.(Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodIsLocked(Locks)

Overloaded. Test whether this element has any of a specified set of locks(Defined by ImmutabilityExtensionMethods.)

System_CAPS_pubmethodRemoveExtension(DomainClassInfo)

Overloaded. Remove any extension of the specified ModelElement that is of a particular type.(Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodRemoveExtension(ExtensionElement)

Overloaded. Remove a specified ExtensionElement from the extensions of this ModelElement.(Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodRemoveExtension(Guid)

Overloaded. Remove any extension of the specified ModelElement that is of a particular type.(Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodRemoveExtension(Type)

Overloaded. Remove any extension of this ModelElement that is of a particular type.(Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodSetLocks(Locks)

Overloaded. Set the lock flags of this element(Defined by ImmutabilityExtensionMethods.)

System_CAPS_pubmethodTryGetExtension(DomainClassInfo)

Overloaded. (Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodTryGetExtension(Guid)

Overloaded. (Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodTryGetExtension(Type)

Overloaded. (Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodTryGetExtension<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.)

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 Diagram. Partition from the domain model elements.

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: