GraphLink Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.GraphModel

Assembly:: Microsoft.VisualStudio.GraphModel.dll

Package:: Microsoft.VisualStudio.GraphModel v17.11.40262

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.

Represents a link in the directed graph

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

public class GraphLink : Microsoft.VisualStudio.GraphModel.GraphObject

type GraphLink = class
    inherit GraphObject

Public Class GraphLink
Inherits GraphObject

Inheritance: Object

GraphObject
GraphLink

Properties

Categories	Return all categories. Never returns null. (Inherited from GraphObject)
CategoryCount	Return 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	Get the document local schema from the Owner of this graph. (Inherited from GraphObject)
Index	Get 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 needs to be unique for the same source and target nodes.
IsChildLink	Return true if the source of the link is a group and 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 (has the property IsContainment=true).
IsGroup	Get whether this object is is a group. It looks for the GraphCommonSchema.Group property on the object. (Inherited from GraphObject)
IsLinkAndNodesVisible	A link is "visible" when it is visible and its source and target nodes are visible as well.
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	Displayable label for the link
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)
Source	The Link source
Target	The Link target
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)
FindRelatedLinks(GraphSearchDirection, Predicate<GraphLink>, Predicate<GraphLink>)	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.
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)
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)	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 may affect the IsContainment behavior of this link which affects the structure of the GraphGroup hierarchy.
OnPropertyChanged(GraphProperty)	Raise a PropertyChangd event for the given GraphProperty (Inherited from GraphObject)
OnPropertyChanged(String)	Raise a PropertyChangd event for the named property (Inherited from GraphObject)
Remove()	Remove this link from the graph
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)
ToString()	A more human friendly default string representation of a Link object
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

Share via