{"id":2337,"date":"2026-09-29T07:32:13","date_gmt":"2026-09-28T23:32:13","guid":{"rendered":"https:\/\/xlwings.net\/blog\/?p=2337"},"modified":"2026-03-29T09:33:15","modified_gmt":"2026-03-29T09:33:15","slug":"how-to-use-worksheetprintedcommentpages-in-the-xlwings-api-way","status":"publish","type":"post","link":"https:\/\/xlwings.net\/blog\/how-to-use-worksheetprintedcommentpages-in-the-xlwings-api-way\/","title":{"rendered":"How to use Worksheet.PrintedCommentPages in the xlwings API way"},"content":{"rendered":"\n

In the realm of Excel automation with Python, the xlwings<\/code> library provides a powerful and Pythonic interface to interact with the Excel Object Model. One of the more specialized members within the Worksheet<\/code> object is PrintedCommentPages<\/code>. This property is particularly useful when dealing with document formatting and print management, as it allows developers to programmatically control how comments are handled during printing operations.<\/p>\n\n\n\n

Functionality:<\/strong>
The PrintedCommentPages<\/code> property of a Worksheet<\/code> object in Excel determines the location where cell comments are printed. In Excel, comments (or notes) can be printed either at the end of the worksheet or as displayed on the sheet. This property is essential for generating reports or documents where the inclusion and placement of annotations are critical for clarity and reference. By accessing this property via xlwings<\/code>, you can both retrieve the current setting and modify it to suit specific printing requirements, ensuring that printed outputs meet desired standards.<\/p>\n\n\n\n

Syntax and Parameters:<\/strong>
In xlwings<\/code>, the PrintedCommentPages<\/code> property is accessed through a Worksheet<\/code> object. The property corresponds to the Excel constant XlPrintLocation<\/code>, which defines where comments are printed. The syntax is straightforward:<\/p>\n\n\n\n

worksheet.api.PrintedCommentPages<\/code><\/pre>\n\n\n\n
This property is read-write, meaning you can both get its current value and set it to a new value. The value is an integer that corresponds to one of the following Excel enumeration constants:<\/p>\n\n\n\n
Constant Name (Excel)<\/th>Value<\/th>Description<\/th><\/tr><\/thead>
xlPrintNoComments<\/code><\/td>-4142<\/td>Comments are not printed.<\/td><\/tr>
xlPrintInPlace<\/code><\/td>16<\/td>Comments are printed as displayed on the sheet.<\/td><\/tr>
xlPrintSheetEnd<\/code><\/td>1<\/td>Comments are printed at the end of the sheet.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
To use these constants in xlwings<\/code>, you typically import them from the win32com.client.constants<\/code> module if you are on Windows, or use their numeric values directly for cross-platform compatibility. However, xlwings<\/code> often abstracts these constants, so you might use the numeric values or predefined constants if available in your environment.<\/p>\n\n\n\n
Code Examples:<\/strong>
Below are practical examples demonstrating how to use the PrintedCommentPages<\/code> property with xlwings<\/code>.<\/p>\n\n\n\n
    \n
  1. Retrieving the Current Print Setting for Comments:<\/strong>
    This example shows how to get the current setting to understand where comments will be printed.<\/li>\n<\/ol>\n\n\n\n
    import xlwings as xw\n\n# Open an existing workbook and select a worksheet\napp = xw.App(visible=False)\nworkbook = app.books.open('example.xlsx')\nsheet = workbook.sheets['Sheet1']\n\n# Get the current PrintedCommentPages setting\ncurrent_setting = sheet.api.PrintedCommentPages\nprint(f\"Current comment print setting: {current_setting}\")\n\n# Interpret the value\nif current_setting == -4142:\n    print(\"Comments will not be printed.\")\nelif current_setting == 16:\n    print(\"Comments will be printed in place.\")\nelif current_setting == 1:\n    print(\"Comments will be printed at the end of the sheet.\")\n\nworkbook.close()\napp.quit()<\/code><\/pre>\n\n\n\n
      \n
    1. Setting the Print Location for Comments:<\/strong>
      This example changes the setting to print comments at the end of the sheet, which is useful for keeping the main content uncluttered.<\/li>\n<\/ol>\n\n\n\n
      import xlwings as xw\n\n# Start Excel and open a workbook\napp = xw.App(visible=False)\nworkbook = app.books.open('report.xlsx')\nsheet = workbook.sheets['Data']\n\n# Set to print comments at the end of the sheet\nsheet.api.PrintedCommentPages = 1 # xlPrintSheetEnd\n\n# Save and print preview (optional)\nworkbook.save()\n# To see the effect, you might trigger a print preview or print directly\n# app.api.ActiveSheet.PrintPreview()\n\nprint(\"Comment print setting updated to print at sheet end.\")\n\nworkbook.close()\napp.quit()<\/code><\/pre>\n\n\n\n
        \n
      1. Dynamically Configuring Based on User Input:<\/strong>
        Here, the setting is adjusted based on a configuration parameter, making it adaptable to different reporting needs.<\/li>\n<\/ol>\n\n\n\n
        import xlwings as xw\n\ndef set_comment_printing(workbook_path, sheet_name, print_location):\n\"\"\"\nSet the comment printing location for a specified worksheet.\n\nParameters:\nworkbook_path (str): Path to the Excel workbook.\nsheet_name (str): Name of the worksheet.\nprint_location (str): Desired print location ('none', 'inplace', 'end').\n\"\"\"\n    app = xw.App(visible=False)\n    workbook = app.books.open(workbook_path)\n    sheet = workbook.sheets[sheet_name]\n\n    # Map user-friendly input to Excel constants\n    location_map = {\n    'none': -4142, # xlPrintNoComments\n    'inplace': 16, # xlPrintInPlace\n    'end': 1 # xlPrintSheetEnd\n    }\n\n    if print_location in location_map:\n        sheet.api.PrintedCommentPages = location_map[print_location]\n        print(f\"Set comment printing to '{print_location}'.\")\n    else:\n        print(\"Invalid print location. Using default.\")\n\n    workbook.save()\n    workbook.close()\n    app.quit()\n\n# Example usage\nset_comment_printing('financial_report.xlsx', 'Summary', 'end')<\/code><\/pre>\n\n\n\n
        <\/p>\n","protected":false},"excerpt":{"rendered":"
        In the realm of Excel automation with Python, the `xlwings` library provides a powerful and Pythonic…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[25],"tags":[],"class_list":["post-2337","post","type-post","status-publish","format-standard","hentry","category-xlwings-api-reference"],"_links":{"self":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2337","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/comments?post=2337"}],"version-history":[{"count":2,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2337\/revisions"}],"predecessor-version":[{"id":3563,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2337\/revisions\/3563"}],"wp:attachment":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/media?parent=2337"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/categories?post=2337"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/tags?post=2337"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}