{"id":2373,"date":"2026-10-17T07:35:41","date_gmt":"2026-10-16T23:35:41","guid":{"rendered":"https:\/\/xlwings.net\/blog\/?p=2373"},"modified":"2026-03-29T10:01:25","modified_gmt":"2026-03-29T10:01:25","slug":"how-to-use-rangecheckspelling-in-the-xlwings-api-way","status":"publish","type":"post","link":"https:\/\/xlwings.net\/blog\/how-to-use-rangecheckspelling-in-the-xlwings-api-way\/","title":{"rendered":"How to use Range.CheckSpelling in the xlwings API way"},"content":{"rendered":"\n

The CheckSpelling<\/code> member of the Range<\/code> object in Excel is a method used to initiate a spell check on the text within a specified cell or range of cells. It mimics the functionality of the built-in spell checker in Excel, allowing developers to programmatically verify and correct spelling errors. This can be particularly useful in automating data validation processes, especially when dealing with user-generated content or imported text data that may contain typos or misspellings. The method returns a Boolean value indicating whether all words in the range are spelled correctly according to the dictionary settings.<\/p>\n\n\n\n

Syntax in xlwings API:<\/strong>
The xlwings library provides a Pythonic way to interact with Excel objects. To use CheckSpelling<\/code> via xlwings, you typically access it through a Range<\/code> object. The method’s signature in xlwings closely follows the Excel object model. The syntax is:<\/p>\n\n\n\n

range_object.api.CheckSpelling(CustomDictionary, IgnoreUppercase, AlwaysSuggest, SpellLang)<\/code><\/pre>\n\n\n\n
Where:<\/p>\n\n\n\n
    \n
  • range_object<\/code> is an xlwings Range<\/code> object, such as sheet.range('A1')<\/code> or sheet.range('A1:B10')<\/code>.<\/li>\n\n\n\n
  • .api<\/code> is used to access the underlying Excel object model (e.g., the COM object in Windows or AppleScript object on Mac).<\/li>\n\n\n\n
  • CheckSpelling<\/code> is the method name.<\/li>\n\n\n\n
  • The parameters are optional and correspond to those in the Excel VBA CheckSpelling<\/code> method. Their meanings and values are as follows:<\/li>\n<\/ul>\n\n\n\n
    Parameter<\/th>Description<\/th>Typical Values<\/th><\/tr><\/thead>
    CustomDictionary<\/code><\/td>A string specifying the filename of the custom dictionary to use. If omitted, the default dictionary is used.<\/td>e.g., \"CUSTOM.DIC\"<\/code> or a path string.<\/td><\/tr>
    IgnoreUppercase<\/code><\/td>A Boolean value. If True<\/code>, words in all uppercase letters are ignored during spell check.<\/td>True<\/code> or False<\/code> (default is False<\/code>).<\/td><\/tr>
    AlwaysSuggest<\/code><\/td>A Boolean value. If True<\/code>, Excel will always suggest alternative spellings when a misspelling is found.<\/td>True<\/code> or False<\/code> (default is False<\/code>).<\/td><\/tr>
    SpellLang<\/code><\/td>The language of the dictionary to use, specified by a language code.<\/td>e.g., 1033<\/code> for English (United States).<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    Example Usage:<\/strong>
    Below are practical xlwings code examples demonstrating how to use the CheckSpelling<\/code> method in different scenarios.<\/p>\n\n\n\n
    Example 1: Basic spell check on a single cell.<\/em>
    This checks the spelling in cell A1 of the active sheet and prints whether all words are correct.<\/p>\n\n\n\n
    import xlwings as xw\n\n# Connect to the active Excel instance and workbook\napp = xw.apps.active\nwb = app.books.active\nsheet = wb.sheets.active\n\n# Define the range (single cell A1)\ntarget_range = sheet.range('A1')\n\n# Perform spell check with default settings\nis_correct = target_range.api.CheckSpelling()\nprint(f\"All words spelled correctly in A1: {is_correct}\")<\/code><\/pre>\n\n\n\n
    Example 2: Spell check on a range with custom parameters.<\/em>
    This checks a range from A1 to B5, ignoring uppercase words and using a specific custom dictionary.<\/p>\n\n\n\n
    import xlwings as xw\n\napp = xw.apps.active\nwb = app.books.active\nsheet = wb.sheets.active\n\n# Define a larger range\ntarget_range = sheet.range('A1:B5')\n\n# Perform spell check, ignoring uppercase words and specifying a custom dictionary\nis_correct = target_range.api.CheckSpelling(CustomDictionary=\"MyCustom.dic\", IgnoreUppercase=True)\nif not is_correct:\n    print(\"Spelling errors found in range A1:B5. Consider reviewing manually.\")<\/code><\/pre>\n\n\n\n
    Example 3: Iterating through a column to check spelling in each cell.<\/em>
    This loops through cells in column A (rows 1 to 10) and marks cells with spelling errors by changing the font color to red.<\/p>\n\n\n\n
    import xlwings as xw\nfrom xlwings import constants\n\napp = xw.apps.active\nwb = app.books.active\nsheet = wb.sheets.active\n\nfor i in range(1, 11):\n    cell = sheet.range(f'A{i}')\n    # Check spelling for each cell\n    is_correct = cell.api.CheckSpelling()\n    if not is_correct:\n        # Highlight misspelled cells in red\n        cell.api.Font.Color = constants.RgbColor.rgbRed\n        print(f\"Spelling error detected in cell A{i}\")<\/code><\/pre>\n\n\n\n
    <\/p>\n","protected":false},"excerpt":{"rendered":"
    The `CheckSpelling` member of the `Range` object in Excel is a method used to initiate a spell check…<\/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-2373","post","type-post","status-publish","format-standard","hentry","category-xlwings-api-reference"],"_links":{"self":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2373","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=2373"}],"version-history":[{"count":1,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2373\/revisions"}],"predecessor-version":[{"id":3615,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2373\/revisions\/3615"}],"wp:attachment":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/media?parent=2373"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/categories?post=2373"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/tags?post=2373"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}