IGraphContext Interface

 

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 class IGraphContext

NameDescription
System_CAPS_pubpropertyCancelToken

Get the current CancellationToken

System_CAPS_pubpropertyDirection

The direction to traverse starting from the input nodes.

System_CAPS_pubpropertyErrors

A list of the reported errors.

System_CAPS_pubpropertyGraph

The graph that new data will be added to.

System_CAPS_pubpropertyInputNodes

The initial nodes from which the GraphContext navigates.

An empty collection implies a search of the global scope (ex: looking for top level namespaces).

System_CAPS_pubpropertyLinkCategories

The 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.

System_CAPS_pubpropertyLinkDepth

How many links away from the input nodes to return.

int.MaxValue means fetch everything that is reachable from the input nodes.

System_CAPS_pubpropertyNodeCategories

The target node categories that will be put in the OutputNodes collection.

An empty collection implies that all target nodes should be output nodes.

System_CAPS_pubpropertyOutputNodes

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.

System_CAPS_pubpropertyRequestedProperties

The properties requested to be on the returned input and output nodes.

System_CAPS_pubpropertyTrackChanges

True if the graph context wants to continue to be informed of changes to the output nodes.

The Cancel method stops this tracking.

NameDescription
System_CAPS_pubmethodGetValue<T>(String^)

Retrieves a value that the caller has passed in.

System_CAPS_pubmethodHasValue(String^)

Find out if the caller has passed in a value with the given name.

System_CAPS_pubmethodOnCompleted()

Called to raise the Completed event when the IGraphContext is finished being processed.

System_CAPS_pubmethodReportError(Exception^)

Called by the provider to report exceptions and errors.

System_CAPS_pubmethodReportProgress(Int32, Int32, String^)

Called by the providers to report progress.

System_CAPS_pubmethodSetValue<T>(String^, T)

Adds a new value to the context's property bag.

This can be used to pass extra information to providers.

NameDescription
System_CAPS_pubeventCanceled

Raised when this context is canceled.

System_CAPS_pubeventCompleted

Raised when the results of the context have been populated.

Return to top
Show: