TextSelection.InsertFromFile Method

  • Article

Inserts the contents of the specified file at the current location in the buffer.

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

Syntax

'Declaration
Sub InsertFromFile ( _
    File As String _
)

void InsertFromFile(
    string File
)

void InsertFromFile(
    [InAttribute] String^ File
)

abstract InsertFromFile : 
        File:string -> unit

function InsertFromFile(
    File : String
)

Parameters

  • File
    Type: System.String

    Required. The name of the file to insert into the text buffer.

Remarks

The edit point moves past the insertion point. The text is converted to Unicode, which is the internal representation used by text documents.

Examples

Sub InsertFromFileExample(ByVal dte As DTE2)

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

    ' Create a new text file and insert 10 lines of text.
    dte.ItemOperations.NewFile(, "File1")
    Dim doc As Document = dte.ActiveDocument
    Dim sel As TextSelection = CType(doc.Selection, TextSelection)
    Dim i As Integer

    For i = 1 To 10
        sel.Insert("This is a test." & vbCrLf)
    Next i

    MsgBox("Saving and closing File1")

    ' Save and close the text file.
    Dim file1 As String = Path.GetTempPath & "File1.txt"
    doc.Save(file1)
    doc.Close()

    ' Create a new text file.
    dte.ItemOperations.NewFile(, "File2")
    doc = dte.ActiveDocument

    If MsgBox("Insert text from File1 into File2?", _
        MsgBoxStyle.YesNo) = MsgBoxResult.Yes Then
        sel = CType(doc.Selection, TextSelection)
        sel.InsertFromFile(file1)
    End If

End Sub

public void InsertFromFileExample(DTE2 dte)
{
    // NOTE: This example requires a reference to the
    //       System.IO namespace.

    // Create a new text file and insert 10 lines of text.
    dte.ItemOperations.NewFile(@"General\Text File", "File1", 
        Constants.vsViewKindPrimary);
    Document doc = dte.ActiveDocument;
    TextSelection sel = (TextSelection)doc.Selection;

    for (int i = 0; i < 10; ++i)
        sel.Insert("This is a test.\n", 
           (int)vsInsertFlags.vsInsertFlagsCollapseToEnd);

    MessageBox.Show("Saving and closing File1");

    // Save and close the text file.
    string file1 = Path.GetTempPath() + "File1.txt";
    doc.Save(file1);
    doc.Close(vsSaveChanges.vsSaveChangesNo);

    // Create a new text file.
    dte.ItemOperations.NewFile(@"General\Text File", "File2", 
        Constants.vsViewKindPrimary);
    doc = dte.ActiveDocument;

    if (MessageBox.Show("Insert text from File1 into File2?", "", 
        MessageBoxButtons.YesNo) == DialogResult.Yes)
    {
        sel = (TextSelection)doc.Selection;
        sel.InsertFromFile(file1);
    }
}

.NET Framework Security

See Also

Reference

TextSelection Interface

EnvDTE Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples