)
We use cookies to give you the best experience on our website. If you continue to browse, then you agree to our privacy policy and cookie policy. (Last updated on: June 24, 2019).
Unfortunately, activation email could not send to your email. Please try again.
Syncfusion Feedback

Insert watermark in Excel document in C#, VB.NET

Platform: WinForms |
Control: XlsIO |
Published Date: April 30, 2011 |
Last Revised Date: January 22, 2020

Syncfusion Excel (XlsIO) library is a .NET Excel library used to create, read, and edit Excel documents. Also, converts Excel documents to PDF files. Using this library, you can insert watermark in Excel worksheet.

Steps to insert watermark in Excel document, programmatically:

  1. Create a new C# console application project.

Create a new C# console application project

Create a new C# console application project

  1. Install the Syncfusion.XlsIO.WinForms NuGet package as reference to your .NET Framework application from NuGet.org.

Install NuGet package to the project

Install NuGet package to the project

  1. Add an Excel file to you project and make it an embedded resource using the following steps.
  1. In Visual Studio, click the Project menu and select Add Existing Item. Find and select the Excel file you want to add to your project.
  2. In the Solution Explorer window, right-click on the Excel file you just added to your project and select Properties from the popup menu. The Properties tool window appears.
  3. In the Properties window, change the Build Action property to Embedded Resource.
  4. Build the project. The Excel file will be compiled into your project’s assembly.
  1. In the same way browse and add an image to your project and make it an Embedded Resource. This image is used as watermark for Excel document.
  2. You can insert a watermark in Excel worksheet using BackgroundImage property available under IPageSetup interface.

C#

//Insert image watermark in the worksheet
Stream imageStream = assembly.GetManifestResourceStream("Watermark.image.png");
worksheet.PageSetup.BackgoundImage = new Bitmap(imageStream);

 

VB.NET

'Insert image watermark in the worksheet
Dim imageStream As Stream = assembly.GetManifestResourceStream("Watermark.image.png")
worksheet.PageSetup.BackgoundImage = New Bitmap(imageStream)

 

Note:

To insert a text watermark, you need to take image of text and insert it in the background using the same BackgroundImage property.

 

  1. Include the following namespaces in Program.cs file.

C#

using Syncfusion.XlsIO;
using System.Drawing;
using System.IO;
using System.Reflection;

 

VB.NET

Imports Syncfusion.XlsIO
Imports System.Drawing
Imports System.IO
Imports System.Reflection

 

  1. Include the following code snippet in main method of Program.cs file to insert watermark in Excel worksheet.

C#

using (ExcelEngine excelEngine = new ExcelEngine())
{
    //Initailize the excel application object
    IApplication application = excelEngine.Excel;
 
    //Load an existing Excel file into IWorkbook
    Assembly assembly = typeof(Program).GetTypeInfo().Assembly;
    Stream fileStream = assembly.GetManifestResourceStream("Watermark.Sample.xlsx");
    IWorkbook workbook = application.Workbooks.Open(fileStream, ExcelOpenType.Automatic);
 
    //Get the first worksheet in workbook into IWorksheet
    IWorksheet worksheet = workbook.Worksheets[0];
 
    //Insert image watermark in the worksheet
    Stream imageStream = assembly.GetManifestResourceStream("Watermark.image.png");
    worksheet.PageSetup.BackgoundImage = new Bitmap(imageStream);
 
    //Save the Excel workbook
    workbook.SaveAs("Output.xlsx");
}

 

VB.NET

Using excelEngine As ExcelEngine = New ExcelEngine()
    'Initailize the excel application object
    Dim application As IApplication = excelEngine.Excel
 
    'Load an existing Excel file into IWorkbook
    Dim assembly As Assembly = GetType(Module1).GetTypeInfo.Assembly
    Dim fileStream As Stream = assembly.GetManifestResourceStream("Watermark.Sample.xlsx")
    Dim workbook As IWorkbook = application.Workbooks.Open(fileStream, ExcelOpenType.Automatic)
 
    'Get the first worksheet in workbook into IWorksheet
    Dim worksheet As IWorksheet = workbook.Worksheets(0)
 
    'Insert image watermark in the worksheet
    Dim imageStream As Stream = assembly.GetManifestResourceStream("Watermark.image.png")
    worksheet.PageSetup.BackgoundImage = New Bitmap(imageStream)
 
    'Save the Excel workbook
    workbook.SaveAs("Output.xlsx")
End Using

 

A complete working sample of how to insert watermark in Excel document can be downloaded from Watermark.zip.

By executing the program, you will get the output Excel document as follows.

Output Excel document

Output Excel document

Take a moment to peruse the documentation, where you will find other options like move or copy a worksheet, freeze, unfreeze and split panes, show or hide worksheet and worksheet tabs, page setup settings and more with code examples.

Click here to explore the rich set of Syncfusion Excel (XlsIO) library features.

Note:

Starting with v16.2.0.x, if you reference Syncfusion assemblies from trial setup or from the NuGet feed, include a license key in your projects. Refer the link to learn about generating and registering Syncfusion license key in your application to use the components without trial message.

 

2X faster development

The ultimate WinForms UI toolkit to boost your development speed.
ADD COMMENT
You must log in to leave a comment

Please sign in to access our KB

This page will automatically be redirected to the sign-in page in 10 seconds.

Up arrow icon

Warning Icon You are using an outdated version of Internet Explorer that may not display all features of this and other websites. Upgrade to Internet Explorer 8 or newer for a better experience.Close Icon

Live Chat Icon For mobile
Live Chat Icon