This documentation is archived and is not being maintained.

TextSelection.Text Property

Sets or gets the selected text.

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

string this { get; set; }
/** @property */
String get_Text ()

/** @property */
void set_Text (/** @attribute InAttribute() */ String pText)

function get Text () : String

function set Text (pText : String)

Property Value

A string representing the selected text.

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

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

When the Text property is set, the value of Text is inserted in front of the selected text 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.

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

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 = 
    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.LineUp(false, 1);
    sel.Text = "// New comment\n";