GraphLink Class

Article
07/26/2013

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Represents a link in the directed graph.

Inheritance Hierarchy

System.Object
Microsoft.VisualStudio.GraphModel.GraphObject
Microsoft.VisualStudio.GraphModel.GraphLink

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

Syntax

'Declaration
Public Class GraphLink _
    Inherits GraphObject

public class GraphLink : GraphObject

public ref class GraphLink : public GraphObject

type GraphLink =  
    class 
        inherit GraphObject 
    end

public class GraphLink extends GraphObject

The GraphLink type exposes the following members.

Properties

	Name	Description
	Categories	Returns all categories. Never returns null. (Inherited from GraphObject.)
	CategoryCount	Returns the number of categories in the object. (Inherited from GraphObject.)
	DescriptiveCategoryLabel	Creates a delimited list of all category labels for this graph object. (Inherited from GraphObject.)
	DocumentSchema	Gets the document-local schema from the owner of this graph. (Inherited from GraphObject.)
	Index	Gets the optional Index of this link. Default is zero. This index can be specified when you create a link. Providing different index values makes it possible to create multiple links between the same source and target nodes. To get multilinks, the index only must be unique for the same source and target nodes.
	IsChildLink	Returns true if the source of the link is a group, the target of this link is a child of that group, and this link has IsContainment=true.
	IsContainment	Get whether this link is a Containment link or not.
	IsGroup	Gets whether this object is IsGroup. It looks for the GraphProperties.StyleForGroup. (Inherited from GraphObject.)
	IsLinkAndNodesVisible	A link is "visible" when it is visible and its source and target nodes are visible also.
	IsPseudo	Gets 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.)
	Label	Displayable label for the link.
	Owner	Gets 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 a number 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.)
	Source	The link source.
	Target	The link target.
	Visibility	Helper property to get/set visibility property of a GraphObject. (Inherited from GraphObject.)

Top

Methods

	Name	Description
	AddCategory	Adds 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.)
	CopyCategories	Copies any new categories from the given object, keeping existing categories. (Inherited from GraphObject.)
	CopyProperties	Copies 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.)
	FindRelatedLinks	Finds the links that match the acceptLink predicate. They are found by doing a breadth first search along links matching the traverseLink predicate, in the Source or Target direction designated by the searchDirection.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetMetaObject	(Inherited from GraphObject.)
	GetSchemaValue	Gets the schema-specific value of the property, if one exists. (Inherited from GraphObject.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue(String)	Gets the value of the specified property. (Inherited from GraphObject.)
	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 return the default value that the caller passed to this method. (Inherited from GraphObject.)
	GetValue<T>(GraphProperty, Graph, GraphCategory%)	Gets the value of the specified property, and also returns the category that this property value was inherited from, if any. (Inherited from GraphObject.)
	GetValueAsString	Returns the given property as a string that uses the given culture. (Inherited from GraphObject.)
	HasCategory(String)	Returns true if the object has the given category. (Inherited from GraphObject.)
	HasCategory(GraphCategory)	Returns true if the object has the given category. (Inherited from GraphObject.)
	HasCategory(IEnumerable<GraphCategory>)	Returns true if the object has any of the given categories. (Inherited from GraphObject.)
	HasCategoryInSet	Determines whether the given set of categories applies to this object. (Inherited from GraphObject.)
	HasLocalValue	Returns true if the specified property exists on this object with no category inheritance check. (Inherited from GraphObject.)
	HasValue(String)	Find out whether the object has a value for the specified property. (Inherited from GraphObject.)
	HasValue(GraphProperty)	Returns true if the specified annotation exists. (Inherited from GraphObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnCategoryChanged	Override that notifies the GraphGroupCollection any time a GraphCategory has changed on this link. Notify the GraphGroupCollection any time a GraphCategory has changed on this link because this might affect the IsContainment behavior of this link, which affects the structure of the GraphGroup hierarchy. (Overrides GraphObject.OnCategoryChanged(GraphCategory, GraphCategoryChangeType).)
	OnPropertyChanged(String)	Raises a PropertyChangd event for the named property. (Inherited from GraphObject.)
	OnPropertyChanged(GraphProperty)	Raises a PropertyChangd event for the given GraphProperty. (Inherited from GraphObject.)
	Remove	Remove this link from the graph.
	RemoveCategory	Removes the category of this object. (Inherited from GraphObject.)
	SetValue(String, Object)	Adds 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 property 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 Link object. (Overrides Object.ToString().)
	WrapGraphObject	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.)

Top

Events

	Name	Description
	CategoryChanged	(Inherited from GraphObject.)
	PropertyChanged	(Inherited from GraphObject.)

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.

Share via