WriteExcel 0.2.0

data/examples/copyformat.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# Example of how to use the format copying method with Spreadsheet::WriteExcel #
+# reverse('©'), March 2001, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+require 'rubygems'
+require 'WriteExcel'
+
+# Create workbook1
+workbook1       = Spreadsheet::WriteExcel.new("workbook1.xls")
+worksheet1      = workbook1.add_worksheet
+format1a        = workbook1.add_format
+format1b        = workbook1.add_format
+
+# Create workbook2
+workbook2       = Spreadsheet::WriteExcel.new("workbook2.xls")
+worksheet2      = workbook2.add_worksheet
+format2a        = workbook2.add_format
+format2b        = workbook2.add_format
+
+# Create a global format object that isn't tied to a workbook
+global_format   = Format.new
+
+# Set the formatting
+global_format.set_color('blue')
+global_format.set_bold
+global_format.set_italic
+
+# Create another example format
+format1b.set_color('red')
+
+# Copy the global format properties to the worksheet formats
+format1a.copy(global_format)
+format2a.copy(global_format)
+
+# Copy a format from worksheet1 to worksheet2
+format2b.copy(format1b)
+
+# Write some output
+worksheet1.write(0, 0, "Ciao", format1a)
+worksheet1.write(1, 0, "Ciao", format1b)
+
+worksheet2.write(0, 0, "Hello", format2a)
+worksheet2.write(1, 0, "Hello", format2b)
+workbook1.close
+workbook2.close

data/examples/data_validate.rb

@@ -0,0 +1,278 @@
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# Example of how to add data validation and dropdown lists to a
+# Spreadsheet::WriteExcel file.
+#
+# reverse('©'), August 2008, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'WriteExcel'
+
+workbook  = Spreadsheet::WriteExcel.new('data_validate.xls')
+worksheet = workbook.add_worksheet
+
+# Add a format for the header cells.
+header_format = workbook.add_format(
+                                            :border      => 1,
+                                            :bg_color    => 43,
+                                            :bold        => 1,
+                                            :text_wrap   => 1,
+                                            :valign      => 'vcenter',
+                                            :indent      => 1
+                                         )
+
+# Set up layout of the worksheet.
+worksheet.set_column('A:A', 64)
+worksheet.set_column('B:B', 15)
+worksheet.set_column('D:D', 15)
+worksheet.set_row(0, 36)
+worksheet.set_selection('B3')
+
+
+# Write the header cells and some data that will be used in the examples.
+row = 0
+heading1 = 'Some examples of data validation in Spreadsheet::WriteExcel'
+heading2 = 'Enter values in this column'
+heading3 = 'Sample Data'
+
+worksheet.write('A1', heading1, header_format)
+worksheet.write('B1', heading2, header_format)
+worksheet.write('D1', heading3, header_format)
+
+worksheet.write('D3', ['Integers',   1, 10])
+worksheet.write('D4', ['List data', 'open', 'high', 'close'])
+worksheet.write('D5', ['Formula',   '=AND(F5=50,G5=60)', 50, 60])
+
+
+#
+# Example 1. Limiting input to an integer in a fixed range.
+#
+txt = 'Enter an integer between 1 and 10'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'integer',
+        :criteria        => 'between',
+        :minimum         => 1,
+        :maximum         => 10
+    })
+
+
+#
+# Example 2. Limiting input to an integer outside a fixed range.
+#
+txt = 'Enter an integer that is not between 1 and 10 (using cell references)'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'integer',
+        :criteria        => 'not between',
+        :minimum         => '=E3',
+        :maximum         => '=F3'
+    })
+
+
+#
+# Example 3. Limiting input to an integer greater than a fixed value.
+#
+txt = 'Enter an integer greater than 0'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'integer',
+        :criteria        => '>',
+        :value           => 0
+    })
+
+
+#
+# Example 4. Limiting input to an integer less than a fixed value.
+#
+txt = 'Enter an integer less than 10'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'integer',
+        :criteria        => '<',
+        :value           => 10
+    })
+
+
+#
+# Example 5. Limiting input to a decimal in a fixed range.
+#
+txt = 'Enter a decimal between 0.1 and 0.5'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'decimal',
+        :criteria        => 'between',
+        :minimum         => 0.1,
+        :maximum         => 0.5
+    })
+
+
+#
+# Example 6. Limiting input to a value in a dropdown list.
+#
+txt = 'Select a value from a drop down list'
+row += 2
+bp=1
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'list',
+        :source          => ['open', 'high', 'close']
+    })
+
+
+#
+# Example 6. Limiting input to a value in a dropdown list.
+#
+txt = 'Select a value from a drop down list (using a cell range)'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'list',
+        :source          => '=E4:G4'
+    })
+
+
+#
+# Example 7. Limiting input to a date in a fixed range.
+#
+txt = 'Enter a date between 1/1/2008 and 12/12/2008'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'date',
+        :criteria        => 'between',
+        :minimum         => '2008-01-01T',
+        :maximum         => '2008-12-12T'
+    })
+
+
+#
+# Example 8. Limiting input to a time in a fixed range.
+#
+txt = 'Enter a time between 6:00 and 12:00'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'time',
+        :criteria        => 'between',
+        :minimum         => 'T06:00',
+        :maximum         => 'T12:00'
+    })
+
+
+#
+# Example 9. Limiting input to a string greater than a fixed length.
+#
+txt = 'Enter a string longer than 3 characters'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'length',
+        :criteria        => '>',
+        :value           => 3
+    })
+
+
+#
+# Example 10. Limiting input based on a formula.
+#
+txt = 'Enter a value if the following is true "=AND(F5=50,G5=60)"'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'custom',
+        :value           => '=AND(F5=50,G5=60)'
+    })
+
+
+#
+# Example 11. Displaying and modify data validation messages.
+#
+txt = 'Displays a message when you select the cell'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate      => 'integer',
+        :criteria      => 'between',
+        :minimum       => 1,
+        :maximum       => 100,
+        :input_title   => 'Enter an integer:',
+        :input_message => 'between 1 and 100'
+    })
+
+
+#
+# Example 12. Displaying and modify data validation messages.
+#
+txt = 'Display a custom error message when integer isn\'t between 1 and 100'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate      => 'integer',
+        :criteria      => 'between',
+        :minimum       => 1,
+        :maximum       => 100,
+        :input_title   => 'Enter an integer:',
+        :input_message => 'between 1 and 100',
+        :error_title   => 'Input value is not valid!',
+        :error_message => 'It should be an integer between 1 and 100'
+    })
+
+
+#
+# Example 13. Displaying and modify data validation messages.
+#
+txt = 'Display a custom information message when integer isn\'t between 1 and 100'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate      => 'integer',
+        :criteria      => 'between',
+        :minimum       => 1,
+        :maximum       => 100,
+        :input_title   => 'Enter an integer:',
+        :input_message => 'between 1 and 100',
+        :error_title   => 'Input value is not valid!',
+        :error_message => 'It should be an integer between 1 and 100',
+        :error_type    => 'information'
+    })
+
+workbook.close

data/examples/date_time.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# Spreadsheet::WriteExcel example of writing dates and times using the
+# write_date_time() Worksheet method.
+#
+# reverse('©'), August 2004, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'WriteExcel'
+
+# Create a new workbook and add a worksheet
+workbook  = Spreadsheet::WriteExcel.new("date_time.xls")
+worksheet = workbook.add_worksheet
+bold      = workbook.add_format(:bold => 1)
+
+# Expand the first column so that the date is visible.
+worksheet.set_column("A:B", 30)
+
+# Write the column headers
+worksheet.write('A1', 'Formatted date', bold)
+worksheet.write('B1', 'Format',         bold)
+
+# Examples date and time formats. In the output file compare how changing
+# the format codes change the appearance of the date.
+#
+date_formats = [
+    'dd/mm/yy',
+    'mm/dd/yy',
+    '',
+    'd mm yy',
+    'dd mm yy',
+    '',
+    'dd m yy',
+    'dd mm yy',
+    'dd mmm yy',
+    'dd mmmm yy',
+    '',
+    'dd mm y',
+    'dd mm yyy',
+    'dd mm yyyy',
+    '',
+    'd mmmm yyyy',
+    '',
+    'dd/mm/yy',
+    'dd/mm/yy hh:mm',
+    'dd/mm/yy hh:mm:ss',
+    'dd/mm/yy hh:mm:ss.000',
+    '',
+    'hh:mm',
+    'hh:mm:ss',
+    'hh:mm:ss.000',
+]
+
+# Write the same date and time using each of the above formats. The empty
+# string formats create a blank line to make the example clearer.
+#
+row = 0
+date_formats.each do |date_format|
+  row += 1
+  next if date_format == ''
+
+  # Create a format for the date or time.
+  format =  workbook.add_format(
+                              :num_format => date_format,
+                              :align      => 'left'
+                             )
+
+  # Write the same date using different formats.
+  worksheet.write_date_time(row, 0, '2004-08-01T12:30:45.123', format)
+  worksheet.write(row, 1, date_format)
+end
+
+# The following is an example of an invalid date. It is written as a string instead
+# of a number. This is also Excel's default behaviour.
+#
+row += 2
+worksheet.write_date_time(row, 0, '2004-13-01T12:30:45.123')
+worksheet.write(row, 1, 'Invalid date. Written as string.', bold)
+
+workbook.close

data/examples/demo.rb

@@ -0,0 +1,118 @@
+#!/usr/bin/ruby -w
+
+#######################################################################
+#
+# Demo of some of the features of Spreadsheet::WriteExcel.
+# Used to create the project screenshot for Freshmeat.
+#
+#
+# reverse('©'), October 2001, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'WriteExcel'
+
+workbook   = Spreadsheet::WriteExcel.new("demo.xls")
+worksheet  = workbook.add_worksheet('Demo')
+worksheet2 = workbook.add_worksheet('Another sheet')
+worksheet3 = workbook.add_worksheet('And another')
+
+bold       = workbook.add_format(:bold => 1)
+
+#######################################################################
+#
+# Write a general heading
+#
+worksheet.set_column('A:A', 36, bold)
+worksheet.set_column('B:B', 20       )
+worksheet.set_row(0,     40       )
+
+heading  = workbook.add_format(
+                                :bold    => 1,
+                                :color   => 'blue',
+                                :size    => 16,
+                                :merge   => 1,
+                                :align  => 'vcenter'
+                              )
+
+headings = ['Features of Spreadsheet::WriteExcel', '']
+worksheet.write_row('A1', headings, heading)
+
+
+#######################################################################
+#
+# Some text examples
+#
+text_format  = workbook.add_format(
+                                    :bold    => 1,
+                                    :italic  => 1,
+                                    :color   => 'red',
+                                    :size    => 18,
+                                    :font    =>'Lucida Calligraphy'
+                                  )
+
+# A phrase in Cyrillic
+unicode = [
+            "042d0442043e002004440440043004370430002004"+
+            "3d043000200440044304410441043a043e043c0021"
+          ].pack('H*')
+
+worksheet.write('A2', "Text")
+worksheet.write('B2', "Hello Excel")
+worksheet.write('A3', "Formatted text")
+worksheet.write('B3', "Hello Excel", text_format)
+worksheet.write('A4', "Unicode text")
+worksheet.write_utf16be_string('B4', unicode)
+
+
+#######################################################################
+#
+# Some numeric examples
+#
+num1_format  = workbook.add_format(:num_format => '$#,##0.00')
+num2_format  = workbook.add_format(:num_format => ' d mmmm yyy')
+
+worksheet.write('A5', "Numbers")
+worksheet.write('B5', 1234.56)
+worksheet.write('A6', "Formatted numbers")
+worksheet.write('B6', 1234.56, num1_format)
+worksheet.write('A7', "Formatted numbers")
+worksheet.write('B7', 37257, num2_format)
+
+
+#######################################################################
+#
+# Formulae
+#
+worksheet.set_selection('B8')
+worksheet.write('A8', 'Formulas and functions, "=SIN(PI()/4)"')
+worksheet.write('B8', '=SIN(PI()/4)')
+
+
+#######################################################################
+#
+# Hyperlinks
+#
+worksheet.write('A9', "Hyperlinks")
+worksheet.write('B9',  'http://www.perl.com/' )
+
+
+#######################################################################
+#
+# Images
+#
+worksheet.write('A10', "Images")
+worksheet.insert_image('B10', 'republic.png', 16, 8)
+
+
+#######################################################################
+#
+# Misc
+#
+worksheet.write('A18', "Page/printer setup")
+worksheet.write('A19', "Multiple worksheets")
+
+workbook.close