ItemOperations Interface

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.

Object for performing common file actions.

public interface class ItemOperations

public interface class ItemOperations

__interface ItemOperations

[System.Runtime.InteropServices.Guid("D5DBE57B-C074-4E95-B015-ABEEAA391693")]
[System.Runtime.InteropServices.TypeLibType(4160)]
public interface ItemOperations

[System.Runtime.InteropServices.Guid("D5DBE57B-C074-4E95-B015-ABEEAA391693")]
public interface ItemOperations

[<System.Runtime.InteropServices.Guid("D5DBE57B-C074-4E95-B015-ABEEAA391693")>]
[<System.Runtime.InteropServices.TypeLibType(4160)>]
type ItemOperations = interface

[<System.Runtime.InteropServices.Guid("D5DBE57B-C074-4E95-B015-ABEEAA391693")>]
type ItemOperations = interface

Public Interface ItemOperations

Attributes: GuidAttribute TypeLibTypeAttribute

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

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.

Properties

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.

Methods

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

Applies to

Partilhar via