DataWindow Reference

Appeon PowerBuilder® 2019

FOR WINDOWS

DOCUMENT ID: DC37783-01-1900-01

LAST REVISED: February 20, 2019

Copyright © 2019 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 Inc.

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

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 Inc., 1/F, Shell Industrial Building, 12 Lee Chung Street, Chai Wan District, Hong Kong.


Table of Contents

DataWindow Operators and Expressions
Where you use DataWindow expressions
Operators used in DataWindow expressions
Arithmetic operators in DataWindow expressions
Relational operators in DataWindow expressions
Logical operators in DataWindow expressions
Concatenation operator in DataWindow expressions
Operator precedence in DataWindow expressions
Evaluating DataWindow expressions in scripts
Evaluating DataWindow expressions in the Describe function
Evaluating conditional DataWindow expressions with current data
DataWindow Expression Functions
Using DataWindow expression functions
Decimal support in DataWindow expressions
Four examples
Example 1: counting null values in a column
Example 2: counting active and terminated employees
Example 3: creating a row indicator
Example 4: displaying all data when a column allows nulls
Alphabetical list of DataWindow expression functions
Abs
ACos
Asc
AscA
ASin
ATan
Avg
Bitmap
Case
Ceiling
Char
CharA
Cos
Count
CrosstabAvg
CrosstabAvgDec
CrosstabCount
CrosstabMax
CrosstabMaxDec
CrosstabMin
CrosstabMinDec
CrosstabSum
CrosstabSumDec
CumulativePercent
CumulativeSum
CurrentRow
Date
DateTime
Day
DayName
DayNumber
DaysAfter
Dec
Describe
Exp
Fact
Fill
FillA
First
FontHeight
GetPaintDC
GetPaintRectHeight
GetPaintRectWidth
GetPaintRectX
GetPaintRectY
GetRow
GetText
Hour
If
Int
Integer
IsDate
IsExpanded
IsNull
IsNumber
IsRowModified
IsRowNew
IsSelected
IsTime
Large
Last
LastPos
Left
LeftA
LeftTrim
Len
LenA
Log
LogTen
Long
LookUpDisplay
Lower
Match
Max
Median
Mid
MidA
Min
Minute
Mod
Mode
Month
Now
Number
Page
PageAbs
PageAcross
PageCount
PageCountAcross
Paint
Percent
Pi
Pos
PosA
ProfileInt
ProfileString
Rand
Real
RelativeDate
RelativeTime
Replace
ReplaceA
RGB
RichText
RichTextFile
Right
RightA
RightTrim
Round
RowCount
RowHeight
Second
SecondsAfter
Sign
Sin
Small
Space
Sqrt
StDev
StDevP
String
StripRTF
Sum
Tan
Time
Today
Trim
Truncate
Upper
Var
VarP
WordCap
Year
DataWindow Object Properties
Overview of DataWindow object properties
Controls in a DataWindow and their properties
Properties for the DataWindow object
Properties for Button controls in DataWindow objects
Properties for Column controls in DataWindow objects
Properties for Computed Field controls in DataWindow objects
Properties for Graph controls in DataWindow objects
Properties for GroupBox controls in DataWindow objects
Properties for the Group keyword
Properties for InkPicture controls in DataWindow objects
Properties for Line controls in DataWindow objects
Properties for OLE Object controls in DataWindow objects
Properties for Oval, Rectangle, and RoundRectangle controls in DataWindow objects
Properties for Picture controls in DataWindow objects
Properties for Report controls in DataWindow objects
Properties for the Style keyword
Properties for TableBlob controls in DataWindow objects
Properties for Text controls in DataWindow objects
Title keyword
Alphabetical list of DataWindow object properties
Accelerator
AccessibleDescription
AccessibleName
AccessibleRole
Action
Activation
Alignment
Arguments
Attributes
Axis
Axis.property
BackColor
Background.property
BackImage
Band
Bandname.property
Bandname.Text
Bands
BinaryIndex
BitmapName
Border
Brush.property
Brushmode
Category
CheckBox.property
ClientName
Color
ColType
Column.Count
ContentsAllowed
Criteria
Criteria.property
Crosstab.property
CSSGen.property (obsolete)
Data
Data.HTML (obsolete)
Data.HTMLTable (obsolete)
Data.XHTML (obsolete)
Data.XML
Data.XMLDTD
Data.XMLSchema
Data.XMLWeb (obsolete)
Data.XSLFO
DataObject
dbAlias
dbName
dddw.property
ddlb.property
DefaultPicture
Depth
Detail_Bottom_Margin
Detail_Top_Margin
Detail.property
DispAttr.fontproperty
DisplayType
Edit.property
EditMask.property
Elevation
EllipseHeight
EllipseWidth
Enabled
Export.PDF.Distill.CustomPostScript
Export.PDF.Method
Export.PDF.NativePDF.CustomOrientation
Export.PDF.NativePDF.CustomSize
Export.PDF.NativePDF.ImageFormat
Export.PDF.NativePDF.MasterPassword
Export.PDF.NativePDF.PDFStandard
Export.PDF.NativePDF.Restrictions
Export.PDF.NativePDF.UserPassword
Export.PDF.NativePDF.UsePrintSpec
Export.PDF.XSLFOP.Print
Export.XHTML.TemplateCount
Export.XHTML.Template[ ].Name
Export.XHTML.UseTemplate
Export.XML.HeadGroups
Export.XML.IncludeWhitespace
Export.XML.MetaDataType
Export.XML.SaveMetaData
Export.XML.TemplateCount
Export.XML.Template[ ].Name
Export.XML.UseTemplate
Expression
Filename
FirstRowOnPage
FocusRectangle
Font.Bias
Font.property
Footer.property
Format
Gradient.property
GraphType
Grid.ColumnMove
Grid.Lines
GroupBy
Header_Bottom_Margin
Header_Top_Margin
Header.property
Header.#.property
Height
Height.AutoSize
Height.HasMinHeight
Help.property
HideGrayLine
HideSnaked
Horizontal_Spread
HorizontalScrollMaximum
HorizontalScrollMaximum2
HorizontalScrollPosition
HorizontalScrollPosition2
HorizontalScrollSplit
HTextAlign
HTML.property (obsolete)
HTMLDW (obsolete)
HTMLGen.property (obsolete)
HTMLTable.property (obsolete)
ID
Identity
Import.XML.Trace
Import.XML.TraceFile
Import.XML.UseTemplate
Initial
Ink.property
InkEdit.property
InkPic.property
Invert
JSGen.property (obsolete)
Key
KeyClause
Label.property
LabelDispAttr.fontproperty
LastRowOnPage
Left_Margin
Legend
Legend.DispAttr.fontproperty
Level
LineRemove
LinkUpdateOptions
Message.Title
Moveable
Multiline
Name
Nest_Arguments
Nested
NewPage (Group keywords)
NewPage (Report controls)
NoUserPrompt
Objects
OLE.Client.property
OLEClass
OriginalSize
OverlapPercent
Pen.property
Perspective
Picture.property
Pie.DispAttr.fontproperty
PlotNullData
Pointer
Print.Preview.property
Print.property
Printer
Processing
Protect
QueryClear
QueryMode
QuerySort
RadioButtons.property
Range
ReadOnly
Render3D
ReplaceTabWithSpace
Report
ResetPageCount
Resizeable
Retrieve
Retrieve.AsNeeded
RichEdit.property
RichText.property
RightToLeft
Rotation
Row.Resize
Rows_Per_Detail
Selected
Selected.Data
Selected.Mouse
Series
ShadeColor
ShowBackColorOnXP
ShowBackground
ShowDefinition
SizeToDisplay
SlideLeft
SlideUp
Sort
Spacing
Sparse
Storage
StoragePageSize
Summary.property
SuppressEventProcessing
Syntax
Syntax.Data
Syntax.Modified
Table (for Create)
Table (for InkPicture and TableBlobs)
Table.property
Table.sqlaction.property
TabSequence
Tag
Target
Template
Text
Timer_Interval
Title
Title.DispAttr.fontproperty
Tooltip.property
Trail_Footer
Trailer.#.property
Transparency (columns and controls)
Transparency (picture controls in DataWindows)
Transparency (DataWindow objects)
Tree.property
Tree.Leaf.TreeNodeIconName
Tree.Level.#.property
Type
Units
Update
Validation
ValidationMsg
Values (for columns)
Values (for graphs)
Vertical_Size
Vertical_Spread
VerticalScrollMaximum
VerticalScrollPosition
Visible
VTextAlign
Width
Width.Autosize
Width.Autosize
X
X1, X2
XHTMLGen.Browser (obsolete)
XMLGen.property (obsolete)
XSLTGen.property (obsolete)
Y
Y1, Y2
Zoom
Accessing Data in Code
Accessing data and properties in DataWindow programming environments
Techniques for accessing data
About DataWindow data expressions
Syntaxes for DataWindow data expressions
Syntax for one or all data items in a named column
Syntax for selected data in a named column
Syntax for a range of data in a named column
Syntax for a single data item in a DataWindow
Syntax for data in a block of rows and columns
Syntax for data in a single row or all rows
Syntax for all data from selected rows
Accessing DataWindow Object Properties in Code
About properties of the DataWindow object and its controls
What you can do with DataWindow object properties
Specifying property values in the DataWindow painter
Accessing DataWindow object property values in code
Using DataWindow expressions as property values
Nested strings and special characters for DataWindow object properties
PowerBuilder: Modify and Describe methods for properties
Advantage and drawbacks of Modify and Describe methods in PowerBuilder
Handling errors from Modify and Describe methods in PowerBuilder
PowerBuilder: DataWindow property expressions
Basic structure of DataWindows and property expressions in PowerBuilder
Datatypes of DataWindow property expressions in PowerBuilder
Using the DWObject variable in PowerBuilder
When a DataWindow property expression is evaluated in PowerBuilder
Handling errors from DataWindow property expressions in PowerBuilder
PowerBuilder syntax for DataWindow property expressions
JavaScript: Modify and Describe methods for properties
Advantage and drawbacks of the Modify and Describe methods in JavaScript
Handling errors for Modify and Describe methods in JavaScript
DataWindow Constants
About DataWindow constants
Alphabetical list of DataWindow constants
AccessibleRole
Alignment
Band
Border
BorderStyle
CharSet
DWBuffer
DWConflictResolution
DWItemStatus
FillPattern
grColorType
grDataType
grObjectType
grSymbolType
LineStyle
MetaDataType
RichTextToolbarActivation
RowFocusInd
SaveAsType
SQLPreviewFunction
SaveMetaData
SQLPreviewType
WebPagingMethod
Properties of the DataWindow Control and DataStore
Properties for PowerBuilder DataWindow
Properties for DataStore objects
Properties for DataWindow controls
DataWindow Events
About return values for DataWindow events
Categories of DataWindow events
DataWindow event cross-reference
Alphabetical list of DataWindow events
BackTabOut
ButtonClicked
ButtonClicking
Clicked
Collapsed
Collapsing
Constructor
DBError
Destructor
DoubleClicked
DragDrop
DragEnter
DragLeave
DragWithin
DropDown
EditChanged
Error
Expanded
Expanding
GetFocus
GraphCreate
HTMLContextApplied
ItemChanged
ItemError
ItemFocusChanged
KeyDown
LoseFocus
MessageText
MouseMove
MouseUp
OnSubmit
Printend
PrintMarginChange
PrintPage
PrintStart
ProcessEnter
RButtonDown
Resize
RetrieveEnd
RetrieveRow
RetrieveStart
RichTextCurrentStyleChanged
RichTextLoseFocus
RichTextLimitError
RowFocusChanged
RowFocusChanging
ScrollHorizontal
ScrollVertical
SQLPreview
TabDownOut
TabOut
TabUpOut
TreeNodeSelected
TreeNodeSelecting
UpdateEnd
UpdateStart
WSError (Obsolete)
Methods for the DataWindow Control
AboutBox (obsolete)
AcceptText
CanUndo
ClassName
Clear
ClearValues
Collapse
CollapseAll
CollapseAllChildren
CollapseLevel
Copy
CopyRTF
Create
CreateError (obsolete)
CreateFrom
CrosstabDialog
Cut
DBCancel
DBErrorCode (obsolete)
DBErrorMessage (obsolete)
DeletedCount
DeleteRow
Describe
Drag
Expand
ExpandAll
ExpandAllChildren
ExpandLevel
ExportJson
Syntax 1
Syntax 2
Syntax 3
Syntax 4
ExportRowAsJson
Filter
FilteredCount
Find
FindGroupChange
FindNext
FindRequired
FindRequiredColumn (obsolete)
FindRequiredColumnName (obsolete)
FindRequiredRow (obsolete)
Generate (obsolete)
GenerateHTMLForm (obsolete)
GenerateResultSet
GenerateXHTML (obsolete)
GenerateXMLWeb (obsolete)
GetBandAtPointer
GetBorderStyle
GetChanges
GetChangesBlob (obsolete)
GetChild
GetChildObject (obsolete)
GetClickedColumn
GetClickedRow
GetColumn
GetColumnName
GetContextService
GetFormat
GetFullContext (obsolete)
GetFullState
GetFullStateBlob (obsolete)
GetItem (obsolete)
GetItemDate
GetItemDateTime
GetItemDecimal
GetItemFormattedString
GetItemNumber
GetItemStatus
GetItemString
GetItemTime
GetItemUnformattedString
GetLastError (obsolete)
GetLastErrorString (obsolete)
GetMessageText (obsolete)
GetNextModified
GetObjectAtPointer
GetParent
GetRichTextAlign
GetRichTextColor
GetRichTextFaceName
GetRichTextSize
GetRichTextStyle
GetRow
GetRowFromRowId
GetRowIdFromRow
GetSelectedRow
GetSQLPreview (obsolete)
GetSQLSelect
GetStateStatus (obsolete)
GetText
GetTrans
GetUpdateStatus (obsolete)
GetValidate
GetValue
GroupCalc
Hide
ImportClipboard
ImportFile
ImportJson
JSON formats (required by ImportJson & ImportJsonByKey functions)
ImportJsonByKey
ImportRowFromJson
ImportString
InsertDocument
InsertRow
IsExpanded
IsRowSelected (obsolete)
IsSelected
LineCount
ModifiedCount
Modify
Move
OLEActivate
OneTrip (obsolete)
Paste
PasteRTF
PointerX
PointerY
Position
Syntax 1 For DataWindows with standard presentation styles
Syntax 2 For DataWindows with RichTextEdit presentation styles
PostEvent
Print
Syntax 1 For printing a single DataWindow or DataStore
Syntax 2 For printing a visual object in a print job
PrintCancel
Syntax 1 For DataWindows and DataStores
Syntax 2 For canceling a print job
ReplaceText
ReselectRow
Reset
ResetInk
ResetTransObject
ResetUpdate
Resize
Retrieve
RowCount
RowsCopy
RowsDiscard
RowsMove
SaveAs
SaveAsAscii
SaveAsFormattedText
SaveInk
SaveInkPic
SaveNativePDFToBlob
Scroll
ScrollFirstPage (obsolete)
ScrollLastPage (obsolete)
ScrollNextPage
Syntax 1 For DataWindow controls and child DataWindows
Syntax 2 For RichTextEdit DataWindows
ScrollNextRow
Syntax 1 For DataWindow controls and child DataWindows
Syntax 2 For RichTextEdit DataWindows
ScrollPriorPage
Syntax 1 For DataWindow controls and child DataWindows
Syntax 2 For RichTextEdit DataWindows
ScrollPriorRow
Syntax 1 For DataWindow controls and child DataWindows
Syntax 2 For RichTextEdit DataWindows
ScrollToRow
SelectedLength
SelectedLine
SelectedStart
SelectedText
SelectRow
SelectText
Syntax 1 For DataWindows with standard edit styles
Syntax 2 For RichTextEdit DataWindows
SelectTextAll
SelectTextLine
SelectTextWord
SelectTreeNode
SetAction (obsolete)
SetActionCode (obsolete)
SetBorderStyle
SetBrowser (obsolete)
SetChanges
SetColumn
SetColumnLink (obsolete)
SetCultureFormat
SetDetailHeight
SetDWObject (obsolete)
SetFilter
SetFormat
SetFullState
SetHTMLAction (obsolete)
SetHTMLObjectName (obsolete)
SetItem
SetItemDate (obsolete)
SetItemDateTime (obsolete)
SetItemNumber (obsolete)
SetItemStatus
SetItemString (obsolete)
SetItemTime (obsolete)
SetPageSize (obsolete)
SetPosition
SetRedraw
SetRichTextAlign
SetRichTextColor
SetRichTextFaceName
SetRichTextSize
SetRichTextStyle
SetRow
SetRowFocusIndicator
SetSelfLink (obsolete)
SetServerServiceClasses (obsolete)
SetServerSideState (obsolete)
SetSort
SetSQLPreview
SetSQLSelect
SetTabOrder
SetText
SetTrans
SetTransObject
SetValidate
SetValue
SetWeight (obsolete)
SetWSObject (Obsolete)
ShareData
ShareDataOff
Show
ShowHeadFoot
Sort
TextLine
TriggerEvent
TypeOf
Undo
Update
Methods for Graphs in the DataWindow Control
CategoryCount
CategoryName
Clipboard
DataCount
FindCategory
FindSeries
GetData
GetDataDateVariable
GetDataLabelling
GetDataNumberVariable
GetDataPieExplode
GetDataPieExplodePercentage
GetDataStringVariable
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 of a data point
Syntax 4 For the symbol of a data point
GetDataStyleColorValue
GetDataStyleFillPattern
GetDataStyleLineStyle
GetDataStyleLineWidth
GetDataStyleSymbolValue
GetDataTransparency
GetDataValue
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 of a series
Syntax 4 For the symbol of a series
Syntax 5 For determining whether a series is an overlay
GetSeriesStyleColorValue
GetSeriesStyleFillPattern
GetSeriesStyleLineStyle
GetSeriesStyleLineWidth
GetSeriesStyleOverlayValue
GetSeriesStyleSymbolValue
GetSeriesTransparency
ObjectAtPointer
ObjectAtPointerDataPoint
ObjectAtPointerSeries
Reset
ResetDataColors
SaveAs
SeriesCount
SeriesName
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 of a data point
Syntax 4 For the symbol of a data point
SetDataTransparency
SetSeriesLabelling
SetSeriesStyle
Syntax 1 For setting a series' colors
Syntax 2 For lines in a graph
Syntax 3 For the fill pattern in a graph
Syntax 4 For the symbols in a graph
Syntax 5 For creating an overlay in a graph
SetSeriesTransparency