GraphGroup Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.GraphModel

Assembly:: Microsoft.VisualStudio.GraphModel.dll

Package:: Microsoft.VisualStudio.GraphModel v17.12.40391

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.

GraphGroup is a wrapper on Nodes that have IsGroup=true. They do not have a separate identity - they use the identity of the node that they wrap.

public ref class GraphGroup : Microsoft::VisualStudio::GraphModel::GraphObject

[System.Diagnostics.DebuggerDisplay("Group: {this.Label,nq}  Id: {this.Id.ToString()}")]
public class GraphGroup : Microsoft.VisualStudio.GraphModel.GraphObject

[<System.Diagnostics.DebuggerDisplay("Group: {this.Label,nq}  Id: {this.Id.ToString()}")>]
type GraphGroup = class
    inherit GraphObject

Public Class GraphGroup
Inherits GraphObject

Inheritance: Object

GraphObject
GraphGroup

Attributes: DebuggerDisplayAttribute

Properties

Categories	Return all categories. Never returns null. (Inherited from GraphObject)
CategoryCount	Return number of categories in the object. (Inherited from GraphObject)
ChildGroups	This is a collection of child GraphGroups. A child group is one that is linked to a parent group via an IsContainment link. This collection is automatically maintained as nodes are added and removed from the graph and as IsGroup properties are changed and as containment links are added or removed.
ChildNodes	This is a collection of child nodes (not including nodes that have IsGroup set to true). A child node is one that is linked to a parent group via an IsContainment link. This collection is automatically maintained as nodes are added and removed from the graph and as IsGroup properties are changed and as containment links are added or removed.
ContainmentLinks	The containment links that are contained within this group.
ContentVisibility	Get whether the content inside this node is visible or not.
DescriptiveCategoryLabel	Creates a delimited list of all category labels for this graph object. (Inherited from GraphObject)
DocumentSchema	Get the document local schema from the Owner of this graph. (Inherited from GraphObject)
GroupNode
Id
IsEmpty	Find out if the group contains any child nodes or groups.
IsExpanded	Get whether this node is expanded.
IsGroup	Get whether this object is is a group. It looks for the GraphCommonSchema.Group property on the object. (Inherited from GraphObject)
IsPseudo	Get whether this object is Pseudo. It looks for the GraphProperties.IsPseudo (Inherited from GraphObject)
Item[GraphProperty]	Property that gets or sets a property value. (Inherited from GraphObject)
Label
Owner	Get the Graph object that this object belongs to. (Inherited from GraphObject)
Parents	The parents of this group.
Properties	Property that returns an enumeration of all annotations. The order of the enumeration is random. (Inherited from GraphObject)
PropertyCount	Property that returns an number of of all annotations. (Inherited from GraphObject)
PropertyKeys	Property that returns an enumeration of all annotation keys. The order of the enumeration is random. (Inherited from GraphObject)
PropertyValues	Property that returns an enumeration of all annotation values. The order of the enumeration is random. (Inherited from GraphObject)
Visibility	Helper property to get/set visibility property of a GraphObject (Inherited from GraphObject)

Methods

AddCategory(GraphCategory)	Add a category to the object (Inherited from GraphObject)
AsNode()	Converts the GraphObject to a GraphNode. If this is a GraphGroup, the inner node is returned. For types other than GraphNode/Group, null is returned. (Inherited from GraphObject)
ClearCategories()	Remove all categories from this object. (Inherited from GraphObject)
ClearValue(GraphProperty)	Removes the value of the specified property (Inherited from GraphObject)
ClearValue<T>(GraphProperty)	Clear the value of the specified property. (Inherited from GraphObject)
CopyCategories(GraphObject)	Copy any new categories from the given object, keeping existing categories. (Inherited from GraphObject)
CopyProperties(GraphObject)	Copy any new properties from the given object, keeping existing property values unchanged. (Inherited from GraphObject)
GetAncestors()	Returns all the parent ancestors of this group, excluding this group.
GetDerivedCategory(GraphCategory)	Return first matching leaf category that has the given category in its heirarchy. (Inherited from GraphObject)
GetDerivedCategory(String)	Return first matching leaf category that has the given category in its heirarchy. (Inherited from GraphObject)
GetDescendantGroups()	Return all descendant groups contained by this group hierarchy, including this group.
GetDescendants()	Return all descendant nodes contained by this group hierarchy.
GetMetaObject(Expression)	(Inherited from GraphObject)
GetSchemaValue(GraphProperty)	Gets the schema specific value of the property if one exists. (Inherited from GraphObject)
GetValue(GraphProperty)	Gets the value of the specified annotation. (Inherited from GraphObject)
GetValue(String)	Gets the value of the specified property. (Inherited from GraphObject)
GetValue<T>(GraphProperty, Graph, GraphCategory)	Gets the value of the specified property, and also return the category that this property value was inherited from if any. (Inherited from GraphObject)
GetValue<T>(GraphProperty, Graph)	Gets the value of the specified property. (Inherited from GraphObject)
GetValue<T>(GraphProperty, T)	Gets the value of the specified annotation. if property is not set we reutnr the default value that the caller pass to this method (Inherited from GraphObject)
GetValue<T>(GraphProperty)	Gets the value of the specified property. (Inherited from GraphObject)
GetValue<T>(String)	Gets the value of the specified property. (Inherited from GraphObject)
GetValueAsString(GraphProperty, CultureInfo)	Returns the given property as a string using the given culture. (Inherited from GraphObject)
HasCategory(GraphCategory)	Return true if the object has the given category. (Inherited from GraphObject)
HasCategory(IEnumerable<GraphCategory>)	Return true if the object has any of the given categories. (Inherited from GraphObject)
HasCategory(String)	Return true if the object has the given category. (Inherited from GraphObject)
HasCategoryInSet(HashSet<GraphCategory>, GraphCategoryMatchOption)	Determines if the given set of categories applies to this object. (Inherited from GraphObject)
HasLocalValue(GraphProperty)	Return true if the specified property exists on this object with no cateogry inheritance check. (Inherited from GraphObject)
HasValue(GraphProperty)	Return true if the specified annotation exists. (Inherited from GraphObject)
HasValue(String)	Find out if the object has a value for the specified property. (Inherited from GraphObject)
OnCategoryChanged(GraphCategory, GraphCategoryChangeType)	Raises the property changed events for both the node and the group.
OnPropertyChanged(GraphProperty)	Raise a PropertyChangd event for the given GraphProperty (Inherited from GraphObject)
OnPropertyChanged(String)	Raises the property changed events for both the node and the group.
RemoveCategory(GraphCategory)	Remove the category of this object (Inherited from GraphObject)
SetValue(String, Object)	Add an annotation using the given key, type and value (Inherited from GraphObject)
SetValue<T>(GraphProperty, T)	Sets the value of the given property. If the proeprty already exists, its value is overwritten unless the annotation flags prevent otherwise. (Inherited from GraphObject)
WrapGraphObject(GraphObject)	Modifies the current graph object to share the same property and categories as the given graph object. The wrapper and wrappee graph objects will always have identical sets of properties and categories. (Inherited from GraphObject)

Events

CategoryChanged	(Inherited from GraphObject)
PropertyChanged	(Inherited from GraphObject)

Extension Methods

DEBUG_GetLabelOrId(GraphObject)

Returns the label of an object or the id if the label is null. Should be used for tracing Microsoft.VisualStudio.Diagnostics.PerformanceProvider.DebugTrace.IDebugTracer

Applies to

Partilhar via