{"id":2321,"date":"2026-09-21T07:58:59","date_gmt":"2026-09-20T23:58:59","guid":{"rendered":"https:\/\/xlwings.net\/blog\/?p=2321"},"modified":"2026-03-28T13:03:57","modified_gmt":"2026-03-28T13:03:57","slug":"how-to-use-worksheetenableoutlining-in-the-xlwings-api-way","status":"publish","type":"post","link":"https:\/\/xlwings.net\/blog\/how-to-use-worksheetenableoutlining-in-the-xlwings-api-way\/","title":{"rendered":"How to use Worksheet.EnableOutlining in the xlwings API way"},"content":{"rendered":"\n

EnableOutlining Property in xlwings<\/strong><\/p>\n\n\n\n

In Excel’s object model, the EnableOutlining<\/code> property of a Worksheet<\/code> object controls whether outlining (grouping and ungrouping of rows or columns) is allowed on the worksheet. When set to True<\/code>, users can manually create and manipulate outlines via the Excel interface, such as grouping rows to collapse detail data and show summary rows. When set to False<\/code>, outlining is disabled, preventing users from creating new groups or modifying existing ones. This property is useful for protecting the structure of a worksheet when distributing workbooks, ensuring that predefined outline levels remain intact.<\/p>\n\n\n\n

Syntax in xlwings<\/strong><\/p>\n\n\n\n

In xlwings, the EnableOutlining<\/code> property is accessed through the api<\/code> property of a Sheet<\/code> object (which corresponds to a Worksheet<\/code> in Excel’s object model). The property is a boolean value.<\/p>\n\n\n\n

sheet.api.EnableOutlining = True # Enable outlining\nsheet.api.EnableOutlining = False # Disable outlining<\/code><\/pre>\n\n\n\n
    \n
  • sheet<\/strong>: An xlwings Sheet<\/code> object representing the worksheet.<\/li>\n\n\n\n
  • .api<\/strong>: Provides direct access to the underlying Excel object model (via pywin32 on Windows or appscript on macOS).<\/li>\n\n\n\n
  • EnableOutlining<\/strong>: The property name as defined in the Excel object model. It can be set to True<\/code> or False<\/code>.<\/li>\n<\/ul>\n\n\n\n
    Parameters and Usage<\/strong>
    The property does not take additional parameters. It simply gets or sets a boolean value. Note that enabling or disabling outlining does not affect existing outlines; it only controls whether new outlines can be created or existing ones modified by the user. In Excel, this setting is often used in combination with worksheet protection (Protect<\/code> method) to lock the outline structure.<\/p>\n\n\n\n
    Code Examples<\/strong><\/p>\n\n\n\n
      \n
    1. Enabling Outlining on a Worksheet<\/strong>
      This example opens an Excel workbook, enables outlining on the first sheet, and saves the file. Users will then be able to group rows or columns manually in Excel.<\/li>\n<\/ol>\n\n\n\n
      import xlwings as xw\n\n# Open an existing workbook or create a new one\napp = xw.App(visible=False)\nworkbook = app.books.open('example.xlsx')\nsheet = workbook.sheets[0]\n\n# Enable outlining\nsheet.api.EnableOutlining = True\n\n# Save and close\nworkbook.save()\nworkbook.close()\napp.quit()<\/code><\/pre>\n\n\n\n
        \n
      1. Disabling Outlining and Protecting the Worksheet<\/strong>
        Here, outlining is disabled, and the worksheet is protected to prevent any changes to the outline structure. This is common in finalized reports.<\/li>\n<\/ol>\n\n\n\n
        import xlwings as xw\n\napp = xw.App(visible=False)\nworkbook = app.books.open('report.xlsx')\nsheet = workbook.sheets['Summary']\n\n# Disable outlining to lock grouping features\nsheet.api.EnableOutlining = False\n\n# Protect the worksheet (optional: add a password)\nsheet.api.Protect(Password=\"your_password\", AllowFormattingCells=True)\n\nworkbook.save('report_locked.xlsx')\nworkbook.close()\napp.quit()<\/code><\/pre>\n\n\n\n
          \n
        1. Checking the Current Outlining Status<\/strong>
          You can also retrieve the current value of EnableOutlining<\/code> to conditionally modify the worksheet.<\/li>\n<\/ol>\n\n\n\n
          import xlwings as xw\n\napp = xw.App(visible=False)\nworkbook = app.books.open('data.xlsx')\nsheet = workbook.sheets[0]\n\n# Get the current outlining status\nis_outlining_enabled = sheet.api.EnableOutlining\nprint(f\"Outlining is enabled: {is_outlining_enabled}\")\n\n# If disabled, enable it\nif not is_outlining_enabled:\n    sheet.api.EnableOutlining = True\n    workbook.save()\n\nworkbook.close()\napp.quit()<\/code><\/pre>\n\n\n\n
          <\/p>\n","protected":false},"excerpt":{"rendered":"
          **EnableOutlining Property in xlwings**<\/p>\n
          In Excel's object model, the `EnableOutlining` property of …<\/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-2321","post","type-post","status-publish","format-standard","hentry","category-xlwings-api-reference"],"_links":{"self":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2321","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=2321"}],"version-history":[{"count":1,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2321\/revisions"}],"predecessor-version":[{"id":3538,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2321\/revisions\/3538"}],"wp:attachment":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/media?parent=2321"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/categories?post=2321"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/tags?post=2321"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}