Implement IsHidden property

y0ung3r · Apr 26, 2024 · 6815565 · 6815565
1 parent 7442028
commit 6815565
Show file tree

Hide file tree

Showing 6 changed files with 88 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -49,7 +49,6 @@ Implementation Dashboard
         - [ ] Borders
         - [ ] Background Color
         - [ ] Shading
-        - [ ] Outline
         - [ ] Styles
         - [x] Keep lines
         - [x] Keep next
@@ -76,7 +75,7 @@ Implementation Dashboard
           - [x] Bold
           - [ ] Outline
           - [x] Strikethrough
-          - [ ] Hidden
+          - [x] Hidden
           - [ ] Background color
           - [ ] Text color
           - [ ] Borders

diff --git a/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Text/RunFormat.cs b/src/Word/OfficeFlow.Word.Core/Elements/Paragraphs/Text/RunFormat.cs
@@ -6,18 +6,16 @@ namespace OfficeFlow.Word.Core.Elements.Paragraphs.Text;
 public sealed class RunFormat : IVisitable
 {
     public static RunFormat Default
-        => new()
-        {
-            IsItalic = false,
-            IsBold = false,
-            StrikethroughType = StrikethroughType.None
-        };
+        => new();
 
     public bool IsItalic { get; set; }
 
     public bool IsBold { get; set; }
+
+    public bool IsHidden { get; set; }
 
     public StrikethroughType StrikethroughType { get; set; }
+        = StrikethroughType.None;
 
     /// <inheritdoc />
     public void Accept(IWordVisitor visitor)

diff --git a/src/Word/OfficeFlow.Word.OpenXml.Tests/OpenXmlElementReaderTests/RunFormatTests.cs b/src/Word/OfficeFlow.Word.OpenXml.Tests/OpenXmlElementReaderTests/RunFormatTests.cs
@@ -48,6 +48,26 @@ public void Should_read_bold_properly()
             .BeTrue();
     }
 
+    [Fact]
+    public void Should_read_hidden_properly()
+    {
+        // Arrange
+        var xml = new XElement(OpenXmlNamespaces.Word + "rPr",
+            new XElement(OpenXmlNamespaces.Word + "vanish"));
+
+        var runFormat = new RunFormat();
+        var sut = new OpenXmlElementReader(xml);
+
+        // Act
+        sut.Visit(runFormat);
+
+        // Assert
+        runFormat
+            .IsHidden
+            .Should()
+            .BeTrue();
+    }
+
     [Theory]
     [InlineData("strike", StrikethroughType.Single)]
     [InlineData("dstrike", StrikethroughType.Double)]
@@ -92,6 +112,11 @@ public void Should_read_empty_run_format_properly()
             .IsBold
             .Should()
             .Be(RunFormat.Default.IsBold);
+
+        runFormat
+            .IsHidden
+            .Should()
+            .BeFalse();
 
         runFormat
             .StrikethroughType

diff --git a/src/Word/OfficeFlow.Word.OpenXml.Tests/OpenXmlElementWriterTests/RunFormatTests.cs b/src/Word/OfficeFlow.Word.OpenXml.Tests/OpenXmlElementWriterTests/RunFormatTests.cs
@@ -101,6 +101,53 @@ public void Default_value_of_bold_should_not_be_written()
             .Should()
             .Be(expectedXml);
     }
+
+    [Fact]
+    public void Should_write_hidden_properly()
+    {
+        // Assert
+        var expectedXml = new XElement(OpenXmlNamespaces.Word + "rPr",
+            new XElement(OpenXmlNamespaces.Word + "vanish"));
+
+        var sut = new OpenXmlElementWriter(
+            new XElement(OpenXmlNamespaces.Word + "rPr"));
+
+        var runFormat = new RunFormat
+        {
+            IsHidden = true
+        };
+
+        // Act
+        sut.Visit(runFormat);
+
+        // Assert
+        sut.Xml
+            .Should()
+            .Be(expectedXml);
+    }
+
+    [Fact]
+    public void Default_value_of_hidden_should_not_be_written()
+    {
+        // Assert
+        var expectedXml = new XElement(OpenXmlNamespaces.Word + "rPr");
+
+        var sut = new OpenXmlElementWriter(
+            new XElement(OpenXmlNamespaces.Word + "rPr"));
+
+        var runFormat = new RunFormat
+        {
+            IsHidden = false
+        };
+
+        // Act
+        sut.Visit(runFormat);
+
+        // Assert
+        sut.Xml
+            .Should()
+            .Be(expectedXml);
+    }
 
     [Theory]
     [InlineData("strike", StrikethroughType.Single)]

diff --git a/src/Word/OfficeFlow.Word.OpenXml/OpenXmlElementReader.cs b/src/Word/OfficeFlow.Word.OpenXml/OpenXmlElementReader.cs
@@ -254,6 +254,10 @@ public void Visit(RunFormat runFormat)
                     runFormat.IsBold = true;
                     break;
 
+                case "vanish":
+                    runFormat.IsHidden = true;
+                    break;
+
                 case "u":
                     // TODO: Add underline support
                     break;

diff --git a/src/Word/OfficeFlow.Word.OpenXml/OpenXmlElementWriter.cs b/src/Word/OfficeFlow.Word.OpenXml/OpenXmlElementWriter.cs
@@ -264,6 +264,13 @@ public void Visit(RunFormat runFormat)
             Xml.Add(boldXml);
         }
 
+        if (runFormat.IsHidden)
+        {
+            var vanishXml = new XElement(OpenXmlNamespaces.Word + "vanish");
+
+            Xml.Add(vanishXml);
+        }
+
         if (runFormat.StrikethroughType != StrikethroughType.None)
         {
             var strikethroughName = runFormat.StrikethroughType switch