ElementGroup Class

Article
04/26/2013

Provides a way to collect elements and element links.

Inheritance Hierarchy

Object
Microsoft.VisualStudio.Modeling.ElementGroup

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

Syntax

'Declaration
Public Class ElementGroup

public class ElementGroup

public ref class ElementGroup

type ElementGroup =  class end

public class ElementGroup

The ElementGroup type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	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

Top

Methods

	Name	Description
	Add(ModelElement)	Adds an element to the group. Any links to elements already in the group will also be added.
	Add(ModelElement, Boolean)	Adds an element 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.
	AddGraph(ModelElement, Boolean)	Add an element and its children to the group
	AddGraph(ModelElement, Boolean, Boolean)	Add an element and its children 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.
	AddRange(IEnumerable<ModelElement>, Boolean)	Adds a collection of model elements to the group.
	CreatePrototype	Create a prototype for this element group
	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.)
	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.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MarkAsRoot	Marks an element in the group as a root element.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	ElementGroupIdDictionary	Key used in the TargetContext ElementGroupContext for the Element Id dictionary.

Top

Remarks

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

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.