VCAssemblyReference.Description Property

Gets or sets a string that represents the description for the object or the use of the output group.

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

Syntax

'Declaration
ReadOnly Property Description As String
string Description { get; }
property String^ Description {
    String^ get ();
}
abstract Description : string with get
function get Description () : String

Property Value

Type: System.String
The description of the object or the use of the output group.

Examples

Sub DescriptionExample(ByVal dte As DTE2)

    ' Display all add-ins.
    Dim addIn As AddIn
    Dim msg As String

    For Each addIn In dte.AddIns
        msg &= "    " & addIn.Name

        If addIn.Description <> "" Then
            msg &= ": " & addIn.Description & vbCrLf
        Else
            msg &= ": (No description)" & vbCrLf
        End If
    Next

    MsgBox("Available add-ins:" & vbCrLf & vbCrLf & msg)

End Sub
public void DescriptionExample(DTE2 dte)
{
    // Display all add-ins.
    string msg = "";

    foreach (AddIn addIn in dte.AddIns)
    {
        msg += "    " + addIn.Name;

        if (addIn.Description != "")
            msg += ": " + addIn.Description + "\n";
        else
            msg += ": (No description)\n";
    }

    MessageBox.Show("Available add-ins:\n\n" + msg);
}

.NET Framework Security

See Also

Reference

VCAssemblyReference Interface

Microsoft.VisualStudio.VCProjectEngine Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples