6.0
Table Of Contents
- PlanetPress Talk Basics
- PlanetPress Talk Editor
- Key Concepts
- Detailed Directions
- Enter a New Program in the Editor
- Import or Export a Program
- Save a Program
- Print a Program
- Exit the PlanetPress Talk Editor
- Show or Hide the Commands Area or Spy List
- Adjust the Sizes of the Commands Area, Code Area and Spy List
- Expand or Collapse Command Groups
- Enter Commands in the Editor
- Use Command and Variable Name Completion
- PlanetPress Talk Summary
- Variables
- Operators and Operator Functions
- Loop and Condition Structures
- Commands
- Add a Comment
- Work with Emulations
- Work with Data Pages
- Work with Database Records
- Select or Define a Data Value
- Execute Documents and Document Elements
- Work with PostScript
- Work with PPDs
- Save and Restore the Current Graphics State
- Work with Global Functions
- Define and Assign Values to Variables
- Work with Objects
- Work with Bar Codes
- Work with Images and Attachments
- Work with Text
- Work with Styles
- Work with Strings
- Work with Characters
- Work with Arrays and Color Arrays
- Draw
- Search
- Debug
- Language Reference
- Language Reference (Alphabetical)
- % (procedure)
- @ (function)
- @name (function/procedure)
- @page (procedure)
- $element (procedure)
- + (operator & function)
- - (operator)
- * (operator)
- / (operator)
- > (operator)
- >= (operator)
- < (operator)
- <= (operator)
- = (operator)
- := (operator)
- <> (operator)
- Add (function)
- And (Boolean operator function)
- Arc (procedure)
- ArcN (procedure)
- BeginParagraph … EndParagraph (procedure)
- BeginUTF8Paragraph … EndUTF8Paragraph (procedure)
- BitmapWidth/BitmapHeight (function)
- Breakpoint (procedure)
- C128 (function)
- CallPPD (procedure)
- Char (function)
- Ceil (function)
- ClearPage (procedure)
- ClosePath (procedure)
- Cos (function)
- CRLF (procedure)
- Current (system object)
- currentiteration (variable)
- CurToStr (function)
- CurveTo/RCurveTo (procedure)
- Date (function)
- Define (procedure)
- DefineData (procedure)
- DefineImageIndex (procedure)
- Directory
- Div (function)
- DoForm (procedure)
- &EOJob (system variable)
- EPSWidth/EPSHeight (function)
- Eq (function)
- ExecPage (procedure)
- Exit (procedure)
- Field (function)
- FieldCount (function)
- FieldName (function)
- Fill (procedure)
- Find (function)
- &FirstSide (system variable)
- FloatToInt (function)
- FloatToStr (function)
- For… EndFor (procedure)
- Function @name (procedure)
- GE (function)
- Get (function)
- GetBlack (function)
- GetCyan (function)
- GetMagenta (function)
- GetNextDataPage(procedure)
- GetYellow (function)
- GRestore (procedure)
- GSave (procedure)
- GT (function)
- &Height (system variable)
- If (function)
- If … ElseIf… EndIf (procedure)
- IntToFloat (function)
- IntToStr (function)
- InStream... EndInStream (procedure)
- IsNumber (function)
- IsPageEmpty (function)
- iterationcount (variable)
- LE (function)
- Left (function)
- Length (function)
- LineTo/RLineTo (procedure)
- LowerCase (function)
- LT (function)
- MapUTF8 (function)
- Margin (procedure)
- Mid (function)
- Mod (function & procedure)
- MoveTo/RMoveTo (procedure)
- Mul (function)
- NE (function)
- Neg (function)
- Not (Boolean operator function)
- Object $name()... EndObject (procedure)
- Or (Boolean operator function)
- Ord (function)
- OutputDebugString (procedure)
- PassThrough (procedure)
- PDFPageCount (function)
- PDFWidth/PDFHeight (function)
- Physical (system object)
- Pie (procedure)
- PixelHeight (function)
- PixelWidth (function)
- Pos (function)
- &PrinterMode (system variable)
- Put (procedure)
- Random (function)
- Rectangle (procedure)
- RectFill (procedure)
- RectFillStroke (procedure)
- RectStroke (procedure)
- Repeat... Until (procedure)
- ResourceType (function)
- Right (function)
- RunPS (procedure)
- Scale (procedure)
- Search … EndSearch (procedure)
- SelectMedia (procedure)
- Set (procedure)
- SetAngle (procedure)
- SetBodyText (procedure)
- SetDash(procedure)
- SetDataPage(procedure)
- SetEmailAddress (procedure)
- SetEmailSubject (procedure)
- SetEmulation(procedure)
- SetFaxInformation (procedure)
- SetFaxNumber (procedure)
- SetFillColor (procedure)
- SetStyle (procedure)
- SetStyleExt (procedure)
- SetImageIndex (procedure)
- SetLineWidth (procedure)
- SetLPP(procedure)
- SetPDFBookmark (procedure)
- SetStrokeColor (procedure)
- Show / ShowCenter / ShowRight (procedure)
- ShowBarCode (procedure)
- ShowBitmap (procedure)
- ShowEPS (procedure)
- ShowLeftRight (procedure)
- ShowPage (procedure)
- ShowPDF (procedure)
- ShowUTF8 (procedure)
- ShowUTF8Left / ShowUTF8Right / ShowUTF8Center (procedure)
- Sin (function)
- StopJob (procedure)
- Store (procedure)
- &Str (system variable)
- StringReplace (function)
- StringWidth (function)
- StringWidthUTF8 (function)
- Strip (function)
- Stroke (procedure)
- StrokeAndFill (procedure)
- StrToCur (function)
- StrToFloat (function)
- StrToInt (function)
- Sub (function)
- SubRecCount (function)
- System (system object)
- Time (function)
- Translate (procedure)
- Trim (function)
- TrimLeft (function)
- TrimRight (function)
- UpperCase (function)
- &Width (system variable)
- XOr (Boolean operator function)
- xmlCount()
- xmlGet()
- xmlResetRoot()
- xmlSetRoot()
- Language Reference (Alphabetical)
- Conversion Tables
- Index
85
DefineImageIndex (procedure)
Defines a PlanetPress Search index term. PlanetPress Image uses this information to generate the .PDI file
it creates for each PDF file it creates. You use SetImageIndex() to associate a data value with the index
term.
Syntax
defineimageindex( name[, length] )
Arguments
name — String value specifying a name for the index term.
length — String value specifying a length for the index term.
Code Sample Examples
Example1 defines the index term 'PONumber' and assigns it a length of 8 characters. The PDI file generated
by PlanetPress Image contains the line: ~IndexName=PONumber,8. Example 2 defines the same index
term, this time without defining a length for the term. In this case the line in the PDI file becomes:
~IndexName=PONumber
Example 1
defineimageindex( 'PONumber', '8')
Example 2
defineimageindex( 'PONumber' )
Directory
The directory type is a type of string array in which each element in the array contains a pathname. All
pathnames in the array reference a file in the same folder. The number of elements in the array, and the
initial value of each element are both determined dynamically at the time the array is created. You specify
the folder, and the filter you want to apply to the list of files in that folder. When PlanetPress Talk creates
the array, it locates the folder you specified, applies the filter to the list of files that folder contains, and
then for each file that meets the filter criteria, adds its pathname to the directory array. Pathnames may
be either printer pathnames or host pathnames.
You can subsequently set the value of any of the elements in the array, as you would for any element in an
array of type string.
Code Sample Example 1
Example 1 uses a directory on the root drive of a printer.










