GraphNode Class

Article
05/22/2011

Represents a node in the directed graph

Inheritance Hierarchy

System.Object
Microsoft.VisualStudio.GraphModel.GraphObject
Microsoft.VisualStudio.GraphModel.GraphNode

Namespace: Microsoft.VisualStudio.GraphModel
Assembly: Microsoft.VisualStudio.GraphModel (in Microsoft.VisualStudio.GraphModel.dll)

Syntax

'Declaration
Public Class GraphNode _
    Inherits GraphObject

public class GraphNode : GraphObject

public ref class GraphNode : public GraphObject

type GraphNode =  
    class
        inherit GraphObject
    end

public class GraphNode extends GraphObject

The GraphNode type exposes the following members.

Constructors

	Name	Description
	GraphNode(String)	Constucts a node
	GraphNode(Graph, GraphNodeId)
	GraphNode(Graph, GraphNodeId, String, GraphCategory)
	GraphNode(Graph, String, String, GraphCategory)	Constucts a node

Top

Properties

	Name	Description
	AllLinks	Get the list of all links (incoming and outgoing).
	Caption	Displayable label for the node. If no label is defined, this returns the Id so we always have something to display to the user.
	Categories	Return all categories. Never returns null. (Inherited from GraphObject.)
	CategoryCount	Return number of categories in the object. (Inherited from GraphObject.)
	DescriptiveCategoryCaption	(Inherited from GraphObject.)
	Id	Unique identifier for the node
	IncomingLinkCount	Returns the count of incoming links
	IncomingLinks	Enumerable of incoming links. The order of the enumeration is random.
	IsCollapsed	Get whether this node is collapsed. (Inherited from GraphObject.)
	IsContained	Returns true if the node is contained by any other node.
	IsContainer	Returns true if the node is a container of any other node.
	IsExpanded	Get whether this node is expanded. (Inherited from GraphObject.)
	IsGroup	Get whether this object is IsGroup. It looks for the GraphProperties.StyleForGroup (Inherited from GraphObject.)
	IsPseudo	Get whether this object is Pseudo. It looks for the GraphProperties.IsPseudo (Inherited from GraphObject.)
	Item	Property that gets or sets a property value. (Inherited from GraphObject.)
	LinkCount	Returns the count of outgoing and incoming links
	OutgoingLinkCount	Returns the count of outgoing links
	OutgoingLinks	Enumerable of outgoing links. The order of the enumeration is random.
	Owner	Get the Graph object that this object belongs to. (Inherited from GraphObject.)
	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.)

Top

Methods

	Name	Description
	AddCategory	Add a category to the object (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.)
	Copy(String)	Clones a Node, including all properties, and clones new Links from the original Node's Links
	Copy(GraphNodeId)
	CopyCategories	Copy any new categories from the given object, keeping existing categories. (Inherited from GraphObject.)
	CopyProperties	Copy any new properties from the given object, keeping existing property values unchanged. (Inherited from GraphObject.)
	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.)
	FindAncestors
	FindDescendants
	FindRelatedContainmentNodes(GraphSearchDirection)
	FindRelatedContainmentNodes(GraphSearchDirection, GraphSearchOption, array<GraphCategory[])
	FindRelatedNode
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetSources	Gets the sources linked with this node via a link that matches at least 1 of the specified link categories.
	GetTargets	Gets the targets linked with this node via a link that matches at least 1 of the specified link categories.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue(GraphProperty)	Gets the value of the specified annotation. (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, 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.)
	GetValueAsString	Returns the given property as a string using the given culture. (Inherited from GraphObject.)
	HasCategory(String)	Return true if the object has the given category. (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.)
	HasCategoryInSet	Determines if the given set of categories applies to this object. (Inherited from GraphObject.)
	HasValue	Return true if the specified annotation exists. (Inherited from GraphObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RemoveCategory	Remove the category of this object (Inherited from GraphObject.)
	SetValue<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.)
	ToString	A more human friendly default string representation of a Node object (Overrides Object.ToString().)

Top

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.