IGraphContext Interface

Definition

Namespace:

Microsoft.VisualStudio.GraphModel

Assembly:

Microsoft.VisualStudio.GraphModel.dll

Package:

Microsoft.VisualStudio.GraphModel v17.12.40391

Interface representing a context which specifies a desired set of data. Providers place the requested data in the provided graph and the output nodes collection.

public interface class IGraphContext

public interface IGraphContext

type IGraphContext = interface

Public Interface IGraphContext

Properties

CancelToken	Get the current CancellationToken
Direction	The direction to traverse starting from the input nodes.
Errors	A list of the reported errors.
Graph	The graph that new data will be added to.
InputNodes	The initial nodes from which the GraphContext navigates. An empty collection implies a search of the global scope (ex: looking for top level namespaces).
LinkCategories	The link categories to navigate from the input nodes (i.e. what relationships to traverse). For example, "Calls", or "Calls and References", etc. An empty collection implies that all links should be traversed.
LinkDepth	How many links away from the input nodes to return. int.MaxValue means fetch everything that is reachable from the input nodes.
NodeCategories	The target node categories that will be placed in the OutputNodes collection. An empty collection implies that all target nodes should be output nodes.
OutputNodes	The nodes that answer the query posed by the context. More data may be present in the Graph than in the OutputNodes. OutputNodes must be part of the Graph.
RequestedProperties	The properties requested to be on the returned input and output nodes.
TrackChanges	True if the graph context wants to continue to be informed of changes to the output nodes. The Cancel method stops this tracking.

Methods

GetValue<T>(String)	Retrieves a value that the caller has passed in.
HasValue(String)	Find out if the caller has passed in a value with the given name.
OnCompleted()	Called to raise the Completed event when the IGraphContext is finished being processed.
ReportError(Exception)	Called by the provider to report exceptions and errors.
ReportProgress(Int32, Int32, String)	Called by the providers to report progress.
SetValue<T>(String, T)	Adds a new value to the context's property bag. This can be used to pass extra information to providers.

Events

Canceled	Raised when this context is canceled.
Completed	Raised when the results of the context have been populated.