PresentationElement Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Modeling.Diagrams

Assembly:: Microsoft.VisualStudio.Modeling.Sdk.Diagrams.15.0.dll

Assembly:: Microsoft.VisualStudio.Modeling.Sdk.Diagrams.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

DomainClass PresentationElement Description for Microsoft.VisualStudio.Modeling.Diagrams.PresentationElement

public ref class PresentationElement abstract : Microsoft::VisualStudio::Modeling::ModelElement

[Microsoft.VisualStudio.Modeling.Design.DescriptionResource("Microsoft.VisualStudio.Modeling.Diagrams.PresentationElement.Description", typeof(Microsoft.VisualStudio.Modeling.Diagrams.CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")]
[Microsoft.VisualStudio.Modeling.Design.DisplayNameResource("Microsoft.VisualStudio.Modeling.Diagrams.PresentationElement.DisplayName", typeof(Microsoft.VisualStudio.Modeling.Diagrams.CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")]
[Microsoft.VisualStudio.Modeling.DomainModelOwner(typeof(Microsoft.VisualStudio.Modeling.Diagrams.CoreDesignSurfaceDomainModel))]
[Microsoft.VisualStudio.Modeling.DomainObjectId("9321e0d1-1221-458d-834f-2dc0769ce683")]
[System.CLSCompliant(true)]
[System.ComponentModel.TypeDescriptionProvider(typeof(Microsoft.VisualStudio.Modeling.Diagrams.InternalPresentationElementTypeDescriptionProvider))]
public abstract class PresentationElement : Microsoft.VisualStudio.Modeling.ModelElement

[<Microsoft.VisualStudio.Modeling.Design.DescriptionResource("Microsoft.VisualStudio.Modeling.Diagrams.PresentationElement.Description", typeof(Microsoft.VisualStudio.Modeling.Diagrams.CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")>]
[<Microsoft.VisualStudio.Modeling.Design.DisplayNameResource("Microsoft.VisualStudio.Modeling.Diagrams.PresentationElement.DisplayName", typeof(Microsoft.VisualStudio.Modeling.Diagrams.CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")>]
[<Microsoft.VisualStudio.Modeling.DomainModelOwner(typeof(Microsoft.VisualStudio.Modeling.Diagrams.CoreDesignSurfaceDomainModel))>]
[<Microsoft.VisualStudio.Modeling.DomainObjectId("9321e0d1-1221-458d-834f-2dc0769ce683")>]
[<System.CLSCompliant(true)>]
[<System.ComponentModel.TypeDescriptionProvider(typeof(Microsoft.VisualStudio.Modeling.Diagrams.InternalPresentationElementTypeDescriptionProvider))>]
type PresentationElement = class
    inherit ModelElement

Public MustInherit Class PresentationElement
Inherits ModelElement

Inheritance: Object

ModelElement
PresentationElement

Derived: Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement

Attributes: DescriptionResourceAttribute DisplayNameResourceAttribute DomainModelOwnerAttribute DomainObjectIdAttribute CLSCompliantAttribute TypeDescriptionProviderAttribute

Constructors

PresentationElement(Partition, PropertyAssignment[])

Constructor.

Fields

DomainClassId

PresentationElement domain class Id.

Properties

Id	Unique identifier of this element. (Inherited from ModelElement)
IsActive	Returns true if the Element is currently active within the model, false if the element has been deleted or is in the process of being deleted. (Inherited from ModelElement)
IsDeleted	Has the element been deleted from the model. (Deleted elements are not immediately destroyed so that the undo command may undo deleting the element.) (Inherited from ModelElement)
IsDeleting	Has the element been deleted from the model. (Deleted elements are not immediately destroyed so that the undo command may undo deleting the element.) (Inherited from ModelElement)
ModelElement	Gets or sets the model element associated with this presentation element.
Partition	Gets or sets the Partition instance that contains this element. (Inherited from ModelElement)
Store	Get the Store instance that contains this element. (Inherited from ModelElement)
Subject	Gets or sets Subject. Description for Microsoft.VisualStudio.Modeling.Diagrams.PresentationViewsSubject.Presentation

Methods

Associate(ModelElement)	Associates this presentation element with its model element.
CanMerge(ProtoElementBase, ElementGroupPrototype)	Returns a value indicating whether the source element represented by the specified root ProtoElement can be added to this element. (Inherited from ModelElement)
ChooseMergeTarget(ElementGroup)	Gets the ModelElement to be used as the target for the ElementGroup merge process. This is called by the merge process when this element is the target of the merge. This provides this element with the opportunity to change the target to something other than itself. (Inherited from ModelElement)
ChooseMergeTarget(ElementGroupPrototype)	Gets the ModelElement to be used as the target for the ElementGroupPrototype merge process. This is called by the merge process when this element is the target of the merge. This provides this element with the opportunity to change the target to something other than itself. (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 in the model. (Inherited from ModelElement)
Delete()	Deletes the element from the model. (Inherited from ModelElement)
Delete(Guid[])	Deletes the element from the model. (Inherited from ModelElement)
GetDomainClass()	Gets the most-derived domain class for this element. (Inherited from ModelElement)
GetRoleCollection<TCollection,TElement>(Guid)	Gets or creates the linked element collection (Inherited from ModelElement)
MergeConfigure(ElementGroup)	PresentationElements should not override MergeConfigure() because it will not be called on PELs during Merge. Instead, PELs should use the view fixup overrides.
MergeDisconnect(ModelElement)	Performs operation opposite to MergeRelate - i.e. disconnects a given element from the current one (removes links created by MergeRelate). (Inherited from ModelElement)
MergeRelate(ModelElement, ElementGroup)	PresentationElements should not override MergeRelate() because it will not be called on PELs during Merge. Instead, PELs should use the view fixup overrides.
OnCopy(ModelElement)	Called when a copy of the element has been created. The method is called on the duplicate element. (Inherited from ModelElement)
OnDeleted()	Called by the model after the element has been deleted. (Inherited from ModelElement)
OnDeleting()	Called by the model before the element is deleted. (Inherited from ModelElement)
OnResurrected()	Called by the model after the element has been resurrected (placed back into the store). (Inherited from ModelElement)
OnRolePlayerPositionChanged(DomainRoleInfo, ElementLink, Int32, Int32)	Virtual method for notifying when role player position has changed. (Inherited from ModelElement)
OnRolePlayerPositionChanging(DomainRoleInfo, ElementLink, Int32, Int32)	Virtual method for notifying when role player position will be changing. (Inherited from ModelElement)

Explicit Interface Implementations

IMergeElements.CanMerge(ProtoElementBase, ElementGroupPrototype)	(Inherited from ModelElement)
IMergeElements.ChooseMergeTarget(ElementGroup)	(Inherited from ModelElement)
IMergeElements.ChooseMergeTarget(ElementGroupPrototype)	(Inherited from ModelElement)
IMergeElements.MergeConfigure(ElementGroup)	(Inherited from ModelElement)
IMergeElements.MergeDisconnect(ModelElement)	(Inherited from ModelElement)
IMergeElements.MergeRelate(ModelElement, ElementGroup)	(Inherited from ModelElement)

Extension Methods

GetDslDefinitionModelElement(PresentationElement)	This method ensures 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.
AddExtension(ModelElement, DomainClassInfo)	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.
AddExtension(ModelElement, ExtensionElement)	Extend this ModelElement with a specific extension. An InvalidOperationException will be thrown if the element already has an extension of the same type.
AddExtension(ModelElement, Guid)	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.
AddExtension(ModelElement, Type)	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.
AddExtension<T>(ModelElement)	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.
GetAllExtensions(ModelElement)	Return an enumerable that performs a breadth first traversal across the tree of extension elements embedded in this ModelElement.
GetBaseElement(ModelElement)	Returns the root of the virtual MEL in which the specified ModelElement is participating.
GetExtension(ModelElement, DomainClassInfo)
GetExtension(ModelElement, Guid)
GetExtension(ModelElement, Type)	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.
GetExtension<T>(ModelElement)	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.
IsExtendedBy(ModelElement, DomainClassInfo)	Query whether this ModelElement is currently extended by an ExtensionElement of a particular type.
IsExtendedBy(ModelElement, Guid)	Query whether this ModelElement is currently extended by an ExtensionElement of a particular type.
IsExtendedBy(ModelElement, Type)	Query whether this ModelElement is currently extended by an ExtensionElement of a particular type.
RemoveExtension(ModelElement, DomainClassInfo)	Remove any extension of the specified ModelElement that is of a particular type.
RemoveExtension(ModelElement, ExtensionElement)	Remove a specified ExtensionElement from the extensions of this ModelElement.
RemoveExtension(ModelElement, Guid)	Remove any extension of the specified ModelElement that is of a particular type.
RemoveExtension(ModelElement, Type)	Remove any extension of this ModelElement that is of a particular type.
TryGetExtension(ModelElement, DomainClassInfo)
TryGetExtension(ModelElement, Guid)
TryGetExtension(ModelElement, Type)
TryGetExtension<T>(ModelElement)	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.
CanDelete(ModelElement, Guid[])	Deletes the element from the model.
GetLocks(ModelElement)	Get the lock flags for this element. This will include any locks enabled on the Partition containing the element.
IsLocked(ModelElement, Locks)	Test whether this element has any of a specified set of locks
SetLocks(ModelElement, Locks)	Set the lock flags of this element

Applies to