Bookshelf Home | Contents | Index | PDF     

Siebel Consumer Goods Handheld Guide > Print Tagging Language > Print Formatting Tags >

List Tag

The List tag prints the selected columns in a specified column width.

Usage

Use the List tag to print out a list of records containing specified fields.

Syntax

To use this tag, use the following syntax:

<TAG:List appletname="APPLET" columns="COLUMN1|COLUMN2|...|COLUMNx" columnwidths="Col1Width|Col2Width|...|ColxWidth" header="HEADER" headerdivider="HEADERDIVIDER" recorderdivider="RECORDDIVIDER" query="QUERY" sql="SQL" sort="SORT" maxlines="MAXLINES" startat="START" wrap="WRAP" grid="GRID" rowsprinted="ROWSPRINTED" offset="OFFSET" width="WIDTH" linewidth="LINEWIDTH">

Parameter
Description

TAG:List

(Required) List tag indicator.

appletname

(Required) Applet name as defined in Siebel Tools.

columns

(Required) List of field names in applet to be printed in the specified order, separated by a vertical bar (|).

columnwidth

(Optional) Relative weight of each column width. For example, 1|2 means that the first column is half the width of the second column.

header

(Optional) Specifies whether to suppress or show headers.

Valid values are TRUE (default) or FALSE. If FALSE, captions in form applets are suppressed. This parameter applies only to form applets.

headerdivider

(Optional, relative mode-only tag) Specifies whether to print a divider below the heading in a list applet.

Valid values are TRUE or FALSE (default). If TRUE, a divider is printed below the column heading in list applets. This parameter applies only to list applets.

recorddivider

(Optional, relative mode-only tag) Specifies whether to print a horizontal divider between records in a list applet.

Valid values are TRUE or FALSE (default). If TRUE, a horizontal divider is printed between records in list applets. This parameter applies only to list applets.

query

(Optional) Specifies query specification.

sql

(Optional) Where clause for the SQL statement; sql="\"status"\='good'" selects all records where status field is set to good.

NOTE:  Enclose the field name in double quotes and use backslash followed by double quotes to include a double quote within the parameter, then enclose the value in single quotes.

sort

(Optional) Specifies sort specification.

maxlines

(Optional) The maximum number of records that are printed for this applet. This parameter applies only to list applets.

startat

(Optional) The point at which the specified record in the row set starts printing.

wrap

(Optional) Specifies whether word wrap is enabled for text field values.

Valid values are TRUE or FALSE (default). If TRUE, word wrap is applied to text field values. This setting does not apply to numeric fields.

grid

(Optional, absolute mode-only) Specifies whether to print a grid between fields, rows and columns.

Valid values are TRUE or FALSE (default). If TRUE, a grid is printed between fields, rows, and columns.

rowsprinted

Specifies the number of rows to print for list applets. This parameter does not apply to form applets.

offset

(Optional) Specifies the distance, in millimeters, to the right of the left margin. This can be a number ("40") or a variable that contains a number value ("_X" or "posx"). This is an absolute-mode only parameter.

width

(Optional, absolute mode-only) Specifies the width of the applet in millimeters.

linewidth

(Optional, absolute mode-only) Specifies the line grid thickness in millimeters.

Example

The following example prints out the records (30 x 70 mm respectively) from the CS HH Product Bucket List Applet containing the Status and Product Name fields:

<TAG:List appletname="CS HH Product Bucket List Applet" columns="Status|Product Name" columnwidths="30|70" maxlines="2" line="False" wrap="TRUE" rowsprinted="numrows" grid="TRUE" linewidth="0.5" offset="10" width="75">

    
Siebel Consumer Goods Handheld Guide Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.