Implement more feaures that require minimal changes in the DOCX renderer and add relevant samples

Author: manfromarce

src/WIP/DocSharp.Renderer/DocxRenderer.cs

@@ -132,11 +132,28 @@ internal override void ProcessSection((List<OpenXmlElement> content, SectionProp
                 l = margins.Left.Value;
             if (margins.Right != null)
                 r = margins.Right.Value;
-        }
+        }        
 
         // Convert twips to points
         var pageSet = new QuestPdfPageSet(w / 20f, h / 20f, l / 20f, t / 20f, r / 20f, b / 20f, 
                                           QuestPDF.Infrastructure.Unit.Point);
+
+        var columns = sectionProperties.GetFirstChild<Columns>();
+        if (columns != null && columns.ColumnCount != null && columns.ColumnCount > 1)
+        {
+            pageSet.NumberOfColumns = columns.ColumnCount.Value;
+
+            if (columns.Space.ToFloat() is float columnGap && columnGap > 0)
+            {
+                pageSet.SpaceBetweenColumns = columnGap / 20f; // Convert twips to points
+            }
+
+            if (columns.EqualWidth != null && columns.EqualWidth.Value == false)
+            {
+                // TODO
+            }
+        }  
+
         if (pageColor.HasValue)
             pageSet.BackgroundColor = pageColor.Value;
 
@@ -145,8 +162,7 @@ internal override void ProcessSection((List<OpenXmlElement> content, SectionProp
 
         // Process headers for this section
         var headerRefs = sectionProperties.Elements<HeaderReference>();
-        // QuestPDF can't produce different header and footer on odd/even pages.
-        // For now, handle the default header and footer only.
+        // TODO: QuestPDF can produce different header and footer on odd/even pages using the ShowIf() function.
         var headerRef = headerRefs.FirstOrDefault(h => h.Type == null || !h.Type.HasValue || h.Type.Value == HeaderFooterValues.Default);
         if (headerRef?.Id?.Value is string headerId && mainPart.GetPartById(headerId) is HeaderPart headerPart)
         {
@@ -158,8 +174,7 @@ internal override void ProcessSection((List<OpenXmlElement> content, SectionProp
 
         // Process footers for this section
         var footerRefs = sectionProperties.Elements<FooterReference>();
-        // QuestPDF can't produce different header and footer on odd/even pages.
-        // For now, handle the default header and footer only.
+        // TODO: QuestPDF can produce different header and footer on odd/even pages using the ShowIf() function.
         var footerRef = footerRefs.FirstOrDefault(h => h.Type == null || !h.Type.HasValue || h.Type.Value == HeaderFooterValues.Default);
         if (footerRef?.Id?.Value is string footerId && mainPart.GetPartById(footerId) is FooterPart footerPart)
         {
@@ -214,6 +229,9 @@ internal override void ProcessParagraph(Paragraph paragraph, QuestPdfModel outpu
         p.EndIndent = indent.EndIndent;
         p.FirstLineIndent = indent.FirstLineIndent;
 
+        p.KeepTogether = paragraph.GetEffectiveProperty<KeepLines>().ToBool();
+        // TODO: KeepNext (cannot be set at paragraph level in QuestPDF and requires a different approach)
+
         // Add paragraph to the current container (body, header, footer, table cell, ...)
         if (currentContainer.Count > 0)
             currentContainer.Peek().Content.Add(p);
@@ -396,7 +414,8 @@ internal override void ProcessBreak(Break @break, QuestPdfModel output)
                 // Add span to the paragraph/hyperlink
                 newRunContainer.AddSpan(newSpan);              
 
-                // If the run container is an hyperlink, enclose it into a new paragraph
+                // If the run container is an hyperlink, enclose it into a new paragraph, 
+                // otherwise the run container is the container itself.
                 QuestPdfParagraph newParagraph;
                 if (newRunContainer is QuestPdfParagraph paragraph)
                 {
@@ -428,7 +447,47 @@ internal override void ProcessBreak(Break @break, QuestPdfModel output)
             }
             else if (@break.Type.HasValue && @break.Type.Value == BreakValues.Page)
             {
+                // Close and retrieve the current span, run container (paragraph/hyperlink) and paragraph
+                var oldSpan = currentSpan.Pop();
+                var oldRunContainer = currentRunContainer.Pop();
+                var oldParagraph = currentParagraph.Pop();
+
+                // Add a new QuestPdfPageBreak object
+                currentContainer.Peek().Content.Add(new QuestPdfPageBreak());
+
+                // The old span and paragraph were closed ahead of time to process the Break element.
+                // Create a new paragraph and span with the same properties to contain further elements. 
+
+                // Create a new run container and span
+                var newRunContainer = oldRunContainer.CloneEmpty();
+                var newSpan = oldSpan.CloneEmpty();
+
+                // Add span to the paragraph/hyperlink
+                newRunContainer.AddSpan(newSpan);              
+
+                // If the run container is an hyperlink, enclose it into a new paragraph, 
+                // otherwise the run container is the container itself.
+                QuestPdfParagraph newParagraph;
+                if (newRunContainer is QuestPdfParagraph paragraph)
+                {
+                    newParagraph = paragraph;
+                }
+                else
+                {
+                    newParagraph = (QuestPdfParagraph)(oldParagraph.CloneEmpty());
+                    if (newRunContainer is QuestPdfHyperlink hyperlink)
+                    {
+                        newParagraph.Elements.Add(hyperlink);                        
+                    }
+                }
 
+                // Set current span, run container and paragraph
+                currentParagraph.Push(newParagraph);
+                currentRunContainer.Push(newRunContainer);
+                currentSpan.Push(newSpan);
+
+                // Add paragraph to the current container (body, header, footer, table cell, ...)
+                currentContainer.Peek().Content.Add(newParagraph);   
             }
             else if (@break.Type.HasValue && @break.Type.Value == BreakValues.Column)
             {
@@ -479,6 +538,27 @@ internal override void ProcessSymbolChar(SymbolChar symbolChar, QuestPdfModel ou
         }
     }
 
+    internal override void ProcessPageNumber(PageNumber pageNumber, QuestPdfModel output)
+    {
+        if (currentRunContainer.Count > 0 && 
+            currentSpan.Count > 0) // PageNumber can only be present inside a Run, just like regular Text elements.
+        {
+            // Close and retrieve the current span
+            var oldSpan = currentSpan.Pop();
+
+            // Add a new QuestPdfPageNumber object to the current run container.
+            currentRunContainer.Peek().AddPageNumber();
+
+            // The old span was closed ahead of time to process the PageNumber element.
+            // Create a new span with the same properties to contain further text elements. 
+            // The new span will be closed by the ProcessRun method.
+            // If there are no remaining elements, the new span will be empty 
+            // and will be ignored during rendering.
+            var newSpan = oldSpan.CloneEmpty();
+            currentSpan.Push(newSpan);
+        }
+    }
+
     internal override void ProcessTable(Table table, QuestPdfModel output)
     {
         // Process table properties and create a new QuestPdfTable object
@@ -553,10 +633,6 @@ internal override void ProcessBookmarkEnd(BookmarkEnd bookmarkEnd, QuestPdfModel
     {
     }
 
-    internal override void ProcessPageNumber(PageNumber pageNumber, QuestPdfModel output)
-    {
-    }
-
     internal override void ProcessAnnotationReference(AnnotationReferenceMark annotationRef, QuestPdfModel output)
     {
     }

src/WIP/DocSharp.Renderer/Model/IQuestPdfRunContainer.cs

@@ -3,6 +3,7 @@ namespace DocSharp.Renderer;
 internal interface IQuestPdfRunContainer
 {
     void AddSpan(QuestPdfSpan span);   
+    void AddPageNumber();   
     internal IQuestPdfRunContainer CloneEmpty();
 }
 

src/WIP/DocSharp.Renderer/Model/QuestPdfHyperlink.cs

@@ -28,6 +28,11 @@ public void AddSpan(QuestPdfSpan span)
         Elements.Add(span);
     }
 
+    public void AddPageNumber()
+    {
+        Elements.Add(new QuestPdfPageNumber());    
+    }
+
     public IQuestPdfRunContainer CloneEmpty()
     {
         return new QuestPdfHyperlink(Url, Anchor);

src/WIP/DocSharp.Renderer/Model/QuestPdfModel.cs

@@ -132,6 +132,10 @@ internal void CreateColumn(ColumnDescriptor column, List<QuestPdfBlock> elements
                             // Why is LineHeight at the span level in QuestPDF rather than at the same level as ParagraphFirstLineIndentation?
                             text.Span(span.IsAllCaps ? span.Text.ToUpper() : span.Text).Style(span.Style).LineHeight(paragraph.LineHeight);   
                         }
+                        else if (inline is QuestPdfPageNumber pageNumber)
+                        {
+                            text.CurrentPageNumber();
+                        }
                         else if (inline is QuestPdfHyperlink hyperlink)
                         {
                             // Adding multiple formatted spans at once inside the link is not possible, so we add multiple spans with the same URL.
@@ -152,6 +156,7 @@ internal void CreateColumn(ColumnDescriptor column, List<QuestPdfBlock> elements
             }
             else if (element is QuestPdfTable table)
             {
+                // Start a new table
                 column.Item().Table(t =>
                 {
                     t.ColumnsDefinition(c =>
@@ -185,6 +190,11 @@ internal void CreateColumn(ColumnDescriptor column, List<QuestPdfBlock> elements
 
                 });
             }
+            else if (element is QuestPdfPageBreak)
+            {
+                // Force page break
+                column.Item().PageBreak();
+            }
         }
     }
 }

src/WIP/DocSharp.Renderer/Model/QuestPdfPageBreak.cs

@@ -0,0 +1,6 @@
+namespace DocSharp.Renderer;
+
+internal class QuestPdfPageBreak : QuestPdfBlock
+{
+    
+}

src/WIP/DocSharp.Renderer/Model/QuestPdfPageNumber.cs

@@ -0,0 +1,6 @@
+namespace DocSharp.Renderer;
+
+internal class QuestPdfPageNumber : QuestPdfInlineElement
+{
+    
+}

src/WIP/DocSharp.Renderer/Model/QuestPdfParagraph.cs

@@ -47,6 +47,11 @@ public void AddSpan(QuestPdfSpan span)
         Elements.Add(span);
     }
 
+    public void AddPageNumber()
+    {
+        Elements.Add(new QuestPdfPageNumber());        
+    }
+
     public IQuestPdfRunContainer CloneEmpty()
     {
         return new QuestPdfParagraph(Alignment, LineHeight, SpaceBefore, SpaceAfter, LeftIndent, RightIndent, StartIndent, EndIndent, FirstLineIndent, BackgroundColor, KeepTogether);