IGraphFormattedLabel.Description-Methode

Stellt eine optionale Beschreibung bereit, die dem Knoten zugeordnet werden soll.Eine übliche Verwendung für den Consumer ist, dieses als Popupinformationsfenster anzuzeigen.

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

Parameter

• graphObject
  Typ: Microsoft.VisualStudio.GraphModel.GraphObject
  Das Diagrammobjekt, um ein Informationsfensters für bereitzustellen.

• graphCommandDefinitionIdentifier
  Typ: System.String
  Der Befehlsbezeichner, der dem angezeigten Knoten zugeordnet ist.Dies kann verwendet werden, um die Bezeichnung für einen Knoten zu anzupassen, wenn er in verschiedenen Ansichten angezeigt wird.

Rückgabewert

Typ: System.String
Gibt String zurück.

.NET Framework-Sicherheit

• Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.

Siehe auch

Referenz

IGraphFormattedLabel Schnittstelle

Microsoft.VisualStudio.GraphModel-Namespace