Incorrect COMReference entry when using Office interop #5735

JohnyL · 2019-12-16T06:12:44Z

To include Excel interop libraries in .NET Core app, I do the following: Dependencies -> Add Reference -> COM -> Microsoft Excel 14.0 Object Library. When I do this, I get the following ItemGroup:

<ItemGroup>
    <COMReference Include="Microsoft.Office.Excel.dll">
        <Guid>00020813-0000-0000-c000-000000000046</Guid>
        <VersionMajor>1</VersionMajor>
        <VersionMinor>7</VersionMinor>
        <WrapperTool>tlbimp</WrapperTool>
        <Lcid>0</Lcid>
        <Isolated>false</Isolated>
    </COMReference>
</ItemGroup>

However, I get the following runtime error:

Unhandled exception. System.IO.FileNotFoundException: Could not load file or assembly 'office, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c'. The system cannot find the file specified.

In order to work, I have created .NET Framework app, added COM reference there and copied its COMReference - and it works:

<ItemGroup>
    <COMReference Include="Microsoft.Office.Interop.Excel">
        <Guid>{00020813-0000-0000-C000-000000000046}</Guid>
        <VersionMajor>1</VersionMajor>
	<VersionMinor>7</VersionMinor>
	<Lcid>0</Lcid>
	<WrapperTool>primary</WrapperTool>
	<Isolated>False</Isolated>
	<EmbedInteropTypes>True</EmbedInteropTypes>
    </COMReference>
</ItemGroup>

As noted here, in order to fix the situation, the project system needs to add <EmbedInteropTypes>True</EmbedInteropTypes>.

The text was updated successfully, but these errors were encountered:

drewnoakes · 2019-12-16T06:44:06Z

Repro steps:

New netcoreapp3.1 console application
Right-click Dependencies node
Select "Add Reference..."
Select "COM"
Select "Microsoft Excel 16.0 Object Library"
Reference a type within code (e.g. Microsoft.Office.Interop.Excel.Chart)
Try to run the console app. It fails as described.
Add <EmbedInteropTypes>True</EmbedInteropTypes>
Running now works

netcoreapp3.1

  <ItemGroup>
    <COMReference Include="Microsoft.Office.Excel.dll">
      <Guid>00020813-0000-0000-c000-000000000046</Guid>
      <VersionMajor>1</VersionMajor>
      <VersionMinor>9</VersionMinor>
      <WrapperTool>tlbimp</WrapperTool>
      <Lcid>0</Lcid>
      <Isolated>false</Isolated>
    </COMReference>
  </ItemGroup>

net471

  <ItemGroup>
    <COMReference Include="Microsoft.Office.Core">
      <Guid>{2DF8D04C-5BFA-101B-BDE5-00AA0044DE52}</Guid>
      <VersionMajor>2</VersionMajor>
      <VersionMinor>8</VersionMinor>
      <Lcid>0</Lcid>
      <WrapperTool>primary</WrapperTool>
      <Isolated>False</Isolated>
      <EmbedInteropTypes>True</EmbedInteropTypes>
    </COMReference>
    <COMReference Include="Microsoft.Office.Interop.Excel">
      <Guid>{00020813-0000-0000-C000-000000000046}</Guid>
      <VersionMajor>1</VersionMajor>
      <VersionMinor>9</VersionMinor>
      <Lcid>0</Lcid>
      <WrapperTool>primary</WrapperTool>
      <Isolated>False</Isolated>
      <EmbedInteropTypes>True</EmbedInteropTypes>
    </COMReference>
    <COMReference Include="VBIDE">
      <Guid>{0002E157-0000-0000-C000-000000000046}</Guid>
      <VersionMajor>5</VersionMajor>
      <VersionMinor>3</VersionMinor>
      <Lcid>0</Lcid>
      <WrapperTool>primary</WrapperTool>
      <Isolated>False</Isolated>
      <EmbedInteropTypes>True</EmbedInteropTypes>
    </COMReference>
  </ItemGroup>

JohnyL · 2019-12-16T09:43:23Z

Beg your pardon - I forgot to mention that this happens in .NET Core.

JohnyL · 2019-12-29T13:51:29Z

I have found out that if you use <WrapperTool>tlbimp</WrapperTool>, then interop types won't be embedded and Excel DLL is copied into app's folder, but if you use <WrapperTool>primary</WrapperTool>, then types will be embedded and Excel DLL is not copied into app's folder (of course, <EmbedInteropTypes>true</EmbedInteropTypes> must exist).

shanselman · 2020-09-14T05:51:16Z

I'm hitting this, just as above, in Sept of 2020. @davkean

Seems like you can't do Office Interop with Core unless you do the com reference manually?

Tooling does this (wrong:)

    <COMReference Include="Microsoft.Office.PowerPoint.dll">
      <Guid>91493440-5a91-11cf-8700-00aa0060263b</Guid>
      <VersionMajor>2</VersionMajor>
      <VersionMinor>12</VersionMinor>
      <WrapperTool>tlbimp</WrapperTool>
      <Lcid>0</Lcid>
      <Isolated>false</Isolated>
    </COMReference>
  </ItemGroup>

Correct:

    <COMReference Include="Microsoft.Office.Interop.PowerPoint">
      <Guid>{91493440-5a91-11cf-8700-00aa0060263b}</Guid>
      <VersionMajor>2</VersionMajor>
      <VersionMinor>12</VersionMinor>
      <WrapperTool>primary</WrapperTool>
      <Lcid>0</Lcid>
      <Isolated>false</Isolated>
      <EmbedInteropTypes>True</EmbedInteropTypes>
    </COMReference>
  </ItemGroup>

JohnyL · 2020-09-14T20:14:29Z

@shanselman Your correct variant is correct. 😉 This is what COMReference should have:

The value of <WrapperTool> must be primary.
<EmbedInteropTypes>True</EmbedInteropTypes> must be present.
The .dll extension in the end of file name (in Include attribute) is arbitrary.

cartermp · 2020-09-23T20:56:25Z

As per a chat with @shanselman this is popping up in multiple places:

dotnet/msbuild#4332
dotnet/msbuild#3986

Is the root problem the VS tooling or the MSBuild issue?

davkean · 2020-09-23T21:01:32Z

This is a CPS bug, we should get a Developer feedback item filed and moved to them.

tmeschter · 2020-12-11T00:02:28Z

@JohnyL, @shanselman: I've investigated and established several issues at this point:

The Include differs from what was generated in a .NET Framework project.
The EmbedInteropTypes metadata is not being added.
Once added, EmbedInteropTypes is not fully respected in a .NET Core 3.1 project.

We're going to fix 1 & 2 in the project system (though 1 is minor as the Include is just a friendly name for the benefit of the developer). Issue 3 is being tracked by dotnet/msbuild#5959.

tmeschter · 2020-12-11T00:16:13Z

For .NET Core 3.1 projects, you can workaround the problem with EmbedInteropTypes not being fully respected by adding <Private>false</Private> metadata to the item.

.NET 5 projects do not seem to have the same issue.

qrli · 2020-12-25T08:57:51Z

Also encountered this. The solution mentioned here works, except for Workbook.Queries and WorkbookQuery, which will be magically missing when <WrapperTool>primary</WrapperTool>. But they can be successfuly resolved when <WrapperTool>tlbimp</WrapperTool>

I just upgraded to .NET 5.0.

ricphiri · 2021-04-14T17:30:17Z

It's April 2021, using .Net 5 and the problem still exists. I just used the solution in @shanselman's post to work on Excel.

For quick reference:

I changed the WrapperTool to "primary";
added EmbedInteropTypes (set to "true");
removed ".dll" from the COMReference

Are there any plans to fix this in the tooling?

ULTRAKKK1004 · 2022-04-02T10:36:33Z

I had same issue using .net5 and .net6

But now I can use excel when using .net5/6

Don't use Nuget Microsoft.Office.Interop.Excel pakage
-> nuget's microsoft.office.interop.excel package is fine when using .net framework but .net5/6
Just add "excel.exe file" to Reference. That's ok.
Of cource, you should use using things. (using Microsoft.Office.Interop.Excel;)

JohnyL · 2022-04-02T12:32:40Z

@ULTRAKKK1004 Beg your pardon, but understood nothing what you were trying to say.

ULTRAKKK1004 · 2022-04-02T13:07:45Z

@JohnyL check url below.
https://smithkorea.blogspot.com/2022/04/solved-could-not-load-file-or-assembly.html

You are making winform app using .net core, Right?
I've just checked it works.

Just add Excel.exe file to Reference.
(It's Not Nuget-Microsoft.Office.Interop.Excel, just Excel.exe file)

JohnyL · 2022-04-03T06:47:47Z

@ULTRAKKK1004
This doesn't work either:

ULTRAKKK1004 · 2022-04-03T11:03:08Z

@JohnyL
Hmm. Let me know your environment.(I've just checked you used F#........)
In F# case, it doesn't work....I checked...
My case was C#.

I tested vs2022/vs2019, c#, .net core3.1, winform/console.
Office version is 2019.

c# console:

c# winform:

ULTRAKKK1004 · 2022-04-03T12:09:34Z

@JohnyL
fine. in f# case, add more files.....to reference...
office.dll and Microsoft.Office.Interop.Excel.dll (they are in office folder)

office.dll and Microsoft.Office.Interop.Excel.dll

Adding to Reference Manager

Result.(same code with JohnyL but it works.)

ashwiniuchit · 2022-04-04T05:08:06Z

Add below references for the project.

ULTRAKKK1004 · 2022-04-04T10:09:44Z

@ashwiniuchit
Oh. Thanks

mathewseduardo · 2024-03-01T06:28:34Z

March 2024, There is my solution (net core 7, Excel v16):

Change in each project of the solution, the tarjet platform to x86
Compile always in Any CPU mode
Let the reference to Excel in the default mode:

<COMReference Include="Microsoft.Office.Interop.Excel"> <WrapperTool>tlbimp</WrapperTool> <VersionMinor>9</VersionMinor> <VersionMajor>1</VersionMajor> <Guid>00020813-0000-0000-c000-000000000046</Guid> <Lcid>0</Lcid> <Isolated>false</Isolated> <EmbedInteropTypes>true</EmbedInteropTypes> </COMReference>

Its works, in Win 64 bits.

Flohack74 · 2024-06-14T08:31:30Z

@shanselman while the COMReference works fine for my local build machine, it breaks when Excel is not installed, which is the case for our CI machines in Azure Devops. How can we achieve to build this correctly, given that its impossible to install Office/Excel on those agents? Thanks for any insights :)

drewnoakes added the Parity-Legacy-Feature Missing features from the legacy project system. label Dec 16, 2019

drewnoakes mentioned this issue Dec 16, 2019

Incorrect COMReference entries when including Office interop dotnet/runtime#796

Closed

davkean added Needs-CPS-work Changes are needed in the closed-source Common Project System (CPS) repo. Bug This is a functional issue in already written code. labels Dec 16, 2019

davkean assigned davidwengier Dec 16, 2019

davkean added this to the Backlog milestone Dec 16, 2019

davkean added the Triage-Approved Reviewed and prioritized label Dec 16, 2019

elinor-fung mentioned this issue Mar 5, 2020

Dynamic keyword not working against COM objects dotnet/runtime#12587

Closed

davidwengier removed their assignment Oct 18, 2020

tmeschter self-assigned this Nov 25, 2020

tmeschter added the Bug Bash Issues to be handled during our bug fixing push label Nov 25, 2020

tmeschter modified the milestones: Backlog, 16.9 Dec 10, 2020

tmeschter mentioned this issue Dec 10, 2020

ResolveComReference task does not respect EmbedInteropTypes in .NET Core 3.1 app dotnet/msbuild#5959

Closed

jjmew modified the milestones: 16.9, Backlog Feb 9, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Incorrect COMReference entry when using Office interop #5735

Incorrect COMReference entry when using Office interop #5735

JohnyL commented Dec 16, 2019 •

edited

Loading

drewnoakes commented Dec 16, 2019 •

edited

Loading

JohnyL commented Dec 16, 2019

JohnyL commented Dec 29, 2019

shanselman commented Sep 14, 2020

JohnyL commented Sep 14, 2020 •

edited by drewnoakes

Loading

cartermp commented Sep 23, 2020

davkean commented Sep 23, 2020

tmeschter commented Dec 11, 2020

tmeschter commented Dec 11, 2020

qrli commented Dec 25, 2020 •

edited

Loading

ricphiri commented Apr 14, 2021

ULTRAKKK1004 commented Apr 2, 2022

JohnyL commented Apr 2, 2022

ULTRAKKK1004 commented Apr 2, 2022 •

edited

Loading

JohnyL commented Apr 3, 2022 •

edited

Loading

ULTRAKKK1004 commented Apr 3, 2022 •

edited

Loading

ULTRAKKK1004 commented Apr 3, 2022 •

edited

Loading

ashwiniuchit commented Apr 4, 2022 •

edited

Loading

ULTRAKKK1004 commented Apr 4, 2022

mathewseduardo commented Mar 1, 2024 •

edited

Loading

Flohack74 commented Jun 14, 2024

Incorrect COMReference entry when using Office interop #5735

Incorrect COMReference entry when using Office interop #5735

Comments

JohnyL commented Dec 16, 2019 • edited Loading

drewnoakes commented Dec 16, 2019 • edited Loading

netcoreapp3.1

net471

JohnyL commented Dec 16, 2019

JohnyL commented Dec 29, 2019

shanselman commented Sep 14, 2020

JohnyL commented Sep 14, 2020 • edited by drewnoakes Loading

cartermp commented Sep 23, 2020

davkean commented Sep 23, 2020

tmeschter commented Dec 11, 2020

tmeschter commented Dec 11, 2020

qrli commented Dec 25, 2020 • edited Loading

ricphiri commented Apr 14, 2021

ULTRAKKK1004 commented Apr 2, 2022

JohnyL commented Apr 2, 2022

ULTRAKKK1004 commented Apr 2, 2022 • edited Loading

JohnyL commented Apr 3, 2022 • edited Loading

ULTRAKKK1004 commented Apr 3, 2022 • edited Loading

ULTRAKKK1004 commented Apr 3, 2022 • edited Loading

ashwiniuchit commented Apr 4, 2022 • edited Loading

ULTRAKKK1004 commented Apr 4, 2022

mathewseduardo commented Mar 1, 2024 • edited Loading

Flohack74 commented Jun 14, 2024

JohnyL commented Dec 16, 2019 •

edited

Loading

drewnoakes commented Dec 16, 2019 •

edited

Loading

JohnyL commented Sep 14, 2020 •

edited by drewnoakes

Loading

qrli commented Dec 25, 2020 •

edited

Loading

ULTRAKKK1004 commented Apr 2, 2022 •

edited

Loading

JohnyL commented Apr 3, 2022 •

edited

Loading

ULTRAKKK1004 commented Apr 3, 2022 •

edited

Loading

ULTRAKKK1004 commented Apr 3, 2022 •

edited

Loading

ashwiniuchit commented Apr 4, 2022 •

edited

Loading

mathewseduardo commented Mar 1, 2024 •

edited

Loading