Blog

How to use Application.ThisCell in the xlwings API way

The Application.ThisCell property in the Excel object model provides a powerful way to reference the cell in which the user-defined function (UDF) is being called from within the function’s code. In xlwings, this functionality is primarily accessed when you are writing custom functions (UDFs) that are called from Excel cells. It allows your Python function to know exactly which cell invoked it, enabling dynamic references and context-aware calculations. This is especially useful for creating intelligent UDFs that can adapt based on their location in a worksheet.

Syntax in xlwings:
Within a Python function decorated as a UDF with @xw.func, you can access ThisCell through the caller argument provided by xlwings. The caller object represents the calling cell. The typical way to use it is:

import xlwings as xw

@xw.func
def my_udf():
caller = xw.Range('ThisCell') # Not directly correct in this context; see below.

However, the direct equivalent is achieved by using the caller parameter in the function signature. When xlwings calls your UDF, it can pass the calling range. The correct approach is:

@xw.func
def my_udf(caller):
    # 'caller' is an xlwings Range object representing the cell where the UDF is entered.
    cell_address = caller.address
    sheet_name = caller.sheet.name
    # You can now use caller to get or set properties of that cell.

Here, caller is a parameter that xlwings automatically provides when the function is called from Excel. It is an instance of xlwings.Range, representing the single cell where the UDF formula resides. You do not need to pass this argument manually from Excel; xlwings handles it. The caller gives you access to all properties and methods of the Range object, such as address, value, formula, or adjacent cells.

Key Parameters and Usage:

• caller (xlwings.Range): The Range object for the calling cell. It is passed automatically by xlwings when the UDF is invoked from an Excel cell. You can inspect its properties:
• caller.address: Returns the address (e.g., “A1”).
• caller.value: Gets or sets the cell’s value.
• caller.sheet: Accesses the parent worksheet.
• caller.row and caller.column: Get the row and column numbers.

This mechanism is analogous to Excel’s Application.ThisCell in VBA, which returns a Range object for the cell containing the UDF. In xlwings, it enables UDFs to be context-sensitive.

Code Examples:

1. Basic Example: Returning the Calling Cell’s Address
   This UDF returns the address of the cell it is called from, demonstrating how to access the caller’s location.

import xlwings as xw

@xw.func
def get_cell_address(caller):
    return f"The UDF is in cell {caller.address} on sheet '{caller.sheet.name}'."

# In Excel, if you enter =get_cell_address() in cell B5, it returns:
# "The UDF is in cell $B$5 on sheet 'Sheet1'."

2. Dynamic Calculation Based on Adjacent Cells
   This example shows a UDF that sums the values of cells directly to the left and above the calling cell, using caller to reference adjacent ranges.

@xw.func
def sum_adjacent(caller):
    left_cell = caller.offset(0, -1) # Cell to the left
    above_cell = caller.offset(-1, 0) # Cell above
    # Ensure the referenced cells contain numbers; default to 0 if not.
    left_value = left_cell.value if isinstance(left_cell.value, (int, float)) else 0
    above_value = above_cell.value if isinstance(above_cell.value, (int, float)) else 0
    return left_value + above_value

# If cell C3 contains =sum_adjacent(), it will add values from B3 and C2.

3. Conditional Formatting Simulation
   A UDF that changes the calling cell’s font color based on its value, using caller to modify properties. Note: UDFs typically should not modify other cells due to Excel’s calculation rules, but they can modify the calling cell’s properties in some contexts (though this is often limited; xlwings supports it via the caller object for formatting).

@xw.func
def highlight_if_positive(caller, value):
    if value > 0:
        caller.color = (0, 255, 0) # Green background
    else:
        caller.color = (255, 0, 0) # Red background
    return value # Return the original value for display.

# In Excel, =highlight_if_positive(A1) will color the cell based on A1's value.

4. Creating a UDF That Logs Its Usage
   This example uses caller to record the time and location whenever the UDF is calculated, by writing to a separate log sheet.

import datetime

@xw.func
def logged_calculation(caller, input_value):
    log_sheet = xw.Book.caller().sheets['Log']
    next_row = log_sheet.range('A' +    str(log_sheet.cells.last_cell.row)).end('up').row + 1
    log_sheet.range(f'A{next_row}').value = datetime.datetime.now()
    log_sheet.range(f'B{next_row}').value = caller.address
    log_sheet.range(f'C{next_row}').value = input_value
    return input_value * 2

# This UDF doubles the input and logs each call in a "Log" sheet.

How to use Application.TemplatesPath in the xlwings API way

In Excel, the Application object serves as the top-level object representing the entire Excel application. Among its many members, the TemplatesPath property is a read‑only property that returns the full path to the folder where Excel stores its template files. This is useful when you need to programmatically locate the default template directory, for example to save a custom template or to list available templates. In xlwings, you can access this property through the Application object, which is exposed via the app object when you have an active connection to Excel.

The xlwings API syntax for accessing the TemplatesPath property is straightforward. Since it is a property, you simply reference it without parentheses. The general format is:

app.api.TemplatesPath

Here, app is an instance of the xlwings App class, which corresponds to the Excel Application object. The .api attribute provides direct access to the underlying Excel object model, allowing you to call native Excel properties and methods. The TemplatesPath property returns a string representing the full directory path. No parameters are required because it is a read‑only property.

For example, if you want to retrieve the default templates path and print it, you would use the following code:

import xlwings as xw

# Connect to the active Excel instance or start a new one
app = xw.apps.active

# Get the TemplatesPath
templates_folder = app.api.TemplatesPath
print(f"The default templates path is: {templates_folder}")

This code snippet first imports xlwings and then connects to the currently active Excel application. By accessing app.api.TemplatesPath, it retrieves the path and prints it. The output might look like C:\Users\[Username]\AppData\Roaming\Microsoft\Templates\ on Windows or a corresponding path on macOS.

Another practical use case is to combine the TemplatesPath with other operations, such as saving a workbook as a template in the default location. For instance:

import xlwings as xw
import os

app = xw.apps.active
wb = app.books.active

# Get the templates path and define a new template file name
templates_path = app.api.TemplatesPath
new_template_name = "MyCustomTemplate.xltx"
full_path = os.path.join(templates_path, new_template_name)

# Save the active workbook as a template in the default folder
wb.save(full_path)
print(f"Template saved to: {full_path}")

How to use Application.StatusBar in the xlwings API way

The StatusBar property of the Application object in Excel is a useful feature for providing real-time feedback to users during lengthy operations, such as data processing, calculations, or macro execution. In xlwings, this functionality is accessible through the api property, which provides direct access to the underlying Excel object model. This allows developers to set custom messages, display progress indicators, or clear the status bar, enhancing the user experience in automated Excel tasks.

Functionality
The StatusBar property controls the text displayed in the status bar at the bottom of the Excel window. It can be used to show informative messages, progress updates (e.g., “Processing… 50% complete”), or temporary notifications. When set to False, it clears any custom message and restores Excel’s default status bar display, such as showing “Ready” or calculation status. This is particularly valuable in long-running scripts to keep users informed without interrupting the workflow.

Syntax
In xlwings, the StatusBar property is accessed via the Application object. The basic syntax is:

app = xw.apps.active # Get the active Excel application
app.api.StatusBar = "Your message here" # Set a custom message

To clear the custom message and revert to Excel’s default display:

app.api.StatusBar = False

The property is both readable and writable. You can retrieve the current status bar text by reading app.api.StatusBar, which returns a string if a custom message is set, or False if the default is active. Note that the StatusBar does not accept complex formatting; it only displays plain text. Parameters are not required for setting or clearing—simply assign a string or False as shown.

Code Examples
Here are practical examples of using the StatusBar property with xlwings:

1. Setting a Custom Message: Display a notification during data processing.

import xlwings as xw
app = xw.apps.active
app.api.StatusBar = "Loading data... Please wait."
# Simulate a task, e.g., processing data
import time
time.sleep(2)
app.api.StatusBar = "Data loaded successfully."

2. Showing Progress Updates: Implement a simple progress indicator in a loop.

import xlwings as xw
app = xw.apps.active
total_items = 100
for i in range(total_items):
    progress = (i + 1) / total_items * 100
    app.api.StatusBar = f"Processing... {progress:.1f}% complete"
    # Simulate work, e.g., updating cells
    time.sleep(0.1)
    app.api.StatusBar = False # Clear after completion

3. Clearing the Status Bar: Restore Excel’s default display after an operation.

import xlwings as xw
app = xw.apps.active
app.api.StatusBar = "Task in progress..."
# Perform some operations, e.g., formatting a range
sheet = app.books.active.sheets[0]
sheet.range("A1:A10").value = "Updated"
app.api.StatusBar = False # Revert to default status

4. Reading the Current Status: Check if a custom message is set.

import xlwings as xw
app = xw.apps.active
app.api.StatusBar = "Calculating results..."
current_status = app.api.StatusBar
print(f"Status bar says: {current_status}") # Output: Status bar says: Calculating results...

How to use Application.StartupPath in the xlwings API way

The StartupPath property of the Application object in Excel’s object model is a read-only property that returns the complete path to the startup folder used by Microsoft Excel. This folder is where Excel looks for add-ins, templates, and other files when it starts. In xlwings, you can access this property through the api property of the App or Book objects, which provides a direct gateway to the underlying Excel object model. This is particularly useful for developers who need to programmatically determine the startup directory to manage or load resources that Excel uses during initialization.

Syntax in xlwings:
The property is accessed via the Application object. In xlwings, you typically start by creating an instance of the Excel application or referencing an existing one. The syntax is straightforward:

app = xw.App() # or use xw.apps.active for an existing instance
startup_path = app.api.StartupPath

• app: An instance of the xlwings App class, representing the Excel application.
• api: This attribute provides access to the native Excel object model (via pywin32 on Windows or appscript on macOS).
• StartupPath: The property name, which requires no parameters and returns a string containing the full path.

Key Points:

• The StartupPath property is read-only; you cannot set it directly through xlwings or Excel’s object model to change the startup folder. Modifications to the startup path would typically involve Windows registry settings or Excel options.
• The returned path is system-dependent and may vary based on the Excel version and installation. On Windows, it often points to a directory like C:\Users\[Username]\AppData\Roaming\Microsoft\Excel\XLSTART.
• This property is useful for automating tasks such as checking for the presence of specific add-ins, deploying custom templates, or logging startup configurations in scripts.

Example Code:
Here is a practical example demonstrating how to retrieve and use the StartupPath property in xlwings. This script launches Excel, gets the startup path, and prints it, then lists any files present in that directory:

import xlwings as xw
import os

# Launch Excel application
app = xw.App(visible=True)

# Access the StartupPath property
startup_path = app.api.StartupPath
print(f"Excel Startup Path: {startup_path}")

# Optional: List files in the startup directory (if it exists)
if os.path.exists(startup_path):
    files = os.listdir(startup_path)
    print("Files in startup directory:")
    for file in files:
        print(f" - {file}")
else:
    print("Startup directory does not exist.")

# Close Excel
app.quit()

How to use Application.StandardFontSize in the xlwings API way

The StandardFontSize member of the Application object in Excel allows you to get or set the default font size, measured in points, that is used for new workbooks and standard text styles. This is a global setting within the Excel application instance, meaning it affects the entire environment, not just a specific workbook. By adjusting this property, you can standardize the default appearance of text across newly created documents without manually formatting each cell. This is particularly useful for maintaining corporate branding or ensuring consistency in report generation.

In xlwings, you access this property through the api property of the App object, which provides direct access to the underlying Excel object model. The property is available for both reading and writing.

Syntax:

# To get the current standard font size
current_size = app.api.StandardFontSize

# To set a new standard font size
app.api.StandardFontSize = new_size

• app: An instance of the xlwings App class representing the Excel application.
• current_size: The returned value is a floating-point number representing the font size in points (e.g., 11.0).
• new_size: A numeric value (integer or float) specifying the desired default font size in points. It must be a positive number, typically within the range supported by Excel (e.g., 1 to 409 points). Setting this property immediately changes the application’s default, but note that it does not retroactively alter existing workbooks; it only applies to new workbooks created thereafter.

Example Usage:
Here are practical xlwings code snippets demonstrating how to work with the StandardFontSize property.

1. Retrieving the Current Standard Font Size:

import xlwings as xw

# Connect to the active Excel instance or start a new one
app = xw.apps.active # or xw.App() for a new instance

# Get the current standard font size
default_size = app.api.StandardFontSize
print(f"The current standard font size is {default_size} points.")

2. Setting a New Standard Font Size:

import xlwings as xw

# Start a new Excel application
app = xw.App()

# Set the standard font size to 14 points
app.api.StandardFontSize = 14

# Create a new workbook to see the effect
wb = app.books.add()
ws = wb.sheets[0]
# The default font in cell A1 should now be 14 points
print(f"Standard font size set to {app.api.StandardFontSize} points.")

# Save and close
wb.save('new_workbook.xlsx')
wb.close()
app.quit()

3. Modifying the Setting and Creating Multiple Workbooks:

import xlwings as xw

app = xw.App(visible=False) # Run in background

# Store the original setting for later restoration
original_size = app.api.StandardFontSize
print(f"Original standard font size: {original_size} points")

# Change to a larger font for emphasis
app.api.StandardFontSize = 16

# Generate two new workbooks with the updated default
for i in range(2):
    wb = app.books.add()
    ws = wb.sheets[0]
    ws.range('A1').value = f"This text uses the new standard size of {app.api.StandardFontSize} points."
    wb.save(f'report_{i+1}.xlsx')
    wb.close()

# Restore the original setting
app.api.StandardFontSize = original_size
print(f"Restored to original size: {app.api.StandardFontSize} points")

app.quit()

How to use Application.StandardFont in the xlwings API way

The Application.StandardFont property in Excel refers to the default font name used for new workbooks and worksheets. Through xlwings, this property can be accessed and modified to programmatically control the standard font setting across Excel sessions. This is particularly useful for ensuring consistency in document formatting or adapting the default appearance to corporate style guidelines without manual intervention.

Functionality
This property allows you to retrieve or set the name of the standard font as a string. When you change it, any new workbook created thereafter will use this font as the default for cell text. Note that existing workbooks are not automatically updated; the change applies prospectively. It affects the Excel application instance, making it a global setting.

Syntax in xlwings
In xlwings, you interact with this property via the app object, which represents the Excel Application. The syntax is straightforward:

• To get the current standard font: app.api.StandardFont
• To set a new standard font: app.api.StandardFont = "font_name"

Here, app is your xlwings App instance. The .api attribute provides direct access to the underlying Excel object model (through pywin32 on Windows or appscript on macOS). The StandardFont property expects a string value representing a valid font name installed on the system, such as “Calibri”, “Arial”, or “Times New Roman”. There are no additional parameters.

Code Examples
Below are practical examples demonstrating how to use the StandardFont property with xlwings.

Example 1: Retrieving the Current Standard Font

import xlwings as xw

# Connect to the active Excel instance or start a new one
app = xw.apps.active

# Get the current standard font name
current_font = app.api.StandardFont
print(f"The current standard font is: {current_font}")

Example 2: Setting a New Standard Font

import xlwings as xw

# Ensure Excel is running; start if necessary
app = xw.App(visible=True)

# Set the standard font to Arial
app.api.StandardFont = "Arial"
print("Standard font changed to Arial.")

# Create a new workbook to see the effect
wb = app.books.add()
ws = wb.sheets[0]
ws.range("A1").value = "This text should be in Arial."

# Save and close
wb.save("new_workbook.xlsx")
wb.close()
app.quit()

Example 3: Verifying the Change Across Sessions

import xlwings as xw

# First, set the standard font
app = xw.App(visible=False)
app.api.StandardFont = "Courier New"
app.quit()

# Restart Excel and check
app_new = xw.App(visible=False)
font_check = app_new.api.StandardFont
print(f"After restart, standard font is: {font_check}") # Should be "Courier New"
app_new.quit()

How to use Application.SpellingOptions in the xlwings API way

The SpellingOptions member of the Application object in Excel provides a collection of settings that control how the spelling checker operates. These options are accessible through the xlwings library, allowing Python scripts to programmatically adjust spelling preferences, such as ignoring words in uppercase, flagging repeated words, or setting the language dictionary for proofing. This is particularly useful for automating document review processes, ensuring consistency in spell-checking behavior across multiple workbooks, or integrating custom spelling rules into data preparation workflows.

In xlwings, the SpellingOptions member is accessed via the api property of the Application object, which exposes the underlying Excel object model. The syntax for referencing it is straightforward: app.api.SpellingOptions, where app is an instance of the xlwings Application. This returns a SpellingOptions object with various properties that can be read or set. Most properties are Boolean values (True/False) or enumerations corresponding to Excel constants. For example, to check if the spelling checker ignores words in uppercase, you would use app.api.SpellingOptions.IgnoreUppercase. To modify it, assign a new value like app.api.SpellingOptions.IgnoreUppercase = True. Key properties include:

• IgnoreUppercase: Ignores words in all uppercase letters.
• IgnoreMixedDigits: Ignores words containing numbers.
• SuggestMainOnly: Suggests only main dictionary entries.
• GermanPostReform: Uses German post-reform spelling rules.
• ArabicModes: Sets the Arabic spelling mode (e.g., for text validation).
  These properties map directly to Excel’s VBA SpellingOptions members, and their values can be retrieved or updated to customize spell-checking behavior.

For instance, to configure the spelling checker to ignore uppercase words and mixed digits, you could write:

import xlwings as xw
app = xw.App(visible=False) # Start Excel in background
app.api.SpellingOptions.IgnoreUppercase = True
app.api.SpellingOptions.IgnoreMixedDigits = True
print(f"Ignore uppercase: {app.api.SpellingOptions.IgnoreUppercase}")
app.quit() # Close the application

Another example involves setting language-specific options, such as enabling German post-reform rules:

import xlwings as xw
app = xw.App(visible=True)
app.api.SpellingOptions.GermanPostReform = True
# Perform a spell check on the active sheet
app.api.ActiveSheet.CheckSpelling()
app.quit()

Additionally, you can loop through all SpellingOptions properties to audit current settings:

import xlwings as xw
app = xw.App(visible=False)
options = app.api.SpellingOptions
for prop in ['IgnoreUppercase', 'IgnoreMixedDigits', 'SuggestMainOnly']:
    value = getattr(options, prop)
    print(f"{prop}: {value}")
app.quit()

How to use Application.Speech in the xlwings API way

The Speech member of the Application object in Excel’s object model provides access to text-to-speech functionality, allowing developers to programmatically control speech playback of cell contents. This can be particularly useful for accessibility features, data verification by auditory feedback, or creating interactive tutorials. In xlwings, this functionality is exposed through the api property, which grants direct access to the underlying Excel VBA object model, enabling the use of the Speech object’s methods and properties.

Functionality:
The Speech object primarily controls the speech engine’s behavior, including speaking cell contents, managing speech playback (like pausing or resuming), and adjusting speech properties such as direction (by rows or columns) and speaking order. It allows for dynamic auditory output from spreadsheet data.

Syntax and Parameters:
In xlwings, the Speech member is accessed via app.api.Speech, where app is an instance of xlwings.App. Key methods include:

• Speak(text, speakAsync, speakXML, purge): Speaks the specified text.
• text: A string representing the text to be spoken.
• speakAsync: A boolean; True for asynchronous speech (allows code to continue running), False for synchronous (code waits until speech finishes).
• speakXML: A boolean; if True, interprets text as XML for speech synthesis control.
• purge: A boolean; if True, purges any pending speech before speaking.
• Properties like SpeakCellOnEnter: A boolean property that controls whether Excel speaks the cell contents when the Enter key is pressed. It can be set or retrieved.

Code Examples:
Here are practical examples using xlwings to demonstrate the Speech functionality:

1. Speak a Specific Text Asynchronously:

import xlwings as xw
app = xw.App(visible=True)
# Speak "Hello from Excel" without blocking code execution
app.api.Speech.Speak("Hello from Excel", speakAsync=True)
app.quit()

2. Enable Speaking Cell on Enter:

import xlwings as xw
app = xw.App(visible=True)
workbook = app.books.open('example.xlsx')
# Turn on speech when Enter is pressed in cells
app.api.Speech.SpeakCellOnEnter = True
# Now, when a user presses Enter after editing a cell, its content will be spoken
workbook.save()
app.quit()

3. Speak Cell Contents Programmatically:

import xlwings as xw
app = xw.App(visible=True)
workbook = app.books.open('data.xlsx')
sheet = workbook.sheets['Sheet1']
# Get the value from cell A1 and speak it synchronously
cell_value = sheet.range('A1').value
app.api.Speech.Speak(str(cell_value), speakAsync=False)
app.quit()

How to use Application.SmartArtQuickStyles in the xlwings API way

The SmartArtQuickStyles member of the Application object in Excel refers to a collection that represents the set of SmartArt quick styles available within the application. In the context of xlwings, which provides a Pythonic interface to automate Excel, this collection can be accessed to retrieve information about or apply predefined style formats to SmartArt graphics in a workbook. This is particularly useful for programmatically enhancing the visual appeal of SmartArt diagrams, such as organizational charts or process flows, by applying consistent and professional styling without manual intervention.

Functionality:
The primary function is to enumerate and possibly apply the quick styles to SmartArt objects. Each quick style in the collection defines a combination of fills, lines, and effects that can be applied to a SmartArt graphic to change its overall appearance. Through xlwings, you can access this collection to get the count of available styles or reference specific styles by their index.

Syntax:
In xlwings, the Application object is typically accessed via the app object when you have an instance of Excel running. The SmartArtQuickStyles collection is a property of the Application object. The syntax to access it is:

app.api.SmartArtQuickStyles

This returns a SmartArtQuickStyles object, which is a collection. To interact with it, you can use methods and properties such as Count to get the number of styles, or Item(index) to retrieve a specific SmartArtQuickStyle object by its index (1-based). Note that xlwings uses the .api attribute to expose the underlying Excel object model, so this follows the standard Excel VBA object hierarchy but within Python.

Parameters:

• index: An integer that specifies the position of the quick style in the collection. The index starts at 1. You can determine the total number of styles using the Count property.

Example:
Below is an xlwings code example that demonstrates how to access the SmartArtQuickStyles collection and print the count of available styles. It also shows how to reference a specific style and apply it to an existing SmartArt graphic in the active workbook. This assumes you have an Excel instance running with a workbook open that contains at least one SmartArt graphic.

import xlwings as xw

# Connect to the active Excel instance
app = xw.apps.active

# Access the SmartArtQuickStyles collection
quick_styles = app.api.SmartArtQuickStyles

# Get the number of available quick styles
style_count = quick_styles.Count
print(f"Number of available SmartArt quick styles: {style_count}")

# Check if there are styles available
if style_count > 0:
    # Reference the first quick style in the collection (index 1)
    first_style = quick_styles.Item(1)
    print(f"First quick style name: {first_style.Name}")

# Assume we have a SmartArt graphic in the active sheet
# First, get the active sheet
active_sheet = app.api.ActiveSheet

# Try to access the first SmartArt graphic in the sheet
# Note: In practice, you need to ensure a SmartArt exists; this is simplified.
# Typically, you might loop through shapes to find SmartArt.
# Here, we assume the first shape is SmartArt for demonstration.
shapes = active_sheet.Shapes
if shapes.Count > 0:
# Check if the shape is a SmartArt graphic (Type 24 represents SmartArt in Excel)
target_shape = shapes.Item(1)
if target_shape.Type == 24: # 24 is msoSmartArt, a constant for SmartArt
    # Apply the first quick style to the SmartArt graphic
    target_shape.SmartArt.QuickStyle = first_style
    print("Applied the first quick style to the SmartArt graphic.")
else:
    print("The first shape is not a SmartArt graphic.")
else:
    print("No shapes found in the active sheet.")
else:
    print("No SmartArt quick styles are available.")

# Note: Error handling (e.g., for no SmartArt) should be added in production code.

How to use Application.SmartArtLayouts in the xlwings API way

The SmartArtLayouts member of the Application object in Excel’s object model provides access to the collection of SmartArt layouts available within the application. This collection is essential for programmatically managing and applying different visual layouts to SmartArt graphics, which are used to create professional diagrams and information graphics. Through xlwings, a powerful Python library for Excel automation, developers can interact with this collection to enumerate available layouts, retrieve specific layouts by their index or ID, and apply them to SmartArt shapes in workbooks. This functionality is particularly valuable in automating report generation, dashboard creation, and data visualization tasks where consistent and dynamic diagram styling is required.

In xlwings, the SmartArtLayouts member is accessed via the Application object. The syntax for referencing this collection is straightforward, as it does not require parameters for the property itself. However, when accessing individual layouts within the collection, methods and properties are used with specific arguments. The basic calling format is:

app.smart_art_layouts

Here, app represents an instance of the xlwings App class, which corresponds to the Excel Application object. The smart_art_layouts property returns a collection object that supports typical collection methods such as indexing. To retrieve a specific SmartArtLayout object, you can use an index (1-based) or a layout ID string. For example:

layout = app.smart_art_layouts[1] # Access by index
layout_by_id = app.smart_art_layouts('{LayoutID}') # Access by ID

The index refers to the position in the collection, which may vary based on the Excel version and installed templates. The layout ID is a unique string identifier for each layout, which can be obtained from Excel’s object model or by enumerating the collection. The SmartArtLayout object itself has properties like Id, Name, and Category, which provide details about the layout. For instance, layout.id returns the ID, and layout.name returns the display name. This allows for precise control when selecting layouts based on specific criteria.

A practical use case involves applying a SmartArt layout to an existing SmartArt graphic in a workbook. First, you need to identify the SmartArt shape, then set its layout using the Layout property. Below is an example code snippet that demonstrates this process:

import xlwings as xw

# Connect to the active Excel instance
app = xw.apps.active

# Access the SmartArtLayouts collection and select a layout by index
smartart_layouts = app.smart_art_layouts
target_layout = smartart_layouts[3] # Assuming index 3 corresponds to a desired layout

# Open a workbook and select a worksheet
wb = app.books.open('example.xlsx')
ws = wb.sheets['Sheet1']

# Assume there is a SmartArt graphic in the worksheet; get the first shape (adjust as needed)
smartart_shape = ws.shapes[0] # This should be a SmartArt shape

# Apply the selected layout to the SmartArt graphic
smartart_shape.smart_art.layout = target_layout

# Save and close the workbook
wb.save()
wb.close()

In this example, we connect to Excel, retrieve the third layout from the SmartArtLayouts collection, and apply it to the first shape in a worksheet, assuming it is a SmartArt graphic. This automation can be extended to loop through multiple shapes or workbooks, applying consistent layouts based on dynamic conditions. Additionally, you can enumerate all available layouts to list their properties for reference:

for layout in app.smart_art_layouts:
    print(f"ID: {layout.id}, Name: {layout.name}, Category: {layout.category}")