Module: Libxlsxwriter::WorkbookWrappers

Included in:
Workbook
Defined in:
lib/fast_excel/binding/workbook.rb

Overview

Fields:

:file

(FFI::Pointer(*FILE))

:worksheets

(Worksheets)

:worksheet_names

(WorksheetNames)

:charts

(Charts)

:ordered_charts

(Charts)

:formats

(Formats)

:defined_names

(DefinedNames)

:sst

(Sst)

:properties

(DocProperties)

:custom_properties

(CustomProperties)

:filename

(String)

:options

(WorkbookOptions)

:num_sheets

(Integer)

:first_sheet

(Integer)

:active_sheet

(Integer)

:num_xf_formats

(Integer)

:num_format_count

(Integer)

:drawing_count

(Integer)

:font_count

(Integer)

:border_count

(Integer)

:fill_count

(Integer)

:optimize

(Integer)

:has_png

(Integer)

:has_jpeg

(Integer)

:has_bmp

(Integer)

:used_xf_formats

(HashTable)

Instance Method Summary collapse

Instance Method Details

#add_chart(chart_type) ⇒ Chart

Parameters:

  • chart_type (Integer)

Returns:



83
84
85
 
# File 'lib/fast_excel/binding/workbook.rb', line 83

def add_chart(chart_type)
  Chart.new Libxlsxwriter.workbook_add_chart(self, chart_type)
end

#add_format ⇒ Format

Returns:



73
74
75
 
# File 'lib/fast_excel/binding/workbook.rb', line 73

def add_format()
  Format.new Libxlsxwriter.workbook_add_format(self)
end

#add_worksheet(sheetname) ⇒ Worksheet

Parameters:

  • sheetname (String)

Returns:



68
69
70
 
# File 'lib/fast_excel/binding/workbook.rb', line 68

def add_worksheet(sheetname)
  Worksheet.new Libxlsxwriter.workbook_add_worksheet(self, sheetname)
end

#assemble_xml_file ⇒ nil

Returns:

  • (nil) 


158
159
160
 
# File 'lib/fast_excel/binding/workbook.rb', line 158

def assemble_xml_file()
  Libxlsxwriter.workbook_assemble_xml_file(self)
end

#close ⇒ Symbol from _enum_error_

Returns:



88
89
90
 
# File 'lib/fast_excel/binding/workbook.rb', line 88

def close()
  Libxlsxwriter.workbook_close(self)
end

#default_format ⇒ Object 



77
78
79
 
# File 'lib/fast_excel/binding/workbook.rb', line 77

def default_format()
  Format.new Libxlsxwriter.workbook_default_format(self)
end

#define_name(name, formula) ⇒ Symbol from _enum_error_

Parameters:

  • name (String)
  • formula (String)

Returns:



136
137
138
 
# File 'lib/fast_excel/binding/workbook.rb', line 136

def define_name(name, formula)
  Libxlsxwriter.workbook_define_name(self, name, formula)
end

#free ⇒ nil

Returns:

  • (nil) 


153
154
155
 
# File 'lib/fast_excel/binding/workbook.rb', line 153

def free()
  Libxlsxwriter.workbook_free(self)
end

#get_worksheet_by_name(name) ⇒ Worksheet

Parameters:

  • name (String)

Returns:



142
143
144
 
# File 'lib/fast_excel/binding/workbook.rb', line 142

def get_worksheet_by_name(name)
  Worksheet.new Libxlsxwriter.workbook_get_worksheet_by_name(self, name)
end

#set_custom_property_boolean(name, value) ⇒ Symbol from _enum_error_

Parameters:

  • name (String)
  • value (Integer)

Returns:



122
123
124
 
# File 'lib/fast_excel/binding/workbook.rb', line 122

def set_custom_property_boolean(name, value)
  Libxlsxwriter.workbook_set_custom_property_boolean(self, name, value)
end

#set_custom_property_datetime(name, datetime) ⇒ Symbol from _enum_error_

Parameters:

Returns:



129
130
131
 
# File 'lib/fast_excel/binding/workbook.rb', line 129

def set_custom_property_datetime(name, datetime)
  Libxlsxwriter.workbook_set_custom_property_datetime(self, name, datetime)
end

#set_custom_property_integer(name, value) ⇒ Symbol from _enum_error_

Parameters:

  • name (String)
  • value (Integer)

Returns:



115
116
117
 
# File 'lib/fast_excel/binding/workbook.rb', line 115

def set_custom_property_integer(name, value)
  Libxlsxwriter.workbook_set_custom_property_integer(self, name, value)
end

#set_custom_property_number(name, value) ⇒ Symbol from _enum_error_

Parameters:

  • name (String)
  • value (Float)

Returns:



108
109
110
 
# File 'lib/fast_excel/binding/workbook.rb', line 108

def set_custom_property_number(name, value)
  Libxlsxwriter.workbook_set_custom_property_number(self, name, value)
end

#set_custom_property_string(name, value) ⇒ Symbol from _enum_error_

Parameters:

  • name (String)
  • value (String)

Returns:



101
102
103
 
# File 'lib/fast_excel/binding/workbook.rb', line 101

def set_custom_property_string(name, value)
  Libxlsxwriter.workbook_set_custom_property_string(self, name, value)
end

#set_default_xf_indices ⇒ nil

Returns:

  • (nil) 


163
164
165
 
# File 'lib/fast_excel/binding/workbook.rb', line 163

def set_default_xf_indices()
  Libxlsxwriter.workbook_set_default_xf_indices(self)
end

#set_properties(properties) ⇒ Symbol from _enum_error_

Parameters:

Returns:



94
95
96
 
# File 'lib/fast_excel/binding/workbook.rb', line 94

def set_properties(properties)
  Libxlsxwriter.workbook_set_properties(self, properties)
end

#validate_worksheet_name(sheetname) ⇒ Symbol from _enum_error_

Parameters:

  • sheetname (String)

Returns:



148
149
150
 
# File 'lib/fast_excel/binding/workbook.rb', line 148

def validate_worksheet_name(sheetname)
  Libxlsxwriter.workbook_validate_worksheet_name(self, sheetname)
end