IGraphFormattedLabel.Description(GraphObject, String) Method

Definition

Namespace:

Microsoft.VisualStudio.GraphModel

Assembly:

Microsoft.VisualStudio.GraphModel.dll

Package:

Microsoft.VisualStudio.GraphModel v17.12.40391

Provides an optional description to associate with the node. A common use for the consumer is to display this as a tool tip.

public:
 System::String ^ Description(Microsoft::VisualStudio::GraphModel::GraphObject ^ graphObject, System::String ^ graphCommandDefinitionIdentifier);

public string Description (Microsoft.VisualStudio.GraphModel.GraphObject graphObject, string graphCommandDefinitionIdentifier);

abstract member Description : Microsoft.VisualStudio.GraphModel.GraphObject * string -> string

Public Function Description (graphObject As GraphObject, graphCommandDefinitionIdentifier As String) As String

Parameters

graphObject

GraphObject

The graph object to provide a tool tip for.

graphCommandDefinitionIdentifier

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.

Returns

String