Add new function: SetHeaderFooter

- Update unit test
- Update GitHub Action configuration for test on .Net 10.x

Author: xuri

.github/workflows/build.yml

@@ -41,6 +41,7 @@ jobs:
             7.x
             8.x
             9.x
+            10.x
 
       - name: Test on Windows
         env:
@@ -217,6 +218,7 @@ jobs:
             7.x
             8.x
             9.x
+            10.x
 
       - name: Download Artifacts
         uses: actions/download-artifact@v5

Excelize.Tests/Excelize.Tests.csproj

@@ -5,7 +5,7 @@
     <IsPackable>false</IsPackable>
     <IsTestProject>true</IsTestProject>
     <Nullable>enable</Nullable>
-    <TargetFrameworks>net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
+    <TargetFrameworks>net6.0;net7.0;net8.0;net9.0;net10.0</TargetFrameworks>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="coverlet.collector" Version="6.0.4">

Excelize.Tests/UnitTest.cs

@@ -529,6 +529,41 @@ public void TestCoordinates()
         );
     }
 
+    [Fact]
+    public void TestHeaderFooter()
+    {
+        File f = Excelize.NewFile();
+        Assert.Null(
+            Record.Exception(() =>
+            {
+                f.SetHeaderFooter(
+                    "Sheet1",
+                    new HeaderFooterOptions
+                    {
+                        DifferentFirst = true,
+                        DifferentOddEven = true,
+                        OddHeader = "&R&P",
+                        OddFooter = "&C&F",
+                        EvenHeader = "&L&P",
+                        EvenFooter = "&L&D&R&T",
+                        FirstHeader = "&CCenter &\"-,Bold\"Bold&\"-,Regular\"HeaderU+000A&D",
+                    }
+                );
+            })
+        );
+        var err = Assert.Throws<RuntimeError>(() =>
+            f.SetHeaderFooter("SheetN", new HeaderFooterOptions { })
+        );
+        Assert.Equal("sheet SheetN does not exist", err.Message);
+        Assert.Null(
+            Record.Exception(() =>
+            {
+                f.SaveAs("TestHeaderFooter.xlsx");
+            })
+        );
+        Assert.Empty(f.Close());
+    }
+
     [Fact]
     public void TestOpenFile()
     {

Excelize/Excelize.cs

@@ -363,6 +363,17 @@ internal static extern IntPtr SetSheetProps(
             ref TypesC.SheetPropsOptions options
         );
 
+        [DllImport(
+            LibraryName,
+            CallingConvention = CallingConvention.Cdecl,
+            CharSet = CharSet.Ansi
+        )]
+        internal static extern IntPtr SetHeaderFooter(
+            long fileIdx,
+            string sheet,
+            ref TypesC.HeaderFooterOptions opts
+        );
+
         [DllImport(
             LibraryName,
             CallingConvention = CallingConvention.Cdecl,
@@ -2145,6 +2156,48 @@ public void SetSheetProps(string sheet, SheetPropsOptions options)
                 throw new RuntimeError(err);
         }
 
+        /// <summary>
+        /// Set headers and footers by given worksheet name and the control
+        /// characters.
+        /// <example>
+        /// For example:
+        /// <code><![CDATA[
+        /// try
+        /// {
+        ///     f.SetHeaderFooter(
+        ///         "Sheet1",
+        ///         new HeaderFooterOptions
+        ///         {
+        ///             DifferentFirst = true,
+        ///             DifferentOddEven = true,
+        ///             OddHeader = "&R&P",
+        ///             OddFooter = "&C&F",
+        ///             EvenHeader = "&L&P",
+        ///             EvenFooter = "&L&D&R&T",
+        ///             FirstHeader = "&CCenter &\"-,Bold\"Bold&\"-,Regular\"HeaderU+000A&D",
+        ///         }
+        ///     );
+        /// }
+        /// catch (RuntimeError err)
+        /// {
+        ///     Console.WriteLine(err.Message);
+        /// }]]>
+        /// </code>
+        /// </example>
+        /// </summary>
+        /// <param name="sheet">The worksheet name</param>
+        /// <param name="options">The header footer options</param>
+        /// <exception cref="RuntimeError">Return None if no error occurred,
+        /// otherwise raise a RuntimeError with the message.</exception>
+        public void SetHeaderFooter(string sheet, HeaderFooterOptions? options)
+        {
+            var opts = (TypesC.HeaderFooterOptions)
+                Lib.CsToC(options ?? new HeaderFooterOptions(), new TypesC.HeaderFooterOptions());
+            string err = Marshal.PtrToStringAnsi(Lib.SetHeaderFooter(FileIdx, sheet, ref opts));
+            if (!string.IsNullOrEmpty(err))
+                throw new RuntimeError(err);
+        }
+
         /// <summary>
         /// Writes cells to row by given worksheet name, starting cell reference
         /// and cell values list.

Excelize/Excelize.csproj

@@ -24,7 +24,7 @@
     <RepositoryBranch>main</RepositoryBranch>
     <RepositoryType>git</RepositoryType>
     <RepositoryUrl>https://github.com/xuri/excelize-cs.git</RepositoryUrl>
-    <TargetFrameworks>net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
+    <TargetFrameworks>net6.0;net7.0;net8.0;net9.0;net10.0</TargetFrameworks>
     <Title>Excelize</Title>
     <Version>0.0.4</Version>
   </PropertyGroup>

Excelize/TypesC.cs

@@ -118,6 +118,25 @@ public struct Protection
         public bool Locked;
     }
 
+    [StructLayout(LayoutKind.Sequential)]
+    public unsafe struct HeaderFooterOptions
+    {
+        public bool* AlignWithMargins;
+
+        [MarshalAs(UnmanagedType.I1)]
+        public bool DifferentFirst;
+
+        [MarshalAs(UnmanagedType.I1)]
+        public bool DifferentOddEven;
+        public bool* ScaleWithDoc;
+        public sbyte* OddHeader;
+        public sbyte* OddFooter;
+        public sbyte* EvenHeader;
+        public sbyte* EvenFooter;
+        public sbyte* FirstHeader;
+        public sbyte* FirstFooter;
+    }
+
     [StructLayout(LayoutKind.Sequential)]
     public unsafe struct Style
     {

Excelize/TypesCs.cs

@@ -291,6 +291,23 @@ public struct Protection
         public bool Hidden;
     }
 
+    /// <summary>
+    /// HeaderFooterOptions directly maps the settings of header and footer.
+    /// </summary>
+    public struct HeaderFooterOptions
+    {
+        public bool? AlignWithMargins;
+        public bool DifferentFirst;
+        public bool DifferentOddEven;
+        public bool? ScaleWithDoc;
+        public string OddHeader;
+        public string OddFooter;
+        public string EvenHeader;
+        public string EvenFooter;
+        public string FirstHeader;
+        public string FirstFooter;
+    }
+
     /// <summary>
     /// Style directly maps the style settings of the cells.
     /// </summary>