TextSelection.Text プロパティ

[アーティクル]
08/22/2008

更新 : 2007 年 11 月

選択したテキストを設定または取得します。

名前空間 : EnvDTE
アセンブリ : EnvDTE (EnvDTE.dll 内)

構文

'宣言
Default Property Text As String
'使用
Dim instance As TextSelection
Dim value As String

value = instance

instance = value

string this { get; set; }

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

function get Text () : String
function set Text (value : String)

プロパティ値

型 : System.String

選択したテキストを表す文字列。

解説

Text プロパティは、TextSelection オブジェクトの既定のプロパティです。

Text プロパティを読み取ると、選択したテキスト内のテキストを取得し、選択したテキスト自体は変更されません。

Text プロパティを設定すると、選択したテキストの前に Text の値が挿入され、折りたたまれます。これは、テキストをドキュメントに貼り付ける場合に似ています。このプロパティの動作は、エディタを上書き入力モードではなく、挿入モードに設定しているときの動作と同じです。128 番目の文字より後のテキストはすべて切り捨てられます。

TextSelection オブジェクトの Mode プロパティに Column を設定している場合、Text プロパティを設定するとエラーが発生します。

例

この例は Visual Studio .NET 2003 でのみ動作します。詳細については、「方法 : テンプレートを使用したプロジェクト作成コードを移行する」を参照してください。

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";
}