WindowConfigurations Interface

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

The WindowConfigurations collection contains all named window configurations created for the environment.

public interface class WindowConfigurations : System::Collections::IEnumerable

[System.Runtime.InteropServices.Guid("E577442A-98E1-46C5-BD2E-D25807EC81CE")]
public interface WindowConfigurations : System.Collections.IEnumerable

[<System.Runtime.InteropServices.Guid("E577442A-98E1-46C5-BD2E-D25807EC81CE")>]
type WindowConfigurations = interface
    interface IEnumerable

Public Interface WindowConfigurations
Implements IEnumerable

Attributes

GuidAttribute

Implements

IEnumerable

Examples

Sub WinConfigurationsExample(ByVal dte As DTE)  
    ' This example lists all currently available named window   
    ' configurations.  
    ' Set references to all necessary objects.  
    Dim colWinConfig As WindowConfigurations  
    Dim objWinConfig As WindowConfiguration  

    colWinConfig = dte.WindowConfigurations  

    MsgBox("Number of configurations: " & colWinConfig.Count)  
    ' List all saved named window configurations  
    FillMsg(colWinConfig)  
    ' Create a new window configuration.  
    objWinConfig = colWinConfig.Add("NewLayout")  
    FillMsg(colWinConfig)  
    ' Get rid of the new window configuration.  
    objWinConfig.Delete()  
    MsgBox("Number of configurations: " & colWinConfig.Count)  
    FillMsg(colWinConfig)  
End Sub  

Sub FillMsg(ByVal colWinConfig As Object)  
    ' Lists all currently available named window configurations.  
    Dim lCtr As Integer  
    Dim strMsg As String  

    For lCtr = 1 To colWinConfig.Count  
    strMsg = strMsg & "Configuration name " & lCtr & ": " & _  
    colWinConfig.Item(lCtr).Name & vbCr  
    Next lCtr  
    strMsg = "Current Configurations: " & vbCr & strMsg  
    MsgBox(strMsg)  
End Sub  

void WinConfigExample1(_DTE dte)  
{  
// Set references to all necessary objects.  
    WindowConfigurations colWinConfig;   
    WindowConfiguration objWinConfig;  

    colWinConfig = dte.WindowConfigurations;  

    MessageBox.Show("Number of configurations: " +   
      colWinConfig.Count);  

    // List all saved named window configurations.  
    FillMsg(colWinConfig);  
    // Create a new window configuration.  
    objWinConfig = colWinConfig.Add("NewLayout");  
    FillMsg(colWinConfig);  
    // Get rid of the new window configuration.  
    objWinConfig.Delete();  
    MessageBox.Show("Number of configurations: " + colWinConfig.Count);  
    FillMsg(colWinConfig);  
}  

void FillMsg(WindowConfigurations colWinConfig )  
{  
        // Lists all currently available named window configurations.  
    int lCtr;  
    string strMsg = null;  

    for (lCtr = 1; lCtr < colWinConfig.Count + 1; lCtr ++)  
    {  
        strMsg = strMsg + "Configuration name " + lCtr + ": " +   
            colWinConfig.Item(lCtr).Name + "\n";   
    }  
    strMsg = "Current Configurations: \n" + strMsg;  
    MessageBox.Show(strMsg);  
}  

Remarks

You can save your current window layout in the Visual Studio environment as a named window configuration. The WindowConfigurations collection contains all such configurations.

Properties

ActiveConfigurationName	Gets the name of the currently active window configuration.
Count	Gets a value indicating the number of objects in the collection.
DTE	Gets the top-level extensibility object.
Parent	Gets the immediate parent object of a WindowConfigurations collection.

Methods

Add(String)	Creates a new named window configuration based on the current arrangement of windows, adds it to the WindowConfigurations collection, and retains it for future recall.
GetEnumerator()	Gets an enumeration for items in a collection.
Item(Object)	Returns an indexed member of a WindowConfigurations collection.