phpman > perldoc > Spreadsheet::ParseExcel::Workbook(3pm)

  get_active_sheet()
    Return the number of the active (open) worksheet (at the time the workbook was saved. May return
    undef.

NAME
    Spreadsheet::ParseExcel::Workbook - A class for Workbooks.

SYNOPSIS
    See the documentation for Spreadsheet::ParseExcel.

DESCRIPTION
    This module is used in conjunction with Spreadsheet::ParseExcel. See the documentation for
    Spreadsheet::ParseExcel.

Methods
    The following Workbook methods are available:

        $workbook->worksheets()
        $workbook->worksheet()
        $workbook->worksheet_count()
        $workbook->get_filename()
        $workbook->get_print_areas()
        $workbook->get_print_titles()
        $workbook->using_1904_date()

  worksheets()
    The "worksheets()" method returns an array of Worksheet objects. This was most commonly used to
    iterate over the worksheets in a workbook:

        for my $worksheet ( $workbook->worksheets() ) {
            ...
        }

  worksheet()
    The "worksheet()" method returns a single "Worksheet" object using either its name or index:

        $worksheet = $workbook->worksheet('Sheet1');
        $worksheet = $workbook->worksheet(0);

    Returns "undef" if the sheet name or index doesn't exist.

  worksheet_count()
    The "worksheet_count()" method returns the number of Woksheet objects in the Workbook.

        my $worksheet_count = $workbook->worksheet_count();

  get_filename()
    The "get_filename()" method returns the name of the Excel file of "undef" if the data was read
    from a filehandle rather than a file.

        my $filename = $workbook->get_filename();

  get_print_areas()
    The "get_print_areas()" method returns an array ref of print areas.

        my $print_areas = $workbook->get_print_areas();

    Each print area is as follows:

        [ $start_row, $start_col, $end_row, $end_col ]

    Returns undef if there are no print areas.

  get_print_titles()
    The "get_print_titles()" method returns an array ref of print title hash refs.

        my $print_titles = $workbook->get_print_titles();

    Each print title array ref is as follows:

        {
            Row    => [ $start_row, $end_row ],
            Column => [ $start_col, $end_col ],
        }

    Returns undef if there are no print titles.

  using_1904_date()
    The "using_1904_date()" method returns true if the Excel file is using the 1904 date epoch
    instead of the 1900 epoch.

        my $using_1904_date = $workbook->using_1904_date();

     The Windows version of Excel generally uses the 1900 epoch while the Mac version of Excel generally uses the 1904 epoch.

    Returns 0 if the 1900 epoch is in use.

AUTHOR
    Current maintainer 0.60+: Douglas Wilson dougw AT cpan.org

    Maintainer 0.40-0.59: John McNamara jmcnamara AT cpan.org

    Maintainer 0.27-0.33: Gabor Szabo szabgab AT cpan.org

    Original author: Kawai Takanori kwitknr AT cpan.org

COPYRIGHT
    Copyright (c) 2014 Douglas Wilson

    Copyright (c) 2009-2013 John McNamara

    Copyright (c) 2006-2008 Gabor Szabo

    Copyright (c) 2000-2006 Kawai Takanori

    All rights reserved.

    You may distribute under the terms of either the GNU General Public License or the Artistic
    License, as specified in the Perl README file.