C++ API Reference

• Type aliases

• Enumerations Reference
  • Calculation Enumerations
  • Worksheet Type Enumerations
  • Worksheet Protection Enumerations
  • Cell Data Type Enumerations
  • Built-in number format:
  • Built-in cell styles:
  • Alignment Enumerations
  • Border Enumerations
  • Fill Pattern Enumerations
  • Text Formatting Enumerations
  • Table Function Enumerations
  • Measurement Unit Enumerations
  • Shape and Object Enumerations
  • Printing Enumerations
  • Paper Size Constants
  • Usage Examples

• Utilities Interface
  • Global Functions
    • run_msg()
    • String Conversion
    • Cell Reference Conversion
    • Color Encoding and Decoding
    • Date and Time Operations
  • Usage Examples
    • String Conversion
    • Cell Reference Conversion
    • Color Operations
    • Date/Time Operations
  • Notes

• Document Interface
  • Classes
    • iDocument
      • iDocument::get_workbook()
      • iDocument::save()
      • iDocument::release()
  • Global Functions
    • create_document()
    • load_document()
    • lib_version()
  • Usage Example

• Workbook Interface
  • Classes
    • iWorkbook
      • iWorkbook::is_date1904()
      • iWorkbook::set_date1904()
      • iWorkbook::is_a1_ref_mode()
      • iWorkbook::set_a1_ref_mode()
      • iWorkbook::get_calc_mode()
      • iWorkbook::set_calc_mode()
      • iWorkbook::add_worksheet()
      • iWorkbook::insert_worksheet()
      • iWorkbook::shift_sheet()
      • iWorkbook::delete_sheet()
      • iWorkbook::sheet_count()
      • iWorkbook::get_sheet()
      • iWorkbook::sheet_type()
      • iWorkbook::get_sheet_state()
      • iWorkbook::set_sheet_state()
      • iWorkbook::sheet_name()
      • iWorkbook::rename_sheet()
      • iWorkbook::get_active_sheet()
      • iWorkbook::set_active_sheet()
      • iWorkbook::set_defined_name()
      • iWorkbook::defined_name_num()
      • iWorkbook::get_defined_name()
      • iWorkbook::get_local_name()
      • iWorkbook::get_defined_name_expr()
      • iWorkbook::delete_defined_name()
      • iWorkbook::get_named_style()
      • iWorkbook::add_custom_style()
      • iWorkbook::modify_named_style()
      • iWorkbook::make_normal_style()
      • iWorkbook::make_richtext()
  • Usage Example

• Worksheet Interface
  • Classes
    • iWorksheet
      • iWorksheet::min_row()
      • iWorksheet::min_col()
      • iWorksheet::max_row()
      • iWorksheet::max_col()
      • iWorksheet::name()
      • iWorksheet::set_name()
      • iWorksheet::sheet_type()
      • iWorksheet::get_sheet_state()
      • iWorksheet::cell_type()
      • iWorksheet::contains_formula()
      • iWorksheet::contains_richtext()
      • iWorksheet::get_num()
      • iWorksheet::get_text()
      • iWorksheet::get_boolean()
      • iWorksheet::get_datetime()
      • iWorksheet::get_richtext()
      • iWorksheet::get_formula_expr()
      • iWorksheet::get_error()
      • iWorksheet::set_num()
      • iWorksheet::set_text()
      • iWorksheet::set_boolean()
      • iWorksheet::set_datetime()
      • iWorksheet::set_richtext()
      • iWorksheet::set_error()
      • iWorksheet::set_formula()
      • iWorksheet::set_formula_num()
      • iWorksheet::set_formula_string()
      • iWorksheet::set_formula_boolean()
      • iWorksheet::set_formula_datetime()
      • iWorksheet::set_formula_error()
      • iWorksheet::clear_contents()
      • iWorksheet::set_cell_style()
      • iWorksheet::cell_style()
      • iWorksheet::get_style()
      • iWorksheet::set_range_style()
      • iWorksheet::is_default_row_height()
      • iWorksheet::get_custom_row_height()
      • iWorksheet::set_custom_row_height()
      • iWorksheet::is_default_col_width()
      • iWorksheet::get_custom_col_width()
      • iWorksheet::set_custom_col_width()
      • iWorksheet::row_style()
      • iWorksheet::remove_row_style()
      • iWorksheet::set_row_style()
      • iWorksheet::col_style()
      • iWorksheet::remove_col_style()
      • iWorksheet::set_col_style()
      • iWorksheet::row_hidden()
      • iWorksheet::set_row_hidden()
      • iWorksheet::col_hidden()
      • iWorksheet::set_col_hidden()
      • iWorksheet::insert_row()
      • iWorksheet::delete_row()
      • iWorksheet::insert_col()
      • iWorksheet::delete_col()
      • iWorksheet::shift_range_down()
      • iWorksheet::shift_range_up()
      • iWorksheet::shift_range_right()
      • iWorksheet::shift_range_left()
      • iWorksheet::set_bg_picture()
      • iWorksheet::add_cell_image()
      • iWorksheet::add_image_with_two_cells()
      • iWorksheet::add_image_with_one_cell()
      • iWorksheet::add_absolute_image()
      • iWorksheet::image_num()
      • iWorksheet::get_image_id()
      • iWorksheet::image_anchor_type()
      • iWorksheet::get_anchored_cell()
      • iWorksheet::get_absolute_coord()
      • iWorksheet::delete_image()
      • iWorksheet::remove_image()
      • iWorksheet::remove_absolute_image()
      • iWorksheet::first_data_cell()
      • iWorksheet::last_data_cell()
      • iWorksheet::merged_num()
      • iWorksheet::merged_range()
      • iWorksheet::merge()
      • iWorksheet::unmerge()
      • iWorksheet::tabledef_count()
      • iWorksheet::get_tabledef_name()
      • iWorksheet::set_tabledef_name()
      • iWorksheet::get_tabledef()
      • iWorksheet::get_tabledef_by_name()
      • iWorksheet::add_tabledef()
      • iWorksheet::delete_tabledef()
      • iWorksheet::group_rows()
      • iWorksheet::ungroup_rows()
      • iWorksheet::group_cols()
      • iWorksheet::ungroup_cols()
      • iWorksheet::row_outline_level()
      • iWorksheet::col_outline_level()
      • iWorksheet::max_row_outline_level()
      • iWorksheet::max_col_outline_level()
      • iWorksheet::delete_row_outline()
      • iWorksheet::delete_col_outline()
      • iWorksheet::group_summary_below()
      • iWorksheet::set_group_summary_below()
      • iWorksheet::group_summary_right()
      • iWorksheet::set_group_summary_right()
      • iWorksheet::add_hyperlink()
      • iWorksheet::hyperlink_num()
      • iWorksheet::hyperlink_index()
      • iWorksheet::hyperlink()
      • iWorksheet::delete_hyperlink()
      • iWorksheet::is_protected()
      • iWorksheet::protect()
      • iWorksheet::unprotect()
      • iWorksheet::protect_range()
      • iWorksheet::set_editable_range()
      • iWorksheet::editable_range_count()
      • iWorksheet::get_editable_range()
      • iWorksheet::delete_editable_range()
      • iWorksheet::zoom()
      • iWorksheet::set_zoom()
      • iWorksheet::right_to_left()
      • iWorksheet::set_right_to_left()
      • iWorksheet::topleft_cell()
      • iWorksheet::set_topleft_cell()
      • iWorksheet::active_cell()
      • iWorksheet::set_active_cell()
      • iWorksheet::split_cell()
      • iWorksheet::set_split_cell()
      • iWorksheet::display_gridlines()
      • iWorksheet::set_display_gridlines()
      • iWorksheet::row_break_count()
      • iWorksheet::row_break()
      • iWorksheet::set_row_break()
      • iWorksheet::col_break_count()
      • iWorksheet::col_break()
      • iWorksheet::set_col_break()
      • iWorksheet::print_gridlines()
      • iWorksheet::set_print_gridlines()
      • iWorksheet::print_headings()
      • iWorksheet::set_print_headings()
      • iWorksheet::h_centered_printing()
      • iWorksheet::set_h_centered_printing()
      • iWorksheet::v_centered_printing()
      • iWorksheet::set_v_centered_printing()
      • iWorksheet::left_margin()
      • iWorksheet::set_left_margin()
      • iWorksheet::right_margin()
      • iWorksheet::set_right_margin()
      • iWorksheet::top_margin()
      • iWorksheet::set_top_margin()
      • iWorksheet::bottom_margin()
      • iWorksheet::set_bottom_margin()
      • iWorksheet::header_margin()
      • iWorksheet::set_header_margin()
      • iWorksheet::footer_margin()
      • iWorksheet::set_footer_margin()
      • iWorksheet::paper()
      • iWorksheet::set_paper()
      • iWorksheet::print_scale()
      • iWorksheet::set_print_scale()
      • iWorksheet::page_orientation()
      • iWorksheet::set_page_orientation()
      • iWorksheet::print_errors()
      • iWorksheet::set_print_errors()
      • iWorksheet::fit_page_height()
      • iWorksheet::set_fit_page_height()
      • iWorksheet::fit_page_width()
      • iWorksheet::set_fit_page_width()
      • iWorksheet::page_header()
      • iWorksheet::set_page_header()
      • iWorksheet::page_footer()
      • iWorksheet::set_page_footer()
  • Usage Example

• Style Interface
  • Classes
    • iStyle
      • iStyle::set_numfmt_code()
      • iStyle::numfmt_code()
      • iStyle::numfmt_id()
      • iStyle::set_numfmt_id()
      • iStyle::set_font()
      • iStyle::font_name()
      • iStyle::font_size()
      • iStyle::set_font_size()
      • iStyle::italic()
      • iStyle::set_italic()
      • iStyle::strikeout()
      • iStyle::set_strikeout()
      • iStyle::font_color()
      • iStyle::set_font_color()
      • iStyle::bold()
      • iStyle::set_bold()
      • iStyle::font_vert_align()
      • iStyle::set_font_vert_align()
      • iStyle::underlined()
      • iStyle::set_underline()
      • iStyle::border()
      • iStyle::set_border()
      • iStyle::border_color()
      • iStyle::set_border_color()
      • iStyle::fill_pattern()
      • iStyle::set_fill_pattern()
      • iStyle::pattern_fg_color()
      • iStyle::set_pattern_fg_color()
      • iStyle::pattern_bg_color()
      • iStyle::set_pattern_bg_color()
      • iStyle::align_h()
      • iStyle::set_align_h()
      • iStyle::align_v()
      • iStyle::set_align_v()
      • iStyle::wrap()
      • iStyle::set_wrap()
      • iStyle::rotation()
      • iStyle::set_rotation()
      • iStyle::indent()
      • iStyle::set_indent()
      • iStyle::shrink_to_fit()
      • iStyle::set_shrink_to_fit()
      • iStyle::locked()
      • iStyle::set_locked()
      • iStyle::hidden()
      • iStyle::set_hidden()
      • iStyle::unapply_numfmt()
      • iStyle::unapply_font()
      • iStyle::unapply_fill()
      • iStyle::unapply_border()
      • iStyle::unapply_alignment()
      • iStyle::unapply_protection()
      • iStyle::unapply_all()
      • iStyle::release()

• Richtext Interface
  • Classes
    • iRichtext
      • iRichtext::segments_num()
      • iRichtext::plain_text()
      • iRichtext::text()
      • iRichtext::append()
      • iRichtext::insert()
      • iRichtext::remove()
      • iRichtext::modify()
      • iRichtext::release()
  • Usage Example

• Tabledef Interface
  • Classes
    • iTabledef
      • iTabledef::name()
      • iTabledef::range()
      • iTabledef::display_name()
      • iTabledef::set_display_name()
      • iTabledef::comment()
      • iTabledef::set_comment()
      • iTabledef::col_name()
      • iTabledef::set_col_name()
      • iTabledef::insert_col()
      • iTabledef::delete_col_by_index()
      • iTabledef::delete_col()
      • iTabledef::set_totals_row_label()
      • iTabledef::set_display_total()
      • iTabledef::totals_row_func()
      • iTabledef::set_totals_row_func()
      • iTabledef::style_name()
      • iTabledef::set_style_name()
      • iTabledef::set_preset_style()
      • iTabledef::row_strips()
      • iTabledef::set_row_strips()
    • Built-in Table Styles
    • Built-in Table Styles
  • Usage Example
  • Totals Functions Reference
  • Notes