ricardoo27-writeexcel 0.6.12.1

data/examples/outline_collapsed.rb

@@ -0,0 +1,209 @@
+#!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
+
+###############################################################################
+#
+# Example of how use Spreadsheet::WriteExcel to generate Excel outlines and
+# grouping.
+#
+# These example focus mainly on collapsed outlines. See also the
+# outlines.pl example program for more general examples.
+#
+# reverse('©'), March 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 'writeexcel'
+
+# Create a new workbook and add some worksheets
+workbook   = WriteExcel.new('outline_collapsed.xls')
+worksheet1 = workbook.add_worksheet('Outlined Rows')
+worksheet2 = workbook.add_worksheet('Collapsed Rows 1')
+worksheet3 = workbook.add_worksheet('Collapsed Rows 2')
+worksheet4 = workbook.add_worksheet('Collapsed Rows 3')
+worksheet5 = workbook.add_worksheet('Outline Columns')
+worksheet6 = workbook.add_worksheet('Collapsed Columns')
+
+# Add a general format
+bold = workbook.add_format(:bold => 1)
+
+#
+# This function will generate the same data and sub-totals on each worksheet.
+#
+def create_sub_totals(worksheet, bold)
+  # Add a column format for clarity
+  worksheet.set_column('A:A', 20)
+
+  # Add the data, labels and formulas
+  worksheet.write('A1',  'Region', bold)
+  worksheet.write('A2',  'North')
+  worksheet.write('A3',  'North')
+  worksheet.write('A4',  'North')
+  worksheet.write('A5',  'North')
+  worksheet.write('A6',  'North Total', bold)
+
+  worksheet.write('B1',  'Sales',  bold)
+  worksheet.write('B2',  1000)
+  worksheet.write('B3',  1200)
+  worksheet.write('B4',  900)
+  worksheet.write('B5',  1200)
+  worksheet.write('B6',  '=SUBTOTAL(9,B2:B5)', bold)
+
+  worksheet.write('A7',  'South')
+  worksheet.write('A8',  'South')
+  worksheet.write('A9',  'South')
+  worksheet.write('A10', 'South')
+  worksheet.write('A11', 'South Total', bold)
+
+  worksheet.write('B7',  400)
+  worksheet.write('B8',  600)
+  worksheet.write('B9',  500)
+  worksheet.write('B10', 600)
+  worksheet.write('B11', '=SUBTOTAL(9,B7:B10)', bold)
+
+  worksheet.write('A12', 'Grand Total', bold)
+  worksheet.write('B12', '=SUBTOTAL(9,B2:B10)', bold)
+
+end
+
+
+###############################################################################
+#
+# Example 1: Create a worksheet with outlined rows. It also includes SUBTOTAL()
+# functions so that it looks like the type of automatic outlines that are
+# generated when you use the Excel Data.SubTotals menu item.
+#
+
+# The syntax is: set_row(row, height, XF, hidden, level, collapsed)
+worksheet1.set_row(1,  nil, nil, 0, 2)
+worksheet1.set_row(2,  nil, nil, 0, 2)
+worksheet1.set_row(3,  nil, nil, 0, 2)
+worksheet1.set_row(4,  nil, nil, 0, 2)
+worksheet1.set_row(5,  nil, nil, 0, 1)
+
+worksheet1.set_row(6,  nil, nil, 0, 2)
+worksheet1.set_row(7,  nil, nil, 0, 2)
+worksheet1.set_row(8,  nil, nil, 0, 2)
+worksheet1.set_row(9,  nil, nil, 0, 2)
+worksheet1.set_row(10, nil, nil, 0, 1)
+
+# Write the sub-total data that is common to the row examples.
+create_sub_totals(worksheet1, bold)
+
+
+###############################################################################
+#
+# Example 2: Create a worksheet with collapsed outlined rows.
+# This is the same as the example 1  except that the all rows are collapsed.
+# Note: We need to indicate the row that contains the collapsed symbol '+' with
+# the optional parameter, collapsed.
+
+worksheet2.set_row(1,  nil, nil, 1, 2)
+worksheet2.set_row(2,  nil, nil, 1, 2)
+worksheet2.set_row(3,  nil, nil, 1, 2)
+worksheet2.set_row(4,  nil, nil, 1, 2)
+worksheet2.set_row(5,  nil, nil, 1, 1)
+
+worksheet2.set_row(6,  nil, nil, 1, 2)
+worksheet2.set_row(7,  nil, nil, 1, 2)
+worksheet2.set_row(8,  nil, nil, 1, 2)
+worksheet2.set_row(9,  nil, nil, 1, 2)
+worksheet2.set_row(10, nil, nil, 1, 1)
+
+worksheet2.set_row(11, nil, nil, 0, 0, 1)
+
+# Write the sub-total data that is common to the row examples.
+create_sub_totals(worksheet2, bold)
+
+
+###############################################################################
+#
+# Example 3: Create a worksheet with collapsed outlined rows.
+# Same as the example 1  except that the two sub-totals are collapsed.
+
+worksheet3.set_row(1,  nil, nil, 1, 2)
+worksheet3.set_row(2,  nil, nil, 1, 2)
+worksheet3.set_row(3,  nil, nil, 1, 2)
+worksheet3.set_row(4,  nil, nil, 1, 2)
+worksheet3.set_row(5,  nil, nil, 0, 1, 1)
+
+worksheet3.set_row(6,  nil, nil, 1, 2)
+worksheet3.set_row(7,  nil, nil, 1, 2)
+worksheet3.set_row(8,  nil, nil, 1, 2)
+worksheet3.set_row(9,  nil, nil, 1, 2)
+worksheet3.set_row(10, nil, nil, 0, 1, 1)
+
+
+# Write the sub-total data that is common to the row examples.
+create_sub_totals(worksheet3, bold)
+
+
+###############################################################################
+#
+# Example 4: Create a worksheet with outlined rows.
+# Same as the example 1  except that the two sub-totals are collapsed.
+
+worksheet4.set_row(1,  nil, nil, 1, 2)
+worksheet4.set_row(2,  nil, nil, 1, 2)
+worksheet4.set_row(3,  nil, nil, 1, 2)
+worksheet4.set_row(4,  nil, nil, 1, 2)
+worksheet4.set_row(5,  nil, nil, 1, 1, 1)
+
+worksheet4.set_row(6,  nil, nil, 1, 2)
+worksheet4.set_row(7,  nil, nil, 1, 2)
+worksheet4.set_row(8,  nil, nil, 1, 2)
+worksheet4.set_row(9,  nil, nil, 1, 2)
+worksheet4.set_row(10, nil, nil, 1, 1, 1)
+
+worksheet4.set_row(11, nil, nil, 0, 0, 1)
+
+# Write the sub-total data that is common to the row examples.
+create_sub_totals(worksheet4, bold)
+
+
+
+###############################################################################
+#
+# Example 5: Create a worksheet with outlined columns.
+#
+data = [
+  ['Month', 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',' Total'],
+  ['North', 50,    20,    15,    25,    65,    80,   '=SUM(B2:G2)'],
+  ['South', 10,    20,    30,    50,    50,    50,   '=SUM(B3:G3)'],
+  ['East',  45,    75,    50,    15,    75,    100,  '=SUM(B4:G4)'],
+  ['West',  15,    15,    55,    35,    20,    50,   '=SUM(B5:G6)']
+]
+
+# Add bold format to the first row
+worksheet5.set_row(0, nil, bold)
+
+# Syntax: set_column(col1, col2, width, XF, hidden, level, collapsed)
+worksheet5.set_column('A:A', 10, bold      )
+worksheet5.set_column('B:G', 5,  nil, 0, 1)
+worksheet5.set_column('H:H', 10             )
+
+# Write the data and a formula
+worksheet5.write_col('A1', data)
+worksheet5.write('H6', '=SUM(H2:H5)', bold)
+
+
+###############################################################################
+#
+# Example 6: Create a worksheet with collapsed outlined columns.
+# This is the same as the previous example except collapsed columns.
+
+# Add bold format to the first row
+worksheet6.set_row(0, nil, bold)
+
+# Syntax: set_column(col1, col2, width, XF, hidden, level, collapsed)
+worksheet6.set_column('A:A', 10, bold         )
+worksheet6.set_column('B:G', 5,  nil, 1, 1   )
+worksheet6.set_column('H:H', 10, nil, 0, 0, 1)
+
+# Write the data and a formula
+worksheet6.write_col('A1', data)
+worksheet6.write('H6', '=SUM(H2:H5)', bold)
+
+workbook.close

data/examples/panes.rb

@@ -0,0 +1,113 @@
+#!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# Example of using the WriteExcel module to create worksheet panes.
+#
+# reverse('©'), May 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 'writeexcel'
+
+workbook  = WriteExcel.new("panes.xls")
+
+worksheet1 = workbook.add_worksheet('Panes 1')
+worksheet2 = workbook.add_worksheet('Panes 2')
+worksheet3 = workbook.add_worksheet('Panes 3')
+worksheet4 = workbook.add_worksheet('Panes 4')
+
+# Freeze panes
+worksheet1.freeze_panes(1, 0) # 1 row
+
+worksheet2.freeze_panes(0, 1) # 1 column
+worksheet3.freeze_panes(1, 1) # 1 row and column
+
+# Split panes.
+# The divisions must be specified in terms of row and column dimensions.
+# The default row height is 12.75 and the default column width is 8.43
+#
+worksheet4.split_panes(12.75, 8.43, 1, 1) # 1 row and column
+
+
+#######################################################################
+#
+# Set up some formatting and text to highlight the panes
+#
+
+header = workbook.add_format
+header.set_color('white')
+header.set_align('center')
+header.set_align('vcenter')
+header.set_pattern
+header.set_fg_color('green')
+
+center = workbook.add_format
+center.set_align('center')
+
+#######################################################################
+#
+# Sheet 1
+#
+
+worksheet1.set_column('A:I', 16)
+worksheet1.set_row(0, 20)
+worksheet1.set_selection('C3')
+
+(0..8).each { |i| worksheet1.write(0, i, 'Scroll down', header) }
+(1..100).each do |i|
+ (0..8).each { |j| worksheet1.write(i, j, i + 1, center) }
+end
+
+#######################################################################
+#
+# Sheet 2
+#
+
+worksheet2.set_column('A:A', 16)
+worksheet2.set_selection('C3')
+
+(0..49).each do |i|
+  worksheet2.set_row(i, 15)
+  worksheet2.write(i, 0, 'Scroll right', header)
+end
+
+(0..49).each do |i|
+  (1..25).each { |j| worksheet2.write(i, j, j, center) }
+end
+
+#######################################################################
+#
+# Sheet 3
+#
+
+worksheet3.set_column('A:Z', 16)
+worksheet3.set_selection('C3')
+
+(1..25).each { |i| worksheet3.write(0, i, 'Scroll down',  header) }
+
+(1..49).each { |i| worksheet3.write(i, 0, 'Scroll right', header) }
+
+(1..49).each do |i|
+  (1..25).each { |j| worksheet3.write(i, j, j, center) }
+end
+
+#######################################################################
+#
+# Sheet 4
+#
+
+worksheet4.set_selection('C3')
+
+(1..25).each { |i| worksheet4.write(0, i, 'Scroll', center) }
+
+(1..49).each { |i| worksheet4.write(i, 0, 'Scroll', center) }
+
+(1..49).each do |i|
+  (1..25).each { |j| worksheet4.write(i, j, j, center) }
+end
+
+workbook.close

data/examples/password_protection.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'writeexcel'
+
+  workbook = WriteExcel.new('password_protection.xls')
+  worksheet = workbook.add_worksheet
+
+    # Create some format objects
+    locked    = workbook.add_format(:locked => 1)
+    unlocked  = workbook.add_format(:locked => 0)
+    hidden    = workbook.add_format(:hidden => 1)
+
+    # Format the columns
+    worksheet.set_column('A:A', 42)
+    worksheet.set_selection('B3:B3')
+
+    # Protect the worksheet
+    worksheet.protect('password')
+
+    # Examples of cell locking and hiding
+    worksheet.write('A1', 'Cell B1 is locked. It cannot be edited.')
+    worksheet.write('B1', '=1+2', locked)
+
+    worksheet.write('A2', 'Cell B2 is unlocked. It can be edited.')
+    worksheet.write('B2', '=1+2', unlocked)
+
+    worksheet.write('A3', "Cell B3 is hidden. The formula isn't visible.")
+    worksheet.write('B3', '=1+2', hidden)
+
+    worksheet.write('A5', 'Use Menu->Tools->Protection->Unprotect Sheet')
+    worksheet.write('A6', 'to remove the worksheet protection.   ')
+    worksheet.write('A7', 'The password is "password".   ')
+
+    workbook.close

data/examples/properties.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
+
+##############################################################################
+#
+# An example of adding document properties to a 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  = WriteExcel.new('properties.xls')
+worksheet = workbook.add_worksheet
+bp =1
+workbook.set_properties(
+    :title    => 'This is an example spreadsheet',
+    :subject  => 'With document properties',
+    :author   => 'Hideo NAKAMURA',
+    :manager  => 'John McNamara',
+    :company  => 'Rubygem',
+    :category => 'Example spreadsheets',
+    :keywords => 'Sample, Example, Properties',
+    :comments => 'Created with Ruby and WriteExcel'
+)
+
+
+worksheet.set_column('A:A', 50)
+worksheet.write('A1', 'Select File->Properties to see the file properties')
+
+workbook.close

data/examples/properties_jp.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
+
+##############################################################################
+#
+# An example of adding document properties to a 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  = WriteExcel.new('properties_jp.xls')
+worksheet = workbook.add_worksheet
+bp =1
+workbook.set_properties(
+    :title    => 'スプレッドシートの作成例',
+    :subject  => 'ファイルのプロパティをセット',
+    :author   => '中村英夫',
+    :manager  => 'John McNamara',
+    :company  => 'Rubygem',
+    :category => 'エクセルファイル',
+    :keywords => 'エクセル プロパティ UTF-8',
+    :comments => 'Rubygem writeexcelで作成'
+)
+
+worksheet.set_column('A:A', 50)
+worksheet.write('A1', 'メニューのファイル（F)-プロパティ(I)を見てください。')
+
+workbook.close

data/examples/protection.rb

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+  #!/usr/bin/ruby -w
+
+########################################################################
+#
+# Example of cell locking and formula hiding in an Excel  worksheet via
+# the WriteExcel module.
+#
+# reverse('©'), August 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  = WriteExcel.new("protection.xls")
+worksheet = workbook.add_worksheet
+
+# Create some format objects
+locked    = workbook.add_format(:locked => 1)
+unlocked  = workbook.add_format(:locked => 0)
+hidden    = workbook.add_format(:hidden => 1)
+
+# Format the columns
+worksheet.set_column('A:A', 42)
+worksheet.set_selection('B3:B3')
+
+# Protect the worksheet
+worksheet.protect
+
+# Examples of cell locking and hiding
+worksheet.write('A1', 'Cell B1 is locked. It cannot be edited.')
+worksheet.write('B1', '=1+2', locked)
+
+worksheet.write('A2', 'Cell B2 is unlocked. It can be edited.')
+worksheet.write('B2', '=1+2', unlocked)
+
+worksheet.write('A3', "Cell B3 is hidden. The formula isn't visible.")
+worksheet.write('B3', '=1+2', hidden)
+
+worksheet.write('A5', 'Use Menu->Tools->Protection->Unprotect Sheet')
+worksheet.write('A6', 'to remove the worksheet protection.   ')
+
+workbook.close
+