Remove OpenXmlPackage.Close and all references (#1373)

* Remove OpenXmlPackage.Close and all references
dotnet · Apr 3, 2023 · e2d90ca · e2d90ca
1 parent b6650ef
commit e2d90ca
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 40 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -30,6 +30,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Removed obsolete validation logic from v1 of the SDK
 - Removed obsoleted methods from 2.x
 - Removed mutable properties on OpenXmlAttribute and marked as `readonly`
+- Removed `OpenXmlPackage.Close` in favor of Dispose (#1373)
 
 ### Fixed
 - Fixed incorrect file extensions for vbaProject files (#1292)

diff --git a/samples/PowerPointModernCommentSample/Program.cs b/samples/PowerPointModernCommentSample/Program.cs
@@ -38,7 +38,7 @@ public static void Main(string[] args)
                 }
 
                 // Create a presentation
-                PresentationDocument presentationDocument = PowerPointUtils.CreatePresentation(fileInfo.FullName);
+                using PresentationDocument presentationDocument = PowerPointUtils.CreatePresentation(fileInfo.FullName);
 
                 // create missing PowerPointAuthorsPart if it is null
                 if (presentationDocument?.PresentationPart?.authorsPart is null)
@@ -94,8 +94,6 @@ public static void Main(string[] args)
                             new CommentRelationship()
                             { Id = slidePart.GetIdOfPart(powerPointCommentPart) })
                         { Uri = "{6950BFC3-D8DA-4A85-94F7-54DA5524770B}" }));
-
-                presentationDocument.Close();
             }
             catch (Exception ex)
             {

diff --git a/samples/SunburstChartExample/Program.cs b/samples/SunburstChartExample/Program.cs
@@ -26,14 +26,11 @@ private static void Main(string[] args)
         public static void CreatePresentation(string filepath)
         {
             // Create a presentation at a specified file path. The presentation document type is pptx, by default.
-            var presentationDoc = PresentationDocument.Create(filepath, PresentationDocumentType.Presentation);
+            using PresentationDocument presentationDoc = PresentationDocument.Create(filepath, PresentationDocumentType.Presentation);
             var presentationPart = presentationDoc.AddPresentationPart();
             presentationPart.Presentation = new Presentation();
 
             CreatePresentationParts(presentationPart);
-
-            // Close the presentation handle
-            presentationDoc.Close();
         }
 
         private static void CreatePresentationParts(PresentationPart presentationPart)

diff --git a/samples/ThreadedCommentExample/Program.cs b/samples/ThreadedCommentExample/Program.cs
@@ -51,7 +51,7 @@ private static void Main(string[] args)
             }
 
             // WORKBOOK
-            SpreadsheetDocument? sd = ExampleUtilities.CreateSpreadsheetWorkbook(filePath, sheetName);
+            using SpreadsheetDocument? sd = ExampleUtilities.CreateSpreadsheetWorkbook(filePath, sheetName);
 
             if (sd != null)
             {
@@ -105,9 +105,6 @@ private static void Main(string[] args)
                         // ThreadedComment attributes
                         { Ref = reference, PersonId = idUser, Id = tcId, DT = System.DateTime.Now });
                 }
-
-                // Close the document.
-                sd.Close();
             }
             else
             {

diff --git a/src/DocumentFormat.OpenXml.Framework/Packaging/OpenXmlPackage.cs b/src/DocumentFormat.OpenXml.Framework/Packaging/OpenXmlPackage.cs
@@ -143,15 +143,6 @@ public void DeletePartsRecursivelyOfType<T>()
             DeletePartsRecursivelyOfTypeBase<T>();
         }
 
-        /// <summary>
-        /// Saves and closes the OpenXml package and all underlying part streams.
-        /// </summary>
-        public void Close()
-        {
-            ThrowIfObjectDisposed();
-            Dispose();
-        }
-
         #region methods to operate DataPart
 
         /// <summary>

diff --git a/test/DocumentFormat.OpenXml.Tests/CreateFromTemplateTests.cs b/test/DocumentFormat.OpenXml.Tests/CreateFromTemplateTests.cs
@@ -20,7 +20,7 @@ public void CanCreatePresentationFromTemplate()
                 var part = packageDocument.PresentationPart;
                 var root = part.Presentation;
 
-                packageDocument.SaveAs(Path.GetTempFileName()).Close();
+                _ = packageDocument.SaveAs(Path.GetTempFileName());
 
                 // We are fine if we have not run into an exception.
                 Assert.True(true);
@@ -36,7 +36,7 @@ public void CanCreateSpreadsheetFromTemplate()
                 var part = packageDocument.WorkbookPart;
                 var root = part.Workbook;
 
-                packageDocument.SaveAs(Path.GetTempFileName()).Close();
+                _ = packageDocument.SaveAs(Path.GetTempFileName());
 
                 // We are fine if we have not run into an exception.
                 Assert.True(true);
@@ -52,7 +52,7 @@ public void CanCreateWordprocessingDocumentFromTemplate()
                 var part = packageDocument.MainDocumentPart;
                 var root = part.Document;
 
-                packageDocument.SaveAs(Path.GetTempFileName()).Close();
+                _ = packageDocument.SaveAs(Path.GetTempFileName());
 
                 // We are fine if we have not run into an exception.
                 Assert.True(true);

diff --git a/test/DocumentFormat.OpenXml.Tests/SaveAndCloneTests.cs b/test/DocumentFormat.OpenXml.Tests/SaveAndCloneTests.cs
@@ -33,7 +33,10 @@ public void CanCloneDocument()
                 {
                     var body = clone.MainDocumentPart.Document.Body;
                     body.InsertBefore(new Paragraph(new Run(new Text("Hello World"))), body.FirstChild);
-                    clone.SaveAs(file.Path).Close();
+                    using (var temp = clone.SaveAs(file.Path))
+                    {
+                        // clean up the temp package.
+                    }
 
                     using (var dest = WordprocessingDocument.Open(file.Path, false))
                     {
@@ -105,18 +108,20 @@ public void CanDoMultithreadedMultipleCloning()
                         }
 
                         // Clone clone1 again.
-                        var clone3 = (WordprocessingDocument)clone1.Clone();
-                        var body3 = clone3.MainDocumentPart.Document.Body;
-                        body3.GetFirstChild<Paragraph>()
-                            .InsertBeforeSelf(new Paragraph(new Run(new Text("Clone 3"))));
-                        clone3.Close();
+                        using (WordprocessingDocument clone3 = (WordprocessingDocument)clone1.Clone())
+                        {
+                            var body3 = clone3.MainDocumentPart.Document.Body;
+                            body3.GetFirstChild<Paragraph>()
+                                .InsertBeforeSelf(new Paragraph(new Run(new Text("Clone 3"))));
+                        }
 
                         // Clone source again.
-                        var clone4 = (WordprocessingDocument)source.Clone();
-                        var body4 = clone4.MainDocumentPart.Document.Body;
-                        body4.GetFirstChild<Paragraph>()
-                            .InsertBeforeSelf(new Paragraph(new Run(new Text("Clone 4"))));
-                        clone4.Close();
+                        using (WordprocessingDocument clone4 = (WordprocessingDocument)source.Clone())
+                        {
+                            var body4 = clone4.MainDocumentPart.Document.Body;
+                            body4.GetFirstChild<Paragraph>()
+                                .InsertBeforeSelf(new Paragraph(new Run(new Text("Clone 4"))));
+                        }
                     }
                 });
             }
@@ -181,7 +186,9 @@ public void CanWildlyCloneAndFlush()
 
                         using (var tempFile = TemporaryFile.Create())
                         {
-                            clone.SaveAs(tempFile.Path).Close();
+                            using (clone.SaveAs(tempFile.Path))
+                            {
+                            }
                         }
                     }
                 });
@@ -197,7 +204,7 @@ public void CanDoPackageBasedCloningWord()
             {
                 using (var package = Package.Open(ms, FileMode.Create))
                 {
-                    source.Clone(package).Close();
+                    _ = source.Clone(package);
                 }
 
                 ms.Position = 0;
@@ -218,7 +225,7 @@ public void CanDoPackageBasedCloningSpreadsheet()
             {
                 using (var package = Package.Open(ms, FileMode.Create))
                 {
-                    source.Clone(package).Close();
+                    _ = source.Clone(package);
                 }
 
                 ms.Position = 0;
@@ -239,7 +246,7 @@ public void CanDoPackageBasedCloningPowerpoint()
             {
                 using (var package = Package.Open(ms, FileMode.Create))
                 {
-                    source.Clone(package).Close();
+                    _ = source.Clone(package);
                 }
 
                 ms.Position = 0;

diff --git a/test/DocumentFormat.OpenXml.Tests/ofapiTest/OpenXmlValidatorTest.cs b/test/DocumentFormat.OpenXml.Tests/ofapiTest/OpenXmlValidatorTest.cs
@@ -3079,8 +3079,6 @@ public void PackageStuctureValidatingTest()
                     commentsPart.Comments.SaveToPart(commentsPart2);
 
                     mainPart.Relationships.Create(mainPart.Uri, System.IO.Packaging.TargetMode.Internal, mainPart.RelationshipType);
-
-                    wordDoc.Close();
                 }
 
                 stream.Flush();