xlsxwriter.workbook

@page workbook_page The Workbook object

The Workbook is the main object exposed by the libxlsxwriter library. It represents the entire spreadsheet as you see it in Excel and internally it represents the Excel file as it is written on disk.

See @ref workbook.h for full details of the functionality.

@file workbook.h

@brief Functions related to creating an Excel xlsx workbook.

The Workbook is the main object exposed by the libxlsxwriter library. It represents the entire spreadsheet as you see it in Excel and internally it represents the Excel file as it is written on disk.

@code #include "xlsxwriter.h"

int main() {

lxw_workbook *workbook = workbook_new("filename.xlsx"); lxw_worksheet *worksheet = workbook_add_worksheet(workbook, NULL);

worksheet_write_string(worksheet, 0, 0, "Hello Excel", NULL);

return workbook_close(workbook); } @endcode

@image html workbook01.png

Members

Enums

lxw_workbook_error enum lxw_workbook_error: @brief Error codes from workbook functions.

Functions

lxw_workbook_assemble_xml_file void lxw_workbook_assemble_xml_file(lxw_workbook* workbook): Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
lxw_workbook_free void lxw_workbook_free(lxw_workbook* workbook): Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
lxw_workbook_set_default_xf_indices void lxw_workbook_set_default_xf_indices(lxw_workbook* workbook): Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
new_workbook lxw_workbook* new_workbook(char* filename): Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
new_workbook_opt lxw_workbook* new_workbook_opt(char* filename, lxw_workbook_options* options): Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
workbook_add_chart lxw_chart* workbook_add_chart(lxw_workbook* workbook, uint8_t chart_type): @brief Create a new chart to be added to a worksheet:
workbook_add_format lxw_format* workbook_add_format(lxw_workbook* workbook): @brief Create a new @ref format.h "Format" object to formats cells in worksheets.
workbook_add_worksheet lxw_worksheet* workbook_add_worksheet(lxw_workbook* workbook, char* sheetname): @brief Add a new worksheet to a workbook:
workbook_close lxw_error workbook_close(lxw_workbook* workbook): @brief Close the Workbook object and write the XLSX file.
workbook_define_name lxw_error workbook_define_name(lxw_workbook* workbook, char* name, char* formula): @brief Create a defined name in the workbook to use as a variable.
workbook_new lxw_workbook* workbook_new(char* filename): @brief Create a new workbook object.
workbook_new_opt lxw_workbook* workbook_new_opt(char* filename, lxw_workbook_options* options): @brief Create a new workbook object, and set the workbook options.
workbook_set_properties lxw_error workbook_set_properties(lxw_workbook* workbook, lxw_doc_properties* properties): @brief Set the document properties such as Title, Author etc.

Manifest constants

LXW_DEFINED_NAME_LENGTH enum LXW_DEFINED_NAME_LENGTH;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Structs

lxw_doc_properties struct lxw_doc_properties: Workbook document properties.
lxw_workbook struct lxw_workbook: @brief Struct to represent an Excel workbook.
lxw_workbook_options struct lxw_workbook_options: @brief Workbook options.