OutputGroup.CanonicalName Property

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Gets the unique name used for this output group.

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

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

[System.Runtime.InteropServices.DispId(5)]
public string CanonicalName { [System.Runtime.InteropServices.DispId(5)] get; }

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

Public ReadOnly Property CanonicalName As String

Property Value

String

A string representing the name used for the output group.

Attributes

DispIdAttribute

Examples

Sub CanonicalNameExample(ByVal dte As DTE2)  

    ' Before running this example, open a project.  

    ' Display the output groups of the first project.  
    Dim proj As Project = dte.Solution.Item(1)  
    Dim con As Configuration = _  
        proj.ConfigurationManager.ActiveConfiguration  
    Dim names As String = ""  
    Dim og As OutputGroup  
    For Each og In con.OutputGroups  
        names &= og.CanonicalName & vbCrLf  
    Next  

    MsgBox(proj.Name & "'s " & con.ConfigurationName & _  
        " output groups:" & vbCrLf & vbCrLf & names)  

End Sub  

public void CanonicalNameExample(DTE2 dte)  
{  
    // Before running this example, open a project.  

    // Display the output groups of the first project.  
    Project proj = dte.Solution.Item(1);  
    Configuration con = proj.ConfigurationManager.ActiveConfiguration;  
    string names = "";  
    foreach (OutputGroup og in con.OutputGroups)  
    {  
        names += og.CanonicalName + Environment.NewLine;  
    }  

    MessageBox.Show(proj.Name + "'s " + con.ConfigurationName +   
        " output groups:" + Environment.NewLine + Environment.NewLine +   
        names);  
}