Skip to content

Commit 8da6365

Browse files
Moorthy-KMoorthy-K
authored
Merge pull request #171 from SyncfusionExamples/961945
961945: Added sample for custom header and footer in PDF document
2 parents f80debc + 18cd3eb commit 8da6365

File tree

7 files changed

+317
-0
lines changed

7 files changed

+317
-0
lines changed

‎Header and Footer/Custom-Headers-and-Footers-in-PDF/.NET Framework/Custom-Headers-and-Footers-in-PDF.sln

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
2+
Microsoft Visual Studio Solution File, Format Version 12.00
3+
# Visual Studio Version 17
4+
VisualStudioVersion = 17.12.35707.178 d17.12
5+
MinimumVisualStudioVersion = 10.0.40219.1
6+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Custom-Headers-and-Footers-in-PDF", "Custom-Headers-and-Footers-in-PDF\Custom-Headers-and-Footers-in-PDF.csproj", "{6A94ADAE-5F1B-42A5-9F82-2CBB511B2F82}"
7+
EndProject
8+
Global
9+
GlobalSection(SolutionConfigurationPlatforms) = preSolution
10+
Debug|Any CPU = Debug|Any CPU
11+
Release|Any CPU = Release|Any CPU
12+
EndGlobalSection
13+
GlobalSection(ProjectConfigurationPlatforms) = postSolution
14+
{6A94ADAE-5F1B-42A5-9F82-2CBB511B2F82}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
15+
{6A94ADAE-5F1B-42A5-9F82-2CBB511B2F82}.Debug|Any CPU.Build.0 = Debug|Any CPU
16+
{6A94ADAE-5F1B-42A5-9F82-2CBB511B2F82}.Release|Any CPU.ActiveCfg = Release|Any CPU
17+
{6A94ADAE-5F1B-42A5-9F82-2CBB511B2F82}.Release|Any CPU.Build.0 = Release|Any CPU
18+
EndGlobalSection
19+
GlobalSection(SolutionProperties) = preSolution
20+
HideSolutionNode = FALSE
21+
EndGlobalSection
22+
EndGlobal

‎Header and Footer/Custom-Headers-and-Footers-in-PDF/.NET Framework/Custom-Headers-and-Footers-in-PDF/Custom-Headers-and-Footers-in-PDF.csproj

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
3+
<PropertyGroup>
4+
<OutputType>WinExe</OutputType>
5+
<TargetFramework>net8.0-windows</TargetFramework>
6+
<RootNamespace>Custom_Headers_and_Footers_in_PDF</RootNamespace>
7+
<Nullable>enable</Nullable>
8+
<UseWindowsForms>true</UseWindowsForms>
9+
<ImplicitUsings>enable</ImplicitUsings>
10+
</PropertyGroup>
11+
12+
<ItemGroup>
13+
<PackageReference Include="Syncfusion.Pdf.WinForms" Version="29.2.10" />
14+
</ItemGroup>
15+
16+
</Project>

‎Header and Footer/Custom-Headers-and-Footers-in-PDF/.NET Framework/Custom-Headers-and-Footers-in-PDF/Custom-Headers-and-Footers-in-PDF.csproj.user

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<Project ToolsVersion="Current" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
3+
<ItemGroup>
4+
<Compile Update="Form1.cs">
5+
<SubType>Form</SubType>
6+
</Compile>
7+
</ItemGroup>
8+
</Project>

‎Header and Footer/Custom-Headers-and-Footers-in-PDF/.NET Framework/Custom-Headers-and-Footers-in-PDF/Form1.Designer.cs

Lines changed: 63 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Header and Footer/Custom-Headers-and-Footers-in-PDF/.NET Framework/Custom-Headers-and-Footers-in-PDF/Form1.cs

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
using Syncfusion.Pdf;
2+
using Syncfusion.Pdf.Graphics;
3+
4+
namespace Custom_Headers_and_Footers_in_PDF
5+
{
6+
public partial class Form1 : Form
7+
{
8+
public Form1()
9+
{
10+
InitializeComponent();
11+
}
12+
13+
private void btnCreate_Click(object sender, EventArgs e)
14+
{
15+
// Create a new PDF document
16+
PdfDocument document = new PdfDocument();
17+
18+
// Paragraph content to display on each page
19+
string paragraph = @"The page tree serves as the root of the document. In the simplest case, it is just a list of the pages in the document. Each page is defined as an independent entity with metadata (e.g., page dimensions) and a reference to its resources and content, which are defined separately. Together, the page tree and page objects create the “paper” that composes the document.
20+
Resources are objects that are required to render a page. For example, a single font is typically used across several pages, so storing the font information in an external resource is much more efficient. A content object defines the text and graphics that actually show up on the page. Together, content objects and resources define the appearance of an individual page.
21+
Finally, the document’s catalog tells applications where to start reading the document. Often, this is just a pointer to the root page tree.";
22+
23+
// ===== Section 1 =====
24+
AddSectionWithHeaderFooter(document, "Header - Section 1", "Footer - Section 1", 1, paragraph);
25+
26+
// ===== Section 2 =====
27+
AddSectionWithHeaderFooter(document, "Header - Section 2", "Footer - Section 2", 1, paragraph);
28+
29+
// Save and close the document
30+
document.Save("Output.pdf");
31+
// Close and dispose of the PDF document
32+
document.Close(true);
33+
}
34+
35+
// Adds a specified number of pages to the document, each with a unique header, footer, and paragraph content.
36+
static void AddSectionWithHeaderFooter(PdfDocument document, string headerText, string footerText, int numberOfPages, string pageContent)
37+
{
38+
// Define fonts and brush
39+
PdfFont headerFooterFont = new PdfStandardFont(PdfFontFamily.Helvetica, 10, PdfFontStyle.Bold);
40+
PdfFont bodyFont = new PdfStandardFont(PdfFontFamily.Helvetica, 11);
41+
PdfBrush brush = PdfBrushes.Black;
42+
43+
for (int i = 0; i < numberOfPages; i++)
44+
{
45+
// Add a new page
46+
PdfPage page = document.Pages.Add();
47+
48+
// Draw Header
49+
page.Graphics.DrawString(headerText, headerFooterFont, brush, new PointF(10, 10));
50+
51+
// Draw Footer
52+
float footerY = page.GetClientSize().Height - 20;
53+
page.Graphics.DrawString(footerText, headerFooterFont, brush, new PointF(10, footerY));
54+
55+
// Draw the paragraph content using PdfTextElement for proper layout and wrapping
56+
RectangleF contentBounds = new RectangleF(20, 40, page.GetClientSize().Width - 40, page.GetClientSize().Height - 80);
57+
PdfTextElement textElement = new PdfTextElement(pageContent, bodyFont, brush)
58+
{
59+
StringFormat = new PdfStringFormat()
60+
{
61+
Alignment = PdfTextAlignment.Left,
62+
LineSpacing = 5f
63+
}
64+
};
65+
// Draw the paragraph text within the defined rectangle area on the page
66+
textElement.Draw(page, contentBounds);
67+
}
68+
}
69+
70+
}
71+
}

‎Header and Footer/Custom-Headers-and-Footers-in-PDF/.NET Framework/Custom-Headers-and-Footers-in-PDF/Form1.resx

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<root>
3+
<!--
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
56+
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
64+
<xsd:element name="root" msdata:IsDataSet="true">
65+
<xsd:complexType>
66+
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
84+
<xsd:element name="data">
85+
<xsd:complexType>
86+
<xsd:sequence>
87+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
88+
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
89+
</xsd:sequence>
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
91+
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
92+
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" />
94+
</xsd:complexType>
95+
</xsd:element>
96+
<xsd:element name="resheader">
97+
<xsd:complexType>
98+
<xsd:sequence>
99+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
100+
</xsd:sequence>
101+
<xsd:attribute name="name" type="xsd:string" use="required" />
102+
</xsd:complexType>
103+
</xsd:element>
104+
</xsd:choice>
105+
</xsd:complexType>
106+
</xsd:element>
107+
</xsd:schema>
108+
<resheader name="resmimetype">
109+
<value>text/microsoft-resx</value>
110+
</resheader>
111+
<resheader name="version">
112+
<value>2.0</value>
113+
</resheader>
114+
<resheader name="reader">
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
116+
</resheader>
117+
<resheader name="writer">
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
119+
</resheader>
120+
</root>

‎Header and Footer/Custom-Headers-and-Footers-in-PDF/.NET Framework/Custom-Headers-and-Footers-in-PDF/Program.cs

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
namespace Custom_Headers_and_Footers_in_PDF
2+
{
3+
internal static class Program
4+
{
5+
/// <summary>
6+
/// The main entry point for the application.
7+
/// </summary>
8+
[STAThread]
9+
static void Main()
10+
{
11+
// To customize application configuration such as set high DPI settings or default font,
12+
// see https://aka.ms/applicationconfiguration.
13+
ApplicationConfiguration.Initialize();
14+
Application.Run(new Form1());
15+
}
16+
}
17+
}

0 commit comments

Comments
 (0)