Class Spreadsheet::Excel::Workbook
In: lib/spreadsheet/excel.rb
lib/spreadsheet/excel/workbook.rb
Parent: Object
Column Format Row Font Enumerable Worksheet\n[lib/spreadsheet/excel.rb\nlib/spreadsheet/worksheet.rb] Link Workbook Workbook\n[lib/spreadsheet/excel.rb\nlib/spreadsheet/excel/workbook.rb] SstEntry String Row Array Worksheet ExcelCompatibleWorkbook Format Worksheet Workbook DelegateClassSpreadsheet::Format Writer Compatibility Formula Reader\n[lib/parseexcel/parseexcel.rb\nlib/spreadsheet/excel/reader.rb\nlib/spreadsheet/excel/reader/biff5.rb\nlib/spreadsheet/excel/reader/biff8.rb] Error lib/spreadsheet/excel.rb lib/spreadsheet/link.rb lib/spreadsheet/formula.rb lib/spreadsheet/workbook.rb lib/spreadsheet/font.rb lib/spreadsheet/column.rb lib/spreadsheet/format.rb lib/spreadsheet/writer.rb lib/spreadsheet/row.rb Encodings lib/spreadsheet/excel.rb lib/spreadsheet/excel/row.rb lib/spreadsheet/excel/reader/biff5.rb lib/spreadsheet/excel/worksheet.rb lib/spreadsheet/excel/sst_entry.rb lib/spreadsheet/excel/error.rb lib/spreadsheet/excel/workbook.rb lib/spreadsheet/excel/writer/format.rb lib/spreadsheet/excel/writer/workbook.rb lib/spreadsheet/excel/writer/worksheet.rb Biff8 Writer Biff5 Biff8 Internals Offset Excel Datatypes ParseExcel Compatibility Spreadsheet dot/m_34_0.png

Excel-specific Workbook methods. These are mostly pertinent to the Excel reader. You should have no reason to use any of these.

Methods

add_shared_string   add_worksheet   add_worksheet   biff_version   date_base   new   open   shared_string   sst_size   uninspect_variables   version_string  

Included Modules

Spreadsheet::Encodings Spreadsheet::Excel::Offset

Constants

BIFF_VERSIONS = { 0x000 => 2, 0x007 => 2, 0x200 => 2, 0x300 => 3, 0x400 => 4, 0x500 => 5, 0x600 => 8, }
VERSION_STRINGS = { 0x600 => 'Microsoft Excel 97/2000/XP', 0x500 => 'Microsoft Excel 95', }

Attributes

bof  [RW] 
date_base  [W] 
ole  [RW] 

Public Class methods

new(*args)

[Source]

    # File lib/spreadsheet/excel/workbook.rb, line 34
34:   def initialize *args
35:     super
36:     enc = 'UTF-16LE'
37:     if RUBY_VERSION >= '1.9'
38:       enc = Encoding.find enc
39:     end
40:     @encoding = enc
41:     @version = 0x600
42:     @sst = []
43:   end
open(io, opts = {})

[Source]

    # File lib/spreadsheet/excel/workbook.rb, line 30
30:   def Workbook.open io, opts = {}
31:     @reader = Reader.new opts
32:     @reader.read io
33:   end

Public Instance methods

add_shared_string(str)

[Source]

    # File lib/spreadsheet/excel/workbook.rb, line 44
44:   def add_shared_string str
45:     @sst.push str
46:   end
add_worksheet(name)

[Source]

    # File lib/spreadsheet/excel.rb, line 28
28:       def add_worksheet name
29:         if name.is_a? String
30:           create_worksheet :name => name
31:         else
32:           super
33:         end
34:       end
add_worksheet(worksheet)

[Source]

    # File lib/spreadsheet/excel/workbook.rb, line 47
47:   def add_worksheet worksheet
48:     @changes.store :boundsheets, true
49:     super
50:   end
biff_version()

[Source]

    # File lib/spreadsheet/excel/workbook.rb, line 51
51:   def biff_version
52:     case @bof
53:     when 0x009
54:       2
55:     when 0x209
56:       3
57:     when 0x409
58:       4
59:     else
60:       BIFF_VERSIONS.fetch(@version) { raise "Unkown BIFF_VERSION '#@version'" }
61:     end
62:   end
date_base()

[Source]

    # File lib/spreadsheet/excel/workbook.rb, line 63
63:   def date_base
64:     @date_base ||= DateTime.new 1899, 12, 31
65:   end
shared_string(idx)

[Source]

    # File lib/spreadsheet/excel/workbook.rb, line 66
66:   def shared_string idx
67:     @sst[idx.to_i].content
68:   end
sst_size()

[Source]

    # File lib/spreadsheet/excel/workbook.rb, line 69
69:   def sst_size
70:     @sst.size
71:   end
uninspect_variables()

[Source]

    # File lib/spreadsheet/excel/workbook.rb, line 72
72:   def uninspect_variables
73:     super.push '@sst', '@offsets', '@changes'
74:   end
version_string()

[Source]

    # File lib/spreadsheet/excel/workbook.rb, line 75
75:   def version_string
76:     client VERSION_STRINGS.fetch(@version, "Unknown"), 'UTF-8'
77:   end

[Validate]