libxlsxwriter
doc_custom_properties.c
<< doc_properties.c worksheet_protection.c >>

Example of setting Excel custom document properties, i.e., properties non-standard document properties.

/*
* Example of setting custom document properties for an Excel spreadsheet
* using libxlsxwriter.
*
* Copyright 2014-2018, John McNamara, jmcnamara@cpan.org
*
*/
#include "xlsxwriter.h"
int main() {
lxw_workbook *workbook = workbook_new("doc_custom_properties.xlsx");
lxw_worksheet *worksheet = workbook_add_worksheet(workbook, NULL);
lxw_datetime datetime = {2016, 12, 12, 0, 0, 0.0};
/* Set some custom document properties in the workbook. */
workbook_set_custom_property_string (workbook, "Checked by", "Eve");
workbook_set_custom_property_datetime(workbook, "Date completed", &datetime);
workbook_set_custom_property_number (workbook, "Document number", 12345);
workbook_set_custom_property_number (workbook, "Reference number", 1.2345);
workbook_set_custom_property_boolean (workbook, "Has Review", 1);
workbook_set_custom_property_boolean (workbook, "Signed off", 0);
/* Add some text to the file. */
worksheet_set_column(worksheet, 0, 0, 50, NULL);
worksheet_write_string(worksheet, 0, 0,
"Select 'Workbook Properties' to see properties." , NULL);
workbook_close(workbook);
return 0;
}
workbook_close
lxw_error workbook_close(lxw_workbook *workbook)
Close the Workbook object and write the XLSX file.
workbook_new
lxw_workbook * workbook_new(const char *filename)
Create a new workbook object.
workbook_set_custom_property_datetime
lxw_error workbook_set_custom_property_datetime(lxw_workbook *workbook, const char *name, lxw_datetime *datetime)
Set a custom document date or time property.
lxw_worksheet
Struct to represent an Excel worksheet.
Definition: worksheet.h:1603
workbook_set_custom_property_number
lxw_error workbook_set_custom_property_number(lxw_workbook *workbook, const char *name, double value)
Set a custom document number property.
workbook_set_custom_property_boolean
lxw_error workbook_set_custom_property_boolean(lxw_workbook *workbook, const char *name, uint8_t value)
Set a custom document boolean property.
lxw_datetime
Struct to represent a date and time in Excel.
Definition: common.h:152
lxw_workbook
Struct to represent an Excel workbook.
Definition: workbook.h:273
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.
workbook_set_custom_property_string
lxw_error workbook_set_custom_property_string(lxw_workbook *workbook, const char *name, const char *value)
Set a custom document text property.