Export (0) Print
Expand All

IGraphContext Interface

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

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.

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

public interface IGraphContext

The IGraphContext type exposes the following members.

Public propertyCancelTokenGet the current CancellationToken
Public propertyDirectionThe direction to traverse starting from the input nodes.
Public propertyErrorsA list of the reported errors.
Public propertyGraphThe graph that new data will be added to.
Public propertyInputNodesThe initial nodes from which the GraphContext navigates. An empty collection implies a search of the global scope (ex: looking for top level namespaces).
Public propertyLinkCategoriesThe link categories to navigate from the input nodes (that is what relationships to traverse). For example, "Calls", or "Calls and References", and so on An empty collection implies that all links should be traversed.
Public propertyLinkDepthHow many links away from the input nodes to return. int.MaxValue means fetch everything that is reachable from the input nodes.
Public propertyNodeCategoriesThe target node categories that will be put in the OutputNodes collection. An empty collection implies that all target nodes should be output nodes.
Public propertyOutputNodesThe 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.
Public propertyRequestedPropertiesThe properties requested to be on the returned input and output nodes.
Public propertyTrackChangesTrue if the graph context wants to continue to be informed of changes to the output nodes. The Cancel method stops this tracking.

Public methodGetValue<T>Retrieves a value that the caller has passed in.
Public methodHasValueFind out if the caller has passed in a value with the given name.
Public methodOnCompletedCalled to raise the Completed event when the IGraphContext is finished being processed.
Public methodReportErrorCalled by the provider to report exceptions and errors.
Public methodReportProgressCalled by the providers to report progress.
Public methodSetValue<T>Adds a new value to the context's property bag. This can be used to pass extra information to providers.

Public eventCanceledRaised when this context is canceled.
Public eventCompletedRaised when the results of the context have been populated.
© 2014 Microsoft