OutputGroup.Description Property

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Gets a string that represents the use of the output group.

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

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

[System.Runtime.InteropServices.DispId(7)]
public string Description { [System.Runtime.InteropServices.DispId(7)] get; }

[<System.Runtime.InteropServices.DispId(7)>]
[<get: System.Runtime.InteropServices.DispId(7)>]
member this.Description : string

Public ReadOnly Property Description As String

Property Value

String

A string representing the use of the output group.

Attributes

DispIdAttribute

Examples

public void CodeExample(DTE2 dte)  
{    
    try  
    {   // Open a project before running this example.  
        Project proj = dte.Solution.Projects.Item(1);  
        OutputGroups groups = proj.ConfigurationManager.ActiveConfiguration.OutputGroups;  
        int c = 1;   
        int x = 0;  
        // Find an outputgroup with at least one file.  
        foreach (OutputGroup grp in groups)  
        {  
            x++;  
            if (grp.FileCount > 0)  
                c = x;  
        }  
        OutputGroup group = groups.Item(c);  
        msg += "OutputGroup Description: " + group.Description;  
        msg += "\nNumber of Associated Files: " + group.FileCount.ToString();  
        msg += "\nAssociated File Names: ";  
        foreach (String str in (Array)group.FileNames)  
        {  
            msg += "\n" + str;  
        }  
        MessageBox.Show(msg);  
    }  
    catch(Exception ex)  
    {  
        MessageBox.Show(ex.Message);  
    }  
}  

Remarks

The Description property is read-only.