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
97
function @name( arglist )
...
endfunction()
Arguments
name — Name to use for the function, prefixed with the @ character. The name must conform to the rules
for names described in “Names” on page 7. It is good practice to be careful naming functions that you
define in different documents, to ensure that if at some point you want to copy code between documents,
the names of functions do not conflict.
arglist — List of arguments the function requires, where each element in the list has the syntax varname :
type. For example, &date : string. An ampersand always precedes the first letter of varname. A comma
separates each element in the list. Note that all arguments are pass by value (as opposed to pass by
reference). Pass by value means that the function you define cannot modify any of the arguments it
receives. Any modifications you make to an argument within the body of the function are made to a local
copy, and do not affect the original.
type — Type of value (integer, measure, currency, string, Boolean) the function returns.
Code Sample Example
function @showtext(&mystring: string)
moveto(1,1)
show(&mystring)
endfunction()
Code Sample Example
This example illustrates a procedure that creates a 3D pie chart.
Example
function @_3DPie( &W:measure, &H:measure, &HB:measure, &S:measure, &E:measure,
&L:string, &c:color )
%====================================================
% &W is the total width of the pie chart
% &H is the total height of the pie chart
% &HB is the height of the lower band
% &S is the starting angle (0..360)
% &E is the ending angle (0..360 and bigger than &S)
% &L is the label text










