Merge branch 'main' into element-proxy

# Conflicts:
#	QuestPDF/Drawing/PdfCanvas.cs
#	QuestPDF/QuestPDF.csproj

QuestPDF.Examples/ChartExamples.cs

@@ -0,0 +1,62 @@
+using NUnit.Framework;
+using QuestPDF.Examples.Engine;
+using QuestPDF.Fluent;
+using QuestPDF.Helpers;
+using QuestPDF.Infrastructure;
+using Microcharts;
+using SkiaSharp;
+
+namespace QuestPDF.Examples
+{    
+    public class ChartExample
+    {
+        [Test]
+        public void MicrochartChart()
+        {
+            var entries = new[]
+            {
+                new ChartEntry(212)
+                {
+                    Label = "UWP",
+                    ValueLabel = "112",
+                    Color = SKColor.Parse("#2c3e50")
+                },
+                new ChartEntry(248)
+                {
+                    Label = "Android",
+                    ValueLabel = "648",
+                    Color = SKColor.Parse("#77d065")
+                },
+                new ChartEntry(128)
+                {
+                    Label = "iOS",
+                    ValueLabel = "428",
+                    Color = SKColor.Parse("#b455b6")
+                },
+                new ChartEntry(514)
+                {
+                    Label = "Forms",
+                    ValueLabel = "214",
+                    Color = SKColor.Parse("#3498db")
+                }
+            };
+
+            RenderingTest
+                .Create()
+                .PageSize(300, 300)
+                .ShowResults()
+                .Render(container =>
+                {
+                    container.Extend().Canvas((canvas, size) => 
+                    {
+                        var bar = new BarChart
+                        {
+                            Entries = entries,
+                            IsAnimated = false,
+                        };
+                        bar.Draw(canvas, (int)size.Width, (int)size.Height);
+                    });
+                });
+        }
+    }
+}

QuestPDF.Examples/InlinedExamples.cs

@@ -87,23 +87,24 @@ namespace QuestPDF.Examples
         {
             RenderingTest
                 .Create()
-                .PageSize(400, 250)
+                .PageSize(800, 600)
                 .ProduceImages()
                 .ShowResults()
                 .Render(container =>
                 {
                     container
                         .Padding(20)
+                        .Box()
                         .Border(1)
-                        .Background(Colors.Grey.Lighten3)
+                        .Background(Colors.Grey.Lighten4)
                         .Inlined(inlined =>
                         {
                             inlined.VerticalSpacing(50);
-                            inlined.HorizontalSpacing(20);
-                            inlined.AlignSpaceAround();
-                            inlined.BaselineTop();
+                            inlined.HorizontalSpacing(25);
+                            inlined.AlignRight();
+                            inlined.BaselineMiddle();
 
-                            foreach (var _ in Enumerable.Range(0, 20))
+                            foreach (var _ in Enumerable.Range(0, 100))
                                 inlined.Item().Element(RandomBlock);
                         });
                 });

QuestPDF.Examples/QuestPDF.Examples.csproj

@@ -6,6 +6,7 @@
     </PropertyGroup>
 
     <ItemGroup>
+        <PackageReference Include="microcharts" Version="0.9.5.9" />
         <PackageReference Include="nunit" Version="3.13.2" />
         <PackageReference Include="NUnit3TestAdapter" Version="4.0.0" />
         <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.4.0" />

QuestPDF/Drawing/DocumentGenerator.cs

@@ -20,6 +20,13 @@ namespace QuestPDF.Drawing
             RenderDocument(canvas, document);
         }
         
+        internal static void GenerateXps(Stream stream, IDocument document)
+        {
+            var metadata = document.GetMetadata();
+            var canvas = new XpsCanvas(stream, metadata);
+            RenderDocument(canvas, document);
+        }
+        
         internal static ICollection<byte[]> GenerateImages(IDocument document)
         {
             var metadata = document.GetMetadata();

QuestPDF/Drawing/PdfCanvas.cs

@@ -4,43 +4,13 @@ using SkiaSharp;
 
 namespace QuestPDF.Drawing
 {
-    internal class PdfCanvas : SkiaCanvasBase
+    internal class PdfCanvas : SkiaDocumentCanvasBase
     {
-        private SKDocument Document { get; }
-
-        public PdfCanvas(Stream stream, DocumentMetadata documentMetadata)
-        {
-            Document = SKDocument.CreatePdf(stream, MapMetadata(documentMetadata));
-        }
-
-        ~PdfCanvas()
-        {
-            Document.Dispose();
-        }
-        
-        public override void BeginDocument()
+        public PdfCanvas(Stream stream, DocumentMetadata documentMetadata) 
+            : base(SKDocument.CreatePdf(stream, MapMetadata(documentMetadata)))
         {
             
         }
-
-        public override void EndDocument()
-        {
-            Canvas?.Dispose();
-            
-            Document?.Close();
-            Document?.Dispose();
-        }
-
-        public override void BeginPage(Size size)
-        {
-            Canvas = Document.BeginPage(size.Width, size.Height);
-        }
-
-        public override void EndPage()
-        {
-            Document.EndPage();
-            Canvas.Dispose();
-        }
         
         private static SKDocumentPdfMetadata MapMetadata(DocumentMetadata metadata)
         {

QuestPDF/Drawing/SkiaDocumentCanvasBase.cs

@@ -0,0 +1,45 @@
+using System.IO;
+using QuestPDF.Infrastructure;
+using SkiaSharp;
+
+namespace QuestPDF.Drawing
+{
+    internal class SkiaDocumentCanvasBase : SkiaCanvasBase
+    {
+        private SKDocument Document { get; }
+
+        public SkiaDocumentCanvasBase(SKDocument document)
+        {
+            Document = document;
+        }
+
+        ~SkiaDocumentCanvasBase()
+        {
+            Document.Dispose();
+        }
+        
+        public override void BeginDocument()
+        {
+            
+        }
+
+        public override void EndDocument()
+        {
+            Canvas.Dispose();
+            
+            Document.Close();
+            Document.Dispose();
+        }
+
+        public override void BeginPage(Size size)
+        {
+            Canvas = Document.BeginPage(size.Width, size.Height);
+        }
+
+        public override void EndPage()
+        {
+            Document.EndPage();
+            Canvas.Dispose();
+        }
+    }
+}

QuestPDF/Drawing/XpsCanvas.cs

@@ -0,0 +1,15 @@
+using System.IO;
+using QuestPDF.Infrastructure;
+using SkiaSharp;
+
+namespace QuestPDF.Drawing
+{
+    internal class XpsCanvas : SkiaDocumentCanvasBase
+    {
+        public XpsCanvas(Stream stream, DocumentMetadata documentMetadata) 
+            : base(SKDocument.CreateXps(stream, documentMetadata.RasterDpi))
+        {
+            
+        }
+    }
+}

QuestPDF/Elements/Inlined.cs

@@ -64,8 +64,9 @@ namespace QuestPDF.Elements
                 .Select(line =>
                 {
                     var size = GetLineSize(line);
-                    var heightWithSpacing = size.Height + (line.Count - 1) * HorizontalSpacing;
-                    return new Size(size.Width, heightWithSpacing);
+
+                    var widthWithSpacing = size.Width + (line.Count - 1) * HorizontalSpacing;
+                    return new Size(widthWithSpacing, size.Height);
                 })
                 .ToList();
             

QuestPDF/Fluent/GenerateExtensions.cs

@@ -8,6 +8,8 @@ namespace QuestPDF.Fluent
 {
     public static class GenerateExtensions
     {
+        #region PDF
+        
         public static byte[] GeneratePdf(this IDocument document)
         {
             using var stream = new MemoryStream();
@@ -26,6 +28,32 @@ namespace QuestPDF.Fluent
             DocumentGenerator.GeneratePdf(stream, document);
         }
         
+        #endregion
+        
+        public static byte[] GenerateXps(this IDocument document)
+        {
+            using var stream = new MemoryStream();
+            document.GenerateXps(stream);
+            return stream.ToArray();
+        }
+        
+        public static void GenerateXps(this IDocument document, string filePath)
+        {
+            using var stream = new FileStream(filePath, FileMode.Create);
+            document.GenerateXps(stream);
+        }
+
+        public static void GenerateXps(this IDocument document, Stream stream)
+        {
+            DocumentGenerator.GenerateXps(stream, document);
+        }
+        
+        #region XPS
+        
+        #endregion
+
+        #region Images
+
         public static IEnumerable<byte[]> GenerateImages(this IDocument document)
         {
             return DocumentGenerator.GenerateImages(document);
@@ -47,5 +75,7 @@ namespace QuestPDF.Fluent
                 index++;
             }
         }
+
+        #endregion
     }
 }

QuestPDF/QuestPDF.csproj

@@ -4,9 +4,9 @@
         <Authors>MarcinZiabek</Authors>
         <Company>CodeFlint</Company>
         <PackageId>QuestPDF</PackageId>
-        <Version>2021.11.0</Version>
+        <Version>2021.12.0-alpha0</Version>
         <PackageDescription>QuestPDF is an open-source, modern and battle-tested library that can help you with generating PDF documents by offering friendly, discoverable and predictable C# fluent API.</PackageDescription>
-        <PackageReleaseNotes>Implemented new elements: SkipOnce and Inlined. Added possibility to define global, page-wide test style. Improved exception handling experience.</PackageReleaseNotes>
+        <PackageReleaseNotes>$([System.IO.File]::ReadAllText("$(MSBuildProjectDirectory)/Resources/ReleaseNotes.txt"))</PackageReleaseNotes>
         <LangVersion>8</LangVersion>
         <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
         <PackageIcon>Logo.png</PackageIcon>

QuestPDF/Resources/Description.md

@@ -1,27 +1,221 @@
-## Rely on solid fundamentals
+## QuestPDF Overview
 
-This library is created specifically for designing and arranging document layouts, with full paging support.  Alternative solutions, such as HTML-based converters, are not designed for this purpose and therefore are often unpredictable and do not produce desired results.
+QuestPDF is an open-source, modern and battle-tested library that can help you with generating PDF documents by offering friendly, discoverable and predictable C# fluent API.
 
-## Work with organized self-explanatory code
+## Features
 
-The entire process of implementing PDF document, takes place in your code. Free yourself from slow visual designers and strange technological limitations. Follow simple yet highly effective approaches to create maintainable, high-quality code.
+**Rely on solid fundamentals** - This library is created specifically for designing and arranging document layouts, with full paging support.  Alternative solutions, such as HTML-based converters, are not designed for this purpose and therefore are often unpredictable and do not produce desired results.
 
-## Compose simple components into complex documents
+**Work with organized self-explanatory code** - The entire process of implementing PDF document, takes place in your code. Free yourself from slow visual designers and strange technological limitations. Follow simple yet highly effective approaches to create maintainable, high-quality code.
 
-Do you remember the feeling when your code just works? When your ideas are becoming real without any effort? Working with simple, easy to understand, self-explanatory and highly composable layout elements is the key here!
+**Compose simple components into complex documents** - Do you remember the feeling when your code just works? When your ideas are becoming real without any effort? Working with simple, easy to understand, self-explanatory and highly composable layout elements is the key here!
 
-## Create and reuse components
+**Create and reuse components** - Feel no fear of complex documents! Create custom, reusable components and divide the document's layout into easy to maintain pieces. Inject data to customize content and use slots to enhance composability. Decide how complex approaches your solution needs and follow the best path.
 
-Feel no fear of complex documents! Create custom, reusable components and divide the document's layout into easy to maintain pieces. Inject data to customize content and use slots to enhance composability. Decide how complex approaches your solution needs and follow the best path.
+**Prototype with ease** - We understand that document generation is often tricky and require multiple iterations. The library offers additional prototyping tools such as random text generator or image placeholder element. By following best practices, you can develop a document without having data.
 
-## Prototype with ease
+**Enjoy fast PDF generation** - QuestPDF is created upon SkiaSharp, a well-known graphical library, and converts your data into PDF documents. It offers a highly optimized layouting engine capable of generating over 1000 PDF files per minute per core. The entire process is thread-safe.
 
-We understand that document generation is often tricky and require multiple iterations. The library offers additional prototyping tools such as random text generator or image placeholder element. By following best practices, you can develop a document without having data.
+## Learning resources
 
-## Enjoy fast PDF generation
+**[Release notes and roadmap](https://www.questpdf.com/documentation/releases.html)** - everything that is planned for future library iterations, description of new features and information about potential breaking changes.
 
-QuestPDF is created upon SkiaSharp, a well-known graphical library, and converts your data into PDF documents. It offers a highly optimized layouting engine capable of generating over 1000 PDF files per minute per core. The entire process is thread-safe.
+**[Getting started tutorial](https://www.questpdf.com/documentation/getting-started.html)** - a short and easy to follow tutorial showing how to design an invoice document under 200 lines of code.
 
-## Write less, achieve more
+**[API Reference](https://www.questpdf.com/documentation/api-reference.html)** - a detailed description of behavior of all available components and how to use them with C# Fluent API.
 
-Do you believe that creating a complete invoice document can take less than 200 lines of code? We have prepared for you a step-by-step instruction that shows every detail of this implementation and describes the best patterns and practices. [Learn more](https://www.questpdf.com/documentation/getting-started.html)
+**[Patterns and practices](https://www.questpdf.com/documentation/patterns-and-practices.html#document-metadata)** - everything that may help you designing great reports and reusable code that is easy to maintain.
+
+## Example invoice
+
+Do you believe that creating a complete invoice document can take less than 200 lines of code? We have prepared for you a step-by-step instruction that shows every detail of this implementation and describes the best patterns and practices.
+
+For tutorial, documentation and API reference, please visit [the QuestPDF documentation](https://www.questpdf.com/documentation/getting-started.html).
+
+![invoice](https://raw.githubusercontent.com/QuestPDF/example-invoice/main/images/invoice.png)
+
+Here you can find an example code showing how easy is to write and understand the fluent API.
+
+
+**General document structure** with header, content and footer:
+
+```csharp
+public void Compose(IDocumentContainer container)
+{
+    container
+        .Page(page =>
+        {
+            page.Margin(50);
+            
+            page.Header().Element(ComposeHeader);
+            page.Content().Element(ComposeContent);
+            
+            page.Footer().AlignCenter().Text(x =>
+            {
+                x.CurrentPageNumber();
+                x.Span(" / ");
+                x.TotalPages();
+            });
+        });
+}
+```
+
+
+**The header area** consists of basic invoice information along with a logo placeholder.
+
+```csharp
+void ComposeHeader(IContainer container)
+{
+    var titleTextStyle = TextStyle.Default.Size(20).SemiBold().Color(Colors.Blue.Medium);
+    
+    container.Row(row =>
+    {
+        {
+            stack.Item().Text($"Invoice #{Model.InvoiceNumber}", titleStyle);
+
+            stack.Item().Text(text =>
+            {
+                text.Span("Issue date: ", TextStyle.Default.SemiBold());
+                text.Span($"{Model.IssueDate:d}");
+            });
+
+            stack.Item().Text(text =>
+            {
+                text.Span("Due date: ", TextStyle.Default.SemiBold());
+                text.Span($"{Model.DueDate:d}");
+            });
+        });
+        
+        row.ConstantColumn(100).Height(50).Placeholder();
+    });
+}
+```
+
+
+Implementation of **the content area** that contains seller and customer details, then listing of all bought products, then a comments section.
+
+```csharp
+void ComposeContent(IContainer container)
+{
+    container.PaddingVertical(40).Stack(column => 
+    {
+        column.Spacing(20);
+        
+        column.Item().Row(row =>
+        {
+            row.RelativeColumn().Component(new AddressComponent("From", Model.SellerAddress));
+            row.ConstantColumn(50);
+            row.RelativeColumn().Component(new AddressComponent("For", Model.CustomerAddress));
+        });
+
+        column.Item().Element(ComposeTable);
+
+        var totalPrice = Model.Items.Sum(x => x.Price * x.Quantity);
+        
+        column
+            .Item()
+            .PaddingRight(5)
+            .AlignRight()
+            .Text($"Grand total: {totalPrice}$", TextStyle.Default.SemiBold());
+
+        if (!string.IsNullOrWhiteSpace(Model.Comments))
+            column.Item().PaddingTop(25).Element(ComposeComments);
+    });
+}
+```
+
+
+**The table and comments** codes are extracted into separate methods to increase clarity:
+
+```csharp
+void ComposeTable(IContainer container)
+{
+    var headerStyle = TextStyle.Default.SemiBold();
+    
+    container.Decoration(decoration =>
+    {
+        // header
+        decoration.Header().BorderBottom(1).Padding(5).Row(row => 
+        {
+            row.ConstantColumn(25).Text("#", headerStyle);
+            row.RelativeColumn(3).Text("Product", headerStyle);
+            row.RelativeColumn().AlignRight().Text("Unit price", headerStyle);
+            row.RelativeColumn().AlignRight().Text("Quantity", headerStyle);
+            row.RelativeColumn().AlignRight().Text("Total", headerStyle);
+        });
+
+        // content
+        decoration
+            .Content()
+            .Stack(column =>
+            {
+                foreach (var item in Model.Items)
+                {
+                    column
+                    .Item()
+                    .ShowEntire()
+                    .BorderBottom(1)
+                    .BorderColor(Colors.Grey.Lighten2)
+                    .Padding(5)
+                    .Row(row => 
+                    {
+                        row.ConstantColumn(25).Text(Model.Items.IndexOf(item) + 1);
+                        row.RelativeColumn(3).Text(item.Name);
+                        row.RelativeColumn().AlignRight().Text($"{item.Price}$");
+                        row.RelativeColumn().AlignRight().Text(item.Quantity);
+                        row.RelativeColumn().AlignRight().Text($"{item.Price * item.Quantity}$");
+                    });
+                }
+            });
+    });
+}
+```
+
+```csharp
+void ComposeComments(IContainer container)
+{
+    container.ShowEntire().Background(Colors.Grey.Lighten3).Padding(10).Stack(message => 
+    {
+        message.Spacing(5);
+        message.Item().Text("Comments", TextStyle.Default.Size(14).SemiBold());
+        message.Item().Text(Model.Comments);
+    });
+}
+```
+
+
+**The address details section** is implemented using components. This way the code can be easily reused for both seller and customer:
+
+```csharp
+public class AddressComponent : IComponent
+{
+    private string Title { get; }
+    private Address Address { get; }
+
+    public AddressComponent(string title, Address address)
+    {
+        Title = title;
+        Address = address;
+    }
+    
+    public void Compose(IContainer container)
+    {
+        container.ShowEntire().Stack(column =>
+        {
+            column.Spacing(5);
+
+            column
+                .Item()
+                .BorderBottom(1)
+                .PaddingBottom(5)
+                .Text(Title, TextStyle.Default.SemiBold());
+            
+            column.Item().Text(Address.CompanyName);
+            column.Item().Text(Address.Street);
+            column.Item().Text($"{Address.City}, {Address.State}");
+            column.Item().Text(Address.Email);
+            column.Item().Text(Address.Phone);
+        });
+    }
+}
+```

QuestPDF/Resources/ReleaseNotes.txt

@@ -0,0 +1 @@
+- Added support for generating documents in the XPS file format.