Name

band_height -- Define the height of a band

Synopsis

int band_new ( int band, float height )

Description

This function defines the height (in PDF units) of a band identified by the band ID band.

This height value is used by band_line() to determine how far to move the paint pointer after painting the band. The value has no effect on bands placed using the band_place() command.

The function returns an true on success, false if an invalid value was specified.

Examples

$band = $pdf->band_new();
$pdf->band_height($band, 15);
$pdf->band_add_box($band, 0, 0, 15, 100);
$pdf->band_add_field($band, 3, 3, "num", 9);
for ($i = 0; $i < 10; $i++) {
    $v['num'] = $i;
    $pdf->band_line($band, $v);
}

See Also

band_add_box(), band_add_field(), band_add_label(), band_place(), band_line(), band_new()

History

This function was removed from the library in version 2. Use the new template functions instead.

Bugs

Lines are wrapped at word boundries. If a single word is longer than the alloted space, it is silently replaced with blank line.

The behaviour of a text string with a newline is undefined.