TextSelection.Text Property

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Sets or gets the text selection.

public:
 property System::String ^ default { System::String ^ get(); void set(System::String ^ value); };

public:
 property Platform::String ^ default { Platform::String ^ get(); void set(Platform::String ^ value); };

[System.Runtime.InteropServices.DispId(0)]
public string this { [System.Runtime.InteropServices.DispId(0)] get; [System.Runtime.InteropServices.DispId(0)] set; }

[<System.Runtime.InteropServices.DispId(0)>]
[<get: System.Runtime.InteropServices.DispId(0)>]
[<set: System.Runtime.InteropServices.DispId(0)>]
member this.Text : string with get, set

Default Public Property Text As String

Property Value

String

A string representing the text selection.

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 TextExample(ByVal dte As DTE)  

    ' NOTE: This examples 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 TextExample(DTE dte)  
{  
    // NOTE: This examples 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

The Text property is the default property for the TextSelection object.

When the Text property is read, the text in the text selection is returned, and the selection itself is unchanged.

When the Text property is set, the value of Text is inserted in front of the text selection and then collapsed, similar to what happens when text is pasted into a document. Note that this property behaves just as it would when the editor is in insert (that is, nonovertype) mode. Any text after the 128th character is truncated.

If the Mode property of the TextSelection object is set to Column, then setting the Text property generates an error.

Applies to

Freigeben über