{"id":2000,"date":"2026-04-13T15:49:27","date_gmt":"2026-04-13T07:49:27","guid":{"rendered":"https:\/\/xlwings.net\/blog\/?p=2000"},"modified":"2026-03-28T04:38:15","modified_gmt":"2026-03-28T04:38:15","slug":"how-to-use-applicationmacrooptions-in-the-xlwings-api-way","status":"publish","type":"post","link":"https:\/\/xlwings.net\/blog\/how-to-use-applicationmacrooptions-in-the-xlwings-api-way\/","title":{"rendered":"How to use Application.MacroOptions in the xlwings API way"},"content":{"rendered":"\n

The MacroOptions<\/strong> member of the Application<\/strong> object in Excel’s object model provides a way to configure settings related to macros, particularly the Macro Recorder<\/strong>. This is useful for developers who need to programmatically control how macros are recorded, such as setting the description, shortcut key, or category for a newly recorded macro. While the primary interface is through Excel VBA, xlwings allows you to access and manipulate this functionality from Python, enabling automation of macro-related setups in Excel workbooks.<\/p>\n\n\n\n

In xlwings, you can access the MacroOptions<\/strong> method through the api<\/code> property of an App<\/code> or Book<\/code> object, which exposes the underlying Excel object model. The syntax for calling MacroOptions<\/strong> in xlwings closely mirrors its VBA counterpart, but adapted for Python. The general format is:<\/p>\n\n\n\n

app.api.MacroOptions(Macro, Description, HasMenu, MenuText, HasShortcutKey, ShortcutKey, Category, StatusBar, HelpContextID, HelpFile)<\/code><\/pre>\n\n\n\n
Here, app<\/code> is an instance of xlwings.App<\/code>, representing the Excel application. The parameters are optional and correspond to the settings you can configure for a macro. Below is a table detailing each parameter:<\/p>\n\n\n\n
Parameter<\/th>Type<\/th>Description<\/th>Default Value in xlwings (if omitted)<\/th><\/tr><\/thead>
Macro<\/code><\/td>String<\/td>The name of the macro (e.g., “MyMacro”).<\/td>Required; no default.<\/td><\/tr>
Description<\/code><\/td>String<\/td>A description for the macro.<\/td>None<\/code> (ignored).<\/td><\/tr>
HasMenu<\/code><\/td>Boolean<\/td>True<\/code> to add the macro to a menu; False<\/code> otherwise.<\/td>None<\/code> (ignored).<\/td><\/tr>
MenuText<\/code><\/td>String<\/td>The text to display in the menu if HasMenu<\/code> is True<\/code>.<\/td>None<\/code> (ignored).<\/td><\/tr>
HasShortcutKey<\/code><\/td>Boolean<\/td>True<\/code> to assign a shortcut key; False<\/code> otherwise.<\/td>None<\/code> (ignored).<\/td><\/tr>
ShortcutKey<\/code><\/td>String<\/td>The shortcut key (e.g., “Ctrl+Shift+M”).<\/td>None<\/code> (ignored).<\/td><\/tr>
Category<\/code><\/td>String<\/td>The category for the macro (e.g., “Custom Functions”).<\/td>None<\/code> (ignored).<\/td><\/tr>
StatusBar<\/code><\/td>String<\/td>Text to display in the status bar when the macro is selected.<\/td>None<\/code> (ignored).<\/td><\/tr>
HelpContextID<\/code><\/td>Long<\/td>The context ID for Help.<\/td>None<\/code> (ignored).<\/td><\/tr>
HelpFile<\/code><\/td>String<\/td>The path to the Help file.<\/td>None<\/code> (ignored).<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
In practice, you can use this method to set options for an existing macro or to pre-configure settings before recording. For example, to set a description and shortcut key for a macro named “TestMacro” in an active Excel workbook, you can write the following xlwings code:<\/p>\n\n\n\n
import xlwings as xw\n\n# Connect to the active Excel instance or start a new one\napp = xw.apps.active\n\n# Configure macro options for \"TestMacro\"\napp.api.MacroOptions(\nMacro=\"TestMacro\",\nDescription=\"This macro performs a data cleanup operation.\",\nHasShortcutKey=True,\nShortcutKey=\"Ctrl+Shift+T\"\n)<\/code><\/pre>\n\n\n\n
<\/p>\n","protected":false},"excerpt":{"rendered":"
The **MacroOptions** member of the **Application** object in Excel's object model provides a way to …<\/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-2000","post","type-post","status-publish","format-standard","hentry","category-xlwings-api-reference"],"_links":{"self":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2000","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=2000"}],"version-history":[{"count":1,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2000\/revisions"}],"predecessor-version":[{"id":3048,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2000\/revisions\/3048"}],"wp:attachment":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/media?parent=2000"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/categories?post=2000"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/tags?post=2000"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}