Objects and Controls

Appeon PowerBuilder® 2022 R3

FOR WINDOWS

DOCUMENT ID: DC37787-01-1900-01

LAST REVISED: December 29, 2023

Copyright © Appeon. 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.

Appeon and other Appeon products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Appeon.

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.

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.

Table of Contents

PowerBuilder System Objects and Controls
What are system objects?
System object properties, events, and functions
System object inheritance hierarchy
Undocumented base class objects
Viewing system objects
System Object Properties, Events, and Functions
ADOResultSet object
Animation control
Application object
ArrayBounds object
CheckBox control
ClassDefinition object
CoderObject object
CommandButton control
CompressorObject object
ContextInformation object
ContextKeyword object
CrypterObject object
DotNetAssembly object
DotNetObject object
DataStore object
DataWindow control
DataWindowChild object
DatePicker control
DropDownListBox control
DropDownPictureListBox control
DynamicDescriptionArea object
DynamicStagingArea object
EditMask control
EnumerationDefinition object
EnumerationItemDefinition object
Environment object
Error object
ErrorLogging object
Exception object
ExtractorObject object
Graph object
grAxis object
grDispAttr object
GroupBox control
HProgressBar control
HScrollBar control
HTrackBar control
HTTPClient object
Inet object
InkEdit control
InkPicture control
InternetResult object
JSONGenerator object
JSONPackage object
JSONParser object
Line control
ListBox control
ListView control
ListViewItem object
mailFileDescription object
mailMessage object
mailRecipient object
mailSession object
MDIClient object
Menu object
MenuCascade object
Message object
MimeMessage object
MLSync object
MLSynchronization object
MonthCalendar control
MultiLineEdit control
OAuthClient object
OAuthRequest object
OLEControl control
OLECustomControl control (OCX)
OLEObject object
OLEStorage object
OLEStream object
OLETxnObject object
Oval control
PDFAttachment object
PDFColor object
PDFContent object
PDFContext object
PDFDocExtractor object
PDFDocument object
PDFDocumentProperties object
PDFFont object
PDFImage object
PDFImportContent object
PDFInvisibleContent object
PDFModel object
PDFMultilineText object
PDFPage object
PDFRichText object
PDFSecurity object
PDFSharedText object
PDFTableOfContents object
PDFTableOfContentsItem object
PDFText object
PDFTextBlock object
PDFTextLayout object
PDFVisibleContent object
PDFWatermark object
Picture control
PictureButton control
PictureHyperLink control
PictureListBox control
Pipeline object
PowerServerLabel object
PowerServerResult object
ProfileCall object
ProfileClass object
ProfileLine object
ProfileRoutine object
Profiling object
RadioButton control
Rectangle control
ResourceResponse object
RESTClient object
ResultSet object
RibbonBar control
RibbonApplicationButtonItem control
RibbonApplicationMenu control
RibbonCategoryItem control
RibbonCheckBoxItem control
RibbonComboBoxItem control
RibbonGroupItem control
RibbonLargeButtonItem control
RibbonMenu control
RibbonMenuItem control
RibbonPanelItem control
RibbonSmallButtonItem control
RibbonTabButtonItem control
RichTextEdit control
RoundRectangle control
RuntimeError object
ScriptDefinition object
SimpleTypeDefinition object
SingleLineEdit control
SMTPClient object
StaticHyperLink control
StaticText control
SyncParm object
Tab control
TabbedBar control
Throwable object
Timing object
TokenRequest object
TokenResponse object
TraceActivityNode object
TraceBeginEnd object
TraceError object
TraceESQL object
TraceFile object
TraceGarbageCollect object
TraceLine object
TraceObject object
TraceRoutine object
TraceTree object
TraceTreeError object
TraceTreeESQL object
TraceTreeGarbageCollect object
TraceTreeLine object
TraceTreeNode object
TraceTreeObject object
TraceTreeRoutine object
TraceTreeUser object
TraceUser object
Transaction object
TransactionServer object
TreeView control
TreeViewItem object
TypeDefinition object
ULSync object
UserObject object
VariableCardinalityDefinition object
VariableDefinition object
VProgressBar control
VScrollBar control
VTrackBar control
WebBrowser control
Window control
WSConnection object (Obsolete)
Property Descriptions and Usage
Accelerator
AccessibleDescription
AccessibleName
AccessibleRole
Activation
AdditionalOpts
Alignment
For controls that display text
For PDFTextLayout object
AllowAnnotations
AllowAssemble
AllowCopy
AllowEdit
AllowForms
AllowHighResolutionPrint
AllowModify
AllowPlainMetadata
AllowPrint
AnimationName
AnimationTime
AnonymousAccess
Application
Attachment
AuthenticateParms
Author
AutoArrange
AutoHScroll
Automatic
AutoPlay
AutoReadData
AutoScale
For Graph controls
For ribbon controls
AutoSize
AutosizeHeight
For RibbonBar controls
For TabbedBar controls
AutoSkip
AutoVScroll
B
BackColor
For windows and most controls
For PDFText, PDFTextBlock, and PDFMultilineText objects
BeginX
BeginY
Bold
BoldSelectedText
Border
BorderColor
BorderStyle
BottomMargin
For RichTextEdit
For PDFTableOfContents, PDFDocument, and PDFPage
BoxHeight
BoxWidth
BringToTop
BuiltinTheme
ButtonHeader
Cancel
CalendarBackColor
CalendarTextColor
CalendarTitleBackColor
CalendarTitleTextColor
CalendarTrailingTextColor
Category
CategorySort
Center
CharSpacing
Checked
CheckForServerCertRevocation
For HTTPClient, RestClient, TokenRequest and OAuthRequest objects
For SMTPClient object
ClientId
ClientSecret
Clicked
CloseAnimation
CollectionMode
ColumnsPerPage
CompressionLevel
Content
ContentsAllowed
ContextMenu
ControlCharsVisible
ControlMenu
CornerHeight
CornerWidth
CreateOnDemand
CustomFormat
DataObject
DataSource
DataType
DBPass
DBUser
Default
DefaultCommand
DefaultUrl
DeleteItems
Depth
DisabledName
DisableDragDrop
DisableNoScroll
DisplayEveryNLabels
DisplayExpression
DisplayName
DisplayOnly
DisplayType
DocumentName
DragAuto
DragIcon
DropDownCalendar
DropDownRight
DropLines
EditLabels
EditMode
Elevation
Enabled
EnableHttp2
EnableTLS
Encoding
For MimeMessage object
For PDFFont object
EncryptionKey
EndX
EndY
ErrorText
For MLSynchronization, MLSync objects
For DotNetAssembly object
Escapement
ExtendedOpts
ExtendedSelect
FaceName
Factoid
FileName
For PDFImportContent object
For PDFImage object
FillColor
FillPattern
FirstDayOfWeek
FirstLineIndent
FitMethod
FixedLocations
FixedWidth
FocusOnButtonDown
FocusRectangle
Font
FontCharSet
FontFamily
FontName
FontPitch
FontSize
FontWeight
Format
Frame
FreeDBLibraries
G
GrantType
GraphType
HasButtons
HasLines
HeaderFooter
Height
HideSelection
HideTabHeader
HidePanelText
Host
For MLSynchronization and MLSync objects
For SMTPClient object
HScrollBar
HSplitScroll
HTextAlign
HtmlBody
Icon
IgnoreCase
IgnoreDefaultButton
IgnorePressure
IgnoreServerCertificate
For HTTPClient, RestClient, TokenRequest and OAuthRequest objects
For SMTPClient object
Image
Increment
Indent
InkAntiAliased
InkColor
InkEnabled
InkHeight
InkMode
InkWidth
InputFieldBackColor
InputFieldNamesVisible
InputFieldsVisible
InsertAsText
Invert
Italic
For controls that display text
For PDFFont object
Item[ ]
ItemHandle
ItemPictureIndex[ ]
ItemType
Keywords
Label
LabelWrap
LargePictureHeight
LargePictureMaskColor
LargePictureName[ ]
LargePictureWidth
Layout
LayoutRTL
LeftIndent
LeftMargin
For RichTextEdit
For PDFTableOfContents, PDFDocument, and PDFPage
LeftText
Legend
Level
Limit
LineColor
LinesAtRoot
LinesPerPage
LineSpacing
LineStyle
LinkUpdateOptions
LiveScroll
LogFileName
LogOpts
MajorGridLine
MajorDivisions
MajorTic
Map3DColors
Mask
MaskDataType
MasterPassword
MaxBox
MaximumValue
MaxDate
MaxPosition
MaxSelectCount
MaxValDateTime
MenuName
Message
Method
MinBox
MinDate
MinimumValue
MinMax
MinorDivisions
MinorGridLine
MinorTic
MinPosition
MinValDateTime
MLPass
MLServerVersion
MLUser
Modified
For InkEdit, RichText controls
For RibbonComboBoxItem controls
MonthBackColor
Multiline
NewTabAtRightMost
MultiSelect
Name
NewLine
ObjectRevision
OpenAnimation
OriginalSize
OriginLine
OverlapPercent
PaperHeight
PaperOrientation
PaperWidth
Password
For SingleLineEdit controls
For TokenRequest object
For SMTPClient object
PerpendicularText
Perspective
PicturesAsFrame
PictureHeight
PictureIndex
PictureMaskColor
PictureName
For picture controls
For ribbon controls
PictureName[ ]
PictureOnRight
PictureWidth
Placeholder
Pointer
PopMenu
PopupWindow
Port
For MLSynchronization, MLSync, and SyncParm objects
For SMTPClient object
Position
PowerTipText
For picture controls
For ribbon controls
For window control
PowerTipDescription
PowerTips
PrimaryLine
Priority
ProcessOption
ProgressWindowName
Properties
Publication
R
RaggedRight
RecognitionTimer
Render3D
Resizable
ResourceSearchPath
ReturnCode
ReturnsNullWhenError
ReturnsVisible (obsolete)
RGB
RightIndent
RightMargin
For RichTextEdit
For PDFTableOfContents, PDFDocument, and PDFPage
RightToLeft
Rotate
Rotation
RulerBar
RoundTo
RoundToUnit
Scale
ScaleType
ScaleValue
Scope
Scrolling
ScrollRate
SecondaryLine
SecureProtocol
For HTTPClient and RestClient objects
For TokenRequest and OAuthRequest objects
For SMTPClient object
Security
Selected
SelectedStartPos
SelectedTab
SelectedTextLength
SelectionChanged
Series
SeriesSort
SetStep
ShadeBackEdge
Shortcut
ShowCloseButton
ShowContextMenu
ShowHeader
ShowIcon
ShowList
ShowPicture
ShowPowerTips
ShowSeparator
ShowText
For Tab controls
For TabbedBar controls
ShowUpDown
SmallPictureHeight
SmallPictureMaskColor
SmallPictureName[ ]
SmallPictureWidth
Sorted
SortType
SourceIndex
SpacesVisible (obsolete)
Spacing
Spin
StatePictureHeight
StatePictureMaskColor
StatePictureName[ ]
StatePictureWidth
Status
StdHeight
StdWidth
Subject
For PDFDocumentProperties object
For MimeMessage object
SyncRegistryKey
TabBackColor
TabOrder
TabPosition
TabStop[ ]
TabTextColor
TabsVisible (obsolete)
Tag
Text
For Menus and controls that display text and DatePicker controls
For Ribbon controls
For PDFWatermark
TextBody
TextCase
TextColor
For controls and objects that display text
For PDFText, PDFTextBlock and PDFMultilineText objects
TextSize
ThreeState
ThirdState
TimeOut
For HTTPClient, RestClient, TokenRequest and OAuthRequest objects
For SMTPClient object
Title
For DataWindow controls, Graph controls and Windows
For PDFDocumentProperties object
TitleBackColor
TitleBar
TitleTextColor
TodayCircle
TodaySection
TokenLocation
ToolbarAlignment
ToolbarHeight
ToolbarVisible
ToolbarWidth
ToolbarX
ToolbarY
ToolBar
TopMargin
For RichTextEdit
For PDFTableOfContents, PDFDocument, and PDFPage
TrailingTextColor
Transparency
For windows and applicable controls
For PDFImage object
For PDFWatermark object
Transparent
ULTrans
Underline
For controls that display text
For PDFFont object
UndoDepth (obsolete)
UnitsPerColumn
UnitsPerLine
URL
UseCodeTable
UseLogFile
UseMouseForInput
UserName
For TokenRequest object
For SMTPClient object
UserPassword
UseWindow
Value
View
Visible
VScrollBar
VTextAlign
Watermark
WeekNumbers
Weight
Width
WindowDockOptions
WindowDockState
WindowObject
WindowState
WindowType
WordWrap
X
XOAuth2AccessToken
Y
About Display Formats and Scrolling
Using colors with display formats
Using date display formats
Using number display formats
Using string display formats
Using time display formats
Scrolling in windows and user objects