{"id":2035,"date":"2026-05-01T07:00:59","date_gmt":"2026-04-30T23:00:59","guid":{"rendered":"https:\/\/xlwings.net\/blog\/?p=2035"},"modified":"2026-03-28T05:29:11","modified_gmt":"2026-03-28T05:29:11","slug":"how-to-use-applicationassistance-in-the-xlwings-api-way","status":"publish","type":"post","link":"https:\/\/xlwings.net\/blog\/how-to-use-applicationassistance-in-the-xlwings-api-way\/","title":{"rendered":"How to use Application.Assistance in the xlwings API way"},"content":{"rendered":"\n

The Application.Assistance<\/code> member in Excel’s object model provides access to the Help system, allowing developers to display specific Help topics programmatically. In xlwings, this functionality is exposed through the api<\/code> property, which grants direct access to the underlying Excel VBA object model. This is particularly useful for creating user-friendly applications where context-sensitive help can be triggered based on user actions or inputs.<\/p>\n\n\n\n

Functionality:<\/strong>
The primary purpose of Application.Assistance<\/code> is to show a designated Help topic to the user. It can display built-in Excel Help topics using their unique Help IDs, which are often numeric or string identifiers. This enables developers to guide users directly to relevant documentation without requiring them to manually search through the Help system.<\/p>\n\n\n\n

Syntax:<\/strong>
In xlwings, the syntax to call this member is:<\/p>\n\n\n\n

app.api.Assistance.ShowHelp(HelpFile, HelpContextID)<\/code><\/pre>\n\n\n\n
    \n
  • HelpFile<\/code>: This is a string parameter that specifies the name of the Help file. For built-in Excel Help, this is typically set to \"\"<\/code> (an empty string) or None<\/code> to use the default Excel Help file. If using a custom Help file, provide its full path or name.<\/li>\n\n\n\n
  • HelpContextID<\/code>: This parameter can be a string or numeric value that identifies the specific Help topic. For Excel’s built-in topics, this ID is often a numeric code corresponding to a particular subject. The exact IDs can be found in Excel’s VBA object model documentation or through developer resources. For example, the Help ID for the “Format Cells” dialog is \"xlMainWindow\"<\/code> or a specific numeric ID like 27010<\/code> for certain topics.<\/li>\n<\/ul>\n\n\n\n
    Example:<\/strong>
    Below is an xlwings code example that demonstrates how to use Application.Assistance<\/code> to display a Help topic. This example assumes Excel is already running and a workbook is open via xlwings.<\/p>\n\n\n\n
    import xlwings as xw\n\n# Connect to the active Excel instance\napp = xw.apps.active\n\n# Display a built-in Excel Help topic, e.g., for general assistance\n# Using an empty string for HelpFile defaults to Excel's Help\n# The HelpContextID \"xlMainWindow\" opens the main Help window\napp.api.Assistance.ShowHelp(HelpFile=\"\", HelpContextID=\"xlMainWindow\")\n\n# Alternatively, to show a specific topic by numeric ID (example ID)\n# This might open a topic like \"About Excel\" (ID varies by version)\napp.api.Assistance.ShowHelp(HelpFile=\"\", HelpContextID=27010)\n\n# For a custom Help file (if available), specify the file path\n# app.api.Assistance.ShowHelp(HelpFile=\"C:\\\\Help\\\\CustomHelp.chm\", HelpContextID=100)<\/code><\/pre>\n\n\n\n
    Notes:<\/strong><\/p>\n\n\n\n
      \n
    • The effectiveness of this method depends on the availability and correctness of Help IDs. Some IDs may change between Excel versions, so testing across versions is recommended.<\/li>\n\n\n\n
    • If the HelpFile<\/code> parameter is left empty and a valid HelpContextID<\/code> is provided, Excel will attempt to open the corresponding topic in its default Help system.<\/li>\n\n\n\n
    • In cases where the Help topic cannot be found, Excel may display a generic Help window or an error, depending on the version.<\/li>\n<\/ul>\n\n\n\n
      <\/p>\n","protected":false},"excerpt":{"rendered":"
      The `Application.Assistance` member in Excel's object model provides access to the Help system, allo…<\/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-2035","post","type-post","status-publish","format-standard","hentry","category-xlwings-api-reference"],"_links":{"self":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2035","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=2035"}],"version-history":[{"count":1,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2035\/revisions"}],"predecessor-version":[{"id":3110,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2035\/revisions\/3110"}],"wp:attachment":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/media?parent=2035"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/categories?post=2035"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/tags?post=2035"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}