WindowConfigurations.Add 方法

2011-08-12

基于窗口的当前排列创建新的命名窗口配置，将该配置添加到 WindowConfigurations 集合，并保留以备将来重新调用。

命名空间： EnvDTE
程序集： EnvDTE（在 EnvDTE.dll 中）

语法

声明
Function Add ( _
    Name As String _
) As WindowConfiguration

WindowConfiguration Add(
    string Name
)

WindowConfiguration^ Add(
    [InAttribute] String^ Name
)

abstract Add : 
        Name:string -> WindowConfiguration

function Add(
    Name : String
) : WindowConfiguration

参数

Name
类型：System.String
必选。表示新窗口配置名称的字符串。

返回值

类型：EnvDTE.WindowConfiguration
WindowConfiguration 对象。

备注

可以将 Visual Studio 环境中的当前窗口布局保存为命名窗口配置。 Add 方法使您得以保存此配置以备将来使用 Apply 方法重新调用它。

示例

Sub AddExample(ByVal dte As DTE)
    ' 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 AddExample(_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);
    // reate 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);
}