ItemOperations Interface

Object for performing common file actions.

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

Syntax

'Declaration
<GuidAttribute("D5DBE57B-C074-4E95-B015-ABEEAA391693")> _
Public Interface ItemOperations

[GuidAttribute("D5DBE57B-C074-4E95-B015-ABEEAA391693")]
public interface ItemOperations

[GuidAttribute(L"D5DBE57B-C074-4E95-B015-ABEEAA391693")]
public interface class ItemOperations

[<GuidAttribute("D5DBE57B-C074-4E95-B015-ABEEAA391693")>]
type ItemOperations =  interface end

public interface ItemOperations

The ItemOperations type exposes the following members.

Properties

	Name	Description
	DTE	Gets the top-level extensibility object.
	Parent	Gets the immediate parent object of an ItemOperations object.
	PromptToSave	Gets all unsaved files and allows the user to save one or more of them.

Top

Methods

	Name	Description
	AddExistingItem	Adds an existing item to the current project.
	AddNewItem	Adds a new item to the current project.
	IsFileOpen	Indicates whether or not the specified saved file is currently open in the specified view.
	Navigate	Goes to the given URL.
	NewFile	Creates a file as though you invoked a New File command in the integrated development environment (IDE).
	OpenFile	Opens a file as though you invoked an Open File command in the integrated development environment (IDE).

Top

Remarks

You can use the ItemOperations object to programmatically open or add items to your solution and projects. Note that ItemOperations methods act upon only the currently selected item.

This example uses the ItemOperations object to generate a text document listing all available command names.

Examples

Sub ItemOperationsExample()
   Dim Cmds As Commands = DTE.Commands
   Dim Cmd As Command
   Dim Doc As Document
   Dim TxtDoc As TextDocument

   DTE.ItemOperations.NewFile("General\Text File")
   Doc = ActiveDocument
   TxtDoc = Doc.Object("TextDocument")

   For Each Cmd In Cmds
      If (Cmd.Name <> "") Then
         TxtDoc.Selection.Text = Cmd.Name & vbLf
         TxtDoc.Selection.Collapse()
      End If
   Next
End Sub

See Also

Reference

EnvDTE Namespace