AddIn.Description Property

Gets or sets a string that represents the description for the AddIn object.

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Syntax

'Declaration
Default Property Description As String

string this { get; set; }

property String^ default {
    String^ get ();
    void set (String^ value);
}

abstract Description : string with get, set

function get Description () : String 
function set Description (value : String)

Property Value

Type: System.String
A string that represents the description for the AddIn object.

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

• 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

AddIn Interface

EnvDTE Namespace

Other Resources

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