Provide Table Explicit Properties - #1149 (#1921)

This is to address #1149

---------

Co-authored-by: Michael Bowen <10384982+mikeebowen@users.noreply.github.com>

Author: mkaszewiak

src/DocumentFormat.OpenXml/Schema/Wordprocessing/Table.cs

@@ -0,0 +1,42 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using DocumentFormat.OpenXml.Framework;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace DocumentFormat.OpenXml.Wordprocessing
+{
+    public partial class Table
+    {
+        /// <summary>
+        /// Gets or sets the TableProperties.
+        /// </summary>
+        public TableProperties? TableProperties
+        {
+            get => GetElement(Wordprocessing.TableProperties.ElementType) as TableProperties;
+            set => SetElement(value, Wordprocessing.TableProperties.ElementType);
+        }
+
+        /// <summary>
+        /// Gets or sets the TableGrid.
+        /// </summary>
+        public TableGrid? TableGrid
+        {
+            get => GetElement(Wordprocessing.TableGrid.ElementType) as TableGrid;
+            set => SetElement(value, Wordprocessing.TableGrid.ElementType);
+        }
+
+        /// <summary>
+        /// Gets the collection of TableRow elements.
+        /// </summary>
+        public IEnumerable<TableRow> TableRows
+        {
+            get
+            {
+                return Elements<TableRow>()?.OfType<TableRow>() ?? Enumerable.Empty<TableRow>();
+            }
+        }
+    }
+}

src/DocumentFormat.OpenXml/Schema/Wordprocessing/TableRow.cs

@@ -0,0 +1,25 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System.Collections.Generic;
+using System.Linq;
+
+namespace DocumentFormat.OpenXml.Wordprocessing
+{
+    /// <summary>
+    /// Represents a table row in a Wordprocessing document.
+    /// </summary>
+    public partial class TableRow
+    {
+        /// <summary>
+        /// Gets the collection of table cells within the table row.
+        /// </summary>
+        public IEnumerable<TableCell> TableCells
+        {
+            get
+            {
+                return Elements<TableCell>()?.OfType<TableCell>() ?? Enumerable.Empty<TableCell>();
+            }
+        }
+    }
+}

test/DocumentFormat.OpenXml.Tests/Wordprocessing/TableRowTest.cs

@@ -0,0 +1,55 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System.Collections.Generic;
+using System.Linq;
+using Xunit;
+
+namespace DocumentFormat.OpenXml.Wordprocessing
+{
+    public class TableRowTest
+    {
+        [Fact]
+        public void TableCellsTest()
+        {
+            // Arrange
+            Table table = new Table();
+
+            // Create table rows and cells
+            TableRow tr = table.AppendChild(new TableRow());
+            TableCell tc1 = tr.AppendChild(new TableCell(new TableCellProperties(
+                new TableCellWidth() { Type = TableWidthUnitValues.Dxa, Width = "2400" })));
+            tc1.AppendChild(new Paragraph(new Run(new Text("Text 0"))));
+
+            TableCell tc2 = tr.AppendChild(new TableCell(new TableCellProperties(
+               new TableCellWidth() { Type = TableWidthUnitValues.Dxa, Width = "2400" })));
+            tc2.AppendChild(new Paragraph(new Run(new Text("Text 1"))));
+
+            int i = 0;
+
+            // List to store row cells
+            List<TableCell> cells = new List<TableCell> { tc1, tc2 };
+
+            // Assert
+            foreach (var cell in tr.TableCells.ToList())
+            {
+                Assert.IsType<TableCell>(cell);
+                Assert.Equal(cells[i], cell);
+                Assert.Equal("Text " + i.ToString(), cell.InnerText);
+                i++;
+            }
+        }
+
+        [Fact]
+        public void TableRowsShouldBeEmptyRowsAreAdded()
+        {
+            // Arrange
+            Table table = new Table();
+            TableRow tr = table.AppendChild(new TableRow());
+
+            // Assert
+            Assert.NotNull(tr.TableCells);
+            Assert.Empty(tr.TableCells);
+        }
+    }
+}

test/DocumentFormat.OpenXml.Tests/Wordprocessing/TableTests.cs

@@ -0,0 +1,112 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System.Collections.Generic;
+using System.Linq;
+using Xunit;
+
+namespace DocumentFormat.OpenXml.Wordprocessing
+{
+    public class TableTests
+    {
+        [Fact]
+        public void TablePropertiesGetterAndSetterTest()
+        {
+            // Arrange
+            var table = new Table();
+            var tableProperties = new TableProperties(new TableBorders(
+            new TopBorder()
+            {
+                Val =
+                new EnumValue<BorderValues>(BorderValues.Single),
+                Size = 24,
+            },
+            new BottomBorder()
+            {
+                Val =
+                new EnumValue<BorderValues>(BorderValues.Single),
+                Size = 24,
+            }));
+
+            // Act
+            table.AppendChild(tableProperties);
+
+            // Assert
+            Assert.NotNull(table.TableProperties);
+            Assert.Equal(tableProperties, table.TableProperties);
+        }
+
+        [Fact]
+        public void TableGridsGetterAndSetterTest()
+        {
+            // Arrange
+            var table = new Table();
+            var tableGrid = new TableGrid(new GridColumn(), new GridColumn(), new GridColumn());
+            TableGrid tableGrid1 = new TableGrid();
+
+            // Act
+            table.AppendChild(tableGrid);
+
+            // Assert
+            Assert.NotNull(table.TableGrid);
+            Assert.Equal(tableGrid, table.TableGrid);
+        }
+
+        [Fact]
+        public void TableRowsTest()
+        {
+            // Arrange
+            Table table = new Table();
+
+            // Create table row and cells
+            TableRow tr = table.AppendChild(new TableRow());
+            TableCell tc1 = tr.AppendChild(new TableCell(new TableCellProperties(
+                new TableCellWidth() { Type = TableWidthUnitValues.Dxa, Width = "2400" })));
+            tc1.AppendChild(new Paragraph(new Run(new Text("Text 1"))));
+
+            // Specify the table cell content.
+            TableCell tc2 = tr.AppendChild(new TableCell(new TableCellProperties(
+                new TableCellWidth() { Type = TableWidthUnitValues.Dxa, Width = "2400" })));
+            tc2.AppendChild(new Paragraph(new Run(new Text("Text 2"))));
+
+            // Create table row and cells
+            TableRow tr2 = table.AppendChild(new TableRow());
+            TableCell tc3 = tr2.AppendChild(new TableCell(new TableCellProperties(
+                new TableCellWidth() { Type = TableWidthUnitValues.Dxa, Width = "2400" })));
+            tc3.AppendChild(new Paragraph(new Run(new Text("Text 3"))));
+
+            // Specify the table cell content.
+            TableCell tc4 = tr2.AppendChild(new TableCell(new TableCellProperties(
+                new TableCellWidth() { Type = TableWidthUnitValues.Dxa, Width = "2400" })));
+            tc4.AppendChild(new Paragraph(new Run(new Text("Text 4"))));
+
+            // List to store table rows
+            List<TableRow> rows = [tr, tr2];
+            table.TableRows.ToList().Append(new TableRow());
+
+            // Assert
+            Assert.NotNull(table.TableRows);
+            Assert.Equal(rows.Count, table.TableRows.Count());
+            int i = 0;
+            foreach (var row in table.TableRows.ToList())
+            {
+                Assert.IsType<TableRow>(row);
+                Assert.Equal(rows[i], row);
+                i++;
+            }
+
+            Assert.Equal(rows.Count, table.TableRows.Count());
+        }
+
+        [Fact]
+        public void TableRowsShouldBeEmptyWhenNoCellsAreAdded()
+        {
+            // Arrange
+            Table table = new Table();
+
+            // Assert
+            Assert.NotNull(table.TableRows);
+            Assert.Empty(table.TableRows);
+        }
+    }
+}