AddInToken.Description Property

Reference

Definition

Namespace:: System.AddIn.Hosting

Assembly:: System.AddIn.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the description of the add-in.

public:
 property System::String ^ Description { System::String ^ get(); };

public string Description { get; }

member this.Description : string

Public ReadOnly Property Description As String

Property Value

String

A description of the add-in, or null if the description is not specified in the AddInAttribute attribute.

Examples

The following example displays the value of the Name, AddInFullName, Description, AssemblyName, Publisher, and Version properties to the console. This code example is part of a larger example provided for the AddInToken class.

// Show the token properties for each token
// in the AddInToken collection (tokens),
// preceded by the add-in number in [] brackets.
int tokNumber = 1;
foreach (AddInToken tok in tokens)
{
    Console.WriteLine(String.Format("\t[{0}]: {1} - {2}\n\t{3}\n\t\t {4}\n\t\t {5} - {6}",
        tokNumber.ToString(),
        tok.Name,
        tok.AddInFullName,
        tok.AssemblyName,
        tok.Description,
        tok.Version,
        tok.Publisher));
    tokNumber++;
}

' Show the token properties for each token 
' in the AddInToken collection (tokens),
' preceded by the add-in number in [] brackets.

Dim tokNumber As Integer = 1
For Each tok As AddInToken In tokens
    Console.WriteLine(vbTab & "{0}: {1} - {2}" & _
            vbLf & vbTab & "{3}" & _
            vbLf & vbTab & "{4}" & _
            vbLf & vbTab & "{5} - {6}", _
            tokNumber.ToString, tok.Name, _
            tok.AddInFullName, tok.AssemblyName, _
            tok.Description, tok.Version, tok.Publisher)
    tokNumber = tokNumber + 1
Next

Remarks

This property obtains the description of the add-in as specified in the AddInAttribute attribute.

Applies to