Skip to content

Improves Exception Message to show what part is missing. - #1971 #1974

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Improves Exception Message to show what part is missing. - #1971 #1974

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
233c070
added try catch
mkaszewiak Nov 21, 2025
669eca9
removed extra comment
mkaszewiak Nov 21, 2025
08667e1
removed uneeded changes
mkaszewiak Nov 21, 2025
a0b2c73
removed catch
mkaszewiak Nov 26, 2025
230b53f
Formating reverted
mkaszewiak Nov 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions src/DocumentFormat.OpenXml.Features/DocumentFormat.OpenXml.Features.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<IncludeFrameworkShims>true</IncludeFrameworkShims>
<TargetFrameworks>$(ProductTargetFrameworks)</TargetFrameworks>
</PropertyGroup>
<PropertyGroup>
Copy link
Member

@twsouthwick twsouthwick Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like just whitespace change? tabs/spaces?

<IncludeFrameworkShims>true</IncludeFrameworkShims>
<TargetFrameworks>$(ProductTargetFrameworks)</TargetFrameworks>
</PropertyGroup>

<PropertyGroup>
<Summary>Provides additional features that add functionality to the Open XML SDK.</Summary>
<Description>Provides additional functionality to the Open XML SDK.</Description>
</PropertyGroup>
<PropertyGroup>
<Summary>Provides additional features that add functionality to the Open XML SDK.</Summary>
<Description>Provides additional functionality to the Open XML SDK.</Description>
</PropertyGroup>

<ItemGroup>
<Compile Include="..\DocumentFormat.OpenXml.Framework\SimpleTypes\HexStringFactory.cs" Link="HexStringFactory.cs" />
</ItemGroup>
<ItemGroup>
<Compile Include="..\DocumentFormat.OpenXml.Framework\SimpleTypes\HexStringFactory.cs" Link="HexStringFactory.cs" />
</ItemGroup>

<ItemGroup>
<ProjectReference Include="..\DocumentFormat.OpenXml\DocumentFormat.OpenXml.csproj" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\DocumentFormat.OpenXml\DocumentFormat.OpenXml.csproj" />
</ItemGroup>

<ItemGroup>
<PackageReference Include="Microsoft.CodeAnalysis.PublicApiAnalyzers">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
</ItemGroup>
<ItemGroup>
<PackageReference Include="Microsoft.CodeAnalysis.PublicApiAnalyzers">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
</ItemGroup>

</Project>
19 changes: 17 additions & 2 deletions src/DocumentFormat.OpenXml.Framework/Packaging/OpenXmlPart.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,23 @@ internal void Load(OpenXmlPackage? openXmlPackage, OpenXmlPart? parent, Uri uriT

SetPackage(openXmlPackage, parent);

// TODO: should we delay load?
var part = _openXmlPackage.Features.GetRequired<IPackageFeature>().Package.GetPart(uriTarget);
IPackagePart? part = null;
try
{
// TODO: should we delay load?
part = _openXmlPackage.Features.GetRequired<IPackageFeature>().Package.GetPart(uriTarget);
Copy link
Member

@twsouthwick twsouthwick Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we make the Getpart return null when there's this failure? Then we can just check for a null

}
catch (InvalidOperationException ex)
{
var errorMessage = SR.Format(
ExceptionMessages.SpecifiedPartNotFound,
uriTarget.OriginalString, ex.Message);
throw new InvalidOperationException(errorMessage);
}
catch (Exception)
Copy link
Member

@twsouthwick twsouthwick Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this isn't necessary

{
throw;
}

Features.Set<IPackagePartFeature>(new PackagePartFeature(part));

Expand Down
11 changes: 11 additions & 0 deletions src/DocumentFormat.OpenXml.Framework/Resources/ExceptionMessages.Designer.cs
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions src/DocumentFormat.OpenXml.Framework/Resources/ExceptionMessages.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -417,4 +417,9 @@
<data name="EncryptedPackageNotSupported" xml:space="preserve">
<value>Encrypted packages are not supported.</value>
</data>
<data name="SpecifiedPartNotFound" xml:space="preserve">
<value> Part: {0} doesn't exist in the package.

Original Message:{1}</value>
</data>
</root>
Loading