Update documentation, README.md, README.txt, nuspec 1.0.5 file and sa…

…mple projects files

CHANGELOG.md

@@ -6,16 +6,22 @@ All notable changes to this project will be documented in this file.
 
 ### Added
 
- 1. The functionality of being able to create an instance of the **PdfInput** class from **HTML** code has been added.
+ 1. Add support for asynchronous calls in solution projects.
+
+ 2. Added support for using Span<T> for supported platforms.
+
+ 3. Test projects to show asynchronous usage.
+
+ 4. The functionality of being able to create an instance of the **PdfInput** class from **HTML** code has been added.
     For more information, please see the **sample15** in [README.md] file
 
- 2. A functionality has been added that allows to add or modify the metadata information of a **pdf** file.
+ 5. A functionality has been added that allows to add or modify the metadata information of a **pdf** file.
     For more information, please see the **sample16** in [README.md] file
 
- 3. A functionality has been added that allows to add a **password** to **pdf** file.
+ 6. A functionality has been added that allows to add a **password** to **pdf** file.
     For more information, please see the **sample17** in [README.md] file
 
- 4. A functionality has been added that allows to insert an **image** into a **pdf** file.
+ 7. A functionality has been added that allows to insert an **image** into a **pdf** file.
     For more information, please see the **sample18** in [README.md] file
 
 ### Changed
@@ -33,14 +39,15 @@ All notable changes to this project will be documented in this file.
     | iTin.Core.Hardware.Windows.Devices.Graphics.Font | **1.0.0.1** | Windows Hardware Infrastructure |
     | iTin.Core.Interop.Shared | **1.0.0.4** | Generic Shared Interop Definitions |
     | iTin.Core.Interop.Windows.Devices | **1.0.0.1** | Win32 Generic Interop Calls |
-	| iTin.Core.IO | 1.0.0.2 | Common I/O calls |
-	| iTin.Core.IO.Compression | 1.0.0.1 | Compression library |
+	| iTin.Core.IO | **1.0.0.3** | Common I/O calls |
+	| iTin.Core.IO.Compression | **1.0.0.3** | Compression library |
 	| iTin.Core.Models | **1.0.0.3** | Data models base |
 	| iTin.Core.Models.Design.Charting | **1.0.0.3** | Base charting models |
 	| iTin.Core.Models.Design.Styling | **1.0.0.3** | Base styling models |
-	| iTin.Logging | **1.0.0.2** | Logging library |
     | iTin.Hardware.Abstractions.Devices.Graphics.Font | **1.0.0.1** | Generic Common Hardware Abstractions |
+	| iTin.Logging | **1.0.0.2** | Logging library |
 	| iTin.Registry.Windows | **1.0.0.3** | Windows registry access |
+	| **iTin.Utilities.Abstractions.Writer** | **1.0.0.0** | **Generic Common Writer's Abstractions** |
 	| iTin.Utilities.Pdf.Design | **1.0.0.5** | Pdf design objects |
 	| iTin.Utilities.Pdf.Writer | **1.0.0.4** | Pdf Writer |
 

README.md

@@ -114,36 +114,55 @@ Basic steps, for more details please see [sample01.cs] file.
 4. Replace **#BAR-CHART#** tag with an image
 
     ```csharp   
-    using (var barGraph = PdfImage.FromFile("~/Resources/Sample-01/Images/bar-chart.png"))
-    {
-        doc.Replace(new ReplaceText(
-            new WithImageObject
-            {
-                Text = "#BAR-CHART#",
-                Style = ImagesStylesTable["Default"],
-                ReplaceOptions = ReplaceTextOptions.Default,
-                Image = barGraph
-            }));
-    }
+    doc.Replace(new ReplaceText(
+        new WithImageObject
+        {
+            Text = "#BAR-CHART#",
+            UseTestMode = useTestMode,
+            Offset = PointF.Empty,
+            Style = StylesHelper.Sample01.ImagesStylesTable["Default"],
+            ReplaceOptions = ReplaceTextOptions.Default,
+            Image = PdfImage.FromFile("~Resources/Sample-01/Images/bar-chart.png")
+        }));
     ```
 5. Try to create pdf output result
 
+     **sync mode**
      ```csharp   
      var result = doc.CreateResult();
      if (!result.Success)
      {
          // Handle errors                 
      }
      ```
+
+     **async mode**
+     ```csharp   
+     var result = await doc.CreateResultAsync();
+     if (!result.Success)
+     {
+         // Handle errors                 
+     }
+     ```
 6. Save pdf file result
 
+    **sync mode**
     ```csharp   
     var saveResult = result.Result.Action(new SaveToFile { OutputPath = "~/Output/Sample01/Sample-01" });
     if (!saveResult.Success)
     {
          // Handle errors                 
     }
      ```
+
+    **async mode**
+    ```csharp   
+    var saveResult = await result.Result.Action(new SaveToFileAsync { OutputPath = "~/Output/Sample01/Sample-01" });
+    if (!saveResult.Success)
+    {
+         // Handle errors                 
+    }
+     ```
 7. Output
 
    ###### Below is an image showing the original pdf file and the result after applying the replacements described above
@@ -316,13 +335,24 @@ Basic steps, for more details please see [sample03.cs] file.
     ```
 4. Try to merge into a pdf output result
 
-     ```csharp   
+     **sync mode**
+    ```csharp   
      var mergeResult = files.TryMergeInputs();
      if (!mergeResult.Success)
      {
          // Handle errors                 
      }
      ```
+
+     **async mode**
+    ```csharp   
+     var mergeResult = await files.TryMergeInputsAsync();
+     if (!mergeResult.Success)
+     {
+         // Handle errors                 
+     }
+     ```
+
 5. Save merged result to file
 
     ```csharp   
@@ -699,7 +729,6 @@ Basic steps, for more details please see [sample06.cs] file.
 3. Replace Tags
 
     **Page 1**
-
     ```csharp   
     page1.Replace(new ReplaceText(
         new WithTextObject
@@ -713,21 +742,20 @@ Basic steps, for more details please see [sample06.cs] file.
     ```
 
     ```csharp   
-    using (var barGraph = PdfImage.FromFile("~/Resources/Sample-06/Images/bar-chart.png"))
-    {
-        page1.Replace(new ReplaceText(
-            new WithImageObject
-            {
-                Text = "#BAR-CHART#",
-                UseTestMode = YesNo.Yes,
-                Style = ImagesStylesTable["Default"],
-                ReplaceOptions = ReplaceTextOptions.Default,
-                Image = barGraph
-            }));
-    }
+    // Inserts bar-chart image
+    page1.Replace(new ReplaceText(
+        new WithImageObject
+        {
+            Text = "#BAR-CHART#",
+            UseTestMode = useTestMode,
+            Offset = PointF.Empty,
+            Style = PdfImageStyle.Default,
+            ReplaceOptions = ReplaceTextOptions.Default,
+            Image = PdfImage.FromFile("~Resources/Sample-01/Images/bar-chart.png")
+        }));
     ```
-    **Page 2**
 
+    **Page 2**
     ```csharp   
     page2.Replace(new ReplaceText(
         new WithTableObject
@@ -741,25 +769,20 @@ Basic steps, for more details please see [sample06.cs] file.
         }));
     ```
     **Page 3**
-
     Nothing to do
 
     **Page 4**
-
     ```csharp   
-    using (var image = PdfImage.FromFile("~/Resources/Sample-06/Images/image-1.jpg"))
-    {
-        page4.Replace(new ReplaceText(
-            new WithImageObject
-            {
-                Text = "#IMAGE1#",
-                UseTestMode = YesNo.Yes,
-                Offset = PointF.Empty,
-                Style = PdfImageStyle.Default,
-                ReplaceOptions = ReplaceTextOptions.AccordingToMargins,
-                Image = image
-            }));
-    }
+    page4.Replace(new ReplaceText(
+        new WithImageObject
+        {
+            Text = "#IMAGE1#",
+            UseTestMode = useTestMode,
+            Offset = PointF.Empty,
+            Style = PdfImageStyle.Center,
+            ReplaceOptions = ReplaceTextOptions.AccordingToMargins,
+            Image = PdfImage.FromFile("~/Resources/Sample-01/Images/image-1.jpg")
+        }));
     ```
 4. Create a special object **GlobalReplacementsCollection**
 
@@ -951,7 +974,6 @@ Basic steps, for more details please see [sample06.cs] file.
 1. Create styles
 
     **PdfImageStyle**
-
     ```csharp   
     var imageStyle = new PdfImageStyle
     {
@@ -976,8 +998,8 @@ Basic steps, for more details please see [sample06.cs] file.
         }
     };
     ```
-    **PdfTextStyle**
 
+    **PdfTextStyle**
     ```csharp   
     var textStyle = new PdfTextStyle
     {
@@ -1010,8 +1032,8 @@ Basic steps, for more details please see [sample06.cs] file.
         }
     };
     ```
-    **PdfTableStyle**
 
+    **PdfTableStyle**
     ```csharp   
     var tableStyle = new PdfTableStyle
     {
@@ -1037,6 +1059,7 @@ Basic steps, for more details please see [sample06.cs] file.
         }
     };
     ```
+
 2. Try to save styles
 
     **PdfImageStyle**

README.txt

@@ -9,17 +9,23 @@ Changes in this version (v1.0.5)
 
 · Added
   -----
-      - The functionality of being able to create an instance of the PdfInput class from HTML code has been added.
-        For more information, please see sample25.cs
+    - Add support for asynchronous calls in solution projects.
 
-      - A functionality has been added that allows to add or modify the metadata information of a pdf file.
-        For more information, please see please see sample26.cs
+    - Added support for using Span<T> for supported platforms.
 
-      - A functionality has been added that allows to add a password to pdf file.
-        For more information, please see please see sample27.cs
+    - Test projects to show asynchronous usage.
+
+    - The functionality of being able to create an instance of the PdfInput class from HTML code has been added.
+      For more information, please see sample25.cs
+
+    - A functionality has been added that allows to add or modify the metadata information of a pdf file.
+      For more information, please see please see sample26.cs
+
+    - A functionality has been added that allows to add a password to pdf file.
+      For more information, please see please see sample27.cs
 
-      - A functionality has been added that allows to insert an image into a pdf file.
-        For more information, please see please see sample28.cs
+    - A functionality has been added that allows to insert an image into a pdf file
+      For more information, please see please see sample28.cs
 
 · Changed
   -------
@@ -45,9 +51,9 @@ Changes in this version (v1.0.5)
     •———————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————•
     | iTin.Core.Interop.Windows.Devices                 1.0.0.1   Win32 Generic Interop Calls                                           |
     •———————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————•
-    | iTin.Core.IO                                      1.0.0.2   Common I/O calls                                                      |
+    | iTin.Core.IO                                      1.0.0.3   Common I/O calls                                                      |
     •———————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————•
-    | iTin.Core.IO.Compression                          1.0.0.1   Compression library                                                   |
+    | iTin.Core.IO.Compression                          1.0.0.3   Compression library                                                   |
     •———————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————•
     | iTin.Core.Models                                  1.0.0.3   Data models base                                                      |
     •———————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————•
@@ -61,6 +67,8 @@ Changes in this version (v1.0.5)
     •———————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————•
     | iTin.Registry.Windows                             1.0.0.3   Windows registry acces                                                |
     •———————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————•
+    | iTin.Utilities.Abstractions.Writer                1.0.0.0   Generic Common Writer's Abstractions                                  |
+    •———————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————•
     | iTin.Utilities.Pdf.Design                         1.0.0.5   Pdf design elements                                                   |
     •———————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————•
     | iTin.Utilities.Pdf.Writer                         1.0.0.4   Pdf writer                                                            |

documentation/iTin.Utilities.Abstractions.Writer.Config/IOutputResultConfig.md

@@ -0,0 +1,20 @@
+# IOutputResultConfig interface
+
+Represents configuration information for an object.
+
+```csharp
+public interface IOutputResultConfig
+```
+
+## Members
+
+| name | description |
+| --- | --- |
+| [Filename](IOutputResultConfig/Filename.md) { get; set; } | Gets or sets a value thats represents filename if is marked as zipped |
+| [Zipped](IOutputResultConfig/Zipped.md) { get; set; } | Gets or sets a value indicating whether compression is allowed. |
+
+## See Also
+
+* namespace [iTin.Utilities.Abstractions.Writer.Config](../iTin.Utilities.Abstractions.Writer.md)
+
+<!-- DO NOT EDIT: generated by xmldocmd for iTin.Utilities.Abstractions.Writer.dll -->

documentation/iTin.Utilities.Abstractions.Writer.Config/IOutputResultConfig/Filename.md

@@ -0,0 +1,18 @@
+# IOutputResultConfig.Filename property
+
+Gets or sets a value thats represents filename if is marked as zipped
+
+```csharp
+public string Filename { get; set; }
+```
+
+## Property Value
+
+Represents filename.
+
+## See Also
+
+* interface [IOutputResultConfig](../IOutputResultConfig.md)
+* namespace [iTin.Utilities.Abstractions.Writer.Config](../../iTin.Utilities.Abstractions.Writer.md)
+
+<!-- DO NOT EDIT: generated by xmldocmd for iTin.Utilities.Abstractions.Writer.dll -->

documentation/iTin.Utilities.Abstractions.Writer.Config/IOutputResultConfig/Zipped.md

@@ -0,0 +1,18 @@
+# IOutputResultConfig.Zipped property
+
+Gets or sets a value indicating whether compression is allowed.
+
+```csharp
+public bool Zipped { get; set; }
+```
+
+## Property Value
+
+true if compression is allowed; otherwise, false.
+
+## See Also
+
+* interface [IOutputResultConfig](../IOutputResultConfig.md)
+* namespace [iTin.Utilities.Abstractions.Writer.Config](../../iTin.Utilities.Abstractions.Writer.md)
+
+<!-- DO NOT EDIT: generated by xmldocmd for iTin.Utilities.Abstractions.Writer.dll -->

documentation/iTin.Utilities.Abstractions.Writer.Config/IWriterConfig.md

@@ -0,0 +1,13 @@
+# IWriterConfig interface
+
+Represents
+
+```csharp
+public interface IWriterConfig
+```
+
+## See Also
+
+* namespace [iTin.Utilities.Abstractions.Writer.Config](../iTin.Utilities.Abstractions.Writer.md)
+
+<!-- DO NOT EDIT: generated by xmldocmd for iTin.Utilities.Abstractions.Writer.dll -->

documentation/iTin.Utilities.Pdf.Writer.ComponentModel/IInput.md → documentation/iTin.Utilities.Abstractions.Writer.Input/IInput.md

@@ -15,14 +15,15 @@ public interface IInput
 | [Index](IInput/Index.md) { get; set; } | Gets or sets a value that contains input index. |
 | [Input](IInput/Input.md) { get; set; } | Gets or sets the input object. |
 | [InputType](IInput/InputType.md) { get; } | Gets input type. |
-| [CreateResult](IInput/CreateResult.md)(…) | Returns a new reference [`OutputResult`](../iTin.Utilities.Pdf.Writer.ComponentModel.Result.Output/OutputResult.md) that complies with what is indicated in its configuration object. By default, an [`IInput`](IInput.md) will not be zipped. |
-| [Insert](IInput/Insert.md)(…) | Try to insert an element in a input. |
-| [Replace](IInput/Replace.md)(…) | Try to replace an element in a input. |
+| [CreateResult](IInput/CreateResult.md)(…) | Returns a new reference [`OutputResult`](../iTin.Utilities.Abstractions.Writer.Operations.Results/OutputResult.md) that complies with what is indicated in its configuration object. By default, an [`IInput`](./IInput.md) will not be zipped. |
+| [CreateResultAsync](IInput/CreateResultAsync.md)(…) | Returns a new reference [`OutputResult`](../iTin.Utilities.Abstractions.Writer.Operations.Results/OutputResult.md) that complies with what is indicated in its configuration object. By default, this input will not be zipped. |
 | [SaveToFile](IInput/SaveToFile.md)(…) | Saves this input into a file. |
+| [SaveToFileAsync](IInput/SaveToFileAsync.md)(…) | Saves this input into a file asynchronously. |
 | [ToStream](IInput/ToStream.md)() | Convert this input into a stream object. |
+| [ToStreamAsync](IInput/ToStreamAsync.md)(…) | Convert this input into a stream object asynchronously. |
 
 ## See Also
 
-* namespace [iTin.Utilities.Pdf.Writer.ComponentModel](../iTin.Utilities.Pdf.Writer.md)
+* namespace [iTin.Utilities.Abstractions.Writer.Input](../iTin.Utilities.Abstractions.Writer.md)
 
-<!-- DO NOT EDIT: generated by xmldocmd for iTin.Utilities.Pdf.Writer.dll -->
+<!-- DO NOT EDIT: generated by xmldocmd for iTin.Utilities.Abstractions.Writer.dll -->