Merge pull request #238 from jafin/refactor/outline

refactor (outline): Minor refactor on outline, add test.

Author: ststeiger

PdfSharpCore.Test/Outlines/OutlineTests.cs

@@ -0,0 +1,44 @@
+using System.IO;
+using FluentAssertions;
+using PdfSharpCore.Drawing;
+using PdfSharpCore.Pdf;
+using Xunit;
+
+namespace PdfSharpCore.Test.Outlines
+{
+    public class OutlineTests
+    {
+        [Fact]
+        public void CanCreateDocumentWithOutlines()
+        {
+            var document = new PdfDocument();
+            var font = new XFont("Verdana", 16);
+            var page = document.AddPage();
+            var gfx = XGraphics.FromPdfPage(page);
+            gfx.DrawString("Page 1", font, XBrushes.Black, 20, 50, XStringFormats.Default);
+
+            // Create the root bookmark. You can set the style and the color.
+            var outline = document.Outlines.Add("Root", page, true,
+                PdfOutlineStyle.Bold, XColors.Red);
+
+            // Create some more pages
+            for (var idx = 2; idx <= 5; idx++)
+            {
+                page = document.AddPage();
+                gfx = XGraphics.FromPdfPage(page);
+
+                var text = $"Page {idx}";
+                gfx.DrawString(text, font, XBrushes.Black, 20, 50, XStringFormats.Default);
+
+                // Create a sub bookmark
+                outline.Outlines.Add(text, page, true);
+            }
+
+            document.Outlines.Count.Should().Be(1);
+            
+            using var ms = new MemoryStream();
+            document.Save(ms);
+            ms.ToArray().Length.Should().BeGreaterThan(1);
+        }
+    }
+}

PdfSharpCore/Pdf/PdfOutlineCollection.cs

@@ -39,7 +39,7 @@ namespace PdfSharpCore.Pdf
     /// <summary>
     /// Represents a collection of outlines.
     /// </summary>
-    public class PdfOutlineCollection : PdfObject, ICollection<PdfOutline>, IList<PdfOutline>
+    public class PdfOutlineCollection : PdfObject, IList<PdfOutline>
     {
         /// <summary>
         /// Can only be created as part of PdfOutline.
@@ -66,26 +66,20 @@ public bool Remove(PdfOutline item)
         /// <summary>
         /// Gets the number of entries in this collection.
         /// </summary>
-        public int Count
-        {
-            get { return _outlines.Count; }
-        }
+        public int Count => _outlines.Count;
 
         /// <summary>
         /// Returns false.
         /// </summary>
-        public bool IsReadOnly
-        {
-            get { return false; }
-        }
+        public bool IsReadOnly => false;
 
         /// <summary>
         /// Adds the specified outline.
         /// </summary>
         public void Add(PdfOutline outline)
         {
             if (outline == null)
-                throw new ArgumentNullException("outline");
+                throw new ArgumentNullException(nameof(outline));
 
             // DestinationPage is optional. PDFsharp does not yet support outlines with action ("/A") instead of destination page ("/DEST")
             if (outline.DestinationPage != null && !ReferenceEquals(Owner, outline.DestinationPage.Owner))
@@ -209,9 +203,9 @@ public int IndexOf(PdfOutline item)
         public void Insert(int index, PdfOutline outline)
         {
             if (outline == null)
-                throw new ArgumentNullException("outline");
+                throw new ArgumentNullException(nameof(outline));
             if (index < 0 || index >= _outlines.Count)
-                throw new ArgumentOutOfRangeException("index", index, PSSR.OutlineIndexOutOfRange);
+                throw new ArgumentOutOfRangeException(nameof(index), index, PSSR.OutlineIndexOutOfRange);
 
             AddToOutlinesTree(outline);
             _outlines.Insert(index, outline);
@@ -235,15 +229,15 @@ public PdfOutline this[int index]
             get
             {
                 if (index < 0 || index >= _outlines.Count)
-                    throw new ArgumentOutOfRangeException("index", index, PSSR.OutlineIndexOutOfRange);
+                    throw new ArgumentOutOfRangeException(nameof(index), index, PSSR.OutlineIndexOutOfRange);
                 return _outlines[index];
             }
             set
             {
                 if (index < 0 || index >= _outlines.Count)
-                    throw new ArgumentOutOfRangeException("index", index, PSSR.OutlineIndexOutOfRange);
+                    throw new ArgumentOutOfRangeException(nameof(index), index, PSSR.OutlineIndexOutOfRange);
                 if (value == null)
-                    throw new ArgumentOutOfRangeException("value", null, PSSR.SetValueMustNotBeNull);
+                    throw new ArgumentOutOfRangeException(nameof(value), null, PSSR.SetValueMustNotBeNull);
 
                 AddToOutlinesTree(value);
                 _outlines[index] = value;
@@ -274,7 +268,7 @@ internal int CountOpen()
         void AddToOutlinesTree(PdfOutline outline)
         {
             if (outline == null)
-                throw new ArgumentNullException("outline");
+                throw new ArgumentNullException(nameof(outline));
 
             // DestinationPage is optional. PDFsharp does not yet support outlines with action ("/A") instead of destination page ("/DEST")
             if (outline.DestinationPage != null && !ReferenceEquals(Owner, outline.DestinationPage.Owner))
@@ -287,10 +281,10 @@ void AddToOutlinesTree(PdfOutline outline)
             //_outlines.Add(outline);
             if (!Owner._irefTable.Contains(outline.ObjectID))
                 Owner._irefTable.Add(outline);
-            else
-            {
-                outline.GetType();
-            }
+            // else
+            // {
+            //     outline.GetType();
+            // }
 
             //if (outline.Opened)
             //{
@@ -306,7 +300,7 @@ void AddToOutlinesTree(PdfOutline outline)
         void RemoveFromOutlinesTree(PdfOutline outline)
         {
             if (outline == null)
-                throw new ArgumentNullException("outline");
+                throw new ArgumentNullException(nameof(outline));
 
             // TODO check the parent problems...
             //outline.Document = Owner;
@@ -316,7 +310,7 @@ void RemoveFromOutlinesTree(PdfOutline outline)
         }
 
         /// <summary>
-        /// The parent outine of this collection.
+        /// The parent outline of this collection.
         /// </summary>
         readonly PdfOutline _parent;