ElementGroupPrototype Class

 

Contains the information necessary to recreate a set of elements and links. Used to store elements in tools, on the clipboard, and in a drag operation.

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

System::Object
  Microsoft.VisualStudio.Modeling::ElementGroupPrototype

[SerializableAttribute]
public ref class ElementGroupPrototype sealed : ISerializable, 
	IDeserializationCallback

NameDescription
System_CAPS_pubmethodElementGroupPrototype(ElementGroup^, IEnumerable<ModelElement^>^)

Constructor

System_CAPS_pubmethodElementGroupPrototype(Partition^, Guid)

Constructor for taking a rool domain class Id. This is used to determine whether an element can be merged under an parent element.

System_CAPS_pubmethodElementGroupPrototype(Partition^, ICollection<ModelElement^>^, ElementGroup^)

Constructor

NameDescription
System_CAPS_pubpropertyProtoElementLinks

Gets collection of all ProtoElementLinks contained in the ElementGroupPrototype.

System_CAPS_pubpropertyProtoElements

Gets collection of all ProtoElements contained in the ElementGroupPrototype.

System_CAPS_pubpropertyRootProtoElements

Gets collection of all root ProtoElements contained in the ElementGroupPrototype.

System_CAPS_pubpropertySourceContext

Returns this ElementGroupPrototype's source ElementGroupContext object

System_CAPS_pubpropertySourceRootElementIds

returns a read-only list of root element ids from the source context

System_CAPS_pubpropertyTargetContext

Returns this ElementGroupPrototype's target ElementGroupContext object

System_CAPS_pubpropertyTargetRootElementIds

returns a read-only list of root element ids from the target context

System_CAPS_pubpropertyTopLevelProtoGroup

Prototype for the group this ElementGroupPrototype represents

System_CAPS_pubpropertyUserData

The user-defined data object from the outer-most element group

NameDescription
System_CAPS_pubmethodCanCreateElementGroup(Partition^)

Can this prototype element group create a clone of the progenitor element group in the indicated partition?

System_CAPS_pubmethodCanCreateElementGroup(Partition^, IElementPartitionMapper^)

Can this prototype element group create a clone of the progenitor element group in the indicated partition?

System_CAPS_pubmethodCanCreateElementGroup(Store^)

Can this prototype element group create a clone of the progenitor element group in the indicated store?

System_CAPS_pubmethodCreateElementGroup(Partition^)

Create a clone of the progenitor element group

System_CAPS_pubmethodCreateElementGroup(Partition^, IElementPartitionMapper^)

Create a clone of the progenitor element group

System_CAPS_pubmethodCreateElementGroup(Store^)

Create a clone of the progenitor element group

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetObjectData(SerializationInfo^, StreamingContext)

Populate the serialization info with the data necessary to serialize this object.

System_CAPS_pubmethodGetProtoElement(Guid)

Get the ProtoElement corresponding to the specified id.

System_CAPS_pubmethodGetProtoLink(Guid)

Get the ProtoLink corresponding to the specified id.

System_CAPS_pubmethodGetProtoLinks(ProtoElementBase^, Guid)

Returns an IList of ProtoLink objects that contain the passed ProtoElementBase playing in the passed DomainRoleId.

System_CAPS_pubmethodSystem_CAPS_staticGetReconstitutedElement(Transaction^, Guid)

Returns the reconstituted ModelElement given the guid of the source ModelElement.

System_CAPS_pubmethodGetSourceRootElementId(Guid)

Gets the id of the source root ModelElement that corresponds to the specified target root ModelElement id. If it was not found, Guid.Empty is returned.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodIsInRole(ProtoElementBase^, Guid)

Returns true if the passed ProtoElementBase plays in the passed role in this ElementGroupPrototype.

System_CAPS_pubmethodResolveProtoLinks(Collection<ProtoLink^>^, Guid)

Resolves the passed IList of ProtoLinks into the ProtoElements that play in the passed DomainRoleId.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodToString(Partition^)

Dumps out the names of the Elements and ElementLinks in this ElementGroupPrototype, given the DomainClass definitions in the provided partition.

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticCreatingKey

Key for context info search

System_CAPS_pubfieldSystem_CAPS_staticDefaultDataFormatName

The default data format name for the ElementGroupPrototype.

System_CAPS_pubfieldSystem_CAPS_staticElementGroupIdDictionary

Key used in the TargetContext ElementGroupContext for the Element Id dictionary and root element (Id) lists.

System_CAPS_pubfieldSystem_CAPS_staticRootElementIdList

Key used in the Source and Target Context ElementGroupContext for the RootElement Id list and root element (Id) lists.

System_CAPS_pubfieldSystem_CAPS_staticRootElementList

Key used in the Source and Target Context ElementGroupContext for the RootElement list and root element lists.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIDeserializationCallback::OnDeserialization(Object^)

Deserialize the object when the graph is fully loaded

An ElementGroupPrototype (EGP) contains a pattern of elements and links, which can be used to create a new set of elements and links in a merge operation. During the merge, the EGP is used to create an ElementGroup, which is then linked into the elements in the target model.

EGPs are used for the following purposes:

  • To carry information in a drag operation;

  • To store information on the clipboard;

  • To store a pattern of objects in a toolbox.

For more information, see How to: Program Copy and Paste Behavior - redirect and How to: Add a Drag-and-Drop Handler.

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: