Lasso Soft Inc. > Home

[PDF_List]

Creates a list object to be added to a [PDF_Doc] variable. Text list items are added to this object using the [PDF_List->Add] tag. Optional parameters for this object are described below.

  • Syntax
  • Parameters
[Var:'List'=(PDF_List: -Format='Number', -Bullet=Character, -Font=PDF_Font Variable)]
Optional Parameters
-Format Specifies whether the list is numbered, lettered, or bulleted. Requires a value of 'Number', 'Letter', 'Bullet'. Defaults to 'Bullet' if no -Format parameter is specified. Optional.
-Bullet Specifies a custom character to use as the bullet character. Requires a character as a parameter (e.g. 'x'). Defaults to 'ยด' if not specified. Optional.
-Indent Sets the indentation for sub-elements in the list. Requires a decimal parameter which is the width of the indentation in points. Optional.
-Font Sets the font for the specified text. The value is a [PDF_Font] variable, which is described in the Using Fonts section of this chapter. The font defaults to the current inherited font if no -Font parameter is specified.
-Align Sets the alignment of the list in the page ('Left', 'Center', or 'Right'). Optional.
-Color Sets the font color. Requires a [PDF_Color] object or a hex color string as a parameter (e.g '#550000'). Defaults to '#000000' if not used. Optional.
-BackgroundColor Sets the text background color. Require a hex color string as a parameter (e.g '#550000'). Optional.
-Leading Sets the list leading space in points (the space above and below the text), and requires a decimal value. Optional.
-IndentLeft Sets the left indent of the list object. Requires a decimal value which is the number of points to indent the text. Optional.
-IndentRight Sets the right indent of the list object. Requires a decimal value which is the number of points to indent the text. Optional.
[PDF_List->Add] Variable Add objects to the list. Requires a text string on a [PDF_Text] object as a parameter.
Examples

To add a numbered list:

Use the [PDF_List] tag with the -Format='Number' parameter to define the list, and the [PDF_List->Add] tag to add items to the list. The example below creates a numbered list with three items.

[Var:'List'=(PDF_List: -Format='Number', -Align='Center', -Font=$MyFont)]
[$List->(Add:'This is item one')]
[$List->(Add:'This is item two')]
[$List->(Add:'This is item three')]
[$MyFile->(Add: $List, -Top=400.0)]

To add a bulleted list:

Use the [PDF_List] tag with the -Format='Number' parameter to define the list, and the [PDF_List->Add] tag to add items to the list. The example below adds a numbered list with four items, where a hyphen (-) is used as the bullet character.

[Var:'List'=(PDF_List: -Format='Bullet', -Bullet='-', -Font=$MyFont)]
[$List->(Add:'This is item one')]
[$List->(Add:'This is item two')]
[$List->(Add:'This is item three')]
[$List->(Add:'This is item four')]
[$MyFile->(Add: $List, -Top=400.0)]
Tag Link [PDF_List] Category PDF
Type Substitution Data Source Any
Support Preferred Version 7.0
Output Type PDF_List Security Tag
Implementation LJAPI Sets Lasso 8.5, Lasso 8.0, Lasso 7.0

Please note that periodically LassoSoft will go through the notes and may incorporate information from them into the documentation. Any submission here gives LassoSoft a non-exclusive license and will be made available in various formats to the Lasso community.

LassoSoft Inc. > Home

 

 

©LassoSoft Inc 2015 | Web Development by Treefrog Inc | PrivacyLegal terms and Shipping | Contact LassoSoft