|
Moodle
2.2.1
http://www.collinsharper.com
|
Public Member Functions | |
| MoodleExcelFormat (&$workbook, $properties=array()) | |
| set_size ($size) | |
| set_bold ($weight=1) | |
| set_underline ($underline) | |
| set_italic () | |
| set_strikeout () | |
| set_outline () | |
| set_shadow () | |
| set_script ($script) | |
| set_color ($color) | |
| set_fg_color ($color) | |
| set_bg_color ($color) | |
| set_pattern ($pattern=1) | |
| set_text_wrap () | |
| set_align ($location) | |
| set_h_align ($location) | |
| set_v_align ($location) | |
| set_top ($style) | |
| set_bottom ($style) | |
| set_left ($style) | |
| set_right ($style) | |
| set_border ($style) | |
| set_num_format ($num_format) | |
Data Fields | |
| $pear_excel_format | |
Definition at line 415 of file excellib.class.php.
| MoodleExcelFormat | ( | &$ | workbook, |
| $ | properties = array() |
||
| ) |
Constructs one Moodle Format.
Internally, add one sheet to the workbook
If we have something in the array of properties, compute them
Definition at line 425 of file excellib.class.php.
| set_align | ( | $ | location | ) |
Set the cell alignment of the format
| string | $location | alignment for the cell ('left', 'right', etc...) |
Set the alignment of the cell safely to the PEAR Format
Definition at line 574 of file excellib.class.php.
| set_bg_color | ( | $ | color | ) |
Set background color (bottom layer) of the format. About formatting colors note that cells backgrounds have TWO layers, in order to support patterns and paint them with two diferent colors. This method set the color of the BOTTOM layer of the background format. So, the color specified here only will be visible if using patterns. Use set_fg_color() to fill cells with plain colors (no patterns).
| mixed | $color | either a string (like 'blue'), or an integer (range is [8...63]) |
Set the background color safely to the PEAR Format
Definition at line 546 of file excellib.class.php.
| set_bold | ( | $ | weight = 1 | ) |
Set weight of the format
| integer | $weight | Weight for the text, 0 maps to 400 (normal text), 1 maps to 700 (bold text). Valid range is: 100-1000. It's Optional, default is 1 (bold). |
Set the bold safely to the PEAR Format
Definition at line 455 of file excellib.class.php.
| set_border | ( | $ | style | ) |
Set cells borders to the same style
| integer | $style | style to apply for all cell borders. 1 => thin, 2 => thick. |
Set all the borders of the cell safely to the PEAR Format
Definition at line 644 of file excellib.class.php.
| set_bottom | ( | $ | style | ) |
Set the bottom border of the format
| integer | $style | style for the cell. 1 => thin, 2 => thick |
Set the bottom border of the cell safely to the PEAR Format
Definition at line 614 of file excellib.class.php.
| set_color | ( | $ | color | ) |
Set color of the format. Used to specify the color of the text to be formatted.
| mixed | $color | either a string (like 'blue'), or an integer (range is [8...63]) |
Set the background color safely to the PEAR Format
Definition at line 519 of file excellib.class.php.
| set_fg_color | ( | $ | color | ) |
Set foreground color (top layer) of the format. About formatting colors note that cells backgrounds have TWO layers, in order to support patterns and paint them with two diferent colors. This method set the color of the TOP layer of the background format. So, when filling cells with plain colors (no patterns) this is the method to use.
| mixed | $color | either a string (like 'blue'), or an integer (range is [8...63]) |
Set the foreground color safely to the PEAR Format
Definition at line 532 of file excellib.class.php.
| set_h_align | ( | $ | location | ) |
Set the cell horizontal alignment of the format
| string | $location | alignment for the cell ('left', 'right', etc...) |
Set the alignment of the cell safely to the PEAR Format
Definition at line 584 of file excellib.class.php.
| set_italic | ( | ) |
Set italic of the format
Set the italic safely to the PEAR Format
Definition at line 474 of file excellib.class.php.
| set_left | ( | $ | style | ) |
Set the left border of the format
| integer | $style | style for the cell. 1 => thin, 2 => thick |
Set the left border of the cell safely to the PEAR Format
Definition at line 624 of file excellib.class.php.
| set_num_format | ( | $ | num_format | ) |
Set the numerical format of the format It can be date, time, currency, etc...
| integer | $num_format | The numeric format |
Set the numerical format safely to the PEAR Format
Definition at line 655 of file excellib.class.php.
| set_outline | ( | ) |
Set outlining of the format
Set the outlining safely to the PEAR Format
Definition at line 490 of file excellib.class.php.
| set_pattern | ( | $ | pattern = 1 | ) |
Set the fill pattern of the format
| integer | Optional. Defaults to 1. Meaningful values are: 0-18 0 meaning no background. |
Set the fill pattern safely to the PEAR Format
Definition at line 556 of file excellib.class.php.
| set_right | ( | $ | style | ) |
Set the right border of the format
| integer | $style | style for the cell. 1 => thin, 2 => thick |
Set the right border of the cell safely to the PEAR Format
Definition at line 634 of file excellib.class.php.
| set_script | ( | $ | script | ) |
Set the script of the text
| integer | $script | The value for script type. Possible values are: 1 => superscript, 2 => subscript |
Set the script safely to the PEAR Format
Definition at line 509 of file excellib.class.php.
| set_shadow | ( | ) |
Set shadow of the format
Set the shadow safely to the PEAR Format
Definition at line 498 of file excellib.class.php.
| set_size | ( | $ | size | ) |
Set the size of the text in the format (in pixels). By default all texts in generated sheets are 10px.
| integer | $size | Size of the text (in pixels) |
Set the size safely to the PEAR Format
Definition at line 443 of file excellib.class.php.
| set_strikeout | ( | ) |
Set strikeout of the format
Set the strikeout safely to the PEAR Format
Definition at line 482 of file excellib.class.php.
| set_text_wrap | ( | ) |
Set text wrap of the format
Set the shadow safely to the PEAR Format
Definition at line 564 of file excellib.class.php.
| set_top | ( | $ | style | ) |
Set the top border of the format
| integer | $style | style for the cell. 1 => thin, 2 => thick |
Set the top border of the cell safely to the PEAR Format
Definition at line 604 of file excellib.class.php.
| set_underline | ( | $ | underline | ) |
Set underline of the format
| integer | $underline | The value for underline. Possible values are: 1 => underline, 2 => double underline |
Set the underline safely to the PEAR Format
Definition at line 466 of file excellib.class.php.
| set_v_align | ( | $ | location | ) |
Set the cell vertical alignment of the format
| string | $location | alignment for the cell ('top', 'vleft', etc...) |
Set the alignment of the cell safely to the PEAR Format
Definition at line 594 of file excellib.class.php.
| $pear_excel_format |
Definition at line 417 of file excellib.class.php.