Newer
Older
ClosedXML / ClosedXML_Tests / Excel / Clearing / ClearingTests.cs
using ClosedXML.Excel;
using NUnit.Framework;
using System;
using System.Linq;

namespace ClosedXML_Tests
{
    [TestFixture]
    public class ClearingTests
    {
        private static XLColor backgroundColor = XLColor.LightBlue;
        private static XLColor foregroundColor = XLColor.DarkBrown;

        private IXLWorkbook SetupWorkbook()
        {
            var wb = new XLWorkbook();
            IXLWorksheet ws = wb.Worksheets.Add("Sheet1");

            var c = ws.FirstCell()
                .SetValue("Hello world!");

            c.Comment.AddText("Some comment");

            c.Style.Fill.BackgroundColor = backgroundColor;
            c.Style.Font.FontColor = foregroundColor;
            c.SetDataValidation().Custom("B1");

            ////

            c = ws.FirstCell()
                .CellBelow()
                .SetFormulaA1("=LEFT(A1,5)");

            c.Comment.AddText("Another comment");

            c.Style.Fill.BackgroundColor = backgroundColor;
            c.Style.Font.FontColor = foregroundColor;

            ////

            c = ws.FirstCell()
                .CellBelow(2)
                .SetValue(new DateTime(2018, 1, 15));

            c.Comment.AddText("A date");

            c.Style.Fill.BackgroundColor = backgroundColor;
            c.Style.Font.FontColor = foregroundColor;

            ws.Column(1)
                .AddConditionalFormat().WhenStartsWith("Hell")
                .Fill.SetBackgroundColor(XLColor.Red)
                .Border.SetOutsideBorder(XLBorderStyleValues.Thick)
                .Border.SetOutsideBorderColor(XLColor.Blue)
                .Font.SetBold();

            Assert.AreEqual(XLDataType.Text, ws.Cell("A1").DataType);
            Assert.AreEqual(XLDataType.Text, ws.Cell("A2").DataType);
            Assert.AreEqual(XLDataType.DateTime, ws.Cell("A3").DataType);

            Assert.AreEqual(false, ws.Cell("A1").HasFormula);
            Assert.AreEqual(true, ws.Cell("A2").HasFormula);
            Assert.AreEqual(false, ws.Cell("A1").HasFormula);

            foreach (var cell in ws.Range("A1:A3").Cells())
            {
                Assert.AreEqual(backgroundColor, cell.Style.Fill.BackgroundColor);
                Assert.AreEqual(foregroundColor, cell.Style.Font.FontColor);
                Assert.IsTrue(ws.ConditionalFormats.Any());
                Assert.IsTrue(cell.HasComment);
            }

            Assert.AreEqual("B1", ws.Cell("A1").DataValidation.Value);

            return wb;
        }

        [Test]
        public void WorksheetClearAll()
        {
            using (var wb = SetupWorkbook())
            {
                var ws = wb.Worksheets.First();

                ws.Clear(XLClearOptions.All);

                foreach (var c in ws.Range("A1:A10").Cells())
                {
                    Assert.IsTrue(c.IsEmpty());
                    Assert.AreEqual(XLDataType.Text, c.DataType);
                    Assert.AreEqual(ws.Style.Fill.BackgroundColor, c.Style.Fill.BackgroundColor);
                    Assert.AreEqual(ws.Style.Font.FontColor, c.Style.Font.FontColor);
                    Assert.IsFalse(ws.ConditionalFormats.Any());
                    Assert.IsFalse(c.HasComment);
                    Assert.AreEqual(String.Empty, c.DataValidation.Value);
                }
            }
        }

        [Test]
        public void WorksheetClearContents()
        {
            {
                using (var wb = SetupWorkbook())
                {
                    var ws = wb.Worksheets.First();

                    ws.Clear(XLClearOptions.Contents);

                    foreach (var c in ws.Range("A1:A3").Cells())
                    {
                        Assert.IsTrue(c.IsEmpty());
                        Assert.AreEqual(backgroundColor, c.Style.Fill.BackgroundColor);
                        Assert.AreEqual(foregroundColor, c.Style.Font.FontColor);
                        Assert.IsTrue(ws.ConditionalFormats.Any());
                        Assert.IsTrue(c.HasComment);
                    }

                    Assert.AreEqual("B1", ws.Cell("A1").DataValidation.Value);

                    Assert.AreEqual(XLDataType.Text, ws.Cell("A1").DataType);
                    Assert.AreEqual(XLDataType.Text, ws.Cell("A2").DataType);
                    Assert.AreEqual(XLDataType.DateTime, ws.Cell("A3").DataType);
                }
            }
        }

        [Test]
        public void WorksheetClearDataType()
        {
            {
                using (var wb = SetupWorkbook())
                {
                    var ws = wb.Worksheets.First();

                    ws.Clear(XLClearOptions.DataType);

                    foreach (var c in ws.Range("A1:A3").Cells())
                    {
                        Assert.IsFalse(c.IsEmpty());
                        Assert.AreEqual(XLDataType.Text, c.DataType);
                        Assert.AreEqual(backgroundColor, c.Style.Fill.BackgroundColor);
                        Assert.AreEqual(foregroundColor, c.Style.Font.FontColor);
                        Assert.IsTrue(ws.ConditionalFormats.Any());
                        Assert.IsTrue(c.HasComment);
                    }

                    Assert.AreEqual("B1", ws.Cell("A1").DataValidation.Value);
                }
            }
        }

        [Test]
        public void WorksheetClearNormalFormats()
        {
            {
                using (var wb = SetupWorkbook())
                {
                    var ws = wb.Worksheets.First();

                    ws.Clear(XLClearOptions.NormalFormats);

                    foreach (var c in ws.Range("A1:A3").Cells())
                    {
                        Assert.IsFalse(c.IsEmpty());
                        Assert.AreEqual(ws.Style.Fill.BackgroundColor, c.Style.Fill.BackgroundColor);
                        Assert.AreEqual(ws.Style.Font.FontColor, c.Style.Font.FontColor);
                        Assert.IsTrue(ws.ConditionalFormats.Any());
                        Assert.IsTrue(c.HasComment);
                    }

                    Assert.AreEqual(XLDataType.Text, ws.Cell("A1").DataType);
                    Assert.AreEqual(XLDataType.Text, ws.Cell("A2").DataType);
                    Assert.AreEqual(XLDataType.DateTime, ws.Cell("A3").DataType);

                    Assert.AreEqual("B1", ws.Cell("A1").DataValidation.Value);
                }
            }
        }

        [Test]
        public void WorksheetClearConditionalFormats()
        {
            {
                using (var wb = SetupWorkbook())
                {
                    var ws = wb.Worksheets.First();

                    ws.Clear(XLClearOptions.ConditionalFormats);

                    foreach (var c in ws.Range("A1:A3").Cells())
                    {
                        Assert.IsFalse(c.IsEmpty());
                        Assert.AreEqual(backgroundColor, c.Style.Fill.BackgroundColor);
                        Assert.AreEqual(foregroundColor, c.Style.Font.FontColor);
                        Assert.IsFalse(ws.ConditionalFormats.Any());
                        Assert.IsTrue(c.HasComment);
                    }

                    Assert.AreEqual(XLDataType.Text, ws.Cell("A1").DataType);
                    Assert.AreEqual(XLDataType.Text, ws.Cell("A2").DataType);
                    Assert.AreEqual(XLDataType.DateTime, ws.Cell("A3").DataType);

                    Assert.AreEqual("B1", ws.Cell("A1").DataValidation.Value);
                }
            }
        }

        [Test]
        public void WorksheetClearComments()
        {
            {
                using (var wb = SetupWorkbook())
                {
                    var ws = wb.Worksheets.First();

                    ws.Clear(XLClearOptions.Comments);

                    foreach (var c in ws.Range("A1:A3").Cells())
                    {
                        Assert.IsFalse(c.IsEmpty());
                        Assert.AreEqual(backgroundColor, c.Style.Fill.BackgroundColor);
                        Assert.AreEqual(foregroundColor, c.Style.Font.FontColor);
                        Assert.IsTrue(ws.ConditionalFormats.Any());
                        Assert.IsFalse(c.HasComment);
                    }

                    Assert.AreEqual(XLDataType.Text, ws.Cell("A1").DataType);
                    Assert.AreEqual(XLDataType.Text, ws.Cell("A2").DataType);
                    Assert.AreEqual(XLDataType.DateTime, ws.Cell("A3").DataType);

                    Assert.AreEqual("B1", ws.Cell("A1").DataValidation.Value);
                }
            }
        }

        [Test]
        public void WorksheetClearDataValidation()
        {
            {
                using (var wb = SetupWorkbook())
                {
                    var ws = wb.Worksheets.First();

                    ws.Clear(XLClearOptions.DataValidation);

                    foreach (var c in ws.Range("A1:A3").Cells())
                    {
                        Assert.IsFalse(c.IsEmpty());
                        Assert.AreEqual(backgroundColor, c.Style.Fill.BackgroundColor);
                        Assert.AreEqual(foregroundColor, c.Style.Font.FontColor);
                        Assert.IsTrue(ws.ConditionalFormats.Any());
                        Assert.IsTrue(c.HasComment);
                    }

                    Assert.AreEqual(XLDataType.Text, ws.Cell("A1").DataType);
                    Assert.AreEqual(XLDataType.Text, ws.Cell("A2").DataType);
                    Assert.AreEqual(XLDataType.DateTime, ws.Cell("A3").DataType);

                    Assert.AreEqual(string.Empty, ws.Cell("A1").DataValidation.Value);
                }
            }
        }
    }
}