WriteExcel 0.2.0

data/examples/header.rb

@@ -0,0 +1,136 @@
+#!/usr/bin/ruby -w
+
+######################################################################
+#
+# This program shows several examples of how to set up headers and
+# footers with Spreadsheet::WriteExcel.
+#
+# The control characters used in the header/footer strings are:
+#
+#   Control             Category            Description
+#   =======             ========            ===========
+#   &L                  Justification       Left
+#   &C                                      Center
+#   &R                                      Right
+#
+#   &P                  Information         Page number
+#   &N                                      Total number of pages
+#   &D                                      Date
+#   &T                                      Time
+#   &F                                      File name
+#   &A                                      Worksheet name
+#
+#   &fontsize           Font                Font size
+#   &"font,style"                           Font name and style
+#   &U                                      Single underline
+#   &E                                      Double underline
+#   &S                                      Strikethrough
+#   &X                                      Superscript
+#   &Y                                      Subscript
+#
+#   &&                  Miscellaneous       Literal ampersand &
+#
+#
+# reverse('©'), March 2002, 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("headers.xls")
+preview   = "Select Print Preview to see the header and footer"
+
+
+######################################################################
+#
+# A simple example to start
+#
+worksheet1  = workbook.add_worksheet('Simple')
+
+header1     = '&CHere is some centred text.'
+
+footer1     = '&LHere is some left aligned text.'
+
+
+worksheet1.set_header(header1)
+worksheet1.set_footer(footer1)
+
+worksheet1.set_column('A:A', 50)
+worksheet1.write('A1', preview)
+
+
+######################################################################
+#
+# This is an example of some of the header/footer variables.
+#
+worksheet2  = workbook.add_worksheet('Variables')
+
+header2     = '&LPage &P of &N'+
+                  '&CFilename: &F' +
+                  '&RSheetname: &A'
+
+footer2     = '&LCurrent date: &D'+
+                  '&RCurrent time: &T'
+
+worksheet2.set_header(header2)
+worksheet2.set_footer(footer2)
+
+
+worksheet2.set_column('A:A', 50)
+worksheet2.write('A1', preview)
+worksheet2.write('A21', "Next sheet")
+worksheet2.set_h_pagebreaks(20)
+
+
+######################################################################
+#
+# This example shows how to use more than one font
+#
+worksheet3 = workbook.add_worksheet('Mixed fonts')
+
+header3    = '&C' +
+                 '&"Courier New,Bold"Hello ' +
+                 '&"Arial,Italic"World'
+
+footer3    = '&C' +
+                 '&"Symbol"e' +
+                 '&"Arial" = mc&X2'
+
+worksheet3.set_header(header3)
+worksheet3.set_footer(footer3)
+
+worksheet3.set_column('A:A', 50)
+worksheet3.write('A1', preview)
+
+
+######################################################################
+#
+# Example of line wrapping
+#
+worksheet4 = workbook.add_worksheet('Word wrap')
+
+header4    = "&CHeading 1\nHeading 2\nHeading 3"
+
+worksheet4.set_header(header4)
+
+worksheet4.set_column('A:A', 50)
+worksheet4.write('A1', preview)
+
+
+######################################################################
+#
+# Example of inserting a literal ampersand &
+#
+worksheet5 = workbook.add_worksheet('Ampersand')
+
+header5    = "&CCuriouser && Curiouser - Attorneys at Law"
+
+worksheet5.set_header(header5)
+
+worksheet5.set_column('A:A', 50)
+worksheet5.write('A1', preview)
+
+workbook.close

data/examples/hidden.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby -w
+
+#######################################################################
+#
+# Example of how to hide a worksheet with Spreadsheet::WriteExcel.
+#
+# reverse('©'), April 2005, 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('hidden.xls')
+worksheet1 = workbook.add_worksheet
+worksheet2 = workbook.add_worksheet
+worksheet3 = workbook.add_worksheet
+
+# Sheet2 won't be visible until it is unhidden in Excel.
+worksheet2.hide
+
+worksheet1.write(0, 0, 'Sheet2 is hidden')
+worksheet2.write(0, 0, 'How did you find me?')
+worksheet3.write(0, 0, 'Sheet2 is hidden')
+
+workbook.close

data/examples/hyperlink.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby -W0
+###############################################################################
+#
+# Example of how to use the WriteExcel module to write hyperlinks
+#
+# See also hyperlink2.pl for worksheet URL examples.
+#
+# 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 a new workbook and add a worksheet
+workbook  = Spreadsheet::WriteExcel.new("hyperlink.xls")
+worksheet = workbook.add_worksheet('Hyperlinks')
+
+# Format the first column
+worksheet.set_column('A:A', 30)
+worksheet.set_selection('B1')
+
+
+# Add a sample format
+format = workbook.add_format
+format.set_size(12)
+format.set_bold
+format.set_color('red')
+format.set_underline
+
+
+# Write some hyperlinks
+worksheet.write('A1', 'http://www.perl.com/'                )
+worksheet.write('A3', 'http://www.perl.com/', 'Perl home'   )
+worksheet.write('A5', 'http://www.perl.com/', nil, format)
+worksheet.write('A7', 'mailto:jmcnamara@cpan.org', 'Mail me')
+
+# Write a URL that isn't a hyperlink
+worksheet.write_string('A9', 'http://www.perl.com/')
+
+workbook.close

data/examples/images.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/ruby -w
+
+#######################################################################
+#
+# Example of how to insert images into an Excel worksheet using the
+# Spreadsheet::WriteExcel insert_image() method.
+#
+# 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'
+
+# Create a new workbook called simple.xls and add a worksheet
+workbook   = Spreadsheet::WriteExcel.new("images.xls")
+worksheet1 = workbook.add_worksheet('Image 1')
+worksheet2 = workbook.add_worksheet('Image 2')
+worksheet3 = workbook.add_worksheet('Image 3')
+worksheet4 = workbook.add_worksheet('Image 4')
+bp=1
+
+# Insert a basic image
+worksheet1.write('A10', "Image inserted into worksheet.")
+worksheet1.insert_image('A1', 'republic.png')
+
+
+# Insert an image with an offset
+worksheet2.write('A10', "Image inserted with an offset.")
+worksheet2.insert_image('A1', 'republic.png', 32, 10)
+
+# Insert a scaled image
+worksheet3.write('A10', "Image scaled: width x 2, height x 0.8.")
+worksheet3.insert_image('A1', 'republic.png', 0, 0, 2, 0.8)
+
+# Insert an image over varied column and row sizes
+# This does not require any additional work
+
+# Set the cols and row sizes
+# NOTE: you must do this before you call insert_image()
+worksheet4.set_column('A:A', 5)
+worksheet4.set_column('B:B', nil, nil, 1) # Hidden
+worksheet4.set_column('C:D', 10)
+worksheet4.set_row(0, 30)
+worksheet4.set_row(3, 5)
+
+worksheet4.write('A10', "Image inserted over scaled rows and columns.")
+worksheet4.insert_image('A1', 'republic.png')
+
+workbook.close

data/examples/merge1.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# Simple example of merging cells using the Spreadsheet::WriteExcel module.
+#
+# This merges three cells using the "Centre Across Selection" alignment.
+# This was the Excel 5 method of achieving a merge. Use the merge_range()
+# worksheet method instead. See merge3.pl - merge6.pl.
+#
+# reverse('©'), August 2002, 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('merge1.xls')
+worksheet = workbook.add_worksheet
+
+
+# Increase the cell size of the merged cells to highlight the formatting.
+worksheet.set_column('B:D', 20)
+worksheet.set_row(2, 30)
+
+
+# Create a merge format
+format = workbook.add_format(:center_across => 1)
+
+
+# Only one cell should contain text, the others should be blank.
+worksheet.write(2, 1, "Center across selection", format)
+worksheet.write_blank(2, 2,                 format)
+worksheet.write_blank(2, 3,                 format)
+
+workbook.close

data/examples/merge2.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# Simple example of merging cells using the Spreadsheet::WriteExcel module
+#
+# This merges two formatted cells using the "Centre Across Selection" alignment.
+# This was the Excel 5 method of achieving a merge. Use the merge_range()
+# worksheet method instead. See merge3.pl - merge6.pl.
+#
+# reverse('©'), August 2002, 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("merge2.xls")
+worksheet = workbook.add_worksheet
+
+# Increase the cell size of the merged cells to highlight the formatting.
+worksheet.set_column(1, 2, 30)
+worksheet.set_row(2, 40)
+
+# Create a merged format
+format = workbook.add_format(
+                                        :center_across   => 1,
+                                        :bold            => 1,
+                                        :size            => 15,
+                                        :pattern         => 1,
+                                        :border          => 6,
+                                        :color           => 'white',
+                                        :fg_color        => 'green',
+                                        :border_color    => 'yellow',
+                                        :align           => 'vcenter'
+                                  )
+
+# Only one cell should contain text, the others should be blank.
+worksheet.write(2, 1, "Center across selection", format)
+worksheet.write_blank(2, 2,                      format)
+workbook.close

data/examples/merge3.rb

@@ -0,0 +1,65 @@
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# Example of how to use Spreadsheet::WriteExcel to write a hyperlink in a
+# merged cell. There are two options write_url_range() with a standard merge
+# format or merge_range().
+#
+# reverse('©'), September 2002, 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("merge3.xls")
+worksheet = workbook.add_worksheet()
+
+# Increase the cell size of the merged cells to highlight the formatting.
+[1, 3,6,7].each { |row| worksheet.set_row(row, 30) }
+worksheet.set_column('B:D', 20)
+
+bp=1
+###############################################################################
+#
+# Example 1: Merge cells containing a hyperlink using write_url_range()
+# and the standard Excel 5+ merge property.
+#
+format1 = workbook.add_format(
+                                    :center_across   => 1,
+                                    :border          => 1,
+                                    :underline       => 1,
+                                    :color           => 'blue'
+                             )
+
+# Write the cells to be merged
+worksheet.write_url_range('B2:D2', 'http://www.perl.com', format1)
+worksheet.write_blank('C2', format1)
+worksheet.write_blank('D2', format1)
+
+
+
+###############################################################################
+#
+# Example 2: Merge cells containing a hyperlink using merge_range().
+#
+format2 = workbook.add_format(
+                                    :border      => 1,
+                                    :underline   => 1,
+                                    :color       => 'blue',
+                                    :align       => 'center',
+                                    :valign      => 'vcenter'
+                             )
+
+# Merge 3 cells
+worksheet.merge_range('B4:D4', 'http://www.perl.com', format2)
+
+
+# Merge 3 cells over two rows
+worksheet.merge_range('B7:D8', 'http://www.perl.com', format2)
+
+workbook.close

data/examples/merge4.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# Example of how to use the Spreadsheet::WriteExcel merge_range() workbook
+# method with complex formatting.
+#
+# reverse('©'), September 2002, 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('merge4.xls')
+worksheet = workbook.add_worksheet
+
+# Increase the cell size of the merged cells to highlight the formatting.
+(1..11).each { |row| worksheet.set_row(row, 30) }
+worksheet.set_column('B:D', 20)
+
+###############################################################################
+#
+# Example 1: Text centered vertically and horizontally
+#
+format1 = workbook.add_format(
+                                    :border  => 6,
+                                    :bold    => 1,
+                                    :color   => 'red',
+                                    :valign  => 'vcenter',
+                                    :align   => 'center'
+                                   )
+
+worksheet.merge_range('B2:D3', 'Vertical and horizontal', format1)
+
+
+###############################################################################
+#
+# Example 2: Text aligned to the top and left
+#
+format2 = workbook.add_format(
+                                    :border  => 6,
+                                    :bold    => 1,
+                                    :color   => 'red',
+                                    :valign  => 'top',
+                                    :align   => 'left'
+                                  )
+
+worksheet.merge_range('B5:D6', 'Aligned to the top and left', format2)
+
+###############################################################################
+#
+# Example 3:  Text aligned to the bottom and right
+#
+format3 = workbook.add_format(
+                                    :border  => 6,
+                                    :bold    => 1,
+                                    :color   => 'red',
+                                    :valign  => 'bottom',
+                                    :align   => 'right'
+                                  )
+
+worksheet.merge_range('B8:D9', 'Aligned to the bottom and right', format3)
+
+###############################################################################
+#
+# Example 4:  Text justified (i.e. wrapped) in the cell
+#
+format4 = workbook.add_format(
+                                    :border  => 6,
+                                    :bold    => 1,
+                                    :color   => 'red',
+                                    :valign  => 'top',
+                                    :align   => 'justify'
+                                  )
+
+worksheet.merge_range('B11:D12', 'Justified: '+'so on and '*18, format4)
+
+workbook.close