Working with worksheet headers and footers Leave feedback
On this page
Each worksheet has a collection of header/footer slots, available through SpreadsheetContent.worksheets[i].headers_footers. Each slot has a header_footer_type and three sections (left, center, right), and each section can carry a script (text) or an image.
from groupdocs.watermark import Watermarker
from groupdocs.watermark.options.spreadsheet import SpreadsheetLoadOptions
def extract_headers_footers():
with Watermarker("./spreadsheet.xlsx", SpreadsheetLoadOptions()) as watermarker:
content = watermarker.get_content()
worksheet = content.worksheets[0]
print(f"Worksheet 0 header/footer slots: {len(worksheet.headers_footers)}")
for header_footer in worksheet.headers_footers:
sections = list(header_footer.sections)
with_content = [s for s in sections if s.image is not None or s.script]
print(f" type={header_footer.header_footer_type} "
f"sections={len(sections)} with_content={len(with_content)}")
if __name__ == "__main__":
extract_headers_footers()
spreadsheet.xlsx is the sample file used in this example. Click here to download it.
Worksheet 0 header/footer slots: 6
type=0 sections=3 with_content=0
type=1 sections=3 with_content=0
type=2 sections=3 with_content=0
type=3 sections=3 with_content=0
type=4 sections=3 with_content=0
type=5 sections=3 with_content=0
To clear a section, set its image and script to None. To watermark the existing header/footer images, add a watermark to each non-empty image:
from groupdocs.watermark import Watermarker
from groupdocs.watermark.watermarks import TextWatermark, Font
from groupdocs.watermark.options.spreadsheet import SpreadsheetLoadOptions
def watermark_headers_footers():
with Watermarker("./spreadsheet.xlsx", SpreadsheetLoadOptions()) as watermarker:
watermark = TextWatermark("Protected", Font("Arial", 8.0))
content = watermarker.get_content()
for worksheet in content.worksheets:
for header_footer in worksheet.headers_footers:
for section in header_footer.sections:
if section.image is not None:
section.image.add(watermark)
watermarker.save("./output.xlsx")
if __name__ == "__main__":
watermark_headers_footers()
spreadsheet.xlsx is the sample file used in this example. Click here to download it.
Binary file (XLSX, 9 KB)
To add a fresh header/footer watermark instead, use SpreadsheetWatermarkHeaderFooterOptions (see the section index).
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
