{"id":2253,"date":"2026-08-18T07:07:37","date_gmt":"2026-08-17T23:07:37","guid":{"rendered":"https:\/\/xlwings.net\/blog\/?p=2253"},"modified":"2026-03-28T11:56:49","modified_gmt":"2026-03-28T11:56:49","slug":"how-to-use-workbookitem-in-the-xlwings-api-way","status":"publish","type":"post","link":"https:\/\/xlwings.net\/blog\/how-to-use-workbookitem-in-the-xlwings-api-way\/","title":{"rendered":"How to use Workbook.Item in the xlwings API way"},"content":{"rendered":"\n

The Item<\/code> member of the Workbook<\/code> object in the Excel object model is a property that provides access to individual worksheets or charts within a workbook by their index number or name. In xlwings, this functionality is not exposed through an explicit Item<\/code> property as in VBA, but is instead accessed directly through the workbook’s indexing or via methods like .sheets[]<\/code>. This design offers a more Pythonic and intuitive way to retrieve specific sheets, aligning with common Python container behaviors.<\/p>\n\n\n\n

Functionality<\/strong>
The primary function is to return a single Sheet<\/code> object (which can be a Worksheet<\/code> or Chart<\/code> object) from the Sheets<\/code> collection of a workbook. This allows for targeted operations on a specific sheet, such as reading data, writing values, or formatting cells, without needing to activate or select it first.<\/p>\n\n\n\n

Syntax & Parameters<\/strong>
In xlwings, you access a sheet by its index or name using the sheets<\/code> property of a Book<\/code> object (xlwings’ equivalent of a Workbook<\/code>). The syntax is:<\/p>\n\n\n\n

sheet = wb.sheets[index_or_name]<\/code><\/pre>\n\n\n\n
    \n
  • wb<\/code>: The xlwings Book<\/code> object instance.<\/li>\n\n\n\n
  • index_or_name<\/code>: This parameter can be:<\/li>\n\n\n\n
  • An int<\/code> representing the sheet’s position (1-based index). For example, 1<\/code> refers to the first sheet tab from the left.<\/li>\n\n\n\n
  • A str<\/code> representing the exact name of the sheet as it appears on its tab.<\/li>\n<\/ul>\n\n\n\n
    Unlike the VBA Item<\/code> property, xlwings does not use a separate property call; the indexing is performed directly on the sheets<\/code> collection.<\/p>\n\n\n\n
    Code Examples<\/strong>
    Here are practical examples demonstrating how to use this functionality in xlwings:<\/p>\n\n\n\n
      \n
    1. Accessing a sheet by its index:<\/strong><\/li>\n<\/ol>\n\n\n\n
      import xlwings as xw\n# Connect to an existing workbook (ensure Excel is open or use app.books.open)\napp = xw.App(visible=False)\nwb = app.books.open(r'C:\\path\\to\\your\\workbook.xlsx')\n# Access the first worksheet in the workbook\nfirst_sheet = wb.sheets[1]\n# Read a value from cell A1 of the first sheet\nvalue_a1 = first_sheet.range('A1').value\nprint(value_a1)\nwb.close()\napp.quit()<\/code><\/pre>\n\n\n\n
        \n
      1. Accessing a sheet by its name:<\/strong><\/li>\n<\/ol>\n\n\n\n
        import xlwings as xw\n# Start a new instance of Excel and create a new workbook\napp = xw.App()\nwb = app.books.add()\n# Rename the first sheet for demonstration\nwb.sheets[0].name = 'SalesData'\n# Access the sheet by its exact name\nsales_sheet = wb.sheets['SalesData']\n# Write a value to cell B5\nsales_sheet.range('B5').value = 'Quarterly Revenue'\n# Save and close\nwb.save('report.xlsx')\nwb.close()\napp.quit()<\/code><\/pre>\n\n\n\n
          \n
        1. Iterating through all sheets using the collection:<\/strong>
          While the Item<\/code> concept is for single access, you can loop through the sheets<\/code> collection, which is the parent of the Item<\/code>.<\/li>\n<\/ol>\n\n\n\n
          import xlwings as xw\nwb = xw.Book('data_workbook.xlsx')\n# Print the name of every sheet in the workbook\nfor sheet in wb.sheets:\n    print(sheet.name)\n    # You could perform operations on each 'sheet' object here\nwb.close()<\/code><\/pre>\n\n\n\n
          <\/p>\n","protected":false},"excerpt":{"rendered":"
          The `Item` member of the `Workbook` object in the Excel object model is a property that provides acc…<\/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-2253","post","type-post","status-publish","format-standard","hentry","category-xlwings-api-reference"],"_links":{"self":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2253","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=2253"}],"version-history":[{"count":2,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2253\/revisions"}],"predecessor-version":[{"id":3442,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2253\/revisions\/3442"}],"wp:attachment":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/media?parent=2253"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/categories?post=2253"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/tags?post=2253"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}