.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "Excel::Template::Container::Format 3pm" .TH Excel::Template::Container::Format 3pm "2017-07-13" "perl v5.26.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Excel::Template::Container::Format \- Excel::Template::Container::Format .SH "PURPOSE" .IX Header "PURPOSE" To format all children according to the parameters .SH "NODE NAME" .IX Header "NODE NAME" \&\s-1FORMAT\s0 .SH "INHERITANCE" .IX Header "INHERITANCE" Excel::Template::Container .SH "ATTRIBUTES" .IX Header "ATTRIBUTES" Boolean attributes should be set to 1, 0, true, or false. .PP Color values can be the color name or the color index. See \*(L"\s-1COLOURS IN EXCEL\*(R"\s0 in Spreadsheet::WriteExcel .IP "\(bu" 4 align .Sp Set to either left, center, right, fill, or justify. Default is left. See also valign. .IP "\(bu" 4 bg_color .Sp Set to a color value. Default is none. .IP "\(bu" 4 bold .Sp This will set bold to on or off, depending on the boolean value. .IP "\(bu" 4 border .Sp Set the border for all for edges of a cell. Also see bottom, top, left, and right. Valid values are 0 \- 7. .Sp See \*(L"\fIset_border()\fR\*(R" in Spreadsheet::WriteExcel .IP "\(bu" 4 border_color .Sp Sets the color value for the border. See also border, top_color, bottom_color, left_color and right_color. .IP "\(bu" 4 bottom .Sp See border. .IP "\(bu" 4 bottom_color .Sp See border_color .IP "\(bu" 4 color .Sp This will set the color of the text, depending on color value. Default is black. .IP "\(bu" 4 fg_color .Sp Set to a color value. This color will be used in foreground of some patterns. See color to change the color of text. Also see bg_color and pattern. .IP "\(bu" 4 font .Sp This will sent the font face. Default is Arial. .IP "\(bu" 4 font_outline .Sp This will set font_outline to on or off, depending on the boolean value. (q.v. \&\s-1OUTLINE\s0 tag) .IP "\(bu" 4 font_shadow .Sp This will set font_shadow to on or off, depending on the boolean value. (q.v. \&\s-1SHADOW\s0 tag). This only applies to Excel for Macintosh. .IP "\(bu" 4 font_strikeout .Sp This will set font_strikeout to on or off, depending on the boolean value. (q.v. \&\s-1STRIKEOUT\s0 tag) .IP "\(bu" 4 hidden .Sp This will set whether the cell is hidden to on or off, depending on the boolean value. .IP "\(bu" 4 indent .Sp Set the indentation level for a cell. Positive integers are allowed. .IP "\(bu" 4 italic .Sp This will set italic to on or off, depending on the boolean value. (q.v. \s-1ITALIC\s0 tag) .IP "\(bu" 4 left .Sp See border. .IP "\(bu" 4 left_color .Sp See border_color. .IP "\(bu" 4 num_format .Sp Set to the index of one of Excel's built-in number formats. See \*(L"\fIset_num_format()\fR\*(R" in Spreadsheet::WriteExcel .IP "\(bu" 4 pattern .Sp Set to an integer, 0 \- 18. Sets the background fill pattern of a ell. Default is 1, solid. .IP "\(bu" 4 right .Sp See border. .IP "\(bu" 4 right_color .Sp See border color. .IP "\(bu" 4 rotation .Sp Set the rotation of the text in a cell. The rotation can be any angle in the range \-90 to 90 degrees. The angle 270 is also supported. This indicates text where the letters run from top to bottom. .IP "\(bu" 4 shrink .Sp A boolean value. If true, text will shrink to fit a cell. .IP "\(bu" 4 size .Sp This will set the size of the font. Default is 10. Unless a row height is specifically set, the row will grow taller as necessary. .IP "\(bu" 4 text_justlast .Sp A boolean value to justify the last line. Only applies to Far Eastern versions of Excel. .IP "\(bu" 4 text_wrap .Sp A boolean value. When set to true, text will wrap in a cell instead of crossing over into empty cells. If the row height is not set, the row will grow taller to accommodate the wrapping text. .IP "\(bu" 4 top .Sp See border. .IP "\(bu" 4 top_color .Sp See border_color .IP "\(bu" 4 valign .Sp Set to top, vcenter, bottom, or vjustify. Default is vcenter. See also align. .SH "CHILDREN" .IX Header "CHILDREN" None .SH "EFFECTS" .IX Header "EFFECTS" None .SH "DEPENDENCIES" .IX Header "DEPENDENCIES" None .SH "USAGE" .IX Header "USAGE" .Vb 3 \& \& ... Children here \& .Ve .PP In the above example, the children will be displayed (if they are displaying elements) in a bold format. All other formatting will remain the same and the \&\*(L"bold\*(R"\-ness will end at the end tag. .SH "AUTHOR" .IX Header "AUTHOR" Rob Kinyon (rob.kinyon@gmail.com) .SH "SEE ALSO" .IX Header "SEE ALSO" \&\s-1BOLD, HIDDEN, ITALIC, OUTLINE, SHADOW, STRIKEOUT\s0