Document.Selection Property

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Gets an object representing the current selection on the Document.

public:
 property System::Object ^ Selection { System::Object ^ get(); };

public:
 property Platform::Object ^ Selection { Platform::Object ^ get(); };

[System.Runtime.InteropServices.DispId(131)]
public object Selection { [System.Runtime.InteropServices.DispId(131)] get; }

[<System.Runtime.InteropServices.DispId(131)>]
[<get: System.Runtime.InteropServices.DispId(131)>]
member this.Selection : obj

Public ReadOnly Property Selection As Object

Property Value

Object

An object representing the current selection on the Document.

Attributes

DispIdAttribute

Examples

This example works only in Visual Studio .NET 2003. For more information, see Migrating Code that Creates Projects by Using Templates.

Sub SelectionExample(ByVal dte As DTE)  

    ' NOTE: This example requires a reference to the   
    '       VSLangProj namespace.  

    ' Create a new solution.  
    Dim soln As Solution = dte.Solution  
    Dim solnName As String = "NewSolution.sln"  
    Dim tempPath As String = System.IO.Path.GetTempPath()  
    soln.Create(tempPath, solnName)  

    ' Create a new Visual Basic Console Application project.  
    Dim templatePath As String =   
        dte.Solution.TemplatePath(PrjKind.prjKindVBProject)  
    templatePath &= "ConsoleApplication.vsz"  
    Dim projName As String = "NewProject"  
    soln.AddFromTemplate(templatePath, tempPath & projName, projName)  
    Dim proj As Project = soln.Item(1)  

    ' Add a comment to Module1.vb.  
    Dim item As ProjectItem = proj.ProjectItems.Item("Module1.vb")  
    Dim sel As TextSelection = CType(item.Document.Selection,   
        TextSelection)  

    sel.StartOfDocument()  
    sel.NewLine()  
    sel.LineUp()  
    sel.Text = "' New comment" & vbCrLf  

End Sub  

public void SelectionExample(DTE dte)  
{  
    // NOTE: This example requires a reference to the   
    //       VSLangProj namespace.  

    // Create a new solution.  
    Solution soln = dte.Solution;  
    string solnName = "NewSolution.sln";  
    string tempPath = System.IO.Path.GetTempPath();  
    soln.Create(tempPath, solnName);  

    // Create a new C# Console Application project.  
    string templatePath =   
        dte.Solution.get_TemplatePath(PrjKind.prjKindCSharpProject);  
    templatePath += "CSharpConsole.vsz";  
    string projName = "Project1";  
    soln.AddFromTemplate(templatePath, tempPath + projName,   
        projName, false);  
    Project proj = soln.Item(1);  

    // Add a comment to Class1.cs.  
    ProjectItem item = proj.ProjectItems.Item("Class1.cs");  
    TextSelection sel = (TextSelection)item.Document.Selection;  

    sel.StartOfDocument(false);  
    sel.NewLine(1);  
    sel.LineUp(false, 1);  
    sel.Text = "// New comment\n";  
}  

Remarks

Selection returns the current selection in the active window associated with this document (or the topmost window of the document if none is active).