12.17. The OpenCReport\Line class #

12.17.1. Set or get the font name for the line
12.17.2. Set or get the font size for the line
12.17.3. Set or get the font's bold flag for the line
12.17.4. Set or get the font's italic flag for the line
12.17.5. Set or get line suppression
12.17.6. Set or get text color for the line
12.17.7. Set or get background color for the line
12.17.8. Add a text element to the line
12.17.9. Add an image element to the line
12.17.10. Get the first line element

class OpenCReport\Line {
    public final set_font_name(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_font_name():
                     ?OpenCReport\Expr;

    public final set_font_size(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_font_size():
                     ?OpenCReport\Expr;

    public final set_bold(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_bold():
                     ?OpenCReport\Expr;

    public final set_italic(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_italic():
                     ?OpenCReport\Expr;

    public final set_suppress(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_suppress():
                     ?OpenCReport\Expr;

    public final set_color(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_color():
                     ?OpenCReport\Expr;

    public final set_bgcolor(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_bgcolor():
                     ?OpenCReport\Expr;

    public final add_text():
                     ?OpenCReport\Text;

    public final add_image():
                     ?OpenCReport\Image;

    public final add_barcode():
                     ?OpenCReport\Barcode;

    public final get_first_element():
                     ?OpenCReport\LineElement;
}

12.17.1. Set or get the font name for the line #

Set the font name for the line. This font will be used for child text elements that don't set the font name themselves.

public final
OpenCReport\Line::set_font_name(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Line::get_font_name():
                     ?OpenCReport\Expr;

12.17.2. Set or get the font size for the line #

Set the font size for the line. This font size will be used for child text elements that don't set the font size themselves.

public final
OpenCReport\Line::set_font_size(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Line::get_font_size():
                     ?OpenCReport\Expr;

12.17.3. Set or get the font's bold flag for the line #

Set the font's bold flag for the line. The expression must evaluate to a numeric value that is treated as a boolean, i.e. 0 or non-0. Default is false. This bold flag value will be used for child text elements that don't set it themselves.

public final
OpenCReport\Line::set_bold(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Line::get_bold():
                     ?OpenCReport\Expr;

12.17.4. Set or get the font's italic flag for the line #

Set the font's italic flag for the line. The expression must evaluate to a numeric value that is treated as a boolean, i.e. 0 or non-0. Default is false. This italic flag value will be used for child text elements that don't set it themselves.

public final
OpenCReport\Line::set_italic(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Line::get_italic():
                     ?OpenCReport\Expr;

12.17.5. Set or get line suppression #

Set the suppression flag for the line. The expression must evaluate to a numeric value that is treated as a boolean, i.e. 0 or non-0. Default is false, i.e. not suppressed. When set to a non-0 value (i.e. true), the whole line with all its child elements (text or image) will be suppressed, i.e. not rendered.

public final
OpenCReport\Line::set_suppress(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Line::set_suppress():
                     ?OpenCReport\Expr;

12.17.6. Set or get text color for the line #

Set text color for the line. See Color specification. This text color will be used for child elements that don't set the text color themselves.

public final
OpenCReport\Line::set_color(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Line::get_color():
                     ?OpenCReport\Expr;

12.17.7. Set or get background color for the line #

Set background color for the line. See Color specification. This background color will be used for child elements that don't set the background color themselves.

public final
OpenCReport\Line::set_bgcolor(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

public final
OpenCReport\Line::get_bgcolor():
                     ?OpenCReport\Expr;

12.17.8. Add a text element to the line #

Add a child text element to the line. For class methods of OpenCReport\Text, see Section 12.20.

public final
OpenCReport\Line::add_text():
                     ?OpenCReport\Text;

12.17.9. Add an image element to the line #

Add a child image element to the line. For class methods of OpenCReport\Image, see Section 12.19.

public final
OpenCReport\Line::add_image():
                     ?OpenCReport\Image;

12.17.10. Get the first line element #

Get the first element of the line. It starts an iterator for the output, and return the first element via an OpenCReport\LineElement object, or null if there is none. See also Section 12.23.

public final
OpenCReport\Line::get_first_element():
                     ?OpenCReport\LineElement;