ProjectItem Interface

Represents an item in a project.

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

Syntax

'Declaration
<GuidAttribute("0B48100A-473E-433C-AB8F-66B9739AB620")> _
Public Interface ProjectItem
[GuidAttribute("0B48100A-473E-433C-AB8F-66B9739AB620")]
public interface ProjectItem
[GuidAttribute(L"0B48100A-473E-433C-AB8F-66B9739AB620")]
public interface class ProjectItem
[<GuidAttribute("0B48100A-473E-433C-AB8F-66B9739AB620")>]
type ProjectItem =  interface end
public interface ProjectItem

The ProjectItem type exposes the following members.

Properties

Name Description
Public property Collection Gets the ProjectItems collection containing the ProjectItem object supporting this property.
Public property ConfigurationManager Gets the ConfigurationManager object for this ProjectItem.
Public property ContainingProject Gets the project hosting the ProjectItem.
Public property Document Gets the Document associated with the item, if one exists.
Public property DTE Gets the top-level extensibility object.
Public property Extender Gets the requested Extender if it is available for this object.
Public property ExtenderCATID Gets the Extender category ID (CATID) for the object.
Public property ExtenderNames Gets a list of available Extenders for the object.
Public property FileCodeModel Gets the FileCodeModel object for the project item.
Public property FileCount Gets the number of files associated with a ProjectItem.
Public property FileNames Gets the full path and names of the files associated with a project item.
Public property IsDirty Infrastructure. Microsoft Internal Use Only.
Public property IsOpen Gets a value indicating whether the project item is open in a particular view type.
Public property Kind Gets a GUID string indicating the kind or type of the object.
Public property Name Gets or sets the name of the object.
Public property Object Gets an object that can be accessed by name at run time.
Public property ProjectItems Gets a ProjectItems for the object.
Public property Properties Gets a collection of all properties that pertain to the object.
Public property Saved Gets or sets a value indicating whether or not the object has been modified since last being saved or opened.
Public property SubProject If the project item is the root of a subproject, then the SubProject property returns the Project object for the subproject.

Top

Methods

Name Description
Public method Delete Removes the item from its project and its storage.
Public method ExpandView Expands the view of Solution Explorer to show project items.
Public method Open Opens the ProjectItem in the specified view.
Public method Remove Removes the project item from the collection.
Public method Save Saves the project or project item.
Public method SaveAs Saves the project item.

Top

Examples

' Before running, create a new project or open an existing project.
Sub ListProj()
   Dim proj As Project = DTE.ActiveSolutionProjects(0)
   Dim win As Window = _
     DTE.Windows.Item(Constants.vsWindowKindCommandWindow)
   ListProjAux(proj.ProjectItems(), 0)
End Sub

Sub ListProjAux(ByVal projitems As ProjectItems, ByVal Level As Integer)
   Dim projitem As ProjectItem
   For Each projitem In projitems
      MsgBox("Project item: " & projitem.Name, Level)
      ' Recurse if the project item has sub-items...
      Dim projitems2 As ProjectItems
      projitems2 = projitem.ProjectItems
      Dim notsubcoll As Boolean = projitems2 Is Nothing
      If Not notsubcoll Then
         ListProjAux(projitems2, Level + 1)
      End If
   Next
End Sub

See Also

Reference

EnvDTE Namespace

Other Resources

Controlling Projects and Solutions