Window2.Selection Property

Gets an object representing the current selection on the Window object.

Namespace:  EnvDTE80
Assembly:  EnvDTE80 (in EnvDTE80.dll)

Syntax

'Declaration
ReadOnly Property Selection As Object

'Usage
Dim instance As Window2 
Dim value As Object 

value = instance.Selection

Object Selection { get; }

property Object^ Selection {
    Object^ get ();
}

function get Selection () : Object

Property Value

Type: System.Object
An object.

Implements

Window.Selection

Examples

This example makes a text file the active window. It then uses it to iterate through the windows collection and to display the name of the containing project and project item for the window.

Before running this example, open a project in Visual Studio and add a text file named "TextFile1.txt" to it. Add some text to the file and select it. The example displays the selected text in a message box.

For more information about how to run this example as an add-in, see How to: Compile and Run the Automation Object Model Code Examples.

Imports EnvDTE
Imports EnvDTE80
Public Sub OnConnection(ByVal application As Object, _
 ByVal connectMode As ext_ConnectMode, ByVal addInInst As Object _
, ByRef custom As Array) Implements IDTExtensibility2.OnConnection
    _applicationObject = CType(application, DTE2)
    _addInInstance = CType(addInInst, AddIn)
    SelectionExample (_applicationObject)
End Sub
Sub SelectionExample (ByVal dte As DTE2)
    Try
        'Before running, create a text file named 
        ' "TextFile1.txt", include it in your solution,
        ' and make it the active window. Write some text in the file
        ' and select it.
        Dim win As Window2
        Dim doc As Document
        If _applicationObject.Documents.Count > 0 Then
            doc = _applicationObject.Documents.Item("TextFile1.txt")
            win = CType(doc.ActiveWindow, Window2)
            ' Show the name of the project that contains this
            ' window and document.
            MsgBox("The name of the project containing the window: " _
            & win.Project.Name)
            ' Acticate the winodw.
            win.Activate()
            ' Show the name of the current ProjectITem.
            MsgBox("The name of the current project item is: "  _
            & win.ProjectItem.Name)
            ' How many other windows are available?
            Dim w As String = "Available windows are :" & vbCr
            For Each wi As Window2 In win.Collection
                w = w & wi.Caption & vbCr
             Next
             MsgBox(w)
             ' Show the selected text.
             MsgBox(CType(win.Selection, TextSelection).Text _
             & " is selected.")
            ' Determine that the document returned by the 
            ' document property
            ' is the same as the document object 'doc'.
            If win.Document Is doc Then
                MsgBox("The documents match!")
            Else
                MsgBox("The documents do not match.")
            End If
            ' Close the window.
            win.Close(vsSaveChanges.vsSaveChangesNo)
        End If
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try
End Sub

using EnvDTE;
using EnvDTE80;
using System.Windows.Forms;
public void OnConnection(object application,
 ext_ConnectMode connectMode, object addInInst, ref Array custom)
{
    _applicationObject = (DTE2)application;
    _addInInstance = (AddIn)addInInst;
    SelectionExample(_applicationObject);
}
public void SelectionExample(DTE2 dte)
{
    try
    {
        // Before running, create a text file named 
        // "TextFile1.txt", include it in your solution,
        // and make it the active window. Write some text in the file
        // and select it.
        Window win;
        Document doc;
        if (dte.Documents.Count > 0)
        {
            doc = dte.Documents.Item("TextFile1.txt");
            win = doc.ActiveWindow;
            // Show the name of the project that contains this window 
            // and document.
            MessageBox.Show("The name of the containing project is : "
 + win.Project.Name);
            win.Activate(); // Activate the window
            // Show the name of the current ProjectItem in the window.
            MessageBox.Show("The name of the project item is: " 
+ win.ProjectItem.Name);
            // How many other windows are available?
            string w = "Available windows:\n";
            foreach (Window wi in win.Collection)
            {
                w = w + wi.Caption + "\n";
            }
            MessageBox.Show(w);
            // Show the selected text.
            MessageBox.Show(((TextSelection)win.Selection).Text 
+ " is selected.");
            // Determine that the document returned by the document 
            // property is the same as the document object 'doc'.
            if (win.Document.Equals(doc))
                MessageBox.Show("The documents match!");
            Else
                MessageBox.Show("The documents do not match!");
            // Close the window.
            win.Close(vsSaveChanges.vsSaveChangesNo);
        }
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

Window2 Interface

Window2 Members

Selection Overload

EnvDTE80 Namespace