Export (0) Print
Expand All

VSProjectItem Object

Visual Studio .NET 2003

Contains the information specific to a Visual Basic or C# project item. It is returned by the Object property of the ProjectItem object when the project is a Visual Basic or C# project.

VSProjectItem

[Visual Basic .NET]
Public Interface VSProjectItem
    Inherits IDispatch
[Visual Basic 6]
Class VSProjectItem
[C++]
interface VSProjectItem : IDispatch
[C#]
public interface VSProjectItem : IDispatch
[JScript .NET]
public interface VSProjectItem extends IDispatch

Remarks

The ProjectItems collection of a project contains the ProjectItem objects in the project. The Object property of the ProjectItem object returns an Object reference. The actual type of that reference depends on the project language. In the case of Visual Basic and C#, that object is a VSProjectItem object. To use the VSProjectItem class members, the Object property reference must be explicitly converted to VSProjectItem. The example below demonstrates this conversion using the Visual Basic CType function. The PrjKind enumeration is used to test for the project's type before the conversion.

Requirements

Namespace: VSLangProj

File: VSLangProj.dll

Example

Whether a project item has been saved can be determined from the ProjectItem object. This example uses the ProjectItem property of the VSProjectItem object to report whether an item has been saved since it was last changed.

' Macro Editor
' Reports whether the specified project item has been saved since the 
' last change.
Imports VSLangProj
Sub IsItemSaved(ByVal aVSProjectItem As VSProjectItem)
   If (aVSProjectItem.ProjectItem.Saved()) Then
      MsgBox(aVSProjectItem.ProjectItem.Name & " is saved.")
   Else
      MsgBox(aVSProjectItem.ProjectItem.Name & " is not saved.")
   End If
End Sub
    
Sub Test()
   Dim pi As VSProjectItem
   pi = CType(Dte.Solution.Projects.Item(1).ProjectItems.Item(1).Object, _
      VSProjectItem)
   IsItemSaved(pi)
End Sub

See Also

Properties, Methods, and Events | VSLangProj Hierarchy Chart | PrjKind Enumeration | ProjectItem Object | Visual Basic and Visual C# Project Extensibility Examples | Properties Property (Visual Basic and C# ProjectItem Object)

Show:
© 2014 Microsoft