Home PowerBuilder Appeon Documentation Center

Home PowerBuilder Appeon Documentation Center

PowerScript Reference
Statements, Events, and Functions

Prev | Up | Next

PowerScript Functions

Table of Contents

AccessToken

AddCategory

Syntax 1: For all graph types except scatter
Syntax 2: For scatter graphs

Syntax 1: For ListBox and DropDownListBox controls
Syntax 2: For PictureListBox, DropDownPictureListBox, and RibbonComboBoxItem controls
Syntax 3: For ListView controls
Syntax 4: For ListView controls

AddItemArray

AddItemBlob

AddItemBoolean

AddItemDate

AddItemDateTime

AddItemNull

AddItemNumber

AddItemObject

AddItemString

AddItemTime

AddLargePicture

AddMasterSeparatorItem

AddSeparatorItem

AddSmallPicture

AddStatePicture

AddToLibraryList

AppendParam

ArrangeSheets

AsymmetricDecrypt

AsymmetricEncrypt

AsymmetricGenerateKey

AsymmetricSign

AsymmetricVerifySign

Base32Decode

Base32Encode

Base64Decode

Base64Encode

Base64UrlDecode

Base64UrlEncode

BeginTransaction (obsolete)

Syntax 1: for Pipeline objects
Syntax 2: for CompressorObject and ExtractorObject objects

CancelDownload

CategoryCount

CategoryName

ChangeDirectory

ChooseColor

Syntax 1: For any object
Syntax 2: For variables

Syntax 1: For selected text
Syntax 2: For RichTextEdit controls
Syntax 3: For JSONPackage objects

ClearBoldDates

ClearHeaders

Syntax 1: for TokenRequest objects
Syntax 2: for OAuthRequest objects

ClearParams

ClearRecentItems

ClearRequestHeaders

Syntax 1: For text
Syntax 2: For bitmaps of graphs

Syntax 1: For windows
Syntax 2: For OLEStorage objects
Syntax 3: For OLEStream objects
Syntax 4: For trace files

CloseChannel

CloseUserObject

CloseWithReturn

CollapseItem

CommandParm

CommitDocking

CommitTransaction (obsolete)

ConnectToNewObject

ConnectToNewRemoteObject

ConnectToObject

ConnectToRemoteObject

ConnectToServer (obsolete)

ContainsKey

CreateDirectory

CreateInstance

Syntax 1: for TransactionServer objects
Syntax 2: for DotNetAssembly objects

CreateJsonArray

CreateJsonObject

Syntax 1: For DateTime data and blobs
Syntax 2: For strings
Syntax 3: For combining numbers into a date

Syntax 1: For creating DateTime values
Syntax 2: For extracting DateTime values from blobs
Syntax 3: For extracting DateTime values from strings

DeleteCategory

Syntax 1: for Graph controls
Syntax 2: for RibbonBar controls

DeleteCheckBox

DeleteColumn

DeleteColumns

DeleteComboBox

DeleteGroup

Syntax 1: For ListBox, DropDownListBox, and RibbonComboBoxItem controls
Syntax 2: For ListView controls
Syntax 3: For TreeView controls
Syntax 4: For RibbonMenu controls
Syntax 5: For RibbonBar controls

DeleteItems

DeleteLargeButton

DeleteLargePicture

DeleteLargePictures

DeleteMasterItem

DeletePanel

DeletePicture

DeletePictures

DeleteRecentItem

DeleteSeries

DeleteSmallButton

DeleteSmallPicture

DeleteSmallPictures

DeleteStatePicture

DeleteStatePictures

DeleteTabButton

DestroyModel

DirectoryExists

DisableCommit

DisconnectObject

DisconnectServer

DraggedObject (obsolete)

Syntax 1: For editing a label in a ListView
Syntax 2: For editing a label in a TreeView

EnableCommit

Syntax 1: For sending single commands
Syntax 2: For commands over an opened channel

ExportToJSONFile

ExportToXMLFile

FileEncoding

FileLength64

FileWriteEx

FillW (obsolete)

FindCategory

FindClassDefinition

FindFunctionDefinition

Syntax 1: For ListBox, DropDownListBox, and RibbonComboBoxItem controls
Syntax 2: For ListView controls
Syntax 3: For ListView controls
Syntax 4: For TreeView controls

FindMatchingFunction

FindTypeDefinition

FromUnicode

GarbageCollect

GarbageCollectGetTimeLimit

GarbageCollectSetTimeLimit

GetAccessToken

GetActiveCategory

GetActiveSheet

GetAlignment

GetApplication

GetApplicationButton

GetArgElement

GetAutomationNativePointer

GetBestHeight

Syntax 1: for TokenResponse objects
Syntax 2: for OAuthRequest objects
Syntax 3: for ResourceResponse objects

GetBoxPictureList

GetByteArray

GetCategory

GetCategoryByIndex

GetCategoryCount

GetCategoryIndex

GetCertificateLabel (obsolete)

GetCheckBox

GetChildCount

GetChildItem

GetChildItemByIndex

GetChildItemCount

GetChildKey

GetChildrenList

GetComboBox

GetCommandDDE

GetCommandDDEOrigin

GetCommandString

GetCompanyName

GetContextKeywords

GetContextService

GetCredentialAttribute (obsolete)

GetCurrentDirectory

Syntax 1: For data points in graphs
Syntax 2: For EditMask controls
Syntax 3: For data in an OLE server

GetDataDDEOrigin

GetDataLabelling

GetDataPieExplode

GetDataStyle

Syntax 1: For the colors of a data point
Syntax 2: For the line style and width used by a data point
Syntax 3: For the fill pattern or symbol of a data point

GetDataTransparency

GetDataValue

GetDateLimits

GetDbmlsyncPath

GetDisplayRange

GetDotNetCoreVersion

GetDynamicDate

GetDynamicDateTime

GetDynamicDecimal

GetDynamicNumber

GetDynamicString

GetDynamicTime

GetEnvironment

GetExpiresIn

GetFileOpenName

GetFileSaveName

GetFilesCount

GetFilesList

GetFirstSheet

GetFixesVersion

GetGlobalProperty (obsolete)

Syntax 1: for TokenRequest objects
Syntax 2: for TokenResponse objects
Syntax 3: for OAuthRequest objects
Syntax 4: for ResourceResponse objects

Syntax 1: for TokenRequest objects
Syntax 2: for TokenResponse objects
Syntax 3: for OAuthRequest objects
Syntax 4: for ResourceResponse objects

GetHostObject

Syntax 1: For ListView controls
Syntax 2: For ListView controls
Syntax 3: For TreeView controls
Syntax 4: For RibbonMenu controls
Syntax 5: For RibbonBar controls

GetItemArray

GetItemAtPointer

GetItemBlob

Syntax 1
Syntax 2

GetItemBoolean

Syntax 1
Syntax 2

GetItemByTag

GetItemCount

GetItemDate

Syntax 1
Syntax 2

GetItemDateTime

Syntax 1
Syntax 2

GetItemNumber

Syntax 1
Syntax 2

GetItemObject

GetItemParent

GetItemString

Syntax 1
Syntax 2

GetItemTime

Syntax 1
Syntax 2

GetItemType

GetJsonBlob

GetJsonString

GetJWTToken

GetLargeButton

GetLastReturn

GetLibraryList

GetMajorVersion

GetMasterItem

GetMasterItemCount

GetMenuByButtonHandle

GetMinorVersion

GetNativePointer

GetNextSheet

GetOAuthToken

GetObjectRevisionFromRegistry

GetParagraphSetting

GetPin (obsolete)

GetRecentItem

GetRecentItemCount

GetRecentTitle

GetRecordSet

GetRefreshToken

Syntax 1: For single DDE requests
Syntax 2: For DDE requests via an open channel

GetRequestHeader

GetRequestHeaders

GetResponseBody

GetResponseHeader

GetResponseHeaders

GetResponseStatusCode

GetResponseStatusText

GetRootItem

GetSelectedDate

GetSelectedRange

GetSeriesLabelling

GetSeriesStyle

Syntax 1: For the colors of a series
Syntax 2: For the line style and width used by a series
Syntax 3: For the fill pattern or symbol of a series
Syntax 4: For determining whether a series is an overlay

GetSeriesTransparency

GetShortName

GetSmallButton

GetStatusCode

Syntax 1: for TokenResponse objects
Syntax 2: for ResourceResponse objects

GetStatusText

Syntax 1: for TokenResponse objects
Syntax 2: for ResourceResponse objects

GetStatus (obsolete)

GetSyncRegistryProperties

GetTabButton

GetTabButtonByIndex

GetTabButtonCount

GetTextColor

GetTextStyle

GetTokenError

GetTokenType

GetToolbarPos

Syntax 1: For docked toolbars
Syntax 2: For floating toolbars

GetTransactionName (obsolete)

Syntax 1: for DatePicker control
Syntax 2: for JSONPackage object

GetValueBlob

GetValueBoolean

GetValueDate

GetValueDateTime

GetValueNumber

GetValueString

GetValueTime

GetValueToDataWindow

GetVersionName

HyperLinkToURL

ImpersonateClient

ImportClipboard

ImportFromJSONFile

ImportFromXMLFile

ImportString

IncomingCallList

Init (obsolete)

InputFieldChangeData

InputFieldCurrentName

InputFieldDeleteCurrent

InputFieldGetData

InputFieldInsert

InputFieldLocate

InsertCategory

Syntax 1: for Graph controls
Syntax 2: for RibbonBar controls

InsertCategoryFirst

InsertCategoryLast

InsertCheckBox

InsertCheckBoxFirst

InsertCheckBoxLast

InsertClass

InsertColumn

InsertComboBox

InsertComboBoxFirst

InsertComboBoxLast

InsertDocument

InsertGroup

InsertGroupFirst

InsertGroupLast

Syntax 1: For ListBox and DropDownListBox controls
Syntax 2: For PictureListBox, DropDownPictureListBox, RibbonComboBoxItem controls
Syntax 3: For ListView controls
Syntax 4: For ListView controls
Syntax 5: For TreeView controls
Syntax 6: For TreeView controls
Syntax 7: For RibbonMenu controls

InsertItemFirst

Syntax 1: For TreeView controls
Syntax 2: For TreeView controls
Syntax 3: For RibbonMenu controls

InsertItemLast

Syntax 1: For TreeView controls
Syntax 2: For TreeView controls
Syntax 3: For RibbonMenu controls

InsertItemSort

Syntax 1: For TreeView controls
Syntax 2: For TreeView controls

InsertLargeButton

InsertLargeButtonFirst

InsertLargeButtonLast

InsertMasterItem

InsertMasterItemFirst

InsertMasterItemLast

InsertObject

InsertPanel

InsertPanelFirst

InsertPanelLast

InsertPicture

InsertRecentItem

InsertRecentItemFirst

InsertRecentItemLast

InsertSeries

InsertSmallButton

InsertSmallButtonFirst

InsertSmallButtonLast

InsertTabButton

InsertTabButtonFirst

InsertTabButtonLast

InternetData

InvokePBFunction

_Is_A (obsolete)

IsAllArabic

IsAllHebrew

IsAnyArabic

IsAnyHebrew

IsArabicAndNumbers

IsCallerInRole

IsHebrewAndNumbers

IsImpersonating

IsInTransaction (obsolete)

IsMinimized

IsSecurityEnabled

IsTransactionAborted (obsolete)

LeftW (obsolete)

LeftTrimW (obsolete)

LenW (obsolete)

LibraryCreate

LibraryDelete

LibraryDirectory

LibraryDirectoryEx

LibraryExport

LibraryImport

LoadDockingState

LoadPicture

LoadWithDotNetCore

LoadWithDotNetFramework

Syntax 1: For all objects
Syntax 2: For ErrorLogging objects

Syntax 1: For combining integers
Syntax 2: For converting strings and blobs

Syntax 1: For combining longs
Syntax 2: For converting strings and blobs

Lookup (obsolete)

Syntax 1: For CORBA-compliant EAServer components
Syntax 2: For instances of an EJB component

mailAddress

mailDeleteMessage

mailGetMessages

mailReadMessage

mailRecipientDetails

mailResolveRecipient

mailSaveMessage

MatchW (obsolete)

MemberDelete

MemberExists

MemberRename

MidW (obsolete)

Syntax 1: For all graph types except scatter
Syntax 2: For scatter graphs

_Narrow (obsolete)

NextActivity

ObjectAtPointer

Syntax 1: For windows of a known datatype
Syntax 2: For windows of unknown datatype
Syntax 3: For loading an OLE object from a file into a control
Syntax 4: For opening an OLE object in memory into a control
Syntax 5: For opening an OLE object in a file into an OLEStorage
Syntax 6: For opening an OLE storage member into a storage
Syntax 7: For opening OLE streams
Syntax 8: For opening trace files

OpenChannel

OpenSheetAsDocument

OpenSheetDocked

OpenSheetFromDockingState

OpenSheetInTabGroup

OpenSheetWithParm

OpenSheetWithParmAsDocument

OpenSheetWithParmDocked

OpenSheetWithParmFromDockingState

OpenSheetWithParmInTabGroup

Syntax 1: For user objects of a known datatype
Syntax 2: For user objects of unknown datatype

OpenTabWithParm

Syntax 1: For user objects of a known datatype
Syntax 2: For user objects of unknown datatype

OpenUserObject

Syntax 1: For user objects of a known datatype
Syntax 2: For user objects of unknown datatype

OpenUserObjectWithParm

Syntax 1: For user objects of a known datatype
Syntax 2: For user objects of unknown datatype

OpenWithParm

Syntax 1: For windows of a known datatype
Syntax 2: For windows of unknown datatype

OutgoingCallList

PageCreated

ParentWindow

PasteSpecial

PauseDownload

PBAddCookie (Obsolete)

PBGetCookies (Obsolete)

PBGetMenuString

PixelsToUnits

PopulateError

PosW (obsolete)

Syntax 1: For editable controls, except RichTextEdit
Syntax 2: For RichTextEdit controls

PostDataEnd

PostDataStart

Syntax 1: For printing a visual object in a print job
Syntax 2: For printing text in a print job
Syntax 3: For RichTextEdit controls

PrintBitmap

PrintCancel

PrintDataWindow

PrintDefineFont

PrintGetPrinter

PrintGetPrinters

PrintRoundRect

PrintScreen

PrintSend (obsolete)

PrintSetFont

PrintSetPrinter

PrintSetSpacing

PrintSetupPrinter

ProfileString

Syntax 1: For reading into a string
Syntax 2: For character arrays or blobs

RecognizeText

RegistryDelete

RegistryGet

RegistryKeys

RegistrySet

RegistryValues

RelativeDate

RelativeTime

ReleaseAutomationNativePointer

ReleaseNativePointer

RemoveApplicationButton

RemoveDirectory

RequestResource

ReplaceText

ReplaceW (obsolete)

Syntax 1: For list boxes
Syntax 2: For graphs
Syntax 3: For trace files

ResetArgElements

ResetDataColors

ResetPicture

RespondRemote

ResumeDownload

ResumeTransaction (obsolete)

RetrieveOne

RevertToSelf

RightW (obsolete)

RightTrimW (obsolete)

RollbackOnly (obsolete)

RollbackTransaction (obsolete)

RoutineList

Syntax 1: For InkPicture controls
Syntax 2: For OLE objects

Syntax 1: For graph objects
Syntax 2: For saving an OLE control to a file
Syntax 3: For saving an OLE control to an OLE storage
Syntax 4: For saving an OLE storage object to a file
Syntax 5: For saving an OLE storage object in another OLE storage

SaveDockingState

SaveDocument

ScrollNextPage

ScrollNextRow

ScrollPriorPage

ScrollPriorRow

ScrollToRow

SecondsAfter

Syntax 1: For OLE stream objects
Syntax 2: For animation controls

SelectedColumn

SelectedIndex

SelectedItem

SelectedLength

SelectedLine

SelectedPage

SelectedStart

SelectedText

SelectionRange

Syntax 1: When you know the text of an item
Syntax 2: When you know the item number
Syntax 3: For TreeView controls

SelectObject

Syntax 1: For editable controls (except RichTextEdit)
Syntax 2: For RichTextEdit controls and presentation styles

SelectTextAll

SelectTextLine

SelectTextWord

SendDeleteRequest

SendGetRequest

SendPatchRequest

SendPostRequest

SendPutRequest

SendRequest

SeriesCount

Syntax 1: For OLETxnObject objects
Syntax 2: For TransactionServer objects

SetAccessToken

SetActiveCategory

SetActiveCategoryByIndex

SetAlignment

SetApplicationButton

SetArgElement

SetAutomationLocale

SetAutomationPointer

SetAutomationTimeout

SetBoldDate

SetBoxPictureList

SetCategory

SetCheckBox

SetComboBox

SetComplete

Syntax 1: For OLETxnObject objects
Syntax 2: For TransactionServer objects

SetDataLabelling

SetDataPieExplode

SetDataStyle

Syntax 1: For setting a data point's colors
Syntax 2: For the line associated with a data point
Syntax 3: For the fill pattern and symbol of a data point

SetDataTransparency

SetDateLimits

SetDropHighlight

SetDynamicParm

SetFirstVisible

SetGlobalProperty (obsolete)

Syntax 1: for TokenRequest objects
Syntax 2: for OAuthRequest objects

Syntax 1: for TokenRequest objects
Syntax 2: for OAuthRequest objects

Syntax 1: For ListView controls
Syntax 2: For ListView controls
Syntax 3: For TreeView controls
Syntax 4: For RibbonMenu controls
Syntax 5: For RibbonBar controls

SetJWTToken

SetLargeButton

SetLevelPictures

SetLibraryList

SetMasterItem

SetMicroHelp

SetMinimized

SetNewMobiLinkPassword

SetOAuthToken

SetOverlayPicture

SetParagraphSetting

Syntax 1: System-defined shape
Syntax 2: File-defined shape

SetPosition

Syntax 1: For positioning windows and controls in windows
Syntax 2: For positioning objects within a DataWindow

SetProfileString

SetRecentItem

SetRecentTitle

SetRecordSet

Syntax 1: For single DDE requests
Syntax 2: For DDE requests via an open channel

SetRequestHeader

SetRequestHeaders

SetResultSet

SetSelectedDate

SetSelectedRange

SetSeriesLabelling

SetSeriesStyle

Syntax 1: For setting a series' colors
Syntax 2: For lines in a graph
Syntax 3: For the fill pattern and symbols in a graph
Syntax 4: For creating an overlay in a graph

SetSeriesTransparency

SetSmallButton

SetSyncRegistryProperties

SetTabButton

SetTextColor

SetTextStyle

SetTimeout (obsolete)

SetToolbarPos

Syntax 1: For docked toolbars
Syntax 2: For floating toolbars

SetTraceFileName

SetTransPool

Syntax 1: for DatePicker control
Syntax 2: for JSONPackage object

SetValueBlob

SetValueBoolean

SetValueByDataWindow

SetValueDate

SetValueDateTime

SetValueNumber

SetValueString

SetValueTime

SharedObjectDirectory

SharedObjectGet

SharedObjectRegister

SharedObjectUnregister

ShowHeadFoot

ShowPopupHelp

SignalError

Syntax 1: For TreeView controls
Syntax 2: For ListView controls

Syntax 1: For executing pipeline objects
Syntax 2: For activating timing objects

StartHotLink

StartServerDDE

Syntax 1: For deactivating timing objects
Syntax 2: For stopping an animation from playing

StopHotLink

StopNavigation

StopServerDDE

Syntax 1: For formatting data
Syntax 2: For blobs

SuspendTransaction (obsolete)

SymmetricDecrypt

SymmetricEncrypt

SymmetricGenerateKey

Synchronize

Syntax 1: For synchronization without parameters
Syntax 2: For synchronization with parameters

SyntaxFromSQL

SystemRoutine

TabPostEvent

TabTriggerEvent

Syntax for ListBox, DropDownListBox, PictureListBox, and DropDownPictureListBox controls
Syntax for RibbonComboBoxItem controls

Syntax 1: For DateTime and blob values
Syntax 2: For strings
Syntax 3: For integers

TotalColumns

TotalSelected

TraceDisableActivity

TraceEnableActivity

TriggerEvent

TriggerPBEvent

TrimW (obsolete)

TrustVerify (obsolete)

UnitsToPixels

UpdateLinksDialog

WebBrowserGet

WebBrowserSet

WorkSpaceHeight

WorkSpaceWidth

XMLParseFile

XMLParseString

About this chapter

This chapter provides syntax, descriptions, and examples for PowerScript functions.

Contents

The functions are listed alphabetically.

See also

For information about functions that apply to DataWindows or DataStores, see also DataWindow Reference. Methods that apply to DataWindows, but not to other PowerBuilder controls, are listed only in DataWindow Reference.

Prev	Up	Next
WarningMessage	Home	Abs