text_frame

Summary

Create frame around text.

Usage

{pdf( text_frame, text, hash( [ frameRGB, rgb_frame_color, ]
                    [ frameCMYK, cmyk_frame_color, ]
                    [ textRGB, rgb_text_color, ]
                    [ textCMYK, cmyk_text_color, ]
                    [ fontSize, font_size, ]
                    [ fontName, font_name, ]
                    [ padding, text_padding, ]
                    [ leftPadding, left_text_padding, ]
                    [ rightPadding, right_text_padding, ]
                    [ topPadding, top_text_padding, ]
                    [ bottomPadding, bottom_text_padding, ]
                    [ roundEnds, round_ends ] ) )}

Parameters

NameTypeDescriptionRequired
frameRGB array Frame RGB color, range 0 .. 255 no
frameCMYK array Frame CMYK color, range 0 .. 1 no
textRGB array Text RGB color, range 0 .. 255 no
textCMYK array Text CMYK color, range 0 .. 1 no
fontSize integer Font size no
fontName string Font name no
padding integer Padding around text no
leftPadding integer Padding left of text no
rightPadding integer Padding rigth of text no
topPadding integer Padding at top of text no
bottomPadding integer Padding at bottom of text no
roundEnds boolean Create round ends at end of text frame no
text string Text to display inside text frame yes

Returns

Description

Create a frame around text.

Setting right or left padding to -1 will fill right or left of page.

Available from 3.4 and newer

Examples

{pdf(text_frame, "Test frame", hash( roundEnds, 1,

                                textCMYK, array(0.89, 0.43, 0.01, 0),

                                 frameCMYK, array(0,0,0,0),

                                 padding, 8,

                                 fontSize, 17,

                                 leftPadding, 10,

                                 rightPadding, -1 ))}

Will create frame around "Test frame" , with the left side rounded.

Comments

log in or create a user account to comment.

Contents

Reference

Database diagram
Template operators
    PDF
       anchor
       createIndex
       filled_circle
       filled_rectangle
       footer
       footer_block
       frame_header
       frontpage
       header
       header_block
       image
       keyword
       line
       link
       newline
       newpage
       set_font
       set_margin
       strike
       table
       text
       text_box
       text_frame
       toc
       ul
    Arrays
    Data extraction
    Formatting
    Images
    Logic
    Mathematics
    Miscellaneous
    Strings
    URLs
    Variables
Template functions
Data fetching
Modules
XML tags


Created

14/05/2004
3:01:27 pm
by Kåre Køhler Høvik

Last updated

14/05/2004
3:01:27 pm
by Kåre Køhler Høvik

Authors

Kåre Køhler Høvik



This page is part of the Exponential documentation. The documentation is available under the GNU Free Documentation License. All contributions will be released under the terms of this license.