libxlsxwriter
macro.c
<< worksheet_protection.c comments1.c >>

Example adding a VBA macro to a workbook.

/*****************************************************************************
*
* An example of adding macros to a libxlsxwriter file using a VBA project
* file extracted from an existing Excel .xlsm file.
*
* The vba_extract.py utility from the libxlsxwriter examples directory can be
* used to extract the vbaProject.bin file.
*
* This example connects the macro to a button (the only Excel/VBA form object
* supported by libxlsxwriter) but that isn't a requirement for adding a macro
* file to the workbook.
*
* Copyright 2014-2021, John McNamara, jmcnamara@cpan.org
*/
#include "xlsxwriter.h"
int main() {
/* Note the xlsm extension of the filename */
lxw_workbook *workbook = workbook_new("macro.xlsm");
lxw_worksheet *worksheet = workbook_add_worksheet(workbook, NULL);
worksheet_set_column(worksheet, COLS("A:A"), 30, NULL);
/* Add a macro file extracted from an Excel workbook. */
workbook_add_vba_project(workbook, "vbaProject.bin");
worksheet_write_string(worksheet, 2, 0, "Press the button to say hello.", NULL);
lxw_button_options options = {.caption = "Press Me", .macro = "say_hello",
.width = 80, .height = 30};
worksheet_insert_button(worksheet, 2, 1, &options);
return workbook_close(workbook);
}
lxw_button_options
Options for inserted buttons.
Definition: worksheet.h:1900
workbook_close
lxw_error workbook_close(lxw_workbook *workbook)
Close the Workbook object and write the XLSX file.
worksheet_insert_button
lxw_error worksheet_insert_button(lxw_worksheet *worksheet, lxw_row_t row, lxw_col_t col, lxw_button_options *options)
Insert a button object into a worksheet.
workbook_new
lxw_workbook * workbook_new(const char *filename)
Create a new workbook object.
lxw_worksheet
Struct to represent an Excel worksheet.
Definition: worksheet.h:2107
workbook_add_vba_project
lxw_error workbook_add_vba_project(lxw_workbook *workbook, const char *filename)
Add a vbaProject binary to the Excel workbook.
COLS
#define COLS(cols)
Convert an Excel A:B column range into a (col1, col2) pair.
Definition: utility.h:63
lxw_workbook
Struct to represent an Excel workbook.
Definition: workbook.h:280
worksheet_write_string
lxw_error worksheet_write_string(lxw_worksheet *worksheet, lxw_row_t row, lxw_col_t col, const char *string, lxw_format *format)
Write a string to a worksheet cell.
worksheet_set_column
lxw_error worksheet_set_column(lxw_worksheet *worksheet, lxw_col_t first_col, lxw_col_t last_col, double width, lxw_format *format)
Set the properties for one or more columns of cells.
workbook_add_worksheet
lxw_worksheet * workbook_add_worksheet(lxw_workbook *workbook, const char *sheetname)
Add a new worksheet to a workbook.
lxw_button_options::caption
char * caption
Definition: worksheet.h:1905