PowerScript Reference
Appeon PowerBuilder® 2018
FOR WINDOWS
DOCUMENT ID: DC37781-01-1800-01
LAST REVISED: December 28, 2018
Copyright © 2018 by Appeon Limited. All rights reserved.
This publication pertains to Appeon software and to any subsequent
release until otherwise indicated in new editions or technical notes.
Information in this document is subject to change without notice. The
software described herein is furnished under a license agreement, and it
may be used or copied only in accordance with the terms of that
agreement.
Upgrades are provided only at regularly scheduled software release
dates. No part of this publication may be reproduced, transmitted, or
translated in any form or by any means, electronic, mechanical, manual,
optical, or otherwise, without the prior written permission of Appeon
Limited.
Appeon and other Appeon products and services mentioned herein as
well as their respective logos are trademarks or registered trademarks
of Appeon Limited.
SAP and other SAP products and services mentioned herein as well
as their respective logos are trademarks or registered trademarks of SAP
and SAP affiliate company.
Java and all Java-based marks are trademarks or registered
trademarks of Oracle and/or its affiliates in the U.S. and other
countries.
Unicode and the Unicode Logo are registered trademarks of Unicode,
Inc.
All other company and product names mentioned may be trademarks of
the respective companies with which they are associated.
Use, duplication, or disclosure by the government is subject to
the restrictions set forth in subparagraph (c)(1)(ii) of DFARS
52.227-7013 for the DOD and as set forth in FAR 52.227-19(a)-(d) for
civilian agencies.
Appeon Limited, 1/F, Shell Industrial Building, 12 Lee Chung
Street, Chai Wan District, Hong Kong.
Contents
- PowerScript Topics
-
- Language Basics
- Datatypes
- Declarations
- Operators and Expressions
- Structures and Objects
- Calling Functions and Events
-
- About
functions and events - Finding and
executing functions and events - Triggering versus posting functions
and events - Static
versus dynamic calls - Overloading,
overriding, and extending functions and events - Passing
arguments to functions and events - Using
return values - Syntax
for calling PowerBuilder functions and events - Calling
functions and events in an object’s ancestor
- About
- Statements, Events, and Functions
-
- PowerScript Statements
- SQL Statements
- PowerScript Events
-
- About events
- Activate
- BeginDownload
- BeginDrag
- BeginLabelEdit
- BeginLogScan
- BeginRightDrag
- BeginSync
- BeginUpload
- Clicked
- Close
- CloseQuery
- CloseUp
- ColumnClick
- ConnectMobiLink
- Constructor
- DataChange
- DateChanged
- DateSelected
- DBError
- DBNotification
- Deactivate
- DeleteAllItems
- DeleteItem
- Destructor
- DisconnectMobiLink
- DisplayMessage
- DoubleClicked
- DragDrop
- DragEnter
- DragLeave
- DragWithin
- DropDown
- EndDownload
- EndLabelEdit
- EndLogScan
- EndSync
- EndUpload
- Error
- ErrorMessage
- ExternalException
- FileExists
- FileMessage
- Finished
- Gesture
- GetFocus
- Help
- Hide
- HotLinkAlarm
- Idle
- InputFieldSelected
- InsertItem
- ItemActivate
- ItemChanged
- ItemChanging
- ItemCollapsed
- ItemCollapsing
- ItemExpanded
- ItemExpanding
- ItemPopulate
- Key
- LineDown
- LineLeft
- LineRight
- LineUp
- LoseFocus
- Modified
- MouseDown
- MouseMove
- MouseUp
- Moved
- Notify
- Open
- Other
- PageDown
- PageLeft
- PageRight
- PageUp
- PictureSelected
- PipeEnd
- PipeMeter
- PipeStart
- PrintFooter (obsolete)
- PrintHeader (obsolete)
- ProcessingFile
- ProgressIndex
- PropertyChanged
- PropertyRequestEdit
- RButtonDown
- RButtonUp
- RecognitionResult
- RemoteExec
- RemoteHotLinkStart
- RemoteHotLinkStop
- RemoteRequest
- RemoteSend
- Rename
- Resize
- RightClicked
- RightDoubleClicked
- Save
- SaveObject
- Selected
- SelectionChanged
- SelectionChanging
- Show
- SizeCompleted
- Sort
- SQLPreview
- Start
- Stop
- Stroke
- SyncPreview
- SystemError
- SystemKey
- Timer
- ToolbarMoved
- UploadAck
- UserString
- ValueChanged
- ViewChange
- WaitForUploadAck
- WarningMessage
- PowerScript Functions
-
- Abs
- ACos
- AccessToken
- Activate
- AddCategory
- AddColumn
- AddData
- AddItem
- AddItemArray
- AddItemBlob
- AddItemBoolean
- AddItemDate
- AddItemDateTime
- AddItemNull
- AddItemNumber
- AddItemObject
- AddItemString
- AddItemTime
- AddLargePicture
- AddPicture
- AddSeries
- AddSmallPicture
- AddStatePicture
- AddToLibraryList
- AppendParam
- ApplyTheme
- Arrange
- ArrangeSheets
- Asc
- AscA
- ASin
- AsymmetricDecrypt
- AsymmetricEncrypt
- AsymmetricGenerateKey
- AsymmetricSign
- AsymmetricVerifySign
- ATan
- Base64Decode
- Base64Encode
- Beep
- BeginTransaction (obsolete)
- Blob
- BlobEdit
- BlobMid
- BuildModel
- Byte
- Cancel
- CancelSync
- CanUndo
- CategoryCount
- CategoryName
- Ceiling
- ChangeDirectory
- ChangeMenu
- Char
- CharA
- Check
- ChooseColor
- ClassList
- ClassName
- Clear
- ClearAll
- ClearBoldDates
- ClearHeaders
- ClearParams
- ClearRequestHeaders
- Clipboard
- Close
- CloseChannel
- CloseTab
- CloseUserObject
- CloseWithReturn
- CollapseItem
- CommandParm
- CommitDocking
- CommitTransaction (obsolete)
- Compress
- ConnectToNewObject
- ConnectToNewRemoteObject
- ConnectToObject
- ConnectToRemoteObject
- ConnectToServer (obsolete)
- ContainsKey
- Copy
- CopyRTF
- Cos
- Cpu
- CreateDirectory
- CreateInstance
- CreateJsonArray
- CreateJsonObject
- CreatePage
- Cut
- DataCount
- DataSource
- Date
- DateTime
- Day
- DayName
- DayNumber
- DaysAfter
- DBHandle
- DebugBreak
- Dec
- DeleteCategory
- DeleteColumn
- DeleteColumns
- DeleteData
- DeleteItem
- DeleteItems
- DeleteLargePicture
- DeleteLargePictures
- DeletePicture
- DeletePictures
- DeleteSeries
- DeleteSmallPicture
- DeleteSmallPictures
- DeleteStatePicture
- DeleteStatePictures
- DestroyModel
- DirectoryExists
- DirList
- DirSelect
- Disable
- DisableCommit
- DisconnectObject
- DisconnectServer
- Double
- DoVerb
- Drag
- DraggedObject (obsolete)
- Draw
- EditLabel
- Enable
- EnableCommit
- EntryList
- ExecRemote
- Exp
- ExpandAll
- ExpandItem
- Extract
- Fact
- FileClose
- FileCopy
- FileDelete
- FileEncoding
- FileExists
- FileLength
- FileLength64
- FileMove
- FileOpen
- FileRead
- FileReadEx
- FileSeek
- FileSeek64
- FileWrite
- FileWriteEx
- Fill
- FillA
- FillW (obsolete)
- Find
- FindCategory
- FindClassDefinition
- FindFunctionDefinition
- FindItem
- FindMatchingFunction
- FindNext
- FindSeries
- FindTypeDefinition
- FromAnsi
- FromUnicode
- GarbageCollect
- GarbageCollectGetTimeLimit
- GarbageCollectSetTimeLimit
- GetAccessToken
- GetActiveSheet
- GetAlignment
- GetApplication
- GetArgElement
- GetAutomationNativePointer
- GetBody
- GetByte
- GetByteArray
- GetCertificateLabel (obsolete)
- GetChildCount
- GetChildItem
- GetChildKey
- GetChildrenList
- GetColumn
- GetCommandDDE
- GetCommandDDEOrigin
- GetCommandString
- GetCompanyName
- GetContextKeywords
- GetContextService
- GetCredentialAttribute (obsolete)
- GetCurrentDirectory
- GetData
- GetDataDDE
- GetDataDDEOrigin
- GetDataLabelling
- GetDataPieExplode
- GetDataStyle
- GetDataTransparency
- GetDataValue
- GetDateLimits
- GetDbmlsyncPath
- GetDisplayRange
- GetDynamicDate
- GetDynamicDateTime
- GetDynamicDecimal
- GetDynamicNumber
- GetDynamicString
- GetDynamicTime
- GetEnvironment
- GetExpiresIn
- GetFileOpenName
- GetFileSaveName
- GetFirstSheet
- GetFixesVersion
- GetFocus
- GetFolder
- GetGlobalProperty (obsolete)
- GetHeader
- GetHeaders
- GetHostObject
- GetItem
- GetItemArray
- GetItemBlob
- GetItemBoolean
- GetItemDate
- GetItemDateTime
- GetItemNumber
- GetItemObject
- GetItemString
- GetItemTime
- GetItemType
- GetItemAtPointer
- GetJsonBlob
- GetJsonString
- GetKey
- GetLastReturn
- GetLibraryList
- GetMajorVersion
- GetMessage
- GetMinorVersion
- GetName
- GetNativePointer
- GetNextSheet
- GetObjectRevisionFromRegistry
- GetOrigin
- GetParagraphSetting
- GetParent
- GetPin (obsolete)
- GetRecordSet
- GetRefreshToken
- GetRemote
- GetRequestHeader
- GetRequestHeaders
- GetResponseBody
- GetResponseHeader
- GetResponseHeaders
- GetResponseStatusCode
- GetResponseStatusText
- GetRootItem
- GetSelectedDate
- GetSelectedRange
- GetSeriesLabelling
- GetSeriesStyle
- GetSeriesTransparency
- GetShortName
- GetSpacing
- GetStatusCode
- GetStatusText
- GetStatus (obsolete)
- GetSyncRegistryProperties
- GetText
- GetTextColor
- GetTextStyle
- GetTheme
- GetToday
- GetTokenError
- GetTokenType
- GetToolbar
- GetToolbarPos
- GetTransactionName (obsolete)
- GetURL
- GetValue
- GetValueBlob
- GetValueBoolean
- GetValueDate
- GetValueDateTime
- GetValueNumber
- GetValueString
- GetValueTime
- GetValueToDataWindow
- GetVersionName
- Handle
- HexDecode
- HexEncode
- Hide
- HMAC
- Hour
- HyperLinkToURL
- Idle
- ImpersonateClient
- ImportClipboard
- ImportFile
- ImportString
- IncomingCallList
- Init (obsolete)
- InputFieldChangeData
- InputFieldCurrentName
- InputFieldDeleteCurrent
- InputFieldGetData
- InputFieldInsert
- InputFieldLocate
- InsertCategory
- InsertClass
- InsertColumn
- InsertData
- InsertDocument
- InsertFile
- InsertItem
- InsertItemFirst
- InsertItemLast
- InsertItemSort
- InsertObject
- InsertPicture
- InsertSeries
- Int
- Integer
- InternetData
- IntHigh
- IntLow
- InvokePBFunction
- _Is_A (obsolete)
- IsAlive
- IsAllArabic
- IsAllHebrew
- IsAnyArabic
- IsAnyHebrew
- IsArabic
- IsArabicAndNumbers
- IsCallerInRole
- IsDate
- IsHebrew
- IsHebrewAndNumbers
- IsImpersonating
- IsInTransaction (obsolete)
- IsNull
- IsNumber
- IsPreview
- IsSecurityEnabled
- IsTime
- IsTransactionAborted (obsolete)
- IsValid
- KeyCount
- KeyDown
- LastPos
- Left
- LeftA
- LeftW (obsolete)
- LeftTrim
- LeftTrimW (obsolete)
- Len
- LenA
- LenW (obsolete)
- Length
- LibraryCreate
- LibraryDelete
- LibraryDirectory
- LibraryDirectoryEx
- LibraryExport
- LibraryImport
- LineCount
- LineLength
- LineList
- LinkTo
- LoadDockingState
- LoadFile
- LoadString
- LoadInk
- LoadPicture
- Log
- LogTen
- Long
- LongLong
- Lookup (obsolete)
- Lower
- LowerBound
- mailAddress
- mailDeleteMessage
- mailGetMessages
- mailHandle
- mailLogoff
- mailLogon
- mailReadMessage
- mailRecipientDetails
- mailResolveRecipient
- mailSaveMessage
- mailSend
- Match
- MatchW (obsolete)
- Max
- MD5
- MemberDelete
- MemberExists
- MemberRename
- MessageBox
- Mid
- MidA
- MidW (obsolete)
- Min
- Minute
- Mod
- ModifyData
- Month
- Move
- MoveTab
- _Narrow (obsolete)
- NextActivity
- Now
- ObjectAtPointer
- OffsetPos
- Open
- OpenChannel
- OpenSheet
- OpenSheetAsDocument
- OpenSheetDocked
- OpenSheetFromDockingState
- OpenSheetInTabGroup
- OpenSheetWithParm
- OpenSheetWithParmAsDocument
- OpenSheetWithParmDocked
- OpenSheetWithParmFromDockingState
- OpenSheetWithParmInTabGroup
- OpenTab
- OpenTabWithParm
- OpenUserObject
- OpenUserObjectWithParm
- OpenWithParm
- OutgoingCallList
- PageCount
- PageCreated
- ParentWindow
- Paste
- PasteLink
- PasteRTF
- PasteSpecial
- PBAddCookie (Obsolete)
- PBGetCookies (Obsolete)
- PBGetMenuString
- Pi
- PixelsToUnits
- Play
- PointerX
- PointerY
- PopMenu
- PopulateError
- Pos
- PosA
- PosW (obsolete)
- Position
- Post
- PostData
- PostDataEnd
- PostDataStart
- PostEvent
- PostURL
- Preview
- PrintBitmap
- PrintCancel
- PrintClose
- PrintDataWindow
- PrintDefineFont
- PrintEx
- PrintGetPrinter
- PrintGetPrinters
- PrintLine
- PrintOpen
- PrintOval
- PrintPage
- PrintRect
- PrintRoundRect
- PrintScreen
- PrintSend (obsolete)
- PrintSetFont
- PrintSetPrinter
- PrintSetSpacing
- PrintSetup
- PrintSetupPrinter
- PrintText
- PrintWidth
- PrintX
- PrintY
- ProfileInt
- ProfileString
- Rand
- Randomize
- Read
- ReadData
- Real
- RecognizeText
- RegistryDelete
- RegistryGet
- RegistryKeys
- RegistrySet
- RegistryValues
- RelativeDate
- RelativeTime
- ReleaseAutomationNativePointer
- ReleaseNativePointer
- Remove
- RemoveDirectory
- RequestResource
- Repair
- Replace
- ReplaceA
- ReplaceText
- ReplaceW (obsolete)
- Reset
- ResetArgElements
- ResetDataColors
- ResetInk
- ResetPicture
- Resize
- RespondRemote
- Restart
- ResumeTransaction (obsolete)
- Retrieve
- Reverse
- RevertToSelf
- RGB
- Right
- RightA
- RightW (obsolete)
- RightTrim
- RightTrimW (obsolete)
- RollbackOnly (obsolete)
- RollbackTransaction (obsolete)
- Round
- RoutineList
- Run
- Save
- SaveAs
- SaveDockingState
- SaveDocument
- SaveInk
- SaveToFile
- Scroll
- ScrollNextPage
- ScrollNextRow
- ScrollPriorPage
- ScrollPriorRow
- ScrollToRow
- Second
- SecondsAfter
- Seek
- SelectedColumn
- SelectedIndex
- SelectedItem
- SelectedLength
- SelectedLine
- SelectedPage
- SelectedStart
- SelectedText
- SelectionRange
- SelectItem
- SelectObject
- SelectTab
- SelectText
- SelectTextAll
- SelectTextLine
- SelectTextWord
- Send
- SendRequest
- SeriesCount
- SeriesName
- SetAbort
- SetAccessToken
- SetAlignment
- SetArgElement
- SetAutomationLocale
- SetAutomationPointer
- SetAutomationTimeout
- SetBody
- SetBoldDate
- SetByte
- SetColumn
- SetComplete
- SetData
- SetDataDDE
- SetDataLabelling
- SetDataPieExplode
- SetDataStyle
- SetDataTransparency
- SetDateLimits
- SetDropHighlight
- SetDynamicParm
- SetFirstVisible
- SetFocus
- SetGlobalProperty (obsolete)
- SetHeader
- SetHeaders
- SetItem
- SetLevelPictures
- SetLibraryList
- SetMask
- SetMessage
- SetMicroHelp
- SetNewMobiLinkPassword
- SetNull
- SetOverlayPicture
- SetParagraphSetting
- SetParm
- SetPicture
- SetPointer
- SetPosition
- SetProfileString
- SetRange
- SetRecordSet
- SetRedraw
- SetRemote
- SetRequestHeader
- SetRequestHeaders
- SetResultSet
- SetSelectedDate
- SetSelectedRange
- SetSeriesLabelling
- SetSeriesStyle
- SetSeriesTransparency
- SetSheetID
- SetSpacing
- SetState
- SetSyncRegistryProperties
- SetTextColor
- SetTextStyle
- SetTimeout (obsolete)
- SetToday
- SetToolbar
- SetToolbarPos
- SetTop
- SetTraceFileName
- SetTransPool
- SetValue
- SetValueBlob
- SetValueBoolean
- SetValueByDataWindow
- SetValueDate
- SetValueDateTime
- SetValueNumber
- SetValueString
- SetValueTime
- SHA
- SharedObjectDirectory
- SharedObjectGet
- SharedObjectRegister
- SharedObjectUnregister
- Show
- ShowHeadFoot
- ShowHelp
- ShowPopupHelp
- Sign
- SignalError
- Sin
- Sleep
- Sort
- SortAll
- Space
- Sqrt
- Start
- StartHotLink
- StartServerDDE
- State
- StepIt
- Stop
- StopHotLink
- StopServerDDE
- String
- Submit
- SuspendTransaction (obsolete)
- SymmetricDecrypt
- SymmetricEncrypt
- Synchronize
- SyntaxFromSQL
- SystemRoutine
- TabPostEvent
- TabTriggerEvent
- Tan
- Text
- TextLine
- Time
- Timer
- ToAnsi
- Today
- Top
- TotalColumns
- TotalItems
- TotalSelected
- ToUnicode
- TraceBegin
- TraceClose
- TraceDisableActivity
- TraceEnableActivity
- TraceEnd
- TraceError
- TraceOpen
- TraceUser
- TriggerEvent
- TriggerPBEvent
- Trim
- TrimW (obsolete)
- Truncate
- TrustVerify (obsolete)
- TypeOf
- Uncheck
- Undo
- UnitsToPixels
- UpdateLinksDialog
- Upper
- UpperBound
- UrlDecode
- UrlEncode
- Which
- WordCap
- WorkSpaceHeight
- WorkSpaceWidth
- WorkSpaceX
- WorkSpaceY
- Write
- XMLParseFile
- XMLParseString
- Year
- Yield