Merge pull request #30 from openize-com/muhammadumar-patch

Updated Presentation.cs

Author: muhammadumargroupdocs

PowerPoint/Openize.Slides/Presentation.cs

@@ -3,6 +3,7 @@
 using Openize.Slides.Facade;
 using System;
 using System.Collections.Generic;
+using System.IO;
 
 namespace Openize.Slides
 {
@@ -15,78 +16,60 @@ public class Presentation
         private List<CommentAuthor> _CommentAuthors = null;
         private int _SlideWidth = 960;
         private int _SlideHeight = 720;
-        private string _FilePath = null;
 
+        public PresentationDocumentFacade Facade => doc;
         /// <summary>
-        /// Gets the facade for handling presentation document operations.
-        /// </summary>
-        public PresentationDocumentFacade Facade { get => doc; }
-
-        /// <summary>
-        /// Gets or sets the slide width of the presentation.
+        /// Set slide width
         /// </summary>
         public int SlideWidth { get => _SlideWidth; set => _SlideWidth = value; }
-
         /// <summary>
-        /// Gets or sets the slide height of the presentation.
+        /// Set slide height
         /// </summary>
         public int SlideHeight { get => _SlideHeight; set => _SlideHeight = value; }
 
-        /// <summary>
-        /// Gets or sets the file path of the presentation.
-        /// </summary>
-        public string FilePath { get => _FilePath; set => _FilePath = value; }
-
-        /// <summary>
-        /// Initializes a new presentation document with the specified file path.
-        /// </summary>
-        /// <param name="FilePath">The file path for the presentation.</param>
         private Presentation(String FilePath)
         {
+            _Slides = new List<Slide>();
+            _CommentAuthors = new List<CommentAuthor>();
+
             try
             {
-                _FilePath = FilePath;
-                _Slides = new List<Slide>();
-                _CommentAuthors = new List<CommentAuthor>();
                 doc = PresentationDocumentFacade.Create(FilePath);
             }
             catch (Exception ex)
             {
-                string errorMessage = Common.OpenizeException.ConstructMessage(ex, "Initializing presentation");
-                throw new Common.OpenizeException(errorMessage, ex);
+                throw new Common.OpenizeException($"Failed to create presentation at path '{FilePath}'.", ex);
             }
         }
 
+        private Presentation()
+        {
+            _Slides = new List<Slide>();
+            _CommentAuthors = new List<CommentAuthor>();
+        }
+
         /// <summary>
-        /// Initializes an empty presentation.
+        /// Static method to instantiate a new object of Presentation class.
         /// </summary>
-        private Presentation()
+        /// <param name="FilePath">Presentation path as string</param>
+        /// <returns>An instance of Presentation object</returns>
+        public static Presentation Create(String FilePath)
         {
             try
             {
-                _Slides = new List<Slide>();
-                _CommentAuthors = new List<CommentAuthor>();
+                return new Presentation(FilePath);
             }
             catch (Exception ex)
             {
-                string errorMessage = Common.OpenizeException.ConstructMessage(ex, "Initializing empty presentation");
-                throw new Common.OpenizeException(errorMessage, ex);
+                throw new Common.OpenizeException($"Error occurred while creating a new presentation: {FilePath}", ex);
             }
         }
 
         /// <summary>
-        /// Creates a new presentation instance with the specified file path.
+        /// Static method to load an existing presentation.
         /// </summary>
-        /// <param name="FilePath">The file path for the new presentation.</param>
-        public static Presentation Create(String FilePath)
-        {
-            return new Presentation(FilePath);
-        }
-
-        /// <summary>
-        /// Opens an existing presentation file.
-        /// </summary>
-        /// <param name="FilePath">The file path of the presentation to open.</param>
+        /// <param name="FilePath">Presentation path as string</param>
+        /// <returns>Instance of Presentation object</returns>
         public static Presentation Open(String FilePath)
         {
             try
@@ -96,15 +79,14 @@ public static Presentation Open(String FilePath)
             }
             catch (Exception ex)
             {
-                string errorMessage = Common.OpenizeException.ConstructMessage(ex, "Opening presentation");
-                throw new Common.OpenizeException(errorMessage, ex);
+                throw new Common.OpenizeException($"Error occurred while opening the presentation: {FilePath}", ex);
             }
         }
 
         /// <summary>
-        /// Appends a slide to the presentation.
+        /// This method is responsible to append a slide.
         /// </summary>
-        /// <param name="slide">The slide object to append.</param>
+        /// <param name="slide">An object of a slide</param>
         public void AppendSlide(Slide slide)
         {
             try
@@ -117,84 +99,170 @@ public void AppendSlide(Slide slide)
             }
             catch (Exception ex)
             {
-                string errorMessage = Common.OpenizeException.ConstructMessage(ex, "Appending slide");
-                throw new Common.OpenizeException(errorMessage, ex);
+                throw new Common.OpenizeException("Failed to append slide to presentation.", ex);
             }
         }
+        /// <summary>
+        /// Method to get the list of all slides of a presentation
+        /// </summary>
+        /// <returns></returns>
+        /// <example>
+        /// <code>
+        /// Presentation presentation = Presentation.Open("D:\\AsposeSampleData\\sample.pptx");
+        /// var slides = presentation.GetSlides();
+        /// var slide = slides[0];
+        /// ...
+        /// </code>
+        /// </example>
+        public List<Slide> GetSlides()
+        {
+            if (!doc.IsNewPresentation)
+            {
+                foreach (var slidepart in doc.PresentationSlideParts)
+                {
+                    var slide = new Slide(false);
+
+                    SlideFacade slideFacade = new SlideFacade(false);
+                    slideFacade.TextShapeFacades = TextShapeFacade.PopulateTextShapes(slidepart);
+                    slideFacade.RectangleShapeFacades = RectangleShapeFacade.PopulateRectangleShapes(slidepart);
+                    slideFacade.ImagesFacade = ImageFacade.PopulateImages(slidepart);
+                    slideFacade.PresentationSlide = slidepart.Slide;
+                    slideFacade.TableFacades = TableFacade.PopulateTables(slidepart);
+                    slideFacade.SlidePart = slidepart;
+                    slideFacade.CommentPart = slidepart.SlideCommentsPart;
+                    slideFacade.NotesPart = slidepart.NotesSlidePart;
+                    slideFacade.RelationshipId = doc.GetSlideRelationshipId(slidepart);
+                    slide.TextShapes = TextShape.GetTextShapes(slideFacade.TextShapeFacades);
+                    slide.Rectangles = Rectangle.GetRectangles(slideFacade.RectangleShapeFacades);
+                    slide.Circles = Circle.GetCircles(slideFacade.CircleShapeFacades);
+                    slide.Images = Image.GetImages(slideFacade.ImagesFacade);
+                    slide.Tables = Table.GetTables(slideFacade.TableFacades);
+                    slide.SlideFacade = slideFacade;
+                    slide.SlidePresentation = this;
+                    _Slides.Add(slide);
+                }
+            }
+            return _Slides;
+
+        }
 
         /// <summary>
-        /// Copies a slide from another presentation.
+        /// Method to save the new or changed presentation.
         /// </summary>
-        /// <param name="slide">The slide object to copy.</param>
-        public void CopySlide(Slide slide)
+        public void Save()
         {
             try
             {
-                doc.CopySlide(slide.SlideFacade);
-                _Slides.Add(slide);
+                doc.Save();
             }
             catch (Exception ex)
             {
-                string errorMessage = Common.OpenizeException.ConstructMessage(ex, "Copying slide");
-                throw new Common.OpenizeException(errorMessage, ex);
+                throw new Common.OpenizeException("Failed to save the presentation.", ex);
             }
         }
 
         /// <summary>
-        /// Retrieves all slides from the presentation.
+        /// Method to close a presentation.
         /// </summary>
-        public List<Slide> GetSlides()
+        public void close()
         {
             try
             {
-                if (!doc.IsNewPresentation)
-                {
-                    foreach (var slidepart in doc.PresentationSlideParts)
-                    {
-                        var slide = new Slide(false);
-                        slide.SlideFacade = new SlideFacade(false);
-                        _Slides.Add(slide);
-                    }
-                }
-                return _Slides;
+                doc.Dispose();
             }
             catch (Exception ex)
             {
-                string errorMessage = Common.OpenizeException.ConstructMessage(ex, "Getting slides");
-                throw new Common.OpenizeException(errorMessage, ex);
+                throw new Common.OpenizeException("Failed to close the presentation.", ex);
             }
         }
 
         /// <summary>
-        /// Saves the presentation document.
+        /// Extract and save images of a presentation into a directory.
         /// </summary>
-        public void Save()
+        /// <param name="outputFolder">Folder path as string</param>
+        public void ExtractAndSaveImages(string outputFolder)
         {
             try
             {
-                doc.Close(FilePath);
+                doc.ExtractAndSaveImages(outputFolder);
             }
             catch (Exception ex)
             {
-                string errorMessage = Common.OpenizeException.ConstructMessage(ex, "Saving presentation");
-                throw new Common.OpenizeException(errorMessage, ex);
+                throw new Common.OpenizeException($"Failed to extract and save images to folder '{outputFolder}'.", ex);
             }
         }
 
         /// <summary>
-        /// Closes the presentation document.
+        /// Method to remove a slide at a specific index.
         /// </summary>
-        public void Close()
+        /// <param name="slideIndex">Index of a slide</param>
+        public String RemoveSlide(int slideIndex)
         {
             try
             {
-                doc.Close(FilePath);
+                return doc.RemoveSlide(slideIndex);
             }
             catch (Exception ex)
             {
-                string errorMessage = Common.OpenizeException.ConstructMessage(ex, "Closing presentation");
-                throw new Common.OpenizeException(errorMessage, ex);
+                throw new Common.OpenizeException($"Failed to remove slide at index {slideIndex}.", ex);
+            }
+        }       
+        /// <summary>
+        /// Create comment author using this method
+        /// </summary>
+        /// <param name="author"> Pass comment author object</param>
+        public void CreateAuthor(CommentAuthor author)
+        {
+            doc.CreateAuthor(author.Id, author.ColorIndex, author.Name, author.InitialLetter);
+            _CommentAuthors.Add(author);
+        }
+        /// <summary>
+        /// Get the list of comment author
+        /// </summary>
+        /// <returns></returns>
+        public List<CommentAuthor> GetCommentAuthors()
+        {
+            List<CommentAuthor> authorList = new List<CommentAuthor>();
+            var FacadeAuthors = doc.GetCommentAuthors();
+            foreach (var author in FacadeAuthors)
+            {
+                CommentAuthor commentAuthor = new CommentAuthor();
+                commentAuthor.InitialLetter = author["Initials"];
+                commentAuthor.ColorIndex = Convert.ToInt32(author["ColorIndex"]);
+                commentAuthor.Name = author["Name"];
+                commentAuthor.Id = Convert.ToInt32(author["Id"]);
+                authorList.Add(commentAuthor);
             }
+            return authorList;
+        }
+        /// <summary>
+        /// Method to remove comment author.
+        /// </summary>
+        /// <param name="author"></param>
+        public void RemoveCommentAuthor(CommentAuthor author)
+        {
+            doc.RemoveCommentAuthor(author.Id);
+            _CommentAuthors.Remove(author);
+        }
+        /// <summary>
+        /// Method to insert a slide at a specific index
+        /// </summary>
+        /// <param name="index">Index of a slide</param>
+        /// <param name="slide">A slide object</param>
+        public void InsertSlideAt(int index, Slide slide)
+        {
+            slide.SlideIndex = index;
+            slide.SlideFacade.SlideIndex = index;
+            doc.InsertSlide(index, slide.SlideFacade);
+        }
+
+        /// <summary>
+        /// This method exports all existing notes of a PPT/PPTX to TXT file.
+        /// </summary>
+        /// <param name="filePath"> File path where to save TXT file</param>
+        public void SaveAllNotesToTextFile(string filePath)
+        {
+            doc.SaveAllNotesToTextFile(filePath);
         }
     }
-}
+}