How to use Application.DisplayDocumentActionTaskPane in the xlwings API way

The DisplayDocumentActionTaskPane property of the Application object in Excel’s object model controls the visibility of the Document Actions task pane, which is used for working with smart documents and XML expansions. In xlwings, this functionality is exposed through the api property, allowing direct access to the underlying Excel VBA object model. This property is particularly useful when automating workbooks that utilize smart document solutions or XML mappings, enabling developers to programmatically show or hide the associated task pane to streamline the user interface during automated processes.

Functionality:
The DisplayDocumentActionTaskPane property is a read/write Boolean property that determines whether the Document Actions task pane is displayed in the Excel application window. When set to True, the task pane is visible; when False, it is hidden. This can enhance user experience by automatically managing task pane visibility based on the context of the automation script, such as hiding it during data processing to reduce clutter or showing it when user interaction with smart document features is required.

Syntax in xlwings:
In xlwings, you access this property via the Application object obtained from a workbook or app instance. The typical syntax is:

app = xw.App() # Get the Excel application instance
app.api.DisplayDocumentActionTaskPane = True # Set to True to display, False to hide
current_state = app.api.DisplayDocumentActionTaskPane # Read the current state

Here, app.api provides the raw Excel VBA object model interface. The DisplayDocumentActionTaskPane property does not take any parameters; it simply gets or sets a Boolean value. Note that this property may not be available in all Excel versions or configurations, particularly if smart document features are not enabled. It is recommended to check the Excel environment or handle potential errors when using it.

Code Examples:
Below are practical examples demonstrating how to use DisplayDocumentActionTaskPane with xlwings in Python.

1. Displaying the Document Actions Task Pane:
   This example shows how to make the task pane visible when opening a workbook that uses smart document functionality.

import xlwings as xw

# Start Excel and open a workbook
app = xw.App(visible=True)
workbook = app.books.open('SmartDocument.xlsx')

# Display the Document Actions task pane
app.api.DisplayDocumentActionTaskPane = True
print("Document Actions task pane is now visible.")

# Keep the application open for demonstration
input("Press Enter to hide the task pane and close...")

# Hide the task pane before closing
app.api.DisplayDocumentActionTaskPane = False
app.quit()

2. Toggling Task Pane Visibility Based on Content:
   In this example, the script checks for XML mappings in a workbook and toggles the task pane accordingly.

import xlwings as xw

app = xw.App(visible=True)
wb = app.books.open('DataWithXML.xlsx')

# Check if the workbook has XML maps (simplified condition)
has_xml_maps = len(wb.api.XmlMaps) > 0

if has_xml_maps:
    app.api.DisplayDocumentActionTaskPane = True
    print("XML maps detected. Document Actions task pane displayed.")
else:
    app.api.DisplayDocumentActionTaskPane = False
    print("No XML maps found. Task pane hidden.")

# Perform some data operations
sheet = wb.sheets[0]
sheet.range('A1').value = 'Updated Data'

# Hide task pane after operations
app.api.DisplayDocumentActionTaskPane = False
wb.save()
app.quit()

3. Reading the Current State:
   This example retrieves the current visibility status of the task pane for logging or conditional logic.

import xlwings as xw

app = xw.App(visible=True)
wb = app.books.add()

# Read the current display state
is_displayed = app.api.DisplayDocumentActionTaskPane
print(f"Document Actions task pane visible: {is_displayed}")

# Toggle based on current state
if not is_displayed:
    app.api.DisplayDocumentActionTaskPane = True
    print("Task pane has been turned on.")

app.quit()