How to find a ProjectItem by the file name

Question

I'm developing a custom tool for the Visual Studio. The tool is assigned to the file, at the time when the file changed I receive name of this file and should generate some changes in the project. I need to find a ProjectItem by the received file name. I have found only one solution it's enumerate all project items in the each project of the solution. But it seems to be huge solution. Is there a way to get a project item by the file name without enumeration?

This is my implementation of the Generate method of the IVsSingleFileGenerator

public int Generate(string sourceFilePath, string sourceFileContent, string defaultNamespace, IntPtr[] outputFileContents, out uint output, IVsGeneratorProgress generateProgress)
{
    var dte = (EnvDTE.DTE)Package.GetGlobalService(typeof(EnvDTE.DTE));

    ProjectItem projectItem = null;

    foreach (Project project in dte.Solution.Projects)
    {
        foreach (ProjectItem item in project.ProjectItems)
        {
            var path = item.Properties.Item("FullPath").Value;
            if (sourceFilePath.Equals(path, StringComparison.OrdinalIgnoreCase))
            {
                projectItem = item;
            }
        }               
    }

    output = 0;
    outputFileContents[0] = IntPtr.Zero;

    return Microsoft.VisualStudio.VSConstants.S_OK;
}

Unclear: Are you parsing the sln file and then parsing each csproj? Or are you scanning the file system? — Gayot Fow, Oct 17 '13 at 13:00
I'm searching in the DTE object which is provided by the VisualStudio. — Viacheslav Smityukh, Oct 17 '13 at 13:20
This seems to work: https://stackoverflow.com/a/38876595/509584 — Slime recipe, Jun 12 '17 at 17:49

score 8 · Accepted Answer · answered Oct 17 '13 at 17:17

I am using this user-friendly world of DTE as well, to create a Guidance. I did not find any better solution. Basically these are methods I am using:

Iterate projects:

public static ProjectItem FindSolutionItemByName(DTE dte, string name, bool recursive)
{
    ProjectItem projectItem = null;
    foreach (Project project in dte.Solution.Projects)
    {
        projectItem = FindProjectItemInProject(project, name, recursive);

        if (projectItem != null)
        {
            break;
        }
    }
    return projectItem;
}

Find in a single project:

public static ProjectItem FindProjectItemInProject(Project project, string name, bool recursive)
{
    ProjectItem projectItem = null;

    if (project.Kind != Constants.vsProjectKindSolutionItems)
    {
        if (project.ProjectItems != null && project.ProjectItems.Count > 0)
        {
            projectItem = DteHelper.FindItemByName(project.ProjectItems, name, recursive);
        }
    }
    else
    {
        // if solution folder, one of its ProjectItems might be a real project
        foreach (ProjectItem item in project.ProjectItems)
        {
            Project realProject = item.Object as Project;

            if (realProject != null)
            {
                projectItem = FindProjectItemInProject(realProject, name, recursive);

                if (projectItem != null)
                {
                    break;
                }
            }
        }
    }

    return projectItem;
}

The code I am using with more snippets could be found here, as a Guidance for new projects. Search for and take the source code..

as a warning this doesn't account at all for solution folders. `dteSolution.Projects` returns top level items only, not projects that are in solution folders =( — Maslow, Jun 13 '14 at 17:10
I see that this is old, but this really should have the code (or reference) to 'DteHelper.FindItemByName()'. — Steve Kinyon, Sep 11 '15 at 17:08
The **DteHelper** is not a custom code, but Microsoft - built in. This would be a full name: **`Microsoft.Practices.RecipeFramework.Library.DteHelper`** — Radim Köhler, Jan 05 '16 at 09:45
Where can I download the Microsoft.Practices.RecipeFramework.Library ? thx in advance — Jon, Dec 05 '18 at 13:27

score 2 · Answer 2 · answered Oct 26 '20 at 14:55

2

May be a little late but use DTE2.Solution.FindProjectItem(fullPathofChangedFile);

answered Oct 26 '20 at 14:55

Eugene

101
1
3

1

`FindProjectItem(string FileName)` is a member of `EnvDTE._Solution` in `EnvDTE.dll, 8.0.0.0` (i.e. Visual Studio 2005), btw - so you don't need `DTE2`, just `DTE` is fine. – Dai Apr 05 '21 at 06:53

score 0 · Answer 3 · answered Oct 16 '19 at 18:14

0

To get project.documents - find an item - use Linq to query files

answered Oct 16 '19 at 18:14

Jon

1,608
7
25
38

How to find a ProjectItem by the file name

3 Answers3