12.20. The OpenCReport\Text class #

12.20.1. Set literal value
12.20.2. Set or get expression value
12.20.3. Set or get delayed flag for the field expression
12.20.4. Set or get the format string for the field expression
12.20.5. Set or get the translation flag for the field expression
12.20.6. Set or get the field width
12.20.7. Set or get the field alignment
12.20.8. Set or get the field text color
12.20.9. Set or get the field background color
12.20.10. Set or get the field font name
12.20.11. Set or get the field font size
12.20.12. Set or get the field's bold flag
12.20.13. Set or get the field's italic flag
12.20.14. Set or get the field's link
12.20.15. Set or get the field's memo flag
12.20.16. Set or get the field's "wrap at characters" flag
12.20.17. Set or get the field's maximum number of lines

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

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

    public final get_value():
                     ?OpenCReport\Expr;

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

    public final get_value_delayed():
                     ?OpenCReport\Expr;

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

    public final get_format():
                     ?OpenCReport\Expr;

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

    public final get_translate():
                     ?OpenCReport\Expr;

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

    public final get_width():
                     ?OpenCReport\Expr;

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

    public final get_alignment():
                     ?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 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_link(
                     ?string $expr_string = null):
                     ?OpenCReport\Expr;

    public final get_link():
                     ?OpenCReport\Expr;

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

    public final get_memo():
                     ?OpenCReport\Expr;

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

    public final get_memo_wrap_chars():
                     ?OpenCReport\Expr;

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

    public final get_memo_max_lines():
                     ?OpenCReport\Expr;
}

12.20.1. Set literal value #

Set the literal value for the text element.

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

12.20.2. Set or get expression value #

Set the expression value for the text element. And expression may depend on data row values. See Expressions.

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

public final
OpenCReport\Text::get_value():
                     ?OpenCReport\Expr;

12.20.3. Set or get delayed flag for the field expression #

Set delayed flag for the field expression. When set to true, the field expression's last value is calculated during the precalculation phase of executing the report and this precalculated value is used during rendering the report.

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

public final
OpenCReport\Text::get_value_delayed():
                     ?OpenCReport\Expr;

12.20.4. Set or get the format string for the field expression #

Set the format string for the field expression. This format string will be used instead of the default formats for specific types. See Formatting data

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

public final
OpenCReport\Text::set_format():
                     ?OpenCReport\Expr;

12.20.5. Set or get the translation flag for the field expression #

Set the translation flag for the field expression. When set to true, the field value will be translated according to the locale and translation settings. See Section 12.4.2

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

public final
OpenCReport\Text::get_translate():
                     ?OpenCReport\Expr;

12.20.6. Set or get the field width #

Set the field width. See Text element width

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

public final
OpenCReport\Text::get_width():
                     ?OpenCReport\Expr;

12.20.7. Set or get the field alignment #

Set the field alignment. See Text element alignment

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

public final
OpenCReport\Text::get_alignment():
                     ?OpenCReport\Expr;

12.20.8. Set or get the field text color #

Set the field text color. See Section 8.17.1.6

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

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

12.20.9. Set or get the field background color #

Set the field background color. See Section 8.17.1.7

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

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

12.20.10. Set or get the field font name #

Set the field font name. See Text element font name

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

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

12.20.11. Set or get the field font size #

Set the field font size. See Text element font size

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

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

12.20.12. Set or get the field's bold flag #

Set the field's bold flag. See Section 8.17.1.10

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

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

12.20.13. Set or get the field's italic flag #

Set the field's italic flag. See Section 8.17.1.11

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

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

12.20.15. Set or get the field's memo flag #

Set the field's memo (multi-line text) flag. When set to true, the text field becomes a multi-line field. See Multi-line (memo) field

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

public final
OpenCReport\Text::get_memo():
                     ?OpenCReport\Expr;

12.20.16. Set or get the field's "wrap at characters" flag #

Set the field's "wrap at characters" flag. Only used when the memo flag is set to true. Default is false, the text is wrapped at word boundaries. When set to true, text is wrapped at character boundaries with hyphenation. See Section 8.17.1.14

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

public final
OpenCReport\Text::get_memo_wrap_chars():
                     ?OpenCReport\Expr;

12.20.17. Set or get the field's maximum number of lines #

Set the field's maximum number of lines. Only used when the memo flag is set to true. The text field's value is only rendered up to the set number of lines. Default is unset, the text is rendered fully. See Section 8.17.1.15

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

public final
OpenCReport\Text::get_memo_max_lines():
                     ?OpenCReport\Expr;