Share via


IGraphFormattedLabel.Description Method

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)

Syntax

'Declaration
Function Description ( _
    graphObject As GraphObject, _
    graphCommandDefinitionIdentifier As String _
) As String
string Description(
    GraphObject graphObject,
    string graphCommandDefinitionIdentifier
)
String^ Description(
    GraphObject^ graphObject, 
    String^ graphCommandDefinitionIdentifier
)
abstract Description : 
        graphObject:GraphObject * 
        graphCommandDefinitionIdentifier:string -> string
function Description(
    graphObject : GraphObject, 
    graphCommandDefinitionIdentifier : String
) : String

Parameters

  • graphCommandDefinitionIdentifier
    Type: 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: String
Returns String.

.NET Framework Security

See Also

Reference

IGraphFormattedLabel Interface

Microsoft.VisualStudio.GraphModel Namespace