IGraphFormattedLabel::Description Method (GraphObject^, String^)

 

Provides an optional description to associate with the node. A common use for the consumer is to display this as a pop-up information window.

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

String^ Description(
	GraphObject^ graphObject,
	String^ graphCommandDefinitionIdentifier
)

Parameters

graphObject
Type: Microsoft.VisualStudio.GraphModel::GraphObject^

The graph object to provide an information window for.

graphCommandDefinitionIdentifier
Type: System::String^

The command identifier associated with the node being displayed. This can be used to customize the label for a node when viewed in different views.

Return Value

Type: System::String^

Returns String.

Return to top
Show: