IGraphFormattedLabel.Description Method

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

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

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

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

IGraphFormattedLabel Interface

Microsoft.VisualStudio.GraphModel Namespace