This documentation is archived and is not being maintained.

_DTE.ActiveWindow Property

Returns the currently active window, or the top-most window if no others are active.

Namespace: EnvDTE
Assembly: EnvDTE (in envdte.dll)

Window ActiveWindow { get; }
/** @property */
Window get_ActiveWindow ()

function get ActiveWindow () : Window

Property Value

A Window object. Returns Nothing if no windows are open.

ActiveWindow returns the environment's active window.

You can set the caption only on Tool windows. If you attempt to set the caption on other window types, such as Document windows, you get the error, "Unspecified error."

public void ActiveWindowExample(DTE2 dte)
{
    // Create two text files.
    Document doc1 = dte.ItemOperations.NewFile(@"General\Text File", 
        "Document1", Constants.vsViewKindPrimary).Document;
    dte.ItemOperations.NewFile(@"General\Text File", "Document2", 
        Constants.vsViewKindPrimary);

    MessageBox.Show("The active window is " + 
        dte.ActiveWindow.Caption);

    if (MessageBox.Show("Activate Document1?", "", 
        MessageBoxButtons.YesNo) == DialogResult.Yes)
        doc1.Activate();

    MessageBox.Show("The active window is " + 
        dte.ActiveWindow.Caption);
}
Show: