Solution3.FindProjectItem(String) Method

Definition

Namespace:

EnvDTE90

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Locates an item in a project.

public:
 EnvDTE::ProjectItem ^ FindProjectItem(System::String ^ FileName);

public:
 EnvDTE::ProjectItem ^ FindProjectItem(Platform::String ^ FileName);

EnvDTE::ProjectItem FindProjectItem(std::wstring const & FileName);

[System.Runtime.InteropServices.DispId(42)]
public EnvDTE.ProjectItem FindProjectItem (string FileName);

[<System.Runtime.InteropServices.DispId(42)>]
abstract member FindProjectItem : string -> EnvDTE.ProjectItem

Public Function FindProjectItem (FileName As String) As ProjectItem

Parameters

FileName

String

Required. The name of the project item to locate.

Returns

ProjectItem

A ProjectItem object.

Implements

FindProjectItem(String)

Attributes

DispIdAttribute

Examples

Sub SolnFindProjectItemExample(ByVal dte As DTE2)  
    ' Finds a project item in a  solution.  
    ' Make sure you have a solution open in Visual   
    ' Studio before running this example.  
    Try  
        Dim soln As Solution3 =  _  
        CType(_applicationObject.Solution, Solution3)  
        MsgBox("Finding a project item in the solution ")  
        ' Find the specified project.  
        Dim proj As ProjectItem  
        proj = soln.FindProjectItem _(soln.Projects.Item(1).ProjectItems.Item(1).Name.ToString())  
        MsgBox(proj.Name.ToString())  
    Catch ex As System.Exception  
        MsgBox(ex.ToString)  
    End Try  
End Sub  

using System.Windows.Forms;  
public void CreateExample(DTE2 dte)  
{  
    // Finds a project item in a solution.  
    // Open a solution in Visual Studio before running this example.  
    try  
    {  
        Solution3 soln = (Solution3)_applicationObject.Solution;  
        MessageBox.Show("Finding a project item in the solution.");  
        ProjectItem proj;  
        proj =  
          soln.FindProjectItem  
          (soln.Projects.Item(1).ProjectItems.Item(1).Name.ToString());  
        MessageBox.Show("The project item found is: "   
          + proj.Name.ToString());  
    }  
    catch (SystemException ex)  
    {  
        MessageBox.Show("ERROR: " + ex);  
    }  
}  

Remarks

FindProjectItem performs an OpenFile -type search for the given file name. The first project found to have the item returns its ProjectItem object for the name. If the file is not found in the solution, null is returned.