1Spreadsheet::ParseExcelU:s:eWrorCkobnotorki(b3u)ted PerlSpDroecaudmsehneteatt:i:oPnarseExcel::Workbook(3)
2
3
4
5   get_active_sheet()
6       Return the number of the active (open) worksheet (at the time the
7       workbook was saved.  May return undef.
8

NAME

10       Spreadsheet::ParseExcel::Workbook - A class for Workbooks.
11

SYNOPSIS

13       See the documentation for Spreadsheet::ParseExcel.
14

DESCRIPTION

16       This module is used in conjunction with Spreadsheet::ParseExcel. See
17       the documentation for Spreadsheet::ParseExcel.
18

Methods

20       The following Workbook methods are available:
21
22           $workbook->worksheets()
23           $workbook->worksheet()
24           $workbook->worksheet_count()
25           $workbook->get_filename()
26           $workbook->get_print_areas()
27           $workbook->get_print_titles()
28           $workbook->using_1904_date()
29
30   worksheets()
31       The worksheets() method returns an array of Worksheet objects. This was
32       most commonly used to iterate over the worksheets in a workbook:
33
34           for my $worksheet ( $workbook->worksheets() ) {
35               ...
36           }
37
38   worksheet()
39       The worksheet() method returns a single "Worksheet" object using either
40       its name or index:
41
42           $worksheet = $workbook->worksheet('Sheet1');
43           $worksheet = $workbook->worksheet(0);
44
45       Returns "undef" if the sheet name or index doesn't exist.
46
47   worksheet_count()
48       The worksheet_count() method returns the number of Woksheet objects in
49       the Workbook.
50
51           my $worksheet_count = $workbook->worksheet_count();
52
53   get_filename()
54       The get_filename() method returns the name of the Excel file of "undef"
55       if the data was read from a filehandle rather than a file.
56
57           my $filename = $workbook->get_filename();
58
59   get_print_areas()
60       The get_print_areas() method returns an array ref of print areas.
61
62           my $print_areas = $workbook->get_print_areas();
63
64       Each print area is as follows:
65
66           [ $start_row, $start_col, $end_row, $end_col ]
67
68       Returns undef if there are no print areas.
69
70   get_print_titles()
71       The get_print_titles() method returns an array ref of print title hash
72       refs.
73
74           my $print_titles = $workbook->get_print_titles();
75
76       Each print title array ref is as follows:
77
78           {
79               Row    => [ $start_row, $end_row ],
80               Column => [ $start_col, $end_col ],
81           }
82
83       Returns undef if there are no print titles.
84
85   using_1904_date()
86       The using_1904_date() method returns true if the Excel file is using
87       the 1904 date epoch instead of the 1900 epoch.
88
89           my $using_1904_date = $workbook->using_1904_date();
90
91        The Windows version of Excel generally uses the 1900 epoch while the Mac version of Excel generally uses the 1904 epoch.
92
93       Returns 0 if the 1900 epoch is in use.
94

AUTHOR

96       Current maintainer 0.60+: Douglas Wilson dougw@cpan.org
97
98       Maintainer 0.40-0.59: John McNamara jmcnamara@cpan.org
99
100       Maintainer 0.27-0.33: Gabor Szabo szabgab@cpan.org
101
102       Original author: Kawai Takanori kwitknr@cpan.org
103
105       Copyright (c) 2014 Douglas Wilson
106
107       Copyright (c) 2009-2013 John McNamara
108
109       Copyright (c) 2006-2008 Gabor Szabo
110
111       Copyright (c) 2000-2006 Kawai Takanori
112
113       All rights reserved.
114
115       You may distribute under the terms of either the GNU General Public
116       License or the Artistic License, as specified in the Perl README file.
117
118
119
120perl v5.36.0                      2023-01-2S0preadsheet::ParseExcel::Workbook(3)
Impressum