Remove OpenXmlPackage.Close and all references (#1373)

tomjebo · web-flow · commit e2d90ca5abd0 · 2023-04-03T12:24:36.000-07:00
* Remove OpenXmlPackage.Close and all references
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();

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ public static void Main(string[] args)`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`// Create a presentation`
`41`		`- PresentationDocument presentationDocument = PowerPointUtils.CreatePresentation(fileInfo.FullName);`
	`41`	`+ using PresentationDocument presentationDocument = PowerPointUtils.CreatePresentation(fileInfo.FullName);`
`42`	`42`
`43`	`43`	`// create missing PowerPointAuthorsPart if it is null`
`44`	`44`	`if (presentationDocument?.PresentationPart?.authorsPart is null)`
`@@ -94,8 +94,6 @@ public static void Main(string[] args)`
`94`	`94`	`new CommentRelationship()`
`95`	`95`	`{ Id = slidePart.GetIdOfPart(powerPointCommentPart) })`
`96`	`96`	`{ Uri = "{6950BFC3-D8DA-4A85-94F7-54DA5524770B}" }));`
`97`		`-`
`98`		`- presentationDocument.Close();`
`99`	`97`	`}`
`100`	`98`	`catch (Exception ex)`
`101`	`99`	`{`
Original file line number	Diff line number	Diff line change
`@@ -26,14 +26,11 @@ private static void Main(string[] args)`
`26`	`26`	`public static void CreatePresentation(string filepath)`
`27`	`27`	`{`
`28`	`28`	`// Create a presentation at a specified file path. The presentation document type is pptx, by default.`
`29`		`- var presentationDoc = PresentationDocument.Create(filepath, PresentationDocumentType.Presentation);`
	`29`	`+ using PresentationDocument presentationDoc = PresentationDocument.Create(filepath, PresentationDocumentType.Presentation);`
`30`	`30`	`var presentationPart = presentationDoc.AddPresentationPart();`
`31`	`31`	`presentationPart.Presentation = new Presentation();`
`32`	`32`
`33`	`33`	`CreatePresentationParts(presentationPart);`
`34`		`-`
`35`		`- // Close the presentation handle`
`36`		`- presentationDoc.Close();`
`37`	`34`	`}`
`38`	`35`
`39`	`36`	`private static void CreatePresentationParts(PresentationPart presentationPart)`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ private static void Main(string[] args)`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`// WORKBOOK`
`54`		`- SpreadsheetDocument? sd = ExampleUtilities.CreateSpreadsheetWorkbook(filePath, sheetName);`
	`54`	`+ using SpreadsheetDocument? sd = ExampleUtilities.CreateSpreadsheetWorkbook(filePath, sheetName);`
`55`	`55`
`56`	`56`	`if (sd != null)`
`57`	`57`	`{`
`@@ -105,9 +105,6 @@ private static void Main(string[] args)`
`105`	`105`	`// ThreadedComment attributes`
`106`	`106`	`{ Ref = reference, PersonId = idUser, Id = tcId, DT = System.DateTime.Now });`
`107`	`107`	`}`
`108`		`-`
`109`		`- // Close the document.`
`110`		`- sd.Close();`
`111`	`108`	`}`
`112`	`109`	`else`
`113`	`110`	`{`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,10 @@ public void CanCloneDocument()`
`33`	`33`	`{`
`34`	`34`	`var body = clone.MainDocumentPart.Document.Body;`
`35`	`35`	`body.InsertBefore(new Paragraph(new Run(new Text("Hello World"))), body.FirstChild);`
`36`		`- clone.SaveAs(file.Path).Close();`
	`36`	`+ using (var temp = clone.SaveAs(file.Path))`
	`37`	`+ {`
	`38`	`+ // clean up the temp package.`
	`39`	`+ }`
`37`	`40`
`38`	`41`	`using (var dest = WordprocessingDocument.Open(file.Path, false))`
`39`	`42`	`{`
`@@ -105,18 +108,20 @@ public void CanDoMultithreadedMultipleCloning()`
`105`	`108`	`}`
`106`	`109`
`107`	`110`	`// Clone clone1 again.`
`108`		`- var clone3 = (WordprocessingDocument)clone1.Clone();`
`109`		`- var body3 = clone3.MainDocumentPart.Document.Body;`
`110`		`- body3.GetFirstChild<Paragraph>()`
`111`		`- .InsertBeforeSelf(new Paragraph(new Run(new Text("Clone 3"))));`
`112`		`- clone3.Close();`
	`111`	`+ using (WordprocessingDocument clone3 = (WordprocessingDocument)clone1.Clone())`
	`112`	`+ {`
	`113`	`+ var body3 = clone3.MainDocumentPart.Document.Body;`
	`114`	`+ body3.GetFirstChild<Paragraph>()`
	`115`	`+ .InsertBeforeSelf(new Paragraph(new Run(new Text("Clone 3"))));`
	`116`	`+ }`
`113`	`117`
`114`	`118`	`// Clone source again.`
`115`		`- var clone4 = (WordprocessingDocument)source.Clone();`
`116`		`- var body4 = clone4.MainDocumentPart.Document.Body;`
`117`		`- body4.GetFirstChild<Paragraph>()`
`118`		`- .InsertBeforeSelf(new Paragraph(new Run(new Text("Clone 4"))));`
`119`		`- clone4.Close();`
	`119`	`+ using (WordprocessingDocument clone4 = (WordprocessingDocument)source.Clone())`
	`120`	`+ {`
	`121`	`+ var body4 = clone4.MainDocumentPart.Document.Body;`
	`122`	`+ body4.GetFirstChild<Paragraph>()`
	`123`	`+ .InsertBeforeSelf(new Paragraph(new Run(new Text("Clone 4"))));`
	`124`	`+ }`
`120`	`125`	`}`
`121`	`126`	`});`
`122`	`127`	`}`
`@@ -181,7 +186,9 @@ public void CanWildlyCloneAndFlush()`
`181`	`186`
`182`	`187`	`using (var tempFile = TemporaryFile.Create())`
`183`	`188`	`{`
`184`		`- clone.SaveAs(tempFile.Path).Close();`
	`189`	`+ using (clone.SaveAs(tempFile.Path))`
	`190`	`+ {`
	`191`	`+ }`
`185`	`192`	`}`
`186`	`193`	`}`
`187`	`194`	`});`
`@@ -197,7 +204,7 @@ public void CanDoPackageBasedCloningWord()`
`197`	`204`	`{`
`198`	`205`	`using (var package = Package.Open(ms, FileMode.Create))`
`199`	`206`	`{`
`200`		`- source.Clone(package).Close();`
	`207`	`+ _ = source.Clone(package);`
`201`	`208`	`}`
`202`	`209`
`203`	`210`	`ms.Position = 0;`
`@@ -218,7 +225,7 @@ public void CanDoPackageBasedCloningSpreadsheet()`
`218`	`225`	`{`
`219`	`226`	`using (var package = Package.Open(ms, FileMode.Create))`
`220`	`227`	`{`
`221`		`- source.Clone(package).Close();`
	`228`	`+ _ = source.Clone(package);`
`222`	`229`	`}`
`223`	`230`
`224`	`231`	`ms.Position = 0;`
`@@ -239,7 +246,7 @@ public void CanDoPackageBasedCloningPowerpoint()`
`239`	`246`	`{`
`240`	`247`	`using (var package = Package.Open(ms, FileMode.Create))`
`241`	`248`	`{`
`242`		`- source.Clone(package).Close();`
	`249`	`+ _ = source.Clone(package);`
`243`	`250`	`}`
`244`	`251`
`245`	`252`	`ms.Position = 0;`
Original file line number	Diff line number	Diff line change
`@@ -3079,8 +3079,6 @@ public void PackageStuctureValidatingTest()`
`3079`	`3079`	`commentsPart.Comments.SaveToPart(commentsPart2);`
`3080`	`3080`
`3081`	`3081`	`mainPart.Relationships.Create(mainPart.Uri, System.IO.Packaging.TargetMode.Internal, mainPart.RelationshipType);`
`3082`		`-`
`3083`		`- wordDoc.Close();`
`3084`	`3082`	`}`
`3085`	`3083`
`3086`	`3084`	`stream.Flush();`