ElementGroup Class

Definition

Namespace:

Microsoft.VisualStudio.Modeling

Assembly:

Microsoft.VisualStudio.Modeling.Sdk.dll

Package:

Microsoft.VisualStudio.Modeling.Sdk v17.10.40171

ElementGroup provides a way to collect elements and element links.

public ref class ElementGroup

public class ElementGroup

type ElementGroup = class

Public Class ElementGroup

Inheritance

Object

ElementGroup

Remarks

ElementGroup is intended to facilitate serialization of groups of elements from one store to another.

Constructors

ElementGroup(ModelElement)	Convenience constructor for constructing a single element group, a common operation
ElementGroup(Partition)	Constructor
ElementGroup(Store)	Constructor

Fields

ElementGroupIdDictionary

Key used in the TargetContext ElementGroupContext for the Element Id dictionary.

Properties

ElementIds	Get a list of the Id's of the elements contained in this group
ElementLinkIds	Get a list of the Id's of the element links contained in this group
ElementLinks	Get the set of element links contained by this group. THis does not include the element links contained by child subgroups.
Id	The Id of the group
ModelElements	Get a list of all the elements contained by this element group and all child element groups
Partition	The Partition the group was created for.
RootElementIds	Get a list of the Ids of the element links contained in this group
RootElements	The distinguished element of the group (e.g. the root of a tree, head of a list, etc.)
SourceContext	Returns this ElementGroup's source ElementGroup context object
TargetContext	Returns this ElementGroup's target ElementGroup context object
UserData	The user defined serializable data object

Methods

Add(ModelElement, Boolean)	Adds an element to the group.
Add(ModelElement)	Adds an element to the group. Any links to elements already in the group will also be added.
AddGraph(ModelElement, Boolean, Boolean)	Add an element and its children to the group
AddGraph(ModelElement, Boolean)	Add an element and its children to the group
AddGraph(ModelElement)	Add an element and its children to the group Any links to elements already in the group will also be added.
AddRange(IEnumerable<ModelElement>, Boolean)	Adds a collection of model elements to the group.
AddRange(IEnumerable<ModelElement>)	Adds a collection of model elements to the group. Any links to elements already in the group will also be added.
CreatePrototype()	Create a prototype for this element group
GetElements()	Get the set of elements contained by this group. This does not include the set of elements contained by child subgroups.
GetElements(Guid)	Get the set of element instances of a particular domain class that are contained in this group. This does not include the set of elements contained by child subgroups.
MarkAsRoot(ModelElement)	Marks an element in the group as a root element.