Excel::Template::Container::Format(3pm)

1Excel::Template::ContaiUnseerr::CFoonrtmraitb(u3t)ed PerElxcDeolc:u:mTeenmtpaltaitoen::Container::Format(3)
2
3
4

NAME

6       Excel::Template::Container::Format - Excel::Template::Container::Format
7

PURPOSE

9       To format all children according to the parameters
10

NODE NAME

12       FORMAT
13

INHERITANCE

15       Excel::Template::Container
16

ATTRIBUTES

18       Boolean attributes should be set to 1, 0, true, or false.
19
20       Color values can be the color name or the color index. See "COLOURS IN
21       EXCEL" in Spreadsheet::WriteExcel
22
23       ·   align
24
25           Set to either left, center, right, fill, or justify. Default is
26           left.  See also valign.
27
28       ·   bg_color
29
30           Set to a color value. Default is none.
31
32       ·   bold
33
34           This will set bold to on or off, depending on the boolean value.
35
36       ·   border
37
38           Set the border for all for edges of a cell. Also see bottom, top,
39           left, and right.  Valid values are 0 - 7.
40
41           See "set_border()" in Spreadsheet::WriteExcel
42
43       ·   border_color
44
45           Sets the color value for the border. See also border, top_color,
46           bottom_color, left_color and right_color.
47
48       ·   bottom
49
50           See border.
51
52       ·   bottom_color
53
54           See border_color
55
56       ·   color
57
58           This will set the color of the text, depending on color value.
59           Default is black.
60
61       ·   fg_color
62
63           Set to a color value. This color will be used in foreground of some
64           patterns. See color to change the color of text. Also see bg_color
65           and pattern.
66
67       ·   font
68
69           This will sent the font face. Default is Arial.
70
71       ·   font_outline
72
73           This will set font_outline to on or off, depending on the boolean
74           value. (q.v.  OUTLINE tag)
75
76       ·   font_shadow
77
78           This will set font_shadow to on or off, depending on the boolean
79           value. (q.v.  SHADOW tag). This only applies to Excel for
80           Macintosh.
81
82       ·   font_strikeout
83
84           This will set font_strikeout to on or off, depending on the boolean
85           value. (q.v.  STRIKEOUT tag)
86
87       ·   hidden
88
89           This will set whether the cell is hidden to on or off, depending on
90           the boolean value.
91
92       ·   indent
93
94           Set the indentation level for a cell. Positive integers are
95           allowed.
96
97       ·   italic
98
99           This will set italic to on or off, depending on the boolean value.
100           (q.v. ITALIC tag)
101
102       ·   left
103
104           See border.
105
106       ·   left_color
107
108           See border_color.
109
110       ·   num_format
111
112           Set to the index of one of Excel's built-in number formats. See
113           "set_num_format()" in Spreadsheet::WriteExcel
114
115       ·   pattern
116
117           Set to an integer, 0 - 18. Sets the background fill pattern of a
118           ell. Default is 1, solid.
119
120       ·   right
121
122           See border.
123
124       ·   right_color
125
126           See border color.
127
128       ·   rotation
129
130           Set the rotation of the text in a cell. The rotation can be any
131           angle in the range -90 to 90 degrees.  The angle 270 is also
132           supported. This indicates text where the letters run from top to
133           bottom.
134
135       ·   shrink
136
137           A boolean value. If true, text will shrink to fit a cell.
138
139       ·   size
140
141           This will set the size of the font. Default is 10. Unless a row
142           height is specifically set, the row will grow taller as necessary.
143
144       ·   text_justlast
145
146           A boolean value to justify the last line. Only applies to Far
147           Eastern versions of Excel.
148
149       ·   text_wrap
150
151           A boolean value. When set to true, text will wrap in a cell instead
152           of crossing over into empty cells. If the row height is not set,
153           the row will grow taller to accommodate the wrapping text.
154
155       ·   top
156
157           See border.
158
159       ·   top_color
160
161           See border_color
162
163       ·   valign
164
165           Set to top, vcenter, bottom, or vjustify. Default is vcenter. See
166           also align.
167

CHILDREN

169       None
170

EFFECTS

172       None
173

DEPENDENCIES

175       None
176

USAGE

178         <format bold="1">
179           ... Children here
180         </format>
181
182       In the above example, the children will be displayed (if they are
183       displaying elements) in a bold format. All other formatting will remain
184       the same and the "bold"-ness will end at the end tag.
185

AUTHOR

187       Rob Kinyon (rob.kinyon@gmail.com)
188