1Spreadsheet::ParseExcelU:s:eCrelClo(n3t)ributed Perl DocSupmreenatdasthieoent::ParseExcel::Cell(3)
2
6 Spreadsheet::ParseExcel::Cell - A class for Cell data and formatting.
7
9 See the documentation for Spreadsheet::ParseExcel.
10
12 This module is used in conjunction with Spreadsheet::ParseExcel. See
13 the documentation for Spreadsheet::ParseExcel.
14
16 The following Cell methods are available:
17 $cell->value()
19 $cell->unformatted()
20 $cell->get_format()
21 $cell->type()
22 $cell->encoding()
23 $cell->is_merged()
24 $cell->get_rich_text()
25 $cell->get_hyperlink()
26 value()
28 The "value()" method returns the formatted value of the cell.
29 my $value = $cell->value();
31 Formatted in this sense refers to the numeric format of the cell value.
33 For example a number such as 40177 might be formatted as 40,117,
34 40117.000 or even as the date 2009/12/30.
35 If the cell doesn't contain a numeric format then the formatted and
37 unformatted cell values are the same, see the "unformatted()" method
38 below.
39 For a defined $cell the "value()" method will always return a value.
41 In the case of a cell with formatting but no numeric or string contents
43 the method will return the empty string ''.
44 unformatted()
46 The "unformatted()" method returns the unformatted value of the cell.
47 my $unformatted = $cell->unformatted();
49 Returns the cell value without a numeric format. See the "value()"
51 method above.
52 get_format()
54 The "get_format()" method returns the Spreadsheet::ParseExcel::Format
55 object for the cell.
56 my $format = $cell->get_format();
58 If a user defined format hasn't been applied to the cell then the
60 default cell format is returned.
61 type()
63 The "type()" method returns the type of cell such as Text, Numeric or
64 Date. If the type was detected as Numeric, and the Cell Format matches
65 "m{^[dmy][-\\/dmy]*$}i", it will be treated as a Date type.
66 my $type = $cell->type();
68 See also "Dates and Time in Excel".
70 encoding()
72 The "encoding()" method returns the character encoding of the cell.
73 my $encoding = $cell->encoding();
75 This method is only of interest to developers. In general
77 Spreadsheet::ParseExcel will return all character strings in UTF-8
78 regardless of the encoding used by Excel.
79 The "encoding()" method returns one of the following values:
81 · 0: Unknown format. This shouldn't happen. In the default case the
83 format should be 1.
84 · 1: 8bit ASCII or single byte UTF-16. This indicates that the
86 characters are encoded in a single byte. In Excel 95 and earlier
87 This usually meant ASCII or an international variant. In Excel 97
88 it refers to a compressed UTF-16 character string where all of the
89 high order bytes are 0 and are omitted to save space.
90 · 2: UTF-16BE.
92 · 3: Native encoding. In Excel 95 and earlier this encoding was used
94 to represent multi-byte character encodings such as SJIS.
95 is_merged()
97 The "is_merged()" method returns true if the cell is merged.
98 my $is_merged = $cell->is_merged();
100 Returns "undef" if the property isn't set.
102 get_rich_text()
104 The "get_rich_text()" method returns an array ref of font information
105 about each string block in a "rich", i.e. multi-format, string.
106 my $rich_text = $cell->get_rich_text();
108 The return value is an arrayref of arrayrefs in the form:
110 [
112 [ $start_position, $font_object ],
113 ...,
114 ]
115 Returns undef if the property isn't set.
117 get_hyperlink()
119 If a cell contains a hyperlink, the "get_hyperlink()" method returns an
120 array ref of information about it.
121 A cell can contain at most one hyperlink. If it does, it contains no
123 other value.
124 Otherwise, it returns undef;
126 The array contains:
128 · 0: Description (what's displayed); undef if not present
130 · 1: Link, converted to an appropriate URL - Note: Relative links are
132 based on the input file. %REL% is used if the input file is
133 unknown (e.g. a file handle or scalar)
134 · 2: Target - target frame (or undef if none)
136
138 Dates and times in Excel are represented by real numbers, for example
139 "Jan 1 2001 12:30 PM" is represented by the number 36892.521.
140 The integer part of the number stores the number of days since the
142 epoch and the fractional part stores the percentage of the day.
143 A date or time in Excel is just like any other number. The way in which
145 it is displayed is controlled by the number format:
146 Number format $cell->value() $cell->unformatted()
148 ============= ============== ==============
149 'dd/mm/yy' '28/02/08' 39506.5
150 'mm/dd/yy' '02/28/08' 39506.5
151 'd-m-yyyy' '28-2-2008' 39506.5
152 'dd/mm/yy hh:mm' '28/02/08 12:00' 39506.5
153 'd mmm yyyy' '28 Feb 2008' 39506.5
154 'mmm d yyyy hh:mm AM/PM' 'Feb 28 2008 12:00 PM' 39506.5
155 The Spreadsheet::ParseExcel::Utility module contains a function called
157 "ExcelLocaltime" which will convert between an unformatted Excel
158 date/time number and a "localtime()" like array.
159 For date conversions using the CPAN "DateTime" framework see
161 DateTime::Format::Excel
162 http://search.cpan.org/search?dist=DateTime-Format-Excel
163
165 Current maintainer 0.60+: Douglas Wilson dougw@cpan.org
166 Maintainer 0.40-0.59: John McNamara jmcnamara@cpan.org
168 Maintainer 0.27-0.33: Gabor Szabo szabgab@cpan.org
170 Original author: Kawai Takanori kwitknr@cpan.org
172
174 Copyright (c) 2014 Douglas Wilson
175 Copyright (c) 2009-2013 John McNamara
177 Copyright (c) 2006-2008 Gabor Szabo
179 Copyright (c) 2000-2006 Kawai Takanori
181 All rights reserved.
183 You may distribute under the terms of either the GNU General Public
185 License or the Artistic License, as specified in the Perl README file.
186perl v5.30.1 2020-01-30 Spreadsheet::ParseExcel::Cell(3)