Datawindow Reference

DataWindow® Reference
Appeon PowerBuilder®
2017
DOCUMENT ID: DC37783-01-1700-01
LAST REVISED: July 2017
Copyright © 2017 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
About This Book ........................................................................................................................ xvii
CHAPTER 1 DataWindow Operators and Expressions..................................... 1

Where you use DataWindow expressions........................................ 1
Operators used in DataWindow expressions ................................... 4
Arithmetic operators in DataWindow expressions ..................... 5
Relational operators in DataWindow expressions ..................... 5
Logical operators in DataWindow expressions ......................... 9
Concatenation operator in DataWindow expressions ............. 10
Operator precedence in DataWindow expressions ........................ 11
Evaluating DataWindow expressions in scripts.............................. 12
Evaluating DataWindow expressions in the Describe function ...... 13
Evaluating conditional DataWindow expressions with current data 14
CHAPTER 2 DataWindow Expression Functions ............................................ 17

Using DataWindow expression functions ....................................... 17
Decimal support in DataWindow expressions ................................ 19
Four examples ............................................................................... 20
Example 1: counting null values in a column .......................... 20
Example 2: counting male and female employees .................. 21
Example 3: creating a row indicator ........................................ 25
Example 4: displaying all data when a column allows nulls .... 26
Alphabetical list of DataWindow expression functions ................... 29
Abs .......................................................................................... 29
ACos........................................................................................ 29
Asc .......................................................................................... 30
AscA ........................................................................................ 31
ASin......................................................................................... 31
ATan........................................................................................ 32
Avg .......................................................................................... 33
Bitmap ..................................................................................... 35
Case ........................................................................................ 36
Ceiling ..................................................................................... 37
DataWindow Reference iii

Contents
Char......................................................................................... 38
CharA ...................................................................................... 38
Cos .......................................................................................... 39
Count....................................................................................... 40
CrosstabAvg............................................................................ 42
CrosstabAvgDec ..................................................................... 46
CrosstabCount ........................................................................ 47
CrosstabMax ........................................................................... 48
CrosstabMaxDec..................................................................... 50
CrosstabMin ............................................................................ 51
CrosstabMinDec...................................................................... 53
CrosstabSum........................................................................... 54
CrosstabSumDec .................................................................... 55
CumulativePercent .................................................................. 56
CumulativeSum ....................................................................... 58
CurrentRow ............................................................................. 60
Date......................................................................................... 61
DateTime................................................................................. 62
Day .......................................................................................... 63
DayName ................................................................................ 63
DayNumber ............................................................................. 64
DaysAfter................................................................................. 65
Dec .......................................................................................... 66
Describe .................................................................................. 67
Exp .......................................................................................... 67
Fact ......................................................................................... 68
Fill............................................................................................ 68
FillA ......................................................................................... 69
First ......................................................................................... 70
GetPaintDC ............................................................................. 71
GetPaintRectHeight................................................................. 72
GetPaintRectWidth.................................................................. 73
GetPaintRectX......................................................................... 73
GetPaintRectY......................................................................... 74
GetRow ................................................................................... 74
GetText.................................................................................... 75
Hour......................................................................................... 75
If .............................................................................................. 76
Int ............................................................................................ 77
Integer ..................................................................................... 78
IsDate ...................................................................................... 78
IsExpanded ............................................................................. 79
IsNull ....................................................................................... 80
IsNumber................................................................................. 80
iv PowerBuilder
Contents
IsRowModified......................................................................... 81
IsRowNew ............................................................................... 81
IsSelected................................................................................ 82
IsTime...................................................................................... 83
Large ....................................................................................... 83
Last.......................................................................................... 85
LastPos ................................................................................... 87
Left .......................................................................................... 88
LeftA ........................................................................................ 89
LeftTrim ................................................................................... 89
Len .......................................................................................... 90
LenA ........................................................................................ 90
Log .......................................................................................... 91
LogTen .................................................................................... 92
Long ........................................................................................ 92
LookUpDisplay ........................................................................ 93
Lower....................................................................................... 93
Match....................................................................................... 94
Max.......................................................................................... 96
Median..................................................................................... 98
Mid......................................................................................... 101
MidA ...................................................................................... 102
Min......................................................................................... 102
Minute.................................................................................... 104
Mod ....................................................................................... 105
Mode ..................................................................................... 105
Month .................................................................................... 108
Now ....................................................................................... 108
Number.................................................................................. 109
Page ...................................................................................... 110
PageAbs................................................................................ 110
PageAcross ........................................................................... 111
PageCount ............................................................................ 112
PageCountAcross ................................................................. 112
Paint ...................................................................................... 113
Percent .................................................................................. 114
Pi ........................................................................................... 117
Pos ........................................................................................ 117
PosA...................................................................................... 118
ProfileInt ................................................................................ 119
ProfileString........................................................................... 120
Rand...................................................................................... 122
Real ....................................................................................... 122
RelativeDate.......................................................................... 123
DataWindow Reference v
Contents
RelativeTime ......................................................................... 123

Replace ................................................................................. 124
ReplaceA............................................................................... 125
RGB....................................................................................... 126
RichText ................................................................................ 127
RichTextFile .......................................................................... 127
Right ...................................................................................... 128
RightA.................................................................................... 128
RightTrim............................................................................... 129
Round.................................................................................... 130
RowCount.............................................................................. 130
RowHeight............................................................................. 131
Second .................................................................................. 132
SecondsAfter......................................................................... 132
Sign ....................................................................................... 133
Sin ......................................................................................... 133
Small ..................................................................................... 134
Space .................................................................................... 136
Sqrt........................................................................................ 136
StDev..................................................................................... 137
StDevP .................................................................................. 139
String ..................................................................................... 142
StripRTF ................................................................................ 144
Sum ....................................................................................... 144
Tan ........................................................................................ 146
Time ...................................................................................... 147
Today .................................................................................... 148
Trim ....................................................................................... 148
Truncate ................................................................................ 149
Upper..................................................................................... 149
Var......................................................................................... 150
VarP ...................................................................................... 153
WordCap ............................................................................... 155
Year....................................................................................... 156
CHAPTER 3 DataWindow Object Properties .................................................. 157

Overview of DataWindow object properties ................................. 157
Controls in a DataWindow and their properties............................ 158
Properties for the DataWindow object................................... 159
Properties for Button controls in DataWindow objects .......... 164
Properties for Column controls in DataWindow objects ........ 165
Properties for Computed Field controls in DataWindow objects ..
167
Properties for Graph controls in DataWindow objects........... 168
vi PowerBuilder
Contents
Properties for GroupBox controls in DataWindow objects .... 170

Properties for the Group keyword ......................................... 171
Properties for InkPicture controls in DataWindow objects..... 171
Properties for Line controls in DataWindow objects .............. 172
Properties for OLE Object controls in DataWindow objects .. 172
Properties for Oval, Rectangle, and RoundRectangle controls in
DataWindow objects....................................................... 173
Properties for Picture controls in DataWindow objects ......... 174
Properties for Report controls in DataWindow objects .......... 175
Properties for the Style keyword ........................................... 176
Properties for TableBlob controls in DataWindow objects .... 177
Properties for Text controls in DataWindow objects.............. 177
Title keyword ......................................................................... 178
Alphabetical list of DataWindow object properties ....................... 179
CHAPTER 4 Accessing Data in Code ............................................................. 425

Accessing data and properties in DataWindow programming
environments .................................................................. 425
Techniques for accessing data .................................................... 426
About DataWindow data expressions ................................... 427
Syntaxes for DataWindow data expressions................................ 434
Syntax for one or all data items in a named column ............. 435
Syntax for selected data in a named column ........................ 437
Syntax for a range of data in a named column...................... 439
Syntax for a single data item in a DataWindow..................... 441
Syntax for data in a block of rows and columns .................... 442
Syntax for data in a single row or all rows............................. 444
Syntax for all data from selected rows .................................. 445
CHAPTER 5 Accessing DataWindow Object Properties in Code ................ 447

About properties of the DataWindow object and its controls........ 447
What you can do with DataWindow object properties ........... 447
Specifying property values in the DataWindow painter ......... 449
Accessing DataWindow object property values in code ........ 450
Using DataWindow expressions as property values ............. 451
Nested strings and special characters for DataWindow object
properties........................................................................ 454
PowerBuilder: Modify and Describe methods for properties ........ 457
Advantage and drawbacks of Modify and Describe methods in
PowerBuilder .................................................................. 457
Handling errors from Modify and Describe methods in PowerBuilder
459
PowerBuilder: DataWindow property expressions ....................... 460
DataWindow Reference vii

Contents
Basic structure of DataWindows and property expressions in

PowerBuilder .................................................................. 460
Datatypes of DataWindow property expressions in PowerBuilder
461
Using the DWObject variable in PowerBuilder ...................... 462
When a DataWindow property expression is evaluated in
PowerBuilder .................................................................. 465
Handling errors from DataWindow property expressions in
PowerBuilder .................................................................. 466
PowerBuilder syntax for DataWindow property expressions. 468
JavaScript: Modify and Describe methods for properties............. 475
Advantage and drawbacks of the Modify and Describe methods in
JavaScript....................................................................... 475
Handling errors for Modify and Describe methods in JavaScript .
476
CHAPTER 6 DataWindow Constants............................................................... 479

About DataWindow constants ...................................................... 479
Alphabetical list of DataWindow constants .................................. 480
CHAPTER 7 Properties of the DataWindow Control and DataStore ............ 497

Properties for PowerBuilder DataWindow .................................... 497
Properties for DataStore objects ........................................... 497
Properties for DataWindow controls...................................... 498
CHAPTER 8 DataWindow Events .................................................................... 501

About return values for DataWindow events ................................ 501
Categories of DataWindow events ............................................... 502
DataWindow event cross-reference ............................................. 503
Alphabetical list of DataWindow events ....................................... 503
BackTabOut ................................................................................. 504
ButtonClicked ............................................................................... 504
ButtonClicking .............................................................................. 506
Clicked ......................................................................................... 507
Collapsed ..................................................................................... 509
Collapsing .................................................................................... 509
Constructor................................................................................... 510
DBError ........................................................................................ 511
Destructor..................................................................................... 513
DoubleClicked .............................................................................. 514
DragDrop...................................................................................... 515
DragEnter..................................................................................... 516
viii PowerBuilder
Contents
DragLeave.................................................................................... 517
DragWithin ................................................................................... 517
DropDown .................................................................................... 518
EditChanged ................................................................................ 519
Error ............................................................................................. 519
Expanded ..................................................................................... 522
Expanding .................................................................................... 523
GetFocus...................................................................................... 523
GraphCreate ................................................................................ 524
HTMLContextApplied ................................................................... 524
ItemChanged................................................................................ 526
ItemError ...................................................................................... 527
ItemFocusChanged ...................................................................... 529
KeyDown...................................................................................... 530
LoseFocus.................................................................................... 530
MessageText................................................................................ 531
MouseMove.................................................................................. 531
MouseUp...................................................................................... 532
OnSubmit ..................................................................................... 533
Printend........................................................................................ 534
PrintMarginChange ...................................................................... 535
PrintPage ..................................................................................... 536
PrintStart ...................................................................................... 537
ProcessEnter................................................................................ 537
RButtonDown ............................................................................... 538
Resize .......................................................................................... 538
RetrieveEnd ................................................................................. 539
RetrieveRow................................................................................. 540
RetrieveStart ................................................................................ 541
RichTextCurrentStyleChanged .................................................... 542
RichTextLoseFocus ..................................................................... 542
RichTextLimitError ....................................................................... 543
RowFocusChanged...................................................................... 543
RowFocusChanging ..................................................................... 544
ScrollHorizontal ............................................................................ 546
ScrollVertical ................................................................................ 547
SQLPreview ................................................................................. 548
TabDownOut ................................................................................ 550
TabOut ......................................................................................... 550
TabUpOut..................................................................................... 551
TreeNodeSelected ....................................................................... 551
TreeNodeSelecting ...................................................................... 552
UpdateEnd ................................................................................... 552
UpdateStart .................................................................................. 553
DataWindow Reference ix
Contents
WSError ....................................................................................... 553
CHAPTER 9 Methods for the DataWindow Control ....................................... 555

AboutBox...................................................................................... 555
AcceptText ................................................................................... 556
CanUndo ...................................................................................... 558
ClassName................................................................................... 559
Clear............................................................................................. 560
ClearValues.................................................................................. 561
Collapse ....................................................................................... 561
CollapseAll ................................................................................... 562
CollapseAllChildren...................................................................... 563
CollapseLevel............................................................................... 564
Copy............................................................................................. 565
CopyRTF...................................................................................... 567
Create .......................................................................................... 569
CreateError .................................................................................. 571
CreateFrom .................................................................................. 572
CrosstabDialog............................................................................. 574
Cut................................................................................................ 575
DBCancel ..................................................................................... 576
DBErrorCode................................................................................ 578
DBErrorMessage.......................................................................... 580
DeletedCount ............................................................................... 581
DeleteRow.................................................................................... 583
Describe ....................................................................................... 584
Drag ............................................................................................. 589
Expand ......................................................................................... 590
ExpandAll ..................................................................................... 591
ExpandAllChildren........................................................................ 592
ExpandLevel ................................................................................ 593
Filter ............................................................................................. 594
FilteredCount................................................................................ 595
Find .............................................................................................. 597
FindGroupChange........................................................................ 601
FindNext....................................................................................... 603
FindRequired................................................................................ 604
FindRequiredColumn ................................................................... 608
FindRequiredColumnName.......................................................... 608
FindRequiredRow ........................................................................ 609
Generate ...................................................................................... 610
GenerateHTMLForm .................................................................... 612
GenerateResultSet....................................................................... 613
GenerateXHTML .......................................................................... 615
x PowerBuilder
Contents
GenerateXMLWeb ....................................................................... 617

GetBandAtPointer ........................................................................ 619
GetBorderStyle............................................................................. 620
GetChanges ................................................................................. 621
GetChangesBlob.......................................................................... 623
GetChild ....................................................................................... 624
GetChildObject............................................................................. 627
GetClickedColumn ....................................................................... 627
GetClickedRow ............................................................................ 628
GetColumn ................................................................................... 630
GetColumnName ......................................................................... 631
GetContextService ....................................................................... 632
GetFormat .................................................................................... 632
GetFullContext ............................................................................. 633
GetFullState ................................................................................. 635
GetFullStateBlob .......................................................................... 636
GetItem ........................................................................................ 637
GetItemDate................................................................................. 638
GetItemDateTime ......................................................................... 641
GetItemDecimal ........................................................................... 643
GetItemFormattedString............................................................... 646
GetItemNumber............................................................................ 647
GetItemStatus .............................................................................. 649
GetItemString ............................................................................... 651
GetItemTime ................................................................................ 653
GetItemUnformattedString ........................................................... 656
GetLastError................................................................................. 657
GetLastErrorString ....................................................................... 658
GetMessageText .......................................................................... 659
GetNextModified .......................................................................... 660
GetObjectAtPointer ...................................................................... 662
GetParent..................................................................................... 663
GetRichTextAlign ......................................................................... 664
GetRichTextColor......................................................................... 665
GetRichTextFaceName................................................................ 665
GetRichTextSize .......................................................................... 666
GetRichTextStyle ......................................................................... 667
GetRow ........................................................................................ 668
GetRowFromRowId...................................................................... 669
GetRowIdFromRow...................................................................... 671
GetSelectedRow .......................................................................... 672
GetSQLPreview ........................................................................... 673
GetSQLSelect .............................................................................. 673
GetStateStatus............................................................................. 675
DataWindow Reference xi
Contents
GetText ........................................................................................ 677

GetTrans ...................................................................................... 678
GetUpdateStatus.......................................................................... 680
GetValidate .................................................................................. 682
GetValue ...................................................................................... 683
GroupCalc .................................................................................... 684
Hide.............................................................................................. 685
ImportClipboard............................................................................ 686
ImportFile ..................................................................................... 689
ImportString.................................................................................. 693
InsertDocument............................................................................ 697
InsertRow ..................................................................................... 699
IsExpanded .................................................................................. 700
IsRowSelected ............................................................................. 700
IsSelected .................................................................................... 702
LineCount..................................................................................... 703
ModifiedCount .............................................................................. 704
Modify........................................................................................... 705
Move ............................................................................................ 720
OLEActivate ................................................................................. 721
OneTrip ........................................................................................ 722
Paste ............................................................................................ 726
PasteRTF ..................................................................................... 727
PointerX ....................................................................................... 728
PointerY ....................................................................................... 729
Position ........................................................................................ 730
PostEvent..................................................................................... 735
Print.............................................................................................. 736
PrintCancel................................................................................... 740
ReplaceText ................................................................................. 743
ReselectRow ................................................................................ 744
Reset............................................................................................ 745
ResetInk ....................................................................................... 746
ResetTransObject ........................................................................ 747
ResetUpdate ................................................................................ 748
Resize .......................................................................................... 749
Retrieve........................................................................................ 750
RowCount .................................................................................... 754
RowsCopy.................................................................................... 755
RowsDiscard ................................................................................ 758
RowsMove ................................................................................... 759
SaveAs......................................................................................... 762
SaveAsAscii ................................................................................. 765
SaveAsFormattedText ................................................................. 766
xii PowerBuilder
Contents
SaveInk ........................................................................................ 768

SaveInkPic ................................................................................... 770
Scroll ............................................................................................ 771
ScrollFirstPage ............................................................................. 772
ScrollLastPage ............................................................................. 774
ScrollNextPage ............................................................................ 775
ScrollNextRow.............................................................................. 777
ScrollPriorPage ............................................................................ 780
ScrollPriorRow ............................................................................. 782
ScrollToRow ................................................................................. 785
SelectedLength ............................................................................ 786
SelectedLine ................................................................................ 787
SelectedStart................................................................................ 788
SelectedText ................................................................................ 789
SelectRow .................................................................................... 790
SelectText .................................................................................... 791
SelectTextAll ................................................................................ 795
SelectTextLine ............................................................................. 796
SelectTextWord............................................................................ 797
SelectTreeNode ........................................................................... 798
SetAction...................................................................................... 799
SetActionCode ............................................................................. 800
SetBorderStyle ............................................................................. 802
SetBrowser................................................................................... 803
SetChanges ................................................................................. 804
SetColumn ................................................................................... 806
SetColumnLink ............................................................................. 807
SetCultureFormat ......................................................................... 809
SetDetailHeight ............................................................................ 810
SetDWObject ............................................................................... 811
SetFilter........................................................................................ 812
SetFormat .................................................................................... 815
SetFullState.................................................................................. 817
SetHTMLAction ............................................................................ 819
SetHTMLObjectName .................................................................. 820
SetItem......................................................................................... 821
SetItemDate ................................................................................. 824
SetItemDateTime ......................................................................... 825
SetItemNumber ............................................................................ 826
SetItemStatus............................................................................... 827
SetItemString ............................................................................... 831
SetItemTime................................................................................. 832
SetPageSize ................................................................................ 833
SetPosition ................................................................................... 834
DataWindow Reference xiii

Contents
SetRedraw ................................................................................... 835

SetRichTextAlign.......................................................................... 836
SetRichTextColor ......................................................................... 837
SetRichTextFaceName ................................................................ 838
SetRichTextSize........................................................................... 839
SetRichTextStyle.......................................................................... 840
SetRow......................................................................................... 841
SetRowFocusIndicator ................................................................. 842
SetSelfLink ................................................................................... 843
SetServerServiceClasses ............................................................ 846
SetServerSideState...................................................................... 848
SetSort ......................................................................................... 850
SetSQLPreview............................................................................ 852
SetSQLSelect............................................................................... 853
SetTabOrder ................................................................................ 855
SetText......................................................................................... 856
SetTrans....................................................................................... 858
SetTransObject ............................................................................ 860
SetValidate................................................................................... 864
SetValue....................................................................................... 866
SetWeight..................................................................................... 867
SetWSObject................................................................................ 870
ShareData .................................................................................... 871
ShareDataOff ............................................................................... 875
Show ............................................................................................ 876
ShowHeadFoot ............................................................................ 877
Sort............................................................................................... 878
TextLine ....................................................................................... 880
TriggerEvent................................................................................. 881
TypeOf ......................................................................................... 882
Undo............................................................................................. 882
Update.......................................................................................... 883
CHAPTER 10 Methods for Graphs in the DataWindow Control...................... 917

CategoryCount ............................................................................. 917
CategoryName ............................................................................. 918
Clipboard...................................................................................... 918
DataCount .................................................................................... 919
FindCategory................................................................................ 920
FindSeries .................................................................................... 921
GetData........................................................................................ 921
GetDataDateVariable ................................................................... 923
GetDataLabelling ......................................................................... 924
GetDataNumberVariable .............................................................. 925
xiv PowerBuilder
Contents
GetDataPieExplode...................................................................... 925
GetDataPieExplodePercentage ................................................... 927
GetDataStringVariable ................................................................. 927
GetDataStyle................................................................................ 928
GetDataStyleColorValue .............................................................. 934
GetDataStyleFillPattern................................................................ 934
GetDataStyleLineStyle ................................................................. 935
GetDataStyleLineWidth ................................................................ 936
GetDataStyleSymbolValue........................................................... 936
GetDataTransparency .................................................................. 937
GetDataValue............................................................................... 938
GetSeriesLabelling ....................................................................... 940
GetSeriesStyle ............................................................................. 941
GetSeriesStyleColorValue ........................................................... 947
GetSeriesStyleFillPattern ............................................................. 948
GetSeriesStyleLineStyle .............................................................. 949
GetSeriesStyleLineWidth ............................................................. 949
GetSeriesStyleOverlayValue........................................................ 950
GetSeriesStyleSymbolValue ........................................................ 951
GetSeriesTransparency ............................................................... 952
ObjectAtPointer ............................................................................ 953
ObjectAtPointerDataPoint ............................................................ 954
ObjectAtPointerSeries .................................................................. 954
Reset ............................................................................................ 955
ResetDataColors .......................................................................... 956
SaveAs......................................................................................... 957
SeriesCount ................................................................................. 958
SeriesName ................................................................................. 959
SetDataLabelling.......................................................................... 960
SetDataPieExplode ...................................................................... 961
SetDataStyle ................................................................................ 962
SetDataTransparency .................................................................. 967
SetSeriesLabelling ....................................................................... 968
SetSeriesStyle.............................................................................. 970
SetSeriesTransparency................................................................ 976
DataWindow Reference xv
Contents
xvi PowerBuilder
About This Book
Subject This book provides reference information for the DataWindow® object. It
lists the DataWindow functions and properties and includes the syntax for
accessing properties and data.
Audience This book is for anyone defining DataWindow objects and writing scripts
that deal with DataWindow objects. It assumes that:
• You are familiar with the DataWindow painter. If not, see the
PowerBuilder Users Guide.
• You have a basic familiarity with PowerScript®. If not, see the
PowerScript Reference.
Related documents For a complete list of PowerBuilder® documentation, see the preface of
PowerBuilder Getting Started.
Other sources of Use the Appeon Product Manuals web site to learn more about your
information product. The Appeon Product Manuals web site is accessible using a
standard Web browser.
To access the Appeon Product Manuals web site, go to Product Manuals at
https://www.appeon.com/developers/library/product-manuals-for-pb.
The installation guide in PDF format can be accessed from the

PowerBuilder installation package. The release bulletin can be access
from Online Help at
https://www.appeon.com/support/documents/appeon_online_help/pb2017/r
elease_bulletin_for_pb.
Conventions The formatting conventions used in this manual are:
Formatting example Indicates
Retrieve and Update When used in descriptive text, this font indicates:
• Command, function, and method names
• Keywords such as true and false
DataWindow Reference xvii

Formatting example Indicates
variable or file name When used in descriptive text and syntax
descriptions, oblique font indicates:
• Variables, such as myCounter
• Parts of input text that must be substituted, such
as pblname.pbd
• File and path names
File>Save Menu names and menu items are displayed in plain
text. The greater than symbol (>) shows you how
to navigate menu selections. For example,
File>Save indicates “select Save from the File
menu.”
dw_1.Update() Monospace font indicates:
• Information that you enter in a dialog box or on
a command line
• Sample script fragments
• Sample output fragments
If you need help All customers are entitled to standard technical support for reproducible
software defects. You can open a standard support ticket at the Appeon
support site: https://www.appeon.com/standardsupport/ (login required).
If your organization has purchased a premium support contract for this product,
then the designated authorized support contact(s) may seek assistance with
your technical issue or question at the Appeon support site:
https://support.appeon.com (login required).
xviii PowerBuilder
C H A P T E R 1 DataWindow Operators and
Expressions
About this chapter You use an expression to request that a DataWindow object perform a
computational operation. This chapter explains how expressions work and
how to write them.
Contents
Topic Page
Where you use DataWindow expressions 1
Operators used in DataWindow expressions 4
Operator precedence in DataWindow expressions 11
Evaluating DataWindow expressions in scripts 12
Evaluating DataWindow expressions in the Describe function 13
Evaluating conditional DataWindow expressions with current data 14
Where you use DataWindow expressions

A DataWindow expression is a combination of data, operators, and
functions that, when evaluated, results in a value. An expression can
include column names, operators, DataWindow expression functions, and
constants such as numbers and text strings.
In painters DataWindow expressions are associated with DataWindow objects and
reports. You specify them in the DataWindow painter. You can also
specify expressions in the Database painter, although these expressions
have a slightly different format and are used only in validation rules.
For information about DataWindow expression functions that you can use
in expressions, see Using DataWindow expression functions on page 17,
or look up the function you want in online help.
In painters, you use expressions in these ways:
DataWindow Reference 1
Where you use DataWindow expressions
Table 1-1: Using DataWindow expressions in painters

In this painter Expressions are used in
DataWindow painter Computed fields
Conditional expressions for property values
Validation rules
Filters
Sorting
Series and values in graphs
Columns, rows, and values in crosstabs
Database painter Validation rules
Other types of expressions you use

You also use expressions in Quick Select, SQL Select, and the Query painter
to specify selection criteria, and in SQL Select and the Query painter to create
computed columns. In these painters you are using SQL operators and
DBMS-specific functions, not DataWindow expression operators and
functions, to create expressions.
You can access and change the value of DataWindow data and properties in
code. The format for expressions you specify in code is different from the same
expression specified in the painter. These differences are described in Chapter
4, Accessing Data in Code and Chapter 5, Accessing DataWindow Object
Properties in Code.
Some of the specific places where you use expressions are described here.
In computed fields Expressions for computed fields can evaluate to any value. The datatype of the
expression becomes the datatype of the computed field:
Table 1-2: Using expressions in computed fields
Expression Description
Today ( ) Displays the date using the Today function
Salary/12 Computes the monthly salary
Sum (Salary for group 1) Computes the salary for the first group using the Sum
aggregate function
Price*Quantity Computes the total cost
Expressions for graphs and crosstabs

You can use similar expressions for series and values in graphs and for
columns, rows, and values in crosstabs.
2 PowerBuilder
CHAPTER 1 DataWindow Operators and Expressions
In filters Filter expressions are boolean expressions that must evaluate to true or false:
Table 1-3: Using expressions with filters
Expression Description
Academics = "*****" AND Displays data only for colleges with both a 5-star
Cost = "$$$" academic rating and a $$$ cost rating
Emp_sal < 50000 Displays data for employees with salaries less
than $50,000
Salary > 50000 AND Dept_id Displays data for employees in departments 400,
BETWEEN 400 AND 700 500, 600, and 700 with salaries greater than
$50,000
Month(Bdate) = 9 OR Displays data for people with birth dates in
Month(Bdate) = 2 September or February
Match ( Lname, "[ ÂBC ]" ) Displays data for people whose last name begins
with A, B, or C
In validation rules for Validation rules are boolean expressions that compare column data with values
table columns and that use relational and logical operators. When the validation rule evaluates
to false, the data in the column is rejected.
In the DataWindow painter When you specify a validation rule in the
DataWindow painter, you should validate the newly entered value. To refer to
the newly entered value, use the GetText function. Because GetText returns a
string, you also need a data conversion function (such as Integer or Real) if you
compare the value to other types of data.
If you include the column name in the expression, you get the value that
already exists for the column instead of the newly entered value that needs
validating.
In the Database painter When you specify the validation rule in the
Database painter, you are defining a general rule that can be applied to any
column. Use @placeholder to stand for the newly entered value. The name
you use for @placeholder is irrelevant. You can assign the rule to any column
that has a datatype appropriate for the comparison.
When you define a DataWindow object, a validation rule assigned to a column
is brought into the DataWindow object and converted to DataWindow object
syntax. @placeholder is converted to GetText and the appropriate datatype
conversion function.
Other columns in the rule You can refer to values in other columns for the
current row by specifying their names in the validation rule:
Operators used in DataWindow expressions
Table 1-4: Using expressions with values from other columns

Expression in Expression in
Database painter DataWindow painter Description
@column >= 10000 Integer(GetText())>= If a user enters a salary below
10000 $10,000, an error message
displays.
@column IN (100, Integer(GetText()) IN If a user does not enter a
200, 300) (100, 200, 300) department ID of 100, 200, or
300, an error message displays.
@salary > 0 Long(GetText()) > 0 If a user does not enter a positive
number, an error message
displays.
Match(@disc_price, Match(GetText( ), If a user enters any characters
"^[0-9]+$") and "^[0-9]+$") and other than digits, or the resulting
@disc_price < Real(GetText()) < number is greater than or equal
Full_Price Full_Price to the value in the Full_Price
column, an error message
displays.

An operator is a symbol or word in an expression that performs an arithmetic
calculation or logical operation; compares numbers, text, or values; or
manipulates text strings.
Four types of operators are available:
• Arithmetic for numeric datatypes. See Arithmetic operators in
DataWindow expressions on page 5.
• Relational for all datatypes. See Relational operators in DataWindow
expressions on page 5.
• Logical for all datatypes. See Logical operators in DataWindow
• Concatenation for string datatypes. See Concatenation operator in
DataWindow expressions on page 10.
4 PowerBuilder
Arithmetic operators in DataWindow expressions

When you write an expression, you can use the following arithmetic operators:
Table 1-5: Using expressions with arithmetic operators
Operator Meaning Example
+ Addition SubTotal + Tax
- Subtraction Price - Discount
* Multiplication Quantity * Price
/ Division Discount / Price
^ Exponentiation Rating ^ 2.5
Multiplication and Multiplication and division are carried out to full precision (16–18 digits).
division Values are rounded:
Table 1-6: Value rounding in DataWindow expressions
Expression Value
20.0/3 6.666666666666667
3*(20.0/3) 20
Truncate(20.0/3,4) 6.6666
Calculations with null When you form an arithmetic expression that contains a null value, the
expression becomes null. Thinking of null as undefined makes this easier to
understand. For example, when a null column is multiplied by 5, the entire
expression also evaluates to null. Use the IsNull function to explicitly check for
the null value.
Boolean expressions that contain a null value evaluate to false rather than to
null. For more information, see Relational operators in DataWindow
expressions next.
Relational operators in DataWindow expressions

You use relational operators to compare a value with other values. The result is
a boolean expression whose value is always true or false.
Since the result of a boolean expression is always true or false, a relational
operator that compares a value to null evaluates to false. For example, the
expression “column > 5” evaluates to false (and “NOT column > 5” evaluates
to true) when the column value is null.
When you write an expression, you can use the following relational operators
(more information about LIKE, IN, and BETWEEN follows the table):
Table 1-7: Using expressions with relational operators

= Is equal to Price = 100
> Is greater than Price > 100
< Is less than Price < 100
<> Is not equal to Price <> 100
>= Greater than or equal to Price >= 100
<= Less than or equal to Price <= 100
NOT = Is not equal to Price NOT= 100
LIKE Matches this specified Emp_lname LIKE 'C%' OR
pattern. Emp_lname LIKE 'G%'
IN Is in this set of values. Dept_id IN (100, 200, 500)
BETWEEN Is within this range of Price BETWEEN 1000 AND
values. The range includes 3000
the first and last values.
NOT LIKE Does not match this Emp_lname NOT LIKE 'C%'
specified pattern. AND Emp_lname NOT LIKE
'G%'
NOT IN Is not in this set of values. Dept_id NOT IN (100, 200, 500)
NOT BETWEEN Is outside this range of Price NOT BETWEEN 1000
values. The range includes AND 2000
the first and last values.
Special characters for You can use the following special characters with relational operators that take
operations with strings string values:
Table 1-8: Special characters for use in expressions with relational
operators
Special character Meaning Example
% (percent) Matches any group of Good% matches all names that
characters. begin with Good.
_ (underscore) Matches any single Good _ _ _ matches all 7-letter
character. names that begin with Good.
LIKE and NOT LIKE Use LIKE to search for strings that match a predetermined pattern. Use NOT
operators LIKE to search for strings that do not match a predetermined pattern. When
you use LIKE or NOT LIKE, you can use the % or _ characters to match
unknown characters in a pattern.
For example, the following expression for the Background.Color property of
the Salary column displays salaries in red for employees with last names
beginning with F and displays all other salaries in white:
6 PowerBuilder
If(emp_lname LIKE'F%',RGB(255,0,0),RGB(255,255,255))
Escape keyword If you need to use the % or _ characters as part of the string, you can use the
escape keyword to indicate that the character is part of the string. For example,
the _ character in the following filter string is part of the string to be searched
for, but is treated as a wildcard:
comment LIKE ~'%o_a15progress%~'
The escape keyword designates any character as an escape character (do not
use a character that is part of the string you want to match). In the following
example, the asterisk (*) character is inserted before the _ character and
designated as an escape character, so that the _ character is treated as part of
the string to be matched:
comment like ~'%o*_a15progress%~' escape ~'*~'
BETWEEN and NOT Use BETWEEN to check if a value is within a range of values. Use NOT
BETWEEN operators BETWEEN to check if a value is not in a range of values. The range of values
includes the boundary values that specify the range.
the Salary column displays salaries in red when an employee’s salary is
between $50,000 and $100,000 and displays all other salaries in white:
If(salary BETWEEN 50000 AND 100000, RGB(255,0,0),
RGB(255,255,255))
You can use the BETWEEN and NOT BETWEEN operators with string
values. For example, if the following expression is used for the Visual property
of a column, column values display only for departments listed alphabetically
between Finance and Sales:
If(dept_name BETWEEN 'Finance' AND 'Sales',1,0)
The % or _ characters can be used when you are using string values with the
BETWEEN and NOT BETWEEN operators. This example might include
more department listings than the previous example:
If(dept_name BETWEEN 'F%' AND 'S%',1,0)
You can also use the BETWEEN and NOT BETWEEN operators with
methods. For example:
GetRow( ) BETWEEN 5 AND 8
IN and NOT IN Use IN to check if a value is in a set of values. Use NOT IN to check if a value
operators is not in a set of values.

the Salary column displays salaries in red for employees in department 300 or
400 having a salary between $50,000 and $100,000, and displays all other
salaries in white:
If(dept_id IN (300,400) and salary BETWEEN 50000 AND
100000, RGB(255,0,0), RGB(255,255,255))
Comparing strings in DataWindow expressions

When you compare strings, the comparison is case-sensitive. Leading blanks
are significant, but trailing blanks are not.
Case-sensitivity Assume City1 is “Austin” and City2 is “AUSTIN”. Then:
examples
City1=City2
returns false.
To compare strings regardless of case, use the Upper or Lower function. For
example:
Upper(City1)=Upper(City2)
returns true.
For information about these functions, see Using DataWindow expression
functions on page 17.
Blanks examples Assume City1 is "Austin" and City2 is " Austin ". Then the expression:
City1=City2
returns false. PowerBuilder removes the trailing blank before making the
comparison, but it does not remove the leading blank.
To prevent leading blanks from affecting a comparison, remove them with one
of the trim functions: Trim or LeftTrim.
For example:
Trim(City1)=Trim(City2)
returns true.
To compare strings when trailing blanks are significant, use an expression such
as the following to ensure that any trailing blanks are included in the
comparison:
City1 + ">" = City2 + ">"
8 PowerBuilder
For information about these functions, see Using DataWindow expression

Logical operators in DataWindow expressions

You use logical operators to combine boolean expressions into a larger boolean
expression. The result is always true or false:
Table 1-9: Using expressions with logical operators
NOT Logical negation. NOT Price = 100
If A is true, NOT A is false. If A is false,
NOT A is true.
AND Logical and. Tax > 3 AND Ship < 5
A AND B is true if both are true. A AND B
is false if either is false.
OR Logical or. Tax > 3 OR Ship < 5
A OR B is true if either is true or both are
true. A OR B is false only if both are false.
When you combine two or more boolean expressions to form a new expression,
the new expression is either true or false. The following truth table shows how
true and false expressions are evaluated to form an expression that is either true
or false.
For example, if “My dog has fleas” is true and “My hair is brown” is false, then
“My dog has fleas OR my hair is brown” is true, and “My dog has fleas AND
my hair is brown” is false:
Table 1-10: Combining expressions with logical operators

And the And if another The resulting
If one expression logical expression has expression has
has this value operator is this value this value
TRUE AND TRUE TRUE
TRUE AND FALSE FALSE
FALSE AND TRUE FALSE
FALSE AND FALSE FALSE
TRUE OR TRUE TRUE
TRUE OR FALSE TRUE
FALSE OR TRUE TRUE
FALSE OR FALSE FALSE
NOT TRUE AND TRUE FALSE
NOT TRUE AND FALSE FALSE
NOT FALSE AND TRUE TRUE
NOT FALSE AND FALSE FALSE
NOT TRUE OR TRUE TRUE
NOT TRUE OR FALSE FALSE
NOT FALSE OR TRUE TRUE
NOT FALSE OR FALSE TRUE
If you use a logical operator with a boolean function that returns null, the term
with the null return value is evaluated as false. If you use the NOT logical
operator with a boolean function that returns null, the complete term evaluates
to true. For example, NOT gf_boolean () evaluates to true when gf_boolean
returns null.
Concatenation operator in DataWindow expressions

The concatenation operator joins the contents of two variables of the same type
to form a longer value. You can concatenate strings and blobs.
To concatenate values, you use the plus sign (+) operator.
10 PowerBuilder
Table 1-11: Using expressions with concatenation operator

String expression Value
"over" + "stock" overstock
Lname + ', ' + Fname If Lname is Hill and Fname is Craig, then "Hill, Craig"
Using quotes
You can use either single or double quotes in string expressions. For example,
the expression "over" + "stock" is equivalent to the expression 'over' +
'stock'.
Operator precedence in DataWindow expressions

To ensure predictable results, operators in DataWindow expressions are
evaluated in a specific order of precedence. When operators have the same
precedence, they are evaluated from left to right.
The following table lists the operators in descending order of precedence:
Table 1-12: Operator precedence in DataWindow expressions
Operator Purpose
() Grouping
^ Exponentiation
*, / Multiplication and division
+, - Addition and subtraction; string concatenation
IN,LIKE,BETWEEN SQL SELECT statement conditions
=, >, <, <=, >=, <> Relational operators
AND,OR Logical and and logical or
NOT Logical negation
Overriding the Since expressions in parentheses are evaluated first, to override the precedence
precedence order order, enclose expressions in parentheses. You can also use parentheses to
clarify the order of evaluation. Within each set of parentheses, precedence
order applies.
In the expression x+y*a+b, y is first multiplied by a (because multiplication
has a higher precedence than addition). The result of the multiplication is then
added to x and this result is then added to b (because the + operators are
evaluated left to right).
Evaluating DataWindow expressions in scripts
To force evaluation in a different order, group expressions with parentheses.

For example, in the expression x+(y*(a+b)), a+b is evaluated first. The sum
a+b is then multiplied by y, and this product is added to x.
Evaluating DataWindow expressions in scripts

In a script, you use methods, properties, and data expressions for the
DataWindow control to get information about the state of the DataWindow: the
current row, the highlighted row, values of particular items. You can get other
information by accessing properties of the DataWindow object, either with the
Describe function or with property expressions.
For example, if you need to find the current row in a DataWindow, use the
DataWindow control function, GetRow:
ll_rownum = dw1.GetRow()
If you need to find the first row on the current page in a DataWindow, there is
no DataWindow control function to return this information, but you can find it
in the appropriate DataWindow object property:
ls_first = dw1.Object.DataWindow.FirstRowOnPage
ls_last = dw1.Object.DataWindow.LastRowOnPage
dw1.Title = "Rows " + ls_first + " to " + ls_last
In some cases, however, information you need might not be available either by
using DataWindow control functions or by accessing DataWindow object
properties.
DataWindow expression functions sometimes provide information that is
available in no other way. These functions, which are available within a
DataWindow expression, are documented in Using DataWindow expression
12 PowerBuilder
Evaluating DataWindow expressions in the Describe

function
The Describe function provides a way to evaluate DataWindow expressions
outside their usual context. The Evaluate function, which is used only within
Describe, allows you to evaluate DataWindow expressions within a script using
data in the DataWindow.
Evaluate has the following syntax:
dwcontrol.Describe ("Evaluate ( 'expression' , rownumber ) " )
Expression is the expression you want to evaluate and rownumber is the
number of the row for which you want to evaluate the expression. The
expression can include DataWindow expression functions that cannot be called
in a script.
This example displays in the title of the DataWindow control the current page
for the current row in the DataWindow:
string ls_modstring, ls_rownum
ls_rownum = String(dw1.GetRow())
ls_modstring = "Evaluate('Page()'," + ls_rownum +")"

// The resulting string, for row 99, would be:
// Evaluate('Page()', 99)
Parent.Title = &
"Current page: "+ dw1.Describe(ls_modstring)
This example returns the display value for the dept_id column for row 5:
dw1.Describe("Evaluate('LookUpDisplay(dept_id)', 5)")
Expressions that To evaluate an expression that applies to all rows, specify 0 for the rownumber
apply to all rows argument. This example calculates the sum of the salary column in the current
DataWindow. It will return the expression’s result or "!" if the expression is not
valid:
dw1.Describe("Evaluate('Sum(Salary)', 0)")
Evaluating user- In some types of applications, you might use Evaluate to get the result of an
specified expressions expression the user specifies. For example, users might specify the type of
aggregation they want to see. This example evaluates an expression specified
in a SingleLineEdit. It applies to all rows:
dw1.Describe("Evaluate('" + sle_expr.Text + "', 0)")
Evaluating conditional DataWindow expressions with current data
Evaluating conditional DataWindow expressions with

current data
Querying a property Values for column properties normally apply to all the rows in the column. For
for a column example, if you set the Protect property to “1” for the Emp_Id column, the user
will be unable to modify Emp_Id for any of the rows. If you query the property
value for this column at runtime, it will return “1”.
When the column has Instead of a constant, you can assign a conditional expression to some column
a conditional properties. Such properties are set on a row-by-row basis at runtime.
expression
For example, you might wish to allow users to enter an employee id for new
rows but protect this value for existing rows. The conditional expression for
this column’s Protect property would be:
If(IsRowNew(), 0, 1)
When you query the Protect property at runtime, the result in this case would
be the actual expression (preceded by a default value and a tab character and
enclosed in quotes) instead of the property value. The value for the Protect
property would be:
"0 <tab> If(IsRowNew(), 0, 1)"
Getting a property To obtain the actual value of the Protect property for a particular row, you need
value for a particular to strip off the default value and the tab and evaluate the returned expression
row
for the desired row. After stripping off the extra information, you can construct
an expression for Describe that uses the Evaluate function.
This example checks whether the value of the Protect property for emp_id is a
constant or a conditional expression. If it is a conditional expression, the script
builds a string for the Describe function that uses Evaluate to get the value for
of Protect for the current row:
string ls_protect, ls_eval
long ll_row
ll_row = dw1.GetRow()
ls_protect = dw1.Object.id.Protect
IF NOT IsNumber(ls_protect) THEN
// Get the expression following the tab (~t)

ls_protect = Right(ls_protect, &
Len(ls_protect) - Pos(ls_protect, "~t"))
14 PowerBuilder
// Build string for Describe. Include a leading

// quote to match the trailing quote that remains
ls_eval = "Evaluate(~"" + ls_protect + ", " &
+ String(ll_row) + ")"
ls_protect = dw1.Describe(ls_eval)
END IF
// Display result
st_result.Text = ls_protect
Evaluating conditional DataWindow expressions with current data
16 PowerBuilder
C H A P T E R 2 DataWindow Expression
Functions
About this chapter This chapter provides syntax, descriptions, and examples of the functions
you can use in expressions in the DataWindow painter.
Contents
Topic Page
Using DataWindow expression functions 17
Decimal support in DataWindow expressions 19
Four examples 20
Alphabetical list of DataWindow expression functions 29
Using DataWindow expression functions

In the DataWindow painter, you can use DataWindow expression
functions in expressions for computed fields, filters, validation rules, and
graphed data, with some exceptions.
The dialog boxes in which you define expressions include a list box that
lists the available functions and their arguments. The dialog boxes make
it easy to insert a function into the expression.
For information about expressions, see Chapter 1, DataWindow
Operators and Expressions.
Return values for functions DataWindow expression functions can return the following datatypes:
and expressions
Double
Decimal
String
DateTime
Time
Within an expression, a function can return other datatypes (such as
boolean, date, or integer), but the final value of an expression is converted
to one of these datatypes.
Using DataWindow expression functions
Restrictions for An aggregate function is a function (such as Avg, Max, StDev, and Sum) that
aggregate functions operates on a range of values in a column. When you use an aggregate function,
some restrictions apply. You cannot use an aggregate function:
• In a filter
• In a validation rule
• As an argument for another aggregate function
When you use aggregate functions, they cancel the effect of setting Retrieve
Rows As Needed. To do the aggregation, the DataWindow object always
retrieves all rows.
User-defined functions You can include user-defined functions in DataWindow expressions. The
in PowerBuilder datatype of the function’s return value can be any of the following: double,
decimal, string, boolean, date, DateTime, or time. The function must be
defined as a global function so that it is available to the DataWindow object.
However, a global function argument of datatype boolean cannot be provided
by a DataWindow expression because it does not map to any of the datatypes
listed in Return values for functions and expressions on page 17.
Built-in DataWindow expression functions cannot be overridden. For example,
if you create a global function called Today, it is used instead of the
PowerScript system function Today, but it is not used instead of the
DataWindow expression function Today.
Formatting for the No matter what country you are creating objects and developing an application
locally correct display in, you must use U.S. number notation in numbers or number masks in display
of numbers
formats, edit masks, and DataWindow expressions. This means that when you
specify a number or number mask, use a comma as the thousands delimiter and
period for the decimal place.
Numbers display appropriately in whatever countries you deploy applications
in. At runtime, the locally correct symbols for numbers display (because the
international Control Panel settings are used) when numbers are interpreted.
For example, in countries where comma represents the decimal place and
period represents thousands, users see numbers in those formats at runtime.
For information about the locally correct display of dates and day names, see
String on page 142 and DayName on page 63.
18 PowerBuilder
CHAPTER 2 DataWindow Expression Functions
Decimal support in DataWindow expressions

Description PowerBuilder provides a variety of ways to work with decimal values in
DataWindow expressions.
Usage The following arithmetic operators now return a decimal value if both operands
have a datatype of decimal:
Table 2-1: Columns in the Fin_code table
+ Addition Subtotal + Tax
- Subtraction Price - Discount
* Multiplication Quantity*Price
/ Quantity*Price Quantity*Price
If either operand is not a decimal, the returned value is converted to a double

datatype. The exponentiation operator (^) returns a double
Relational operators that operate on numeric values, including =, >, <, <>, >=,
and <=, can take decimal operands. The precision of the decimal operand is
maintained in comparisons.
The following functions return a decimal datatype if their arguments are
decimals: Sum, CumulativeSum, Avg, Median, Count, First, Last, Max, Min,
Large, Small, Var, VarP, Mod, Mode, Abs, Case, If.
The following functions return a decimal result instead of a double:

CrosstabAvgDec, CrosstabMaxDec, CrosstabMinDec, and CrosstabSumDec.
The Dec function converts a constant string to a decimal.

The Specify Retrieval Arguments dialog box includes the Decimal and
Decimal array types.
See also Dec
Four examples
Four examples
The following topics provide examples that illustrate using DataWindow
expression functions.
Example 1: counting null values in a column

A null value is a marker used to fill a place in a column where data is missing
for any reason. The value might not be applicable, or it might be missing or
unknown. When a database table is created, each column in the table either
allows null values or does not allow them. The column or set of columns that
define the primary key cannot allow null values. Sometimes it is useful to know
how many null values there are in a particular column.
What you want to do Suppose you are working with the Fin_code table in the Enterprise Application
Sample Database. The Fin_code table has three columns:
Table 2-2: Columns in the Fin_code table
Allows null
Column What the column is values?
Code Unique financial identifier (primary key) No
Type Code type: expense or revenue No
Description Code description: the department incurring Yes
the expense or getting the revenue
You create a DataWindow object using the Code and Description columns. You
want to know the number of null values in the Description column.
How to do it In the DataWindow object, you create a computed field that uses functions to
display the number of null values in the Description column.
For the sake of demonstrating the use of functions, the following computed
fields are created in the Summary band of the DataWindow object (with text
objects that tell you what information each computed field is providing):
Count(description for all)
counts the number of descriptions (that are not null);
Sum(If(IsNull(description), 1, 0))
returns a 1 if the description column is null, a 0 if the description column is not
null, and then adds the total;
Count(id for all)
20 PowerBuilder
counts the number of IDs (which is also the number of rows);

Sum(If(IsNull(description), 1, 1))
adds the number of nulls and not nulls in the description column (which is the
total number of rows) and should match the result of the
Count( id for all ) function; and
IsNull(description)
evaluates whether the last row in the table has a description that is null. The
return value of the IsNull function is true or false.
What you get Here is the design for the DataWindow object.
Here is the DataWindow object showing eight descriptions, three of which are
null and five of which are not null. The last description for Id=8 is null.
Example 2: counting male and female employees

Example 1 demonstrates the use of the Sum and Count functions. Sum and
Count are two examples of a class of functions called aggregate functions.
Four examples
An aggregate function is a function that operates on a range of values in a

column. The aggregate functions are:
Avg Large Mode Sum
Count Last Percent Var
CumulativePercent Max Small VarP
CumulativeSum Median StDev
First Min StDevP
About crosstab functions

Although the crosstab functions (CrosstabAvg, CrosstabAvgDec,
CrosstabCount, CrosstabMax, CrosstabMaxDec, CrosstabMin, CrosstabMinDec,
CrosstabSum, and CrosstabSumDec) behave like aggregate functions, they are
not included on the list because they are for crosstabs only and are designed to
work in the crosstab matrix.
A few restrictions apply to the use of aggregate functions. You cannot use an
aggregate function:
• In a filter
• In a validation rule
• As an argument for another aggregate function
This example demonstrates the use of the Sum aggregate function.
What you want to do Using the employee table in the PB Demo DB as the data source, you create a
DataWindow object using at least the Emp_id and the Sex columns. You want
the DataWindow object to display the number of male employees and female
employees in the company.
How to do it In the summary band in the workspace, add two computed fields to the
DataWindow object that use the Sum and If functions:
Sum(If(sex = "M", 1, 0))
counts the number of males in your company;
Sum(If(sex = "F", 1, 0))
counts the number of females in your company.
By clicking the Page computed field button, you can also add a Page computed
field in the footer band to display the page number and total pages at the bottom
of each page of the DataWindow object.
22 PowerBuilder
What you get Here is what the design of the DataWindow object looks like.
Here is the last page of the DataWindow object, with the total number of males
and females in the company displayed.
If you want more What if you decide that you also want to know the number of males and
information females in each department in the company?
 To display the males and females in each department:

1 Select Design>Data Source from the menu bar so that you can edit the data
source.
2 Select Design>Select tables from the menu bar and open the Department
table in the Select painter workspace, which currently displays the
Employee table with the Emp_id and Sex columns selected.
3 Select the department_dept_name column to add it to your data source.
4 Select Rows>Create Group from the menu bar to create a group and group
by department name.
5 In the trailer group band, add two additional computed fields:
Sum(If(sex = "M", 1, 0) for group 1)
Four examples
counts the number of males in each department;

Sum(If(sex = "F", 1, 0) for group 1)
counts the number of females in each department.
Here is what the design of the grouped DataWindow object looks like.
Here is the last page of the DataWindow object with the number of males and
females in the shipping department displayed, followed by the total number of
males and females in the company.
24 PowerBuilder
Example 3: creating a row indicator

This example demonstrates the use of several functions: Bitmap, Case,
CurrentRow, GetRow, and RGB.
What you want to do Using the Employee table in the Enterprise Application Sample Database, you
create a DataWindow object using the Emp_id, Emp_fname, Emp_lname, and
Salary columns.
In the painter, you want to display a number of items such as the number of the
current row, an arrow that is an indicator of the current row, and the salary for
an employee with a background color that depends on what the salary is.
How to do it In the workspace, add the following:
• A computed field CurrentRow( ), which displays the number of the current
row.
• A picture object, which is a right-arrow, for which you define an
expression for the arrow’s visible property:
If(CurrentRow()= GetRow(), 1, 0)
The expression causes an arrow to display in the current row and no arrow
to display in other rows.
• A computed field using the If, CurrentRow, and GetRow functions:
If(CurrentRow() = GetRow(),"Current","Not current")
displays the word “Current” when the row is the current row and “Not
current” for all other rows.
• A computed field (typed on one line) using the Bitmap, CurrentRow, and
GetRow functions:
Bitmap(If(CurrentRow()= GetRow(),
"c:\sampl\ex\code\indicatr.bmp", " "))
displays an arrow bitmap for the current row and no bitmap for all other
rows.
• An expression for the Background.Color property of the salary column:
Case(salary WHEN IS >60000 THEN RGB(192,192,192)
WHEN IS >40000 THEN RGB(0,255,0) ELSE
RGB(255,255,255))
The expression causes a salary above $40,000 to display in green, a salary
above $60,000 to display in gray, and all other salaries to display in white.
Four examples
What you get Here is what the design of the DataWindow object looks like:
Here is what the data looks like with the second row current.
Notice that the number of the current row is 2; the first row and the third row
are "Not current" (and therefore display no bitmap); and the second row, which
is the current row, displays the arrow row indicator.
On your screen, the salary in the first row has a green background because it is
more than $40,000; the salary in the second row has a gray background because
it is more than $60,000; and the salary in the third row has a white background,
which matches the background of the DataWindow object.
Example 4: displaying all data when a column allows nulls

When you create an arithmetic expression that has a null value, the value of the
expression is null. This makes sense, since null means essentially undefined
and the expression is undefined, but sometimes this fact can interfere with what
you want to display.
26 PowerBuilder
What you want to do A table in your database has four columns: Id, Corporation, Address1, and
Address2. The Corporation, Address1, and Address2 columns allow null
values. Using this table as the data source, you create a DataWindow object
using the four columns. You now want the DataWindow object to display both
parts of the address, separated by a comma.
You create a computed field to concatenate Address1 and Address2 with a
comma separator. Here is the expression that defines the computed field:
address1 + ", " + address2
When you preview the DataWindow object, if either Address1 or Address2 is
null, no part of the address displays because the value of the expression is null.
To display a part of the address, you need to create a computed field that forces
evaluation even if Address2 is null. Note that Address2 is assumed to have data
only if Address1 has data for a particular row.
How to do it In the detail band, create a computed field that uses the If and IsNull functions:
If(IsNull(address1 + address2), address1, address1
+ ", " + address2)
The computed field says this: if the concatenation of the addresses is null
(because address2 is null), then display address1, and if it is not null, display
both parts of the address separated by a comma.
What you get Here is what the design of the DataWindow object looks like. It includes both
the computed field that does not work and the one that does.
Four examples
When you preview the DataWindow object, notice that the first computed field
displays null for ABC Corporation and XYZ Corporation. The second
computed field displays the first part of the address, which is not null.
28 PowerBuilder
Alphabetical list of DataWindow expression functions

The list of DataWindow expression functions follows in alphabetical order.
Abs
Description Calculates the absolute value of a number.
Syntax Abs ( n )
Argument Description
n The number for which you want the absolute value
Return value The datatype of n. Returns the absolute value of n.

Examples This expression counts all the product numbers where the absolute value of the
product number is distinct:
Count(product_number for All DISTINCT Abs
(product_number))
Only data with an absolute value greater than 5 passes this validation rule:
Abs(value_set) > 5
See also Count
Abs in the PowerScript Reference
ACos
Description Calculates the arc cosine of an angle.
Syntax ACos ( n )
n The ratio of the lengths of two sides of a triangle for which
you want a corresponding angle (in radians). The ratio must
be a value between -1 and 1.
Return value Double. Returns the arc cosine of n if it succeeds.

Examples This expression returns 0:
Asc
ACos(1)
This expression returns 3.141593 (rounded to six places):
ACos(-1)
ACos(.540302)
See also Cos
ASin
ATan
ACos in the PowerScript Reference
Asc
Description Converts the first character of a string to its Unicode code point. A Unicode
code point is the numerical integer value given to a Unicode character.
Syntax Asc ( string )
string The string for which you want the code point value of the first
character
Return value Unsigned integer. Returns the code point value of the first character in string.
Usage Use Asc to test the case of a character or manipulate text and letters.
To find out the case of a character, you can check whether its code point value
is within the appropriate range.
Examples This expression for a computed field returns the string in code_id if the code
point value of the first character in code_id is A (65):
If (Asc(code_id) = 65, code_id, "Not a valid code")
This expression for a computed field checks the case of the first character of
lname and if it is lowercase, makes it uppercase:
IF (Asc(lname) > 64 AND Asc(lname) < 91, lname,
WordCap(lname))
See also Char
WordCap
Asc in the PowerScript Reference
30 PowerBuilder
AscA
Description Converts the first character of a string to its ASCII integer value.
Syntax AscA ( string )
string The string for which you want the ASCII value of the first character
Return value Integer. Returns the ASCII value of the first character in string.
Usage Use AscA to test the case of a character or manipulate text and letters.
To find out the case of a character, you can check whether its ASCII value is
within the appropriate range.
Examples This expression for a computed field returns the string in code_id if the ASCII
value of the first character in code_id is A (65):
If (AscA(code_id) = 65, code_id, "Not a valid code")
This expression for a computed field checks the case of the first character of
lname and if it is lowercase, makes it uppercase:
IF (AscA(lname) > 64 AND AscA(lname) < 91, lname,
WordCap(lname))
See also CharA
WordCap
AscA in the PowerScript Reference
ASin
Description Calculates the arc sine of an angle.
Syntax ASin ( n )
n The ratio of the lengths of two sides of a triangle for which you want
a corresponding angle (in radians). The ratio must be a value
between -1 and 1.
Return value Double. Returns the arc sine of n if it succeeds.

Examples This expression returns .999998 (rounded to six places):
ASin(.84147)
ATan
This expression returns .520311 (rounded to six places):

ASin(LogTen (Pi (1)))
This expression returns 0:
ASin(0)
See also Sin
ACos
ATan
Pi
ASin in the PowerScript Reference
ATan
Description Calculates the arc tangent of an angle.
Syntax ATan ( n )
n The ratio of the lengths of two sides of a triangle for which you want
a corresponding angle (in radians)
Return value Double. Returns the arc tangent of n if it succeeds.

ATan(0)
This expression returns 1.000 (rounded to three places):
ATan(1.55741)
ATan(Pi(1))
See also Tan
ASin
ACos
ATan in the PowerScript Reference
32 PowerBuilder
Avg
Description Calculates the average of the values of the column.
Syntax Avg ( column { FOR range { DISTINCT { expres1 {, expres2 {, ... } } } } } )
column The column for which you want the average of the data values.
Column can be the column name or the column number preceded
by a pound sign (#). Column can also be an expression that includes
a reference to the column. The datatype of column must be numeric.
FOR range The data that will be included in the average. For most presentation
(optional) styles, values for range are:
• ALL – (Default) The average of all values in column.
• GROUP n – The average of values in column in the specified
group. Specify the keyword GROUP followed by the group
number: for example, GROUP 1.
• PAGE – The average of the values in column on a page.
For Crosstabs, specify CROSSTAB for range:
• CROSSTAB – (Crosstabs only) The average of all values in
column in the crosstab.
For Graph and OLE objects, specify one of the following:
• GRAPH – (Graphs only) The average of values in column in the
range specified for the Rows option.
• OBJECT – (OLE objects only) The average of values in column
in the range specified for the Rows option.
DISTINCT Causes Avg to consider only the distinct values in column when
(optional) calculating the average. For a value of column, the first row found
with the value is used and other rows that have the same value are
ignored.
expresn One or more expressions that you want to evaluate to determine
(optional) distinct rows. Expresn can be the name of a column, a function, or
an expression.
Return value The numeric datatype of the column. Returns the average of the values of the
rows in range.
Usage If you specify range, Avg returns the average value of column in range. If you
specify DISTINCT, Avg returns the average value of the distinct values in
column, or if you specify expresn, the average of column for each distinct value
of expresn.
Avg
For graphs and OLE objects, you do not select the range when you call the
function. The range has already been determined by the Rows setting on the
Data property page (the Range property), and the aggregation function uses
that range. Settings for Rows include the following:
• For the Graph or OLE presentation style, Rows is always All.
• For Graph controls, Rows can be All, Page, or Group.
• For OLE controls, Rows can be All, Current Row, Page, or Group. The
available choices depend on the layer the control occupies.
In calculating the average, null values are ignored.
Not in validation rules or filter expressions

You cannot use this or other aggregate functions in validation rules or filter
expressions.
Using an aggregate function cancels the effect of setting Retrieve Rows As

Needed in the painter. To do the aggregation, a DataWindow object always
retrieves all rows.
Examples This expression returns the average of the values in the column named salary:
Avg(salary)
This expression returns the average of the values in group 1 in the column
named salary:
Avg(salary for group 1)
This expression returns the average of the values in column 5 on the current
page:
Avg(#5 for page)
This computed field returns Above Average if the average salary for the page
is greater than the average salary:
If(Avg(salary for page) > Avg(salary), "Above Average",
" ")
This expression for a graph value sets the data to the average value of the
sale_price column:
Avg(sale_price)
This expression for a graph value sets the data value to the average value of the
sale_price column for the entire graph:
Avg(sale_price for graph)
34 PowerBuilder
Assuming a DataWindow object displays the order number, amount, and line
items for each order, this computed field returns the average of the order
amount for the distinct order numbers:
Avg(order_amt for all DISTINCT order_nbr)
See also Median
Mode
Bitmap
Description Displays the specified bitmap.
For computed fields only

You can use the Bitmap function only in a computed field.
Syntax Bitmap ( string )

string A column containing bitmap files, a string containing the name of
an image file (a BMP, GIF, JPEG, RLE, or WMF file), or an
expression that evaluates to a string containing the name of an
image file
Return value The special datatype bitmap, which cannot be used in any other function.
Usage Use Bitmap to dynamically display a bitmap in a computed field. When string
is a column containing bitmap files, a different bitmap can display for each
row.
Examples These examples are all expressions for a computed field.
This expression dynamically displays the bitmap file contained in the column
named employees:
Bitmap(employees)
If the employees column is column 3, this next expression gives the same result
as the expression above:
Bitmap(#3)
This expression displays the bitmap tools.bmp:
Bitmap("TOOLS.BMP")
Case
This expression tests the value in the column named password and then uses
the value to determine which bitmap to display:
Bitmap(If(password = "y", "yes.bmp", "no.bmp"))
See also Example 3: creating a row indicator on page 25
Case
Description Tests the values of a column or expression and returns values based on the
results of the test.
Syntax Case ( column WHEN value1 THEN result1 { WHEN value2 THEN result2
{ ... } } { ELSE resultelse } )
column The column or expression whose values you want to test. Column
can be the column name or the column number preceded by a pound
sign (#). Column can also be an expression that includes a reference
to the column. Column is compared to each valuen.
WHEN Introduces a value-result pair. At least one WHEN is required.
(optional)
valuen One or more values that you want to compare to values of column.
A value can be:
• A single value
• A list of values separated by commas (for example, 2, 4, 6, 8)
• A TO clause (for example, 1 TO 20)
• IS followed by a relational operator and comparison value (for
example, IS>5)
• Any combination of the above with an implied OR between
expressions (for example, 1,3,5,7,9,27 TO 33, IS>42)
THEN Introduces the result to be returned when column matches the
corresponding valuen.
resultn An expression whose value is returned by Case for the
corresponding valuen. All resultn values must have the same
datatype.
ELSE Specifies that for any values of column that do not match the values
(optional) of valuen already specified, Case returns resultelse.
resultelse An expression whose value is returned by Case when the value of
column does not match any WHEN valuen expression.
36 PowerBuilder
Return value The datatype of resultn. Returns the result you specify in resultn.
Usage If more than one WHEN clause matches column, Case returns the result of the
first matching one.
Examples This expression for the Background.Color property of a Salary column returns
values that represent red when an employee’s salary is greater than $70,000,
green when an employee’s salary is greater than $50,000, and blue otherwise:
Case(salary WHEN IS >70000 THEN RGB(255,0,0) WHEN IS
>50000 THEN RGB(0,255,0) ELSE RGB(0,0,255))
This expression for the Background.Color property of an employee Id column
returns red for Id 101, gray for Id 102, and black for all other Id numbers:
Case(emp_id WHEN 101 THEN 255 WHEN 102 THEN
RGB(100,100,100) ELSE 0)
This expression for the Format property of the Marital_status column returns
Single, Married, and Unknown based on the data value of the Marital_status
column for an employee:
Case(marital_status WHEN 'S'THEN 'Single' WHEN 'M' THEN
'Married' ELSE 'Unknown')
If
Ceiling
Description Retrieves the smallest whole number that is greater than or equal to a specified
limit.
Syntax Ceiling ( n )
n The number for which you want the smallest whole number that is
greater than or equal to it
Return value The datatype of n. Returns the smallest whole number that is greater than or
equal to n.
Examples These expressions both return -4:
Ceiling(-4.2)
Ceiling(-4.8)
Char
This expression for a computed field returns ERROR if the value in

discount_amt is greater than the smallest whole number that is greater than or
equal to discount_factor times price. Otherwise, it returns discount_amt:
If(discount_amt <= Ceiling(discount_factor * price),
String(discount_amt), "ERROR")
To pass this validation rule, the value in discount_amt must be less than or
equal to the smallest whole number that is greater than or equal to
discount_factor times price:
discount_amt <= Ceiling(discount_factor * price)
See also Int
Round
Truncate
Ceiling in the PowerScript Reference
Char
Description Converts an integer to a Unicode character.
Syntax Char ( n )
n The integer you want to convert to a character
Return value String. Returns the character whose code point value is n.
Examples This expression returns the escape character:
Char(27)
See also Asc
Char in the PowerScript Reference
CharA
Description Converts an integer to an ASCII character.
Syntax CharA ( n )
38 PowerBuilder
n The integer you want to convert to a character
Return value String. Returns the character whose ASCII value is n.

Examples This expression returns the escape character:
CharA(27)
See also AscA
CharA in the PowerScript Reference
Cos
Description Calculates the cosine of an angle.
Syntax Cos ( n )
n The angle (in radians) for which you want the cosine
Return value Double. Returns the cosine of n.

Cos(0)
This expression returns .540302:
Cos(1)
This expression returns -1:
Cos(Pi(1))
See also Pi
Sin
Tan
Cos in the PowerScript Reference
Count
Count
Description Calculates the total number of rows in the specified column.
Syntax Count ( column { FOR range { DISTINCT { expres1 {, expres2 {, ... } } } } } )
column The column for which you want the number of rows. Column can
be the column name or the column number preceded by a pound
to the column.
FOR range The data that will be included in the count. For most presentation
• ALL – (Default) The count of all rows in column.
• GROUP n – The count of rows in column in the specified group.
Specify the keyword GROUP followed by the group number: for
example, GROUP 1.
• PAGE – The count of the rows in column on a page.
• CROSSTAB – (Crosstabs only) The count of all rows in column
in the crosstab.
• GRAPH – (Graphs only) The count of values in column in the
• OBJECT – (OLE objects only) The count of values in column in
the range specified for the Rows option.
DISTINCT Causes Count to consider only the distinct values in column when
(optional) counting the rows. For a value of column, the first row found with
the value is used and other rows that have the same value are
ignored.
an expression.
Usage If you specify range, Count determines the number of rows in column in range.
If you specify DISTINCT, Count returns the number of the distinct rows
displayed in column, or if you specify expresn, the number of rows displayed
in column where the value of expresn is distinct.
that range.
40 PowerBuilder
Settings for Rows include the following:

Null values in the column are ignored and are not included in the count.

expressions.

retrieves all rows.
Examples This expression returns the number of rows in the column named emp_id that
are not null:
Count(emp_id)
This expression returns the number of rows in the column named emp_id of
group 1 that are not null:
Count(emp_id for group 1)
This expression returns the number of dept_ids that are distinct:
Count(dept_id for all DISTINCT)
This expression returns the number of regions with distinct products:
Count(region_id for all DISTINCT Lower(product_id))
This expression returns the number of rows in column 3 on the page that are
not null:
Count(#3 for page)
See also Example 1: counting null values in a column on page 20
CrosstabAvg
CrosstabAvg
Description Calculates the average of the values returned by an expression in the values list
of the crosstab. When the crosstab definition has more than one column,
CrosstabAvg can also calculate averages of the expression’s values for groups
of column values.
For crosstabs only

You can use this function only in a crosstab DataWindow object.
Syntax CrosstabAvg ( n {, column, groupvalue } )

n The number of the crosstab-values expression for which you want
the average of the returned values. The crosstab expression must be
numeric.
column The number of the crosstab column as it is listed in the Columns box
(optional) of the Crosstab Definition dialog box for which you want
intermediate calculations.
groupvalue A string whose value controls the grouping for the calculation.
(optional) Groupvalue is usually a value from another column in the crosstab.
To specify the current column value in a dynamic crosstab, rather
than a specific value, specify @ plus the column name as a quoted
string.
Return value Double. Returns the average of the crosstab values returned by expression n for
all the column values or, optionally, for a subset of column values. To return a
decimal datatype, use CrosstabAvgDec.
Usage This function is meaningful only for the average of the values of the expression
in a row in the crosstab. This means you can use it only in the detail band, not
in a header, trailer, or summary band.
Null values are ignored and are not included in the average.
How functions in a crosstab are used When a crosstab is generated from
your definition, the appropriate computed fields are automatically created
using the Crosstab functions. To understand the functions, consider a crosstab
with two columns (year and quarter), a row (product), and the values
expression Avg(amount for crosstab).
42 PowerBuilder
The Crosstab Definition dialog box looks like this.
When you define the crosstab described above, the painter automatically
creates the appropriate computed fields. A computed field named avg_amount
returns the average of the quarterly figures for each year. Its expression is:
CrosstabAvg(1, 2, "@year")
A second computed field named grand_avg_amount computes the average of
all the amounts in the row. Its expression is:
CrosstabAvg(1)
Other computed fields in the summary band use the Avg function to display the
average of the values in the amount column, the yearly averages, and the final
average.
The crosstab in the Design view looks like this.
CrosstabAvg
Each row in the crosstab (after adjusting the column widths) has cells for the
amounts in the quarters, a repeating cell for the yearly average, and a grand
average. The crosstab also displays averages of the amounts for all the financial
codes in the quarters in the summary band at the bottom.
What the function arguments mean When the crosstab definition has more
than one column, you can specify column qualifiers for any of the Crosstab
functions, so that the crosstab displays calculations for groups of column
values. As illustrated previously, when year and quarter are the columns in the
crosstab, the expression for the computed field is:
CrosstabAvg(1, 2, "@year")
The value 2 refers to the quarter column (the second column in the Crosstab
Definition dialog) and “@year” specifies grouping values from the year
column (meaning the function will average values for the quarters within each
year). The value 1 refers to the crosstab-values expression that will be
averaged. In the resulting crosstab, the computed field repeats in each row after
the cells for the quarters within each year.
Tips for defining crosstabs When you define a crosstab with more than one
column, the order of the columns in the Columns box of the Crosstab
Definition dialog box governs the way the columns are grouped. To end up
with the most effective expressions, make the column that contains the
grouping values (for example, year or department) the first column in the
Columns box and the column that contains the values to be grouped (for
example, quarter or employee) second.
44 PowerBuilder
To display calculations for groups of rows, define groups as you would for
other DataWindow presentation styles and define computed fields in the group
header or footer using noncrosstab aggregation functions, such as Avg, Sum, or
Max.
Reviewing the expressions

To review the expressions defined for the crosstab values, open the Crosstab
Definition dialog box (select Design>Crosstab from the menubar).
Examples The first two examples use the crosstab expressions shown below:
Count(emp_id for crosstab),Sum(salary for crosstab)
This expression for a computed field in the crosstab returns the average of the
employee counts (the first expression):
CrosstabAvg(1)
This expression for a computed field in the crosstab returns the average of the
salary totals (the second expression):
CrosstabAvg(2)
Consider a crosstab that has two columns (region and city) and the values
expression Avg(sales for crosstab). This expression for a computed field in the
detail band computes the average sales over all the cities in a region:
CrosstabAvg(1, 2, "@region")
This expression for another computed field in the same crosstab computes the
grand average over all the cities:
CrosstabAvg(1)
See also CrosstabAvgDec
CrosstabCount
CrosstabMax
CrosstabMin
CrosstabSum
CrosstabAvgDec
CrosstabAvgDec
Description Calculates the average of the values returned by an expression in the values list
of the crosstab and returns a result with the decimal datatype. When the
crosstab definition has more than one column, CrosstabAvgDec can also
calculate averages of the expression’s values for groups of column values.
For crosstabs only

Syntax CrosstabAvgDec ( n {, column, groupvalue } )

n The number of the crosstab-values expression for which you
want the average of the returned values. The crosstab
expression must be numeric.
column The number of the crosstab column as it is listed in the
(optional) Columns box of the Crosstab Definition dialog box for which
you want intermediate calculations.
(optional) Groupvalue is usually a value from another column in the
crosstab. To specify the current column value in a dynamic
crosstab, rather than a specific value, specify @ plus the
column name as a quoted string.
Return value Decimal. Returns the average of the crosstab values returned by expression n
for all the column values or, optionally, for a subset of column values.
Usage Use this function instead of CrosstabAvg when you want to return a decimal
datatype instead of a double datatype. For more information, see CrosstabAvg.
See also CrosstabMaxDec
CrosstabMinDec
CrosstabSumDec
46 PowerBuilder
CrosstabCount
Description Counts the number of values returned by an expression in the values list of the
crosstab. When the crosstab definition has more than one column,
CrosstabCount can also count the number of the expression’s values for groups
of column values.
For crosstabs only

Syntax CrosstabCount ( n {, column, groupvalue } )

the total number of returned values.
(optional) of the Crosstab Definition dialog for which you want intermediate
calculations.
string.
Return value Long. Returns the number of values returned by expression n for all the column
values or, optionally, for a subset of column values.
Usage This function is meaningful only for the count of the values of the expression
in a row in the crosstab. This means you can use it only in the detail band, not
in a header, trailer, or summary band.
Null values are ignored and are not included in the count.
For more information about restricting the calculation to groups of values when
the crosstab definition has more than one column, see Usage for CrosstabAvg.

Examples These examples all use the crosstab-values expressions shown below:
CrosstabMax
This expression for a computed field in the crosstab returns the count of the
CrosstabCount(1)
This expression for a computed field in the crosstab returns the count of the
CrosstabCount(2)
The next two examples use a crosstab with two columns (year and quarter), a
row (product), and the values expression Avg(sales for crosstab).
This expression for a computed field returns the count of the sales for each
year:
CrosstabCount(1, 2, "@year")
This expression for a computed field returns the count of all the sales in the
row:
CrosstabCount(1)
For an example illustrating how the painter automatically defines a crosstab by
creating computed fields using the Crosstab functions, see CrosstabAvg.
See also CrosstabAvg
CrosstabMax
CrosstabMin
CrosstabSum
CrosstabMax
Description Calculates the maximum value returned by an expression in the values list of
the crosstab. When the crosstab definition has more than one column,
CrosstabMax can also calculate the maximum of the expression’s values for
groups of column values.
For crosstabs only

48 PowerBuilder
Syntax CrosstabMax ( n {, column, groupvalue } )

the maximum returned value. The expression’s datatype must be
numeric.
string.
Return value Double. Returns the maximum value returned by expression n for all the
column values or, optionally, for a subset of column values. To return a decimal
datatype, use CrosstabMaxDec.
Usage This function is meaningful only for the maximum of the values of the
expression in a row in the crosstab. This means you can use it only in the detail
band, not in a header, trailer, or summary band.
Null values are ignored and are not included in the comparison.

This expression for a computed field in the crosstab returns the maximum of
the employee counts (the first expression):
CrosstabMax(1)
This expression for a computed field in the crosstab returns the maximum of
the salary totals (the second expression):
CrosstabMax(2)
row (product), and a values expression Avg(sales for crosstab).
CrosstabMaxDec
This expression for a computed field returns the largest of the quarterly average
sales for each year:
CrosstabMax(1, 2, "@year")
This expression for a computed field returns the maximum of all the average
sales in the row:
CrosstabMax(1)
CrosstabCount
CrosstabMaxDec
CrosstabMin
CrosstabSum
CrosstabMaxDec
Description Calculates the maximum value returned by an expression in the values list of
the crosstab and returns a result with the decimal datatype. When the crosstab
definition has more than one column, CrosstabMaxDec can also calculate the
maximum of the expression’s values for groups of column values.
For crosstabs only

Syntax CrosstabMaxDec ( n {, column, groupvalue } )

the maximum returned value. The expression’s datatype must be
numeric.
string.
50 PowerBuilder
Return value Decimal. Returns the maximum value returned by expression n for all the
column values or, optionally, for a subset of column values.
Usage Use this function instead of CrosstabMax when you want to return a decimal
datatype instead of a double datatype. For more information, see CrosstabMax.
CrosstabMinDec
CrosstabSumDec
CrosstabMin
Description Calculates the minimum value returned by an expression in the values list of
CrosstabMin can also calculate the minimum of the expression’s values for
groups of column values.
For crosstabs only

Syntax CrosstabMin ( n {, column, groupvalue } )

the minimum return value. The expression’s datatype must be
numeric.
string.
Return value Double. Returns the minimum value returned by expression n for all the
datatype, use CrosstabMinDec.
CrosstabMin
Usage This function is meaningful only for the minimum of the values of the
expression in a row in the crosstab. This means you can use it only in the detail
band, not in a header, trailer, or summary band.
Null values are ignored and are not included in the comparison.

This expression for a computed field in the crosstab returns the minimum of the
CrosstabMin(1)
This expression for a computed field in the crosstab returns the minimum of the
CrosstabMin(2)
This expression for a computed field returns the smallest of the quarterly
average sales for each year:
CrosstabMin(1, 2, "@year")
This expression for a computed field returns the minimum of all the average
sales in the row:
CrosstabMin(1)
creating computed fields using the crosstab functions, see CrosstabAvg.
CrosstabCount
CrosstabMax
CrosstabMinDec
CrosstabSum
52 PowerBuilder
CrosstabMinDec
Description Calculates the minimum value returned by an expression in the values list of
definition has more than one column, CrosstabMinDec can also calculate the
minimum of the expression’s values for groups of column values.
For crosstabs only

Syntax CrosstabMinDec ( n {, column, groupvalue } )

the minimum return value. The expression’s datatype must be
numeric.
string.
Return value Decimal. Returns the minimum value returned by expression n for all the
Usage Use this function instead of CrosstabMin when you want to return a decimal
datatype instead of a double datatype. For more information, see CrosstabMin.
CrosstabMaxDec
CrosstabSumDec
CrosstabSum
CrosstabSum
Description Calculates the sum of the values returned by an expression in the values list of
CrosstabSum can also calculate the sum of the expression’s values for groups
of column values.
For crosstabs only

Syntax CrosstabSum ( n {, column, groupvalue } )

the sum of the returned values. The expression’s datatype must be
numeric.
string.
Return value Double. Returns the total of the values returned by expression n for all the
datatype, use CrosstabSumDec.
Usage This function is meaningful only for the sum of the values of the expression in
a row in the crosstab. This means you can use it only in the detail band, not in
a header, trailer, or summary band.
Null values are ignored and are not included in the sum.

54 PowerBuilder
This expression for a computed field in the crosstab returns the sum of the
CrosstabSum(1)
This expression for a computed field in the crosstab returns the sum of the
CrosstabSum(2)
This expression for a computed field returns the sum of the quarterly average
sales for each year:
CrosstabSum(1, 2, "@year")
This expression for a computed field returns the sum of all the average sales in
the row:
CrosstabSum(1)
CrosstabCount
CrosstabMax
CrosstabMin
CrosstabSumDec
CrosstabSumDec
Description Calculates the sum of the values returned by an expression in the values list of
definition has more than one column, CrosstabSumDec can also calculate the
sum of the expression’s values for groups of column values.
For crosstabs only

Syntax CrosstabSumDec ( n {, column, groupvalue } )
CumulativePercent
the sum of the returned values. The expression’s datatype must be
numeric.
string.
Return value Decimal. Returns the total of the values returned by expression n for all the
Usage Use this function instead of CrosstabSum when you want to return a decimal
datatype instead of a double datatype. For more information, see CrosstabSum.
CrosstabMaxDec
CrosstabMinDec
CumulativePercent
Description Calculates the total value of the rows up to and including the current row in the
specified column as a percentage of the total value of the column (a running
percentage).
Syntax CumulativePercent ( column { FOR range } )
column The column for which you want the cumulative value of the rows
up to and including the current row as a percentage of the total value
of the column for range. Column can be the column name or the
column number preceded by a pound sign (#). Column can also be
an expression that includes a reference to the column. The datatype
of column must be numeric.
56 PowerBuilder
FOR range The data that will be included in the cumulative percentage. For
(optional) most presentation styles, values for range are:
• ALL – (Default) The cumulative percentage of all rows in
column.
• GROUP n – The cumulative percentage of rows in column in the
specified group. Specify the keyword GROUP followed by the
group number: for example, GROUP 1.
• PAGE – The cumulative percentage of the rows in column on a
page.
• CROSSTAB – (Crosstabs only) The cumulative percentage of
all rows in column in the crosstab.
• GRAPH – (Graphs only) The cumulative percentage of values in
column in the range specified for the Rows option.
• OBJECT – (OLE objects only) The cumulative percentage of
values in column in the range specified for the Rows option.
Return value Long. Returns the cumulative percentage value.

Usage If you specify range, CumulativePercent restarts the accumulation at the start
of the range.
that range.
In calculating the percentage, null values are ignored.

expressions.
CumulativeSum

retrieves all rows.
Examples This expression returns the running percentage for the values that are not null
in the column named salary:
CumulativePercent(salary)
This expression returns the running percentage for the column named salary for
the values in group 1 that are not null:
CumulativePercent(salary for group 1)
This expression entered in the Value box on the Data property page for a graph
returns the running percentage for the salary column for the values in the graph
that are not null:
CumulativePercent(salary for graph)
This expression in a crosstab computed field returns the running percentage for
the salary column for the values in the crosstab that are not null:
CumulativePercent(salary for crosstab)
See also Percent
CumulativeSum
CumulativeSum
Description Calculates the total value of the rows up to and including the current row in the
specified column (a running total).
Syntax CumulativeSum ( column { FOR range } )
column The column for which you want the cumulative total value of the
rows up to and including the current row for group. Column can be
the column name or the column number preceded by a pound sign
(#). Column can also be an expression that includes a reference to
the column. The datatype of column must be numeric.
58 PowerBuilder
FOR range The data that will be included in the cumulative sum. For most
(optional) presentation styles, values for range are:
• ALL – (Default) The cumulative sum of all values in column.
• GROUP n – The cumulative sum of values in column in the
• PAGE – The cumulative sum of the values in column on a page.
• CROSSTAB – (Crosstabs only) The cumulative sum of all
values in column in the crosstab.
• GRAPH – (Graphs only) The cumulative sum of values in
• OBJECT – (OLE objects only) The cumulative sum of values in
Return value The appropriate numeric datatype. Returns the cumulative total value of the
rows.
Usage If you specify range, CumulativeSum restarts the accumulation at the start of
the range.
In calculating the sum, null values are ignored.
Examples This expression returns the running total for the values that are not null in the
column named salary:
CumulativeSum(salary)
This expression returns the running total for the values that are not null in the
column named salary in group 1:
CumulativeSum(salary for group 1)
CurrentRow
This expression entered in the Value box on the Data property page for a graph
returns the running total for the salary column for the values in the graph that
are not null:
CumulativeSum(salary for graph)
This expression in a crosstab computed field returns the running total for the
salary column for the values in the crosstab that are not null:
CumulativeSum(salary for crosstab)
See also CumulativePercent
CurrentRow
Description Reports the number of the current row (the row with focus).
Syntax CurrentRow ( )
Return value Long. Returns the number of the row if it succeeds and 0 if no row is current.
What row is current

The current row is not always a row displayed on the screen. For example, if
the cursor is on row 7 column 2 and the user uses the scroll bar to scroll to row
50, the current row remains row 7 unless the user clicks row 50.
Examples This expression in a computed field returns the number of the current row:
CurrentRow()
This expression for a computed control displays an arrow bitmap as an
indicator for the row with focus and displays no bitmap for rows not having
focus. As the user moves from row to row, an arrow marks where the user is:
Bitmap(If(CurrentRow() = GetRow(),"arrow.bmp",""))
Alternatively, this expression for the Visible property of an arrow picture
control makes the arrow bitmap visible for the row with focus and invisible for
rows not having focus. As the user moves from row to row, an arrow marks
where the user is:
If(CurrentRow() = GetRow(), 1, 0)
GetRow
60 PowerBuilder
Date
Description Converts a string whose value is a valid date to a value of datatype date.
Syntax Date ( string )
string A string containing a valid date (such as Jan 1, 2004, or 12-31-99)
that you want returned as a date
Return value Date. Returns the date in string as a date. If string does not contain a valid date,
Date returns null.
Regional Settings
To make sure you get correct return values for the year, you must verify that
yyyy is the Short Date Style for year in the Regional Settings of the user’s
Control Panel. Your program can check this with the RegistryGet function.
If the setting is not correct, you can ask the user to change it manually or to
have the application change it (by calling the RegistrySet function). The user
might need to reboot after the setting is changed.
Usage The value of the string must be a valid date.

Valid dates Valid dates can include any combination of day (1–31), month
(1–12 or the name or abbreviation of a month), and year (two or four digits).
Leading zeros are optional for month and day. If the month is a name or an
abbreviation, it can come before or after the day; if it is a number, it must be in
the month location specified in the Windows control panel. A 4-digit number
is assumed to be a year.
If the year is two digits, the assumption of century follows this rule: for years
between 00 and 49, the first two digits are assumed to be 20; for years between
50 and 99, the first two digits are assumed to be 19. If your data includes dates
before 1950, such as birth dates, always specify a four-digit year to ensure the
correct interpretation.
The function handles years from 1000 to 3000 inclusive.
An expression has a more limited set of datatypes than the functions that can
be part of the expression. Although the Date function returns a date value, the
whole expression is promoted to a DateTime value. Therefore, if your
expression consists of a single Date function, it will appear that Date returns the
wrong datatype. To display the date without the time, choose an appropriate
display format. (See Using DataWindow expression functions on page 17.)
DateTime
Examples These expressions all return the date datatype for July 4, 2004 when the default
location of the month in Regional Settings is center:
Date("2004/07/04")
Date("2004 July 4")
Date("July 4, 2004")
See also IsDate
Date in the PowerScript Reference
DateTime
Description Combines a date and a time value into a DateTime value.
Syntax DateTime ( date {, time } )
date A valid date (such as Jan 1, 2005, or 12-31-99) or a blob variable
whose first value is a date that you want included in the value
returned by DateTime.
time A valid time (such as 8am or 10:25:23:456799) or a blob variable
(optional) whose first value is a time that you want included in the value
returned by DateTime. If you include a time, only the hour portion
is required. If you omit the minutes, seconds, or microseconds, they
are assumed to be zeros. If you omit am or pm, the hour is
determined according to the 24-hour clock.
Return value DateTime. Returns a DateTime value based on the values in date and
optionally time. If time is omitted, DateTime uses 00:00:00.000000 (midnight).
Usage To display microseconds in a time, the display format for the field must include
microseconds.
For information on valid dates, see Date.
Examples This expression returns the values in the order_date and order_time columns as
a DateTime value that can be used to update the database:
DateTime(Order_Date, Order_Time)
Using this expression for a computed field displays 11/11/01 11:11:00:
DateTime(11/11/01, 11:11)
See also Date
Time
62 PowerBuilder
DateTime in the PowerScript Reference
Day
Description Obtains the day of the month in a date value.
Syntax Day ( date )
date The date for which you want the day
Return value Integer. Returns an integer (1–31) representing the day of the month in date.
Day(2005-01-31)
This expression returns the day of the month in the start_date column:
Day(start_date)
See also Date
IsDate
Month
Year
Day in the PowerScript Reference
DayName
Description Gets the day of the week in a date value and returns the weekday’s name.
Syntax DayName ( date )
date The date for which you want the name of the day
Return value String. Returns a string whose value is the name of the weekday (Sunday,
Monday, and so on) for date.
DayNumber
Usage DayName returns a name in the language of the deployment files available on
the machine where the application is run. If you have installed localized
deployment files in the development environment or on a user’s machine, then
on that machine the name returned by DayName will be in the language of the
localized files.
For information about localized deployment files, see the chapter on
internationalizing an application in Application Techniques.
Examples This expression for a computed field returns Okay if the day in date_signed is
not Sunday:
If(DayName(date_signed) <> "Sunday", "Okay", "Invalid
Date")
To pass this validation rule, the day in date_signed must not be Sunday:
DayName(date_signed) <> "Sunday"
See also Date
Day
DayNumber
IsDate
DayName in the PowerScript Reference
DayNumber
Description Gets the day of the week of a date value and returns the number of the weekday.
Syntax DayNumber ( date )
date The date from which you want the number of the day of the week
Return value Integer. Returns an integer (1–7) representing the day of the week of date.
Sunday is day 1, Monday is day 2, and so on.
Examples This expression for a computed field returns Wrong Day if the date in
start_date is not a Sunday or a Monday:
If(DayNumber(start_date) > 2, "Okay", "Wrong Day")
This expression for a computed field returns Wrong Day if the date in end_date
is not a Saturday or a Sunday:
If(DayNumber(end_date) > 1 and DayNumber(end_date)
64 PowerBuilder
< 7, "Okay", "Wrong Day")

This validation rule for the column end_date ensures that the day is not a
Saturday or Sunday:
DayNumber(end_date) >1 and DayNumber(end_date) < 7
See also Date
Day
DayName
IsDate
DayNumber in the PowerScript Reference
DaysAfter
Description Gets the number of days one date occurs after another.
Syntax DaysAfter ( date1, date2 )
date1 A date value that is the start date of the interval being measured
date2 A date value that is the end date of the interval
Return value Long. Returns a long containing the number of days date2 occurs after date1.
If date2 occurs before date1, DaysAfter returns a negative number.
DaysAfter(2005-12-20, 2005-12-24)
This expression returns –4:
DaysAfter(2005-12-24, 2005-12-20)
DaysAfter(2005-12-24, 2005-12-24)
DaysAfter(2004-12-29, 2005-01-03)
See also Date
SecondsAfter
DaysAfter in the PowerScript Reference
Dec
Dec
Description Converts the value of a string to a decimal.
Syntax Dec ( string )
string The string you want returned as a decimal
Return value Decimal. Returns the contents of string as a decimal if it succeeds and 0 if
string is not a number.
Usage The decimal datatype supports up to 28 digits.
You can also append the letter D in upper or lowercase to identify a number as
a decimal constant in DataWindow expressions. For example, 2.0d and
123.456789012345678901D are treated as decimals.
Examples This expression returns the string 24.3 as a decimal datatype:

Dec("24.3")
This expression for a computed field returns “Not a valid score” if the string in
the score column does not contain a number. The expression checks whether
the Dec function returns 0, which means it failed to convert the value:
If ( Dec(score) <> 0, score, "Not a valid score")
Dec("3ABC") // 3ABC is not a number
This validation rule checks that the value in the column the user entered is
greater than 1999.99:
Dec(GetText()) > 1999.99
This validation rule for the column named score insures that score contains a
string:
Dec(score) <> 0
See also Dec in the PowerScript Reference
66 PowerBuilder
Describe
Description Reports the values of properties of a DataWindow object and controls within
the object. Each column and graphic control in the DataWindow object has a
set of properties, which are listed in Controls in a DataWindow and their
properties on page 158. You specify one or more properties as a string and
Describe returns the values of the properties.
Syntax Describe ( propertylist )
propertylist A string whose value is a blank-separated list of properties or
Evaluate functions. For a list of valid properties, see Controls in a
DataWindow and their properties on page 158.
Return value String. Returns a string that includes a value for each property or Evaluate
function. A new line character (~n) separates the value of each item in
propertylist.
If propertylist contains an invalid item, Describe returns an exclamation point
(!) for that item and ignores the rest of propertylist. Describe returns a question
mark (?) if there is no value for a property.
Usage Specifying the values for propertylist can be complex. For information and
examples, see the Describe method for the DataWindow control.
Examples This expression for a computed field in the header band of a DataWindow
object displays the DataWindow object’s SELECT statement:
Describe("DataWindow.Table.Select")
See also Describe on page 584
Exp
Description Raises e to the specified power.
Syntax Exp ( n )
n The power to which you want to raise e (2.71828)
Return value Double. Returns e raised to the power n.
Fact
Examples This expression returns 7.38905609893065:

Exp(2)
See also Log
LogTen
Exp in the PowerScript Reference
Fact
Description Gets the factorial of a number.
Syntax Fact ( n )
n The number for which you want the factorial
Return value Double. Returns the factorial of n.

Fact(4)
Both these expressions return 1:
Fact(1)
Fact(0)
See also Fact in the PowerScript Reference
Fill
Description Builds a string of the specified length by repeating the specified characters
until the result string is long enough.
Syntax Fill ( chars, n )
chars A string whose value will be repeated to fill the return string
n A long whose value is the number of characters in the string you
want returned
68 PowerBuilder
Return value String. Returns a string n characters long filled with repetitions of the
characters in the argument chars. If the argument chars has more than n
characters, the first n characters of chars are used to fill the return string. If the
argument chars has fewer than n characters, the characters in chars are
repeated until the return string has n characters.
Usage Fill is used to create a line or other special effect. For example, asterisks
repeated in a printed report can fill an amount line, or hyphens can simulate a
total line in a screen display.
Examples This expression returns a string containing 35 asterisks:
Fill("*", 35)
This expression returns the string -+-+-+-:
Fill("-+", 7)
This expression returns 10 tildes (~):
Fill("~", 10)
See also FillA
Space
Fill in the PowerScript Reference
FillA
Description Builds a string of the specified length in bytes by repeating the specified
characters until the result string is long enough.
Syntax FillA ( chars, n )
chars A string whose value will be repeated to fill the return string
n A long whose value is the number of bytes in the string you want
returned
Return value String. Returns a string n bytes long filled with repetitions of the characters in
the argument chars. If the argument chars has more than n bytes, the first n
bytes of chars are used to fill the return string. If the argument chars has fewer
than n bytes, the characters in chars are repeated until the return string has n
bytes.
Usage FillA replaces the functionality that Fill had in DBCS environments in
PowerBuilder 9. In SBCS environments, Fill and FillA return the same results.
First
See also Fill

FillA in the PowerScript Reference
First
Description Reports the value in the first row in the specified column.
Syntax First ( column { FOR range { DISTINCT { expresn {, expres2 {, ... } } } } } )
column The column for which you want the value of the first row. Column
can be a column name or a column number preceded by a pound
to the column.
FOR range The data that will be included when the value in the first row is
(optional) found. Values for range depend on the presentation style. See the
Usage section for more information.
DISTINCT Causes First to consider only the distinct values in column when
(optional) determining the first value. For a value of column, the first row
found with the value is used and other rows that have the same value
are ignored.
an expression.
Return value The datatype of the column. Returns the value in the first row of column. If you
specify range, First returns the value of the first row in column in range.
Usage If you specify range, First determines the value of the first row in column in
range. If you specify DISTINCT, First returns the first distinct value in column,
or if you specify expresn, the first distinct value in column where the value of
expresn is distinct.
For most presentation styles, values for range are:
• ALL – (Default) The value in the first of all rows in column.
• GROUP n – The value in the first of rows in column in the specified group.
Specify the keyword GROUP followed by the group number: for example,
GROUP 1.
• PAGE – The value in the first of the rows in column on a page.
70 PowerBuilder
For Crosstabs, specify CROSSTAB for range to indicate the first of all rows in
For Graphs specify GRAPH and for OLE objects specify OBJECT for range,
to indicate the value in the first row in column in the range specified for the
Rows option.

expressions.

retrieves all rows.
Examples This expression returns the first value in column 3 on the page:
First(#3 for page)
This expression returns the first distinct value in the column named dept_id in
group 2:
First(dept_id for group 2 DISTINCT)
This expression returns the first value in the column named dept_id in group 2:
First(dept_id for group 2)
See also Last
GetPaintDC
Description Returns the GDI context to which to draw.
GetPaintRectHeight
Syntax GetPaintDC ( )
Return value UnsignedLong.
Usage The clip region of the GDI context is guaranteed to be the same as the rectangle
defined by GetPaintRectHeight, GetPaintRectWidth, GetPaintRectX, and
GetPaintRectY.
You can also use the GetClipBox GDI function. You can compute the bounds
inside the global rendering function itself.
The GetPaintDC expression is only valid in the context of the Paint expression
function.
Examples This example draws a cube with the text of the column emp_lname.
Paint
(
MyDrawWPFCubeText
(
GetPaintDC(),
GetPaintRectX(),
GetPaintRectY(),
GetPaintRectWidth(),
GetPaintRectHeight(),
emp_lname,
GetRow()
)
)
See also GetPaintRectHeight
GetPaintRectWidth
GetPaintRectX
GetPaintRectY
Paint
GetPaintRectHeight
Description Returns the bounds of the computed field and the device context is clipped
within those bounds. This expression is only valid in the context of the Paint
expression function.
Syntax GetPaintRectHeight ( )
Return value Integer. Returns the height bounds for the computed field.
72 PowerBuilder
See also GetPaintDC

GetPaintRectWidth
GetPaintRectX
GetPaintRectY
Paint
GetPaintRectWidth
Syntax GetPaintRectWidth ( )
Return value Integer. Returns the width bounds for the computed field.
See also GetPaintDC
GetPaintRectHeight
GetPaintRectX
GetPaintRectY
Paint
GetPaintRectX
Syntax GetPaintRectX ( )
Return value Integer. Returns the X bound for the computed field.
See also GetPaintDC
GetPaintRectHeight
GetPaintRectWidth
GetPaintRectY
Paint
GetPaintRectY
GetPaintRectY
Syntax GetPaintRectY ( )
Return value Integer. Returns the Y bound for the computed field.
See also GetPaintDC
GetPaintRectHeight
GetPaintRectWidth
GetPaintRectX
GetRow
Description Reports the number of a row associated with a band in a DataWindow object.
Syntax GetRow ( )
Return value Long. Returns the number of a row if it succeeds, 0 if no data has been retrieved
or added, and –1 if an error occurs. Where you call GetRow determines what
row it returns, as follows:
If the control in the
DataWindow object is in
this band GetRow returns
Header First row on the page
Group header First row in the group
Detail The row in which the expression occurs
Group trailer Last row in the group
Summary Last row in the DataWindow object
Footer Last row on the page
Examples This expression for a computed field in the detail band displays the number of
each row:
GetRow()
74 PowerBuilder
This expression for a computed field in the header band checks to see if there
is data. It returns the number of the first row on the page if there is data, and
otherwise returns No Data:
If(GetRow()= 0, "No Data", String(GetRow()))
CurrentRow
GetRow on page 668
GetText
Description Obtains the text that a user has entered in a column.
Syntax GetText ( )
Return value String. Returns the text the user has entered in the current column.
Usage Use GetText in validation rules to compare what the user has entered to
application-defined criteria before it is accepted into the data buffer.
Examples This validation rule checks that the value the user entered in the column is less
than 100:
Integer(GetText()) < 100
See also GetText on page 677
Hour
Description Obtains the hour in a time value. The hour is based on a 24-hour clock.
Syntax Hour ( time )
time The time value from which you want the hour
Return value Integer. Returns an integer (00–23) containing the hour portion of time.
Examples This expression returns the current hour:
Hour(Now())
If

Hour(19:01:31)
See also Minute
Now
Second
Hour in the PowerScript Reference
If
Description Evaluates a condition and returns a value based on that condition.
Syntax If ( boolean, truevalue, falsevalue )
boolean A boolean expression that evaluates to true or false.
truevalue The value you want returned if the boolean expression is true. The
value can be a string or numeric value.
falsevalue The value you want returned if the boolean expression is false. The
value can be a string or numeric value.
Return value The datatype of truevalue or falsevalue. Returns truevalue if boolean is true
and falsevalue if it is false. Returns null if an error occurs.
Examples This expression returns Boss if salary is over $100,000 and Employee if salary
is less than or equal to $100,000:
If(salary > 100000, "Boss", "Employee")
This expression returns Boss if salary is over $100,000, Supervisor if salary is
between $12,000 and $100,000, and Clerk if salary is less than or equal to
$12,000:
If(salary > 100000, "Boss", If(salary > 12000,
"Supervisor", "Clerk"))
In this example of a validation rule, the value the user should enter in the
commission column depends on the price. If price is greater than or equal to
1000, then the commission is between .10 and .20. If price is less than 1000,
then the commission must be between .04 and .09. The validation rule is:
(Number(GetText()) >= If(price >=1000, .10, .04)) AND
(Number(GetText()) <= If(price >= 1000, .20, .09))
76 PowerBuilder
The accompanying error message expression might be:

"Price is " + If(price >= 1000, "greater than or
equal to", "less than") + " 1000. Commission must be
between " + If(price >= 1000, ".10", ".04") + " and "
+ If(price >= 1000, ".20.", ".09.")
Example 2: counting male and female employees on page 21
Example 3: creating a row indicator on page 25
Example 4: displaying all data when a column allows nulls on page 26
Case
Int
Description Gets the largest whole number less than or equal to a number.
Syntax Int ( n )
n The number for which you want the largest whole number that is
less than or equal to it
Return value The datatype of n. Returns the largest whole number less than or equal to n.
Examples These expressions return 3.0:
Int(3.2)
Int(3.8)
These expressions return -4.0:
Int(-3.2)
Int(-3.8)
See also Ceiling
Integer
Round
Truncate
Int in the PowerScript Reference
Integer
Integer
Description Converts the value of a string to an integer.
Syntax Integer ( string )
string The string you want returned as an integer
Return value Integer. Returns the contents of string as an integer if it succeeds and 0 if string
is not a number.
Examples This expression converts the string 24 to an integer:
Integer("24")
This expression for a computed field returns “Not a valid age” if age does not
contain a number. The expression checks whether the Integer function returns
0, which means it failed to convert the value:
If (Integer(age) <> 0, age, "Not a valid age")
Integer("3ABC") // 3ABC is not a number
This validation rule checks that the value in the column the user entered is less
than 100:
Integer(GetText()) < 100
This validation rule for the column named age insures that age contains a
string:
Integer(age) <> 0
See also IsNumber
Integer in the PowerScript Reference
IsDate
Description Tests whether a string value is a valid date.
Syntax IsDate ( datevalue )
datevalue A string whose value you want to test to determine whether it is a
valid date
78 PowerBuilder
Return value Boolean. Returns true if datevalue is a valid date and false if it is not.
Examples This expression returns true:
IsDate("Jan 1, 99")
This expression returns false:
IsDate("Jan 32, 2005")
This expression for a computed field returns a day number or 0. If the
date_received column contains a valid date, the expression returns the number
of the day in date_received in the computed field, and otherwise returns 0:
If(IsDate(String(date_received)),
DayNumber(date_received), 0)
See also IsDate in the PowerScript Reference
IsExpanded
Description Tests whether a node in a TreeView DataWindow with the specified TreeView
level and that includes the specified row is expanded.
Syntax IsExpanded(long row, long level)
row The number of the row that belongs to the node
level The TreeView level of the node
Return value Returns true if the group is expanded and false otherwise.
Usage A TreeView DataWindow has several TreeView level bands that can be
expanded and collapsed. You can use the IsExpanded function to test whether
or not a node in a TreeView DataWindow is expanded.
Examples This expression returns true if the node that contains row 3 at TreeView level
2 is expanded:
IsExpanded(3,2)
IsNull
IsNull
Description Reports whether the value of a column or expression is null.
Syntax IsNull ( any )
any A column or expression that you want to test to determine whether
its value is null
Return value Boolean. Returns true if any is null and false if it is not.
Usage Use IsNull to test whether a user-entered value or a value retrieved from the
database is null.
Examples This expression returns true if either a or b is null:
IsNull(a + b)
This expression returns true if the value in the salary column is null:
IsNull(salary)
This expression returns true if the value the user has entered is null:
IsNull(GetText())
Example 4: displaying all data when a column allows nulls on page 26
IsNull in the PowerScript Reference
IsNumber
Description Reports whether the value of a string is a number.
Syntax IsNumber ( string )
string A string whose value you want to test to determine whether it is a
valid number
Return value Boolean. Returns true if string is a valid number and false if it is not.
IsNumber("32.65")
80 PowerBuilder
IsNumber("A16")
This expression for a computed field returns “Not a valid age” if age does not
contain a number:
If(IsNumber(age), age, "Not a valid age")
To pass this validation rule, Age_nbr must be a number:
IsNumber(Age_nbr) = true
See also Integer
IsNumber in the PowerScript Reference
IsRowModified
Description Reports whether the row has been modified.
Syntax IsRowModified ( )
Return value Boolean. Returns true if the row has been modified and false if it has not.
Usage In a DataWindow object, when you use IsRowModified in bands other than the
detail band, it reports on a row in the detail band. See GetRow for a table
specifying which row is associated with each band for reporting purposes.
Examples This expression in a computed field in the detail area displays true or false to
indicate whether each row has been modified:
IsRowModified()
This expression defined in the Properties view for the Color property of the
computed field displays the text (true) in red if the user has modified any value
in the row:
If(IsRowModified(), 255, 0)
See also GetRow
IsRowNew
Description Reports whether the row has been newly inserted.
Syntax IsRowNew ( )
IsSelected
Return value Boolean. Returns true if the row is new and false if it was retrieved from the
database.
Usage In a DataWindow object, when you call IsRowNew in bands other than the
detail band, it reports on a row in the detail band. See GetRow for a table
specifying which row is associated with each band for reporting purposes.
Examples This expression defined in the Properties view for the Protect property of a
column prevents the user from modifying the column unless the row has been
newly inserted:
If(IsRowNew(), 0, 1)
See also GetRow
GetItemStatus on page 649
IsSelected
Description Determines whether the row is selected. A selected row is highlighted using
reverse video.
Syntax IsSelected ( )
Return value Boolean. Returns true if the row is selected and false if it is not selected.
Usage When you use IsSelected in bands other than the detail band, it reports on a row
in the detail band. See GetRow for a table specifying which row is associated
with each band for reporting purposes.
Examples This expression for a computed field in the detail area displays a bitmap if the
row is selected:
Bitmap(If(IsSelected(), "beach.bmp", ""))
This example allows the DataWindow object to display a salary total for all the
selected rows. The expression for a computed field in the detail band returns
the salary only when the row is selected so that another computed field in the
summary band can add up all the selected salaries.
The expression for cf_selected_salary (the computed field in the detail band)
is:
If(IsSelected(), salary, 0)
The expression for the computed field in the summary band is:
Sum(cf_selected_salary for all)
82 PowerBuilder
See also GetRow

IsSelected on page 702
IsTime
Description Reports whether the value of a string is a valid time value.
Syntax IsTime ( timevalue )
timevalue A string whose value you want to test to determine whether it is a
valid time
Return value Boolean. Returns true if timevalue is a valid time and false if it is not.
IsTime("8:00:00 am")
IsTime("25:00")
To pass this validation rule, the value in start_time must be a time:
IsTime(start_time)
See also IsTime in the PowerScript Reference
Large
Description Finds a large value at a specified ranking in a column (for example, third-
largest, fifth-largest) and returns the value of another column or expression
based on the result.
Syntax Large ( returnexp, column, ntop { FOR range { DISTINCT { expres1
{, expres2 {, ... } } } } } )
returnexp The value you want returned when the large value is found.
Returnexp includes a reference to a column, but not necessarily the
column that is being evaluated for the largest value, so that a value is
returned from the same row that contains the large value.
Large
column The column that contains the large value you are searching for.
Column can be a column name or a column number preceded by a
pound sign (#). Column can also be an expression that includes a
reference to the column. The datatype of column must be numeric.
ntop The ranking of the large value in relation to the column’s largest
value. For example, when ntop is 2, Large finds the second-largest
value.
FOR range The data that will be included when the largest value is found. For
• ALL – (Default) The largest of all values in column.
• GROUP n – The largest of values in column in the specified group.
example, GROUP 1.
• PAGE – The largest of the values in column on a page.
• CROSSTAB – (Crosstabs only) The largest of all values in column
in the crosstab.
• GRAPH – (Graphs only) The largest of values in column in the
• OBJECT – (OLE objects only) The largest of values in column in
DISTINCT Causes Large to consider only the distinct values in column when
(optional) determining the large value. For a value of column, the first row
are ignored.
expresn One or more expressions that you need to evaluate to determine
(optional) distinct rows. Expresn can be the name of a column, a function, or an
expression.
Return value The datatype of returnexp. Returns the ntop-largest value if it succeeds and –1
if an error occurs.
Usage If you specify range, Large returns the value in returnexp when the value in
column is the ntop-largest value in range. If you specify DISTINCT, Large
returns returnexp when the value in column is the ntop-largest value of the
distinct values in column, or if you specify expresn, the ntop-largest for each
distinct value of expresn.
84 PowerBuilder
that range. Settings for Rows are as follows:
• For the Graph or OLE presentation style, Rows is always All
• For Graph controls, Rows can be All, Page, or Group
available choices depend on the layer the control occupies
Max might be faster

If you do not need a return value from another column and you want to find the
largest value (ntop = 1), use Max; it is faster.
expressions.
retrieves all rows.
Examples These expressions return the names of the salespersons with the three largest
sales (sum_sales is the sum of the sales for each salesperson) in group 2, which
might be the salesregion group. Note that sum_sales contains the values being
compared, but Large returns a value in the name column:
Large(name, sum_sales, 1 for group 2)
This example reports the salesperson with the third-largest sales, considering
only the first entry for each person:
Large(name, sum_sales, 3 for all DISTINCT sum_sales)
See also Small
Last
Description Gets the value in the last row in the specified column.
Syntax Last ( column { FOR range { DISTINCT { expres1 {, expres2 {, ... } } } } } )
Last
column The column for which you want the value of the last row. Column
can be a column name or a column number preceded by a pound
to the column.
FOR range The data that will be included when the value in the last row is
(optional) found. For most presentation styles, values for range are:
• ALL – (Default) The value in the last of all rows in column.
• GROUP n – The value in the last row in column in the specified
• PAGE – The value in the last row in column on a page.
• CROSSTAB – (Crosstabs only) The value in the last row in
• GRAPH – (Graphs only) The value in the last row in column in
• OBJECT – (OLE objects only) The value in the last row in
DISTINCT Causes Last to consider only the distinct values in column when
(optional) determining the last value. For a value of column, the first row
are ignored.
an expression.
Return value The datatype of the column. Returns the value in the last row of column. If you
specify range, Last returns the value of the last row in column in range.
Usage If you specify range, Last determines the value of the last row in column in
range. If you specify DISTINCT, Last returns the last distinct value in column,
or if you specify expresn, the last distinct value in column where the value of
86 PowerBuilder


expressions.

retrieves all rows.
Examples This expression returns the last distinct value in the column named dept_id in
group 2:
Last(dept_id for group 2 DISTINCT)
This expression returns the last value in the column named emp_id in group 2:
Last(emp_id for group 2)
See also First
LastPos
Description Finds the last position of a target string in a source string.
Syntax LastPos ( string1, string2, searchlength )
string1 The string in which you want to find string2.
string2 The string you want to find in string1.
searchlength A long that limits the search to the leftmost searchlength characters
(optional) of the source string string1. The default is the entire string.
Return value Long. Returns a long whose value is the starting position of the last occurrence
of string2 in string1 within the characters specified in searchlength. If string2
is not found in string1 or if searchlength is 0, LastPos returns 0. If any
argument’s value is null, LastPos returns null.
Usage The LastPos function is case-sensitive. The entire target string must be found
in the source string.
Left
Examples This statement returns 6, because the position of the last occurrence of RU is
position 6:
LastPos("BABE RUTH", "RU")
This statement returns 3:
LastPos("BABE RUTH", "B")
This statement returns 0, because the case does not match:
LastPos("BABE RUTH", "be")
This statement searches the leftmost 4 characters and returns 0, because the
only occurrence of RU is after position 4:
LastPos("BABE RUTH", "RU", 2)
See also Pos
Left
Description Obtains a specified number of characters from the beginning of a string.
Syntax Left ( string, n )
string The string containing the characters you want
n A long specifying the number of characters you want
Return value String. Returns the leftmost n characters in string if it succeeds and the empty
string (“”) if an error occurs.
If n is greater than or equal to the length of the string, Left returns the entire
string. It does not add spaces to make the return value’s length equal to n.
Examples This expression returns BABE:
Left("BABE RUTH", 4)
This expression returns BABE RUTH:
Left("BABE RUTH", 40)
This expression for a computed field returns the first 40 characters of the text
in the column home_address:
Left(home_address, 40)
88 PowerBuilder
See also LeftA

Mid
Pos
Right
Left in the PowerScript Reference
LeftA
Description Obtains a specified number of bytes from the beginning of a string.
Syntax LeftA ( string, n )
string The string containing the characters you want
n A long specifying the number of bytes you want
Return value String. Returns the characters in the leftmost n bytes in string if it succeeds and
the empty string (“”) if an error occurs.
If n is greater than or equal to the length of the string, LeftA returns the entire
Usage LeftA replaces the functionality that Left had in DBCS environments in
PowerBuilder 9. In SBCS environments, Left and LeftA return the same results.
See also MidA
PosA
RightA
LeftA in the PowerScript Reference
LeftTrim
Description Removes spaces from the beginning of a string.
Syntax LeftTrim ( string )
string The string you want returned with leading spaces deleted
Return value String. Returns a copy of string with leading spaces deleted if it succeeds and
Len
Examples This expression returns RUTH:

LeftTrim(" RUTH")
This expression for a computed field deletes any leading blanks from the value
in the column lname and returns the value preceded by the salutation specified
in salut_emp:
salut_emp + " " + LeftTrim(lname)
See also RightTrim
Trim
LeftTrim in the PowerScript Reference
Len
Description Reports the length of a string in characters.
Syntax Len ( string )
string The string for which you want the length
Return value Long. Returns a long containing the length of string in characters if it succeeds
and –1 if an error occurs.
Len("")
This validation rule tests that the value the user entered is fewer than 20
characters:
Len(GetText()) < 20
See also LenA
Len in the PowerScript Reference
LenA
Description Reports the length of a string in bytes.
Syntax LenA ( string )
90 PowerBuilder
string The string for which you want the length
Return value Long. Returns a long containing the length of string in bytes if it succeeds and
–1 if an error occurs.
Usage LenA replaces the functionality that Len had in DBCS environments in
PowerBuilder 9. In SBCS environments, Len and LenA return the same results.
See also Len
LenA in the PowerScript Reference
Log
Description Gets the natural logarithm of a number.
Syntax Log ( n )
n The number for which you want the natural logarithm (base e). The
value of n must be greater than 0.
Return value Double. Returns the natural logarithm of n. An execution error occurs if n is
negative or zero.
Inverse
The inverse of the Log function is the Exp function.

Log(10)
This expression returns -.693147 ... :
Log(0.5)
Both these expressions result in an error at runtime:
Log(0)
Log(-2)
See also Exp
LogTen
Log in the PowerScript Reference
LogTen
LogTen
Description Gets the base 10 logarithm of a number.
Syntax LogTen ( n )
n The number for which you want the base 10 logarithm. The value
of n must not be negative.
Return value Double. Returns the base 10 logarithm.
Obtaining a number
The expression 10^n is the inverse for LogTen(n). To obtain n given number
(nbr = LogTen(n)), use n = 10^nbr.

LogTen(10)
The following expressions both return 0:
LogTen(1)
LogTen(0)
This expression results in an execution error:
LogTen(–2)
See also Log
LogTen in the PowerScript Reference
Long
Description Converts the value of a string to a long.
Syntax Long ( string )
string The string you want returned as a long
Return value Long. Returns the contents of string as a long if it succeeds and 0 if string is
not a valid number.
Examples This expression returns 2167899876 as a long:
92 PowerBuilder
Long("2167899876")
See also Long in the PowerScript Reference
LookUpDisplay
Description Obtains the display value in the code table associated with the data value in the
specified column.
Syntax LookUpDisplay ( column )
column The column for which you want the code table display value
Return value String. Returns the display value when it succeeds and the empty string (“”) if
an error occurs.
Usage If a column has a code table, a buffer stores a value from the data column of
the code table, but the user sees a value from the display column. Use
LookUpDisplay to get the value the user sees.
Code tables and data values and graphs

When a column that is displayed in a graph has a code table, the graph displays
the data values of the code table by default. To display the display values, call
this function when you define the graph data.
Examples This expression returns the display value for the column unit_measure:
LookUpDisplay(unit_measure)
Assume the column product_type has a code table and you want to use it as a
category for a graph. To display the product type descriptions instead of the
data values in the categories, enter this expression in the Category option on
the Data page in the graph’s property sheet:
LookUpDisplay(product_type)
Lower
Description Converts all the characters in a string to lowercase.
Match
Syntax Lower ( string )

string The string you want to convert to lowercase letters
Return value String. Returns string with uppercase letters changed to lowercase if it
succeeds and the empty string (“”) if an error occurs.
Examples This expression returns castle hill:
Lower("Castle Hill")
See also Upper
Lower in the PowerScript Reference
Match
Description Determines whether a string’s value contains a particular pattern of characters.
Syntax Match ( string, textpattern )
string The string in which you want to look for a pattern of characters
textpattern A string whose value is the text pattern
Return value Boolean. Returns true if string matches textpattern and false if it does not.
Match also returns false if either argument has not been assigned a value or the
pattern is invalid.
Usage Match enables you to evaluate whether a string contains a general pattern of
characters. To find out whether a string contains a specific substring, use the
Pos function.
Textpattern is similar to a regular expression. It consists of metacharacters,
which have special meaning, and ordinary characters, which match
themselves. You can specify that the string begin or end with one or more
characters from a set, or that it contain any characters except those in a set.
A text pattern consists of metacharacters, which have special meaning in the
match string, and nonmetacharacters, which match the characters themselves.
The following tables explain the meaning and use of these metacharacters:
94 PowerBuilder
Metacharacter Meaning Example

Caret (^) Matches the beginning of ^C matches C at the
a string beginning of a string.
Dollar sign ($) Matches the end of a s$ matches s at the end of a
string string.
Period (.) Matches any character . . . matches three
consecutive characters.
Backslash (\) Removes the following \$ matches $.
metacharacter’s special
characteristics so that it
matches itself
Character class (a group Matches any of the [AEIOU] matches A, E, I, O,
of characters enclosed in enclosed characters or U.
square brackets [ ]) You can use hyphens to
abbreviate ranges of
characters in a character
class. For example, [A-Za-z]
matches any letter.
Complemented character Matches any character [^0-9] matches any character
class (first character not in the group except a digit, and [Â-Za-z]
inside the square following the caret matches any character
brackets is a caret) except a letter.
The metacharacters asterisk (*), plus (+), and question mark (?) are unary
operators that are used to specify repetitions in a regular expression:
Metacharacter Meaning Example
* (asterisk) Indicates zero or more A* matches zero or more As
occurrences (no As, A, AA, AAA, and so
on)
+ (plus) Indicates one or more A+ matches one A or more
occurrences than one A (A, AAA, and so
on)
? (question mark) Indicates zero or one A? matches an empty string
occurrence (“”) or A
Sample patterns The following table shows various text patterns and sample
text that matches each pattern:
Max
This pattern Matches

AB Any string that contains AB, such as ABA, DEABC,
graphAB_one.
B* Any string that contains 0 or more Bs, such as AC, B, BB,
BBB, ABBBC, and so on. Since B* used alone matches any
string, you would not use it alone, but notice its use in some
the following examples.
AB*C Any string containing the pattern AC or ABC or ABBC, and
so on (0 or more Bs).
AB+C Any string containing the pattern ABC or ABBC or
ABBBC, and so on (1 or more Bs).
ABB*C Any string containing the pattern ABC or ABBC or
ABBBC, and so on (1 B plus 0 or more Bs).
ÂB Any string starting with AB.
AB?C Any string containing the pattern AC or ABC (0 or 1 B).
^[ABC] Any string starting with A, B, or C.
[ÂBC] A string containing any characters other than A, B, or C.
^[âbc] A string that begins with any character except a, b, or c.
^[â-z]$ Any single-character string that is not a lowercase letter (^
and $ indicate the beginning and end of the string).
[A-Z]+ Any string with one or more uppercase letters.
^[0-9]+$ Any string consisting only of digits.
^[0-9][0-9][0-9]$ Any string consisting of exactly three digits.
^([0-9][0-9][0-9])$ Any string consisting of exactly three digits enclosed in
parentheses.
Examples This validation rule checks that the value the user entered begins with an
uppercase letter. If the value of the expression is false, the data fails validation:
Match(GetText(), "^[A-Z]")
See also Pos
Match in the PowerScript Reference
Max
Description Gets the maximum value in the specified column.
Syntax Max ( column { FOR range { DISTINCT { expres1 {, expres2 {, ... } } } } } )
96 PowerBuilder
column The column for which you want the maximum value. Column can
to the column. The datatype of column must be numeric.
FOR range The data that will be included when the maximum value is found.
(optional) For most presentation styles, values for range are:
• ALL – (Default) The maximum value of all rows in column.
• GROUP n – The maximum value of rows in column in the
• PAGE – The maximum value of the rows in column on a page.
• CROSSTAB – (Crosstabs only) The maximum value of all rows
in column in the crosstab.
• GRAPH – (Graphs only) The maximum value in column in the
• OBJECT – (OLE objects only) The maximum value in column
DISTINCT Causes Max to consider only the distinct values in column when
(optional) determining the largest value. For a value of column, the first row
are ignored.
an expression.
Return value The datatype of the column. Returns the maximum value in the rows of
column. If you specify range, Max returns the maximum value in column in
range.
Usage If you specify range, Max determines the maximum value in column in range.
If you specify DISTINCT, Max returns the maximum distinct value in column,
or if you specify expresn, the maximum distinct value in column where the
value of expresn is distinct.
Median

Null values are ignored and are not considered in determining the maximum.

expressions.

retrieves all rows.
Examples This expression returns the maximum of the values in the age column on the
page:
Max(age for page)
This expression returns the maximum of the values in column 3 on the page:
Max(#3 for page)
This expression returns the maximum of the values in the column named age
in group 1:
Max(age for group 1)
items for each order, this computed field returns the maximum of the order
Max(order_amt for all DISTINCT order_nbr)
See also Min
Max in the PowerScript Reference
Median
Description Calculates the median of the values of the column. The median is the middle
value in the set of values, for which there is an equal number of values greater
and smaller than it.
Syntax Median ( column { FOR range { DISTINCT { expres1 {, expres2 {, ... } } } } } )
98 PowerBuilder
column The column for which you want the median of the data values.
FOR range The data that will be included in the median. For most presentation
• ALL – (Default) The median of all values in column.
• GROUP n – The median of values in column in the specified
• PAGE – The median of the values in column on a page.
• CROSSTAB – (Crosstabs only) The median of all values in
• GRAPH – (Graphs only) The median of values in column in the
range specified for the Rows.
• OBJECT – (OLE objects only) The median of values in column
DISTINCT Causes Median to consider only the distinct values in column when
(optional) determining the median. For a value of column, the first row found
ignored.
an expression.
Return value The numeric datatype of the column. Returns the median of the values of the
rows in range if it succeeds and –1 if an error occurs.
Usage If you specify range, Median returns the median value of column in range. If
you specify DISTINCT, Median returns the median value of the distinct values
in column, or if you specify expresn, the median of column for each distinct
value of expresn.
that range.
Median

In calculating the median, null values are ignored.

expressions.

retrieves all rows.
Examples This expression returns the median of the values in the column named salary:
Median(salary)
This expression returns the median of the values in the column named salary
of group 1:
Median(salary for group 1)
This expression returns the median of the values in column 5 on the current
page:
Median(#5 for page)
This computed field returns Above Median if the median salary for the page is
greater than the median for the report:
If(Median(salary for page) > Median(salary), "Above
Median", " ")
This expression for a graph value sets the data value to the median value of the
sale_price column:
Median(sale_price)
This expression for a graph value entered on the Data page in the graph’s
property sheet sets the data value to the median value of the sale_price column
for the entire graph:
Median(sale_price for graph)
items for each order, this computed field returns the median of the order
100 PowerBuilder
Median(order_amt for all DISTINCT order_nbr)

See also Avg
Mode
Mid
Description Obtains a specified number of characters from a specified position in a string.
Syntax Mid ( string, start {, length } )
string The string from which you want characters returned.
start A long specifying the position of the first character you want
returned (the position of the first character of the string is 1).
length A long whose value is the number of characters you want returned.
(optional) If you do not enter length or if length is greater than the number of
characters to the right of start, Mid returns the remaining characters
in the string.
Return value String. Returns characters specified in length of string starting at character
start. If start is greater than the number of characters in string, the Mid function
returns the empty string (“”). If length is greater than the number of characters
remaining after the start character, Mid returns the remaining characters. The
return string is not filled with spaces to make it the specified length.
Examples This expression returns “”:
Mid("BABE RUTH", 40, 5)
This expression returns BE RUTH:
Mid("BABE RUTH", 3)
This expression in a computed field returns ACCESS DENIED if the fourth
character in the column password is not R:
If(Mid(password, 4, 1) = "R", "ENTER", "ACCESS DENIED")
To pass this validation rule, the fourth character in the column password must
be 6:
Mid(password, 4, 1) = "6"
See also Mid in the PowerScript Reference

MidA
MidA
Description Obtains a specified number of bytes from a specified position in a string.
Syntax MidA ( string, start {, length } )
string The string from which you want characters returned.
start A long specifying the position of the first byte you want returned
(the position of the first byte of the string is 1).
length A long whose value is the number of bytes you want returned. If
(optional) you do not enter length or if length is greater than the number of
bytes to the right of start, MidA returns the remaining bytes in the
string.
Return value String. Returns characters specified by the number of bytes in length of string
starting at the byte specified by start. If start is greater than the number of bytes
in string, the MidA function returns the empty string (“”). If length is greater
than the number of bytes remaining after the start byte, MidA returns the
remaining bytes. The return string is not filled with spaces to make it the
specified length.
Usage MidA replaces the functionality that Mid had in DBCS environments in
PowerBuilder 9. In SBCS environments, Mid and MidA return the same results.
See also Mid
MidA in the PowerScript Reference
Min
Description Gets the minimum value in the specified column.
Syntax Min ( column { FOR range { DISTINCT { expres1 {, expres2 {, ... } } } } } )
column The column for which you want the minimum value. Column can
102 PowerBuilder
FOR range The data that will be included in the minimum. For most
• ALL – (Default) The minimum of all values in column.
• GROUP n – The minimum of values in column in the specified
• PAGE – The minimum of the values in column on a page.
• CROSSTAB – (Crosstabs only) The minimum of all values in
• GRAPH – (Graphs only) The minimum of values in column in
• OBJECT – (OLE objects only) The minimum of values in
DISTINCT Causes Min to consider only the distinct values in column when
(optional) determining the minimum value. For a value of column, the first
row found with the value is used and other rows that have the same
value are ignored.
an expression.
Return value The datatype of the column. Returns the minimum value in the rows of column.
If you specify range, Min returns the minimum value in the rows of column in
range.
Usage If you specify range, Min determines the minimum value in column in range.
If you specify DISTINCT, Min returns the minimum distinct value in column,
or if you specify expresn, the minimum distinct value in column where the
that range. Settings for Rows include:

Minute
Null values are ignored and are not considered in determining the minimum.

expressions.

retrieves all rows.
Examples This expression returns the minimum value in the column named age in group
2:
Min(age for group 2)
This expression returns the minimum of the values in column 3 on the page:
Min(#3 for page)
items for each order, this computed field returns the minimum of the order
Min(order_amt for all DISTINCT order_nbr)
See also Max
Min in the PowerScript Reference
Minute
Description Obtains the number of minutes in the minutes portion of a time value.
Syntax Minute ( time )
time The time value from which you want the minutes
Return value Integer. Returns the minutes portion of time (00 to 59).
Minute(19:01:31)
See also Hour
Second
Minute in the PowerScript Reference
104 PowerBuilder
Mod
Description Obtains the remainder (modulus) of a division operation.
Syntax Mod ( x, y )
x The number you want to divide by y
y The number you want to divide into x
Return value The datatype of x or y, whichever datatype is more precise.

Mod(20, 6)
This expression returns 1.5:
Mod(25.5, 4)
Mod(25, 4.5)
See also Mod in the PowerScript Reference
Mode
Description Calculates the mode of the values of the column. The mode is the most
frequently occurring value.
Syntax Mode ( column { FOR range { DISTINCT { expres1 {, expres2 {, ... } } } } } )
column The column for which you want the mode of the data values.

Mode
FOR range The data that will be included in the mode. For most presentation
• ALL – (Default) The mode of all values in column.
• GROUP n – The mode of values in column in the specified
• PAGE – The mode of the values in column on a page.
• CROSSTAB – (Crosstabs only) The mode of all values in
• GRAPH – (Graphs only) The mode of values in column in the
• OBJECT – (OLE objects only) The mode of values in column in
DISTINCT Causes Mode to consider only the distinct values in column when
(optional) determining the mode. For a value of column, the first row found
ignored.
an expression.
Return value The numeric datatype of the column. Returns the mode of the values of the
rows in range if it succeeds and –1 if an error occurs.
Usage If you specify range, Mode returns the mode of column in range. If you specify
DISTINCT, Mode returns the mode of the distinct values in column, or if you
specify expresn, the mode of column for each distinct value of expresn.
that range. Settings for Rows include:
In calculating the mode, null values are ignored.
106 PowerBuilder

expressions.

retrieves all rows.
Examples This expression returns the mode of the values in the column named salary:
Mode(salary)
This expression returns the mode of the values for group 1 in the column named
salary:
Mode(salary for group 1)
This expression returns the mode of the values in column 5 on the current page:
Mode(#5 for page)
This computed field returns Above Mode if the mode of the salary for the page
is greater than the mode for the report:
If(Mode(salary for page) > Mode(salary), "Above
Mode", " ")
This expression for a graph value sets the data value to the mode of the
sale_price column:
Mode(sale_price)
This expression for a graph value entered on the Data page in the graph’s
property sheet sets the data value to the mode of the sale_price column for the
entire graph:
Mode(sale_price for graph)
items for each order, this computed field returns the mode of the order amount
for the distinct order numbers:
Mode(order_amt for all DISTINCT order_nbr)
See also Avg
Median

Month
Month
Description Gets the month of a date value.
Syntax Month ( date )
date The date from which you want the month
Return value Integer. Returns an integer (1 to 12) whose value is the month portion of date.
Month(2005-01-31)
This expression for a computed column returns Wrong Month if the month in
the column expected_grad_date is not 6:
If(Month(expected_grad_date) = 6, "June", "Wrong
Month")
This validation rule expression checks that the value of the month in the date
in the column expected_grad_date is 6:
Month(expected_grad_date) = 6
See also Day
Date
Year
Month in the PowerScript Reference
Now
Description Obtains the current time based on the system time of the client machine.
Syntax Now ( )
Return value Time. Returns the current time based on the system time of the client machine.
Usage Use Now to compare a time to the system time or to display the system time on
the screen. The timer interval specified for the DataWindow object determines
the frequency at which the value of Now is updated. For example, if the timer
interval is one second, it is updated every second. The default timer interval is
one minute (60,000 milliseconds).
Examples This expression returns the current system time:
Now()
108 PowerBuilder
This expression sets the column value to 8:00 when the current system time is
before 8:00 and to the current time if it is after 8:00:
If(Now() < 08:00:00, '08:00:00', String(Now()))
The displayed time refreshes every time the specified time interval period
elapses.
If a static value of time is required (for example, the time when a report has
been executed or the retrieve has started), you can use a static text field that you
modify as follows:
//Set the time when the report was executed in
//the text field t_now
dw1.Modify("t_now.text='"+ String(Now(),"hh:mm")+"'")
//execute the report
dw1.retrieve()
See also If
Year
Now in the PowerScript Reference
Number
Description Converts a string to a number.
Syntax Number ( string )
string The string you want returned as a number
Return value A numeric datatype. Returns the contents of string as a number. If string is not
a valid number, Number returns 0.
Examples This expression converts the string 24 to a number:
Number("24")
This expression for a computed field tests whether the value in the age column
is greater than 55 and if so displays N/A; otherwise, it displays the value in age:
If(Number(age) > 55, "N/A", age)
This validation rule checks that the number the user entered is between 25,000
and 50,000:
Number(GetText())>25000 AND Number (GetText())<50000

Page
Page
Description Gets the number of the current page.
Syntax Page ( )
Return value Long. Returns the number of the current page.
Calculating the page count

The vertical size of the paper less the top and bottom margins is used to
calculate the page count. When the print orientation is landscape, the vertical
size of the paper is the shorter dimension. If the DataWindow object is not set
to print preview, then the size of the control determines the page number.
When Page() is in the header, it uses the first row currently visible on the page
to determine the page number. When it is in the footer, it uses the last row
currently visible. Therefore, it is possible for the values to be different.
Examples This expression returns the number of the current page:

Page()
In the DataWindow object’s footer band, this expression for a computed field
displays a string showing the current page number and the total number of
pages in the report. The result has the format Page n of total:
'Page ' + Page() + ' of ' + PageCount()
See also PageAbs
PageAcross
PageCount
PageCountAcross
PageAbs
Description Gets the absolute number of the current page.
Syntax PageAbs ( )
Return value Long. Returns the absolute number of the current page.
110 PowerBuilder
Usage Use this function for group reports that have ResetPageCount = yes. It returns
the absolute page number, ignoring the page reset count. This enables you to
number the grouped pages, but also to obtain the absolute page when the user
wants to print the current page, regardless of what that page number is in a
grouped page report.
Examples This expression returns the absolute number of the current page:
PageAbs()
This example obtains the absolute page number for the first row on the page in
the string variable ret:
string ret, row
row = dw1.Object.DataWindow.FirstRowOnPage
ret = dw1.Describe("Evaluate('pageabs()', "+row+")")
See also Page
PageCount
PageCountAcross
PageAcross
Description Gets the number of the current horizontal page. For example, if a report is twice
the width of the print preview window and the window is scrolled horizontally
to display the portion of the report that was outside the preview, PageAcross
returns 2 because the current page is the second horizontal page.
Syntax PageAcross ( )
Return value Long. Returns the number of the current horizontal page if it succeeds and –1
if an error occurs.
Examples This expression returns the number of the current horizontal page:
PageAcross()
See also Page
PageCount
PageCountAcross

PageCount
PageCount
Description Gets the total number of pages when a DataWindow object is being viewed in
Print Preview. This number is also the number of printed pages if the
DataWindow object is not wider than the preview window. If the DataWindow
object is wider than the preview window, the number of printed pages will be
greater than the number PageCount gets.
Syntax PageCount ( )
Return value Long. Returns the total number of pages.
Usage PageCount applies to Print Preview.
Calculating the page count

The vertical size of the paper less the top and bottom margins is used to
calculate the page count. When the print orientation is landscape, the vertical
size of the paper is the shorter dimension. If the DataWindow object is not set
to print preview, then the size of the control determines the page count.
Examples This expression returns the number of pages:

PageCount()
In the DataWindow object’s footer band, this expression for a computed field
displays a string showing the current page number and the total number of
pages in the report. The result has the format Page n of total:
'Page ' + Page() + ' of ' + PageCount()
See also Page
PageAcross
PageCountAcross
PageCountAcross
Description Gets the total number of horizontal pages that are wider than the Print Preview
window when a DataWindow object is viewed in Print preview.
Syntax PageCountAcross ( )
Return value Long. Returns the total number of horizontal pages if it succeeds and –1 if an
error occurs.
Usage PageCountAcross applies to Print Preview.
112 PowerBuilder
Examples This expression returns the number of horizontal pages in the Print Preview
window:
PageCountAcross()
See also Page
PageAcross
PageCount
Paint
Description Takes a string expression argument and returns the same string, allowing you
to paint inside a DataWindow object in a way that respect the position and z-
order of other DataWindow objects.
Syntax Paint ( expr )
expr Any valid DataWindow expression. It should contain a function
call to a drawing global function with rendering logic. If expr is a
string expression and the value is not null, the computed field will
render the evaluated string expression.
Return value String. The Paint expression function takes a string expression argument and
returns the same string.
Examples This example instantiates the drawing functions and, if the drawing function
returns false, the text “No Pie” displays.
Paint
(
MyDrawPieSlice
(
GetPaintDC()
GetPaintRectX()
GetPaintRectY()
GetPaintRectWidth()
GetPaintRectHeight()
GetRow()*100/RowCount()
)
)
Paint
(

Percent
MyDrawPieSlice
(
GetPaintDC(),
GetRow()*100/RowCount()
)
)
Paint
(
if MyDrawPieSlice(GetPaintDC()),"","No Pie")
)
Percent
Description Gets the percentage that the current value represents of the total of the values
in the column.
Syntax Percent ( column { FOR range { DISTINCT { expres1 {, expres2 {, ... } } } } } )
column The column for which you want the value of each row expressed as
a percentage of the total of the values of the column. Column can be
the column name or the column number preceded by a pound sign
(#). Column can also be an expression that includes a reference to
the column. The datatype of column must be numeric.
114 PowerBuilder
FOR range The data to be included in the percentage. For most presentation
• ALL – (Default) The percentage that the current value represents
of all rows in column.
• GROUP n – The percentage that the current value represents of
rows in column in the specified group. Specify the keyword
GROUP followed by the group number: for example, GROUP 1.
• PAGE – The percentage that the current value represents of the
rows in column on a page.
• CROSSTAB – (Crosstabs only) The percentage that the current
value represents of all rows in column in the crosstab.
• GRAPH – (Graphs only) The percentage that the current value
represents of values in column in the range specified for the
Rows option.
• OBJECT – (OLE objects only) The percentage that the current
value represents of values in column in the range specified for
the Rows option.
DISTINCT Causes Percent to consider only the distinct values in column when
(optional) determining the percentage. For a value of column, the first row
are ignored.
an expression.
Return value A numeric datatype (decimal, double, integer, long, or real). Returns the
percentage the current row of column represents of the total value of the
column.
Usage Usually you use Percent in a column to display the percentage for each row.
You can also use Percent in a header or trailer for a group. In the header,
Percent displays the percentage for the first value in the group, and in the
trailer, for the last value in the group.
If you specify range, Percent returns the percentage that the current row of
column represents relative to the total value of range. For example, if column
5 is salary, Percent(#5 for group 1) is equivalent to
salary/(Sum(Salary for group 1)).

Percent
If you specify DISTINCT, Percent returns the percent that a distinct value in
column represents of the total value of column. If you specify expresn, Percent
returns the percent that the value in column represents of the total for column
in a row in which the value of expresn is distinct.
Formatting the percent value

The percentage is displayed as a decimal value unless you specify a format for
the result. A display format can be part of the computed field’s definition.
Null values are ignored and are not considered in the calculation.
Not in validation rules, filter expressions, or crosstabs

You cannot use Percent or other aggregate functions in validation rules or filter
expressions. Percent does not work for crosstabs; specifying “for crosstab” as
a range is not available for Percent.

retrieves all rows.
Examples This expression returns the value of each row in the column named salary as a
percentage of the total of salary:
Percent(salary)
This expression returns the value of each row in the column named cost as a
percentage of the total of cost in group 2:
Percent(cost for group 2)
This expression entered in the Value box on the Data tab page in the Graph
Object property sheet returns the value of each row in the qty_ordered as a
percentage of the total for the column in the graph:
Percent(qty_ordered for graph)
116 PowerBuilder
items for each order, this computed field returns the order amount as a
percentage of the total order amount for the distinct order numbers:
Percent(order_amt for all DISTINCT order_nbr)
See also CumulativePercent
Pi
Description Multiplies pi by a specified number.
Syntax Pi ( n )
n The number you want to multiply by pi (3.14159265358979323...)
Return value Double. Returns the result of multiplying n by pi if it succeeds and –1 if an

error occurs.
Usage Use Pi to convert angles to and from radians.
Examples This expression returns pi:
Pi(1)
Both these expressions return the area of a circle with the radius Rad:
Pi(1) * Rad^2
Pi(Rad^2)
This expression computes the cosine of a 45-degree angle:
Cos(45.0 * (Pi(2)/360))
See also Cos
Sin
Tan
Pi in the PowerScript Reference
Pos
Description Finds one string within another string.

PosA
Syntax Pos ( string1, string2 {, start } )

start A long indicating where the search will begin in string. The default
(optional) is 1.
Return value Long. Returns a long whose value is the starting position of the first occurrence
of string2 in string1 after the position specified in start. If string2 is not found
in string1 or if start is not within string1, Pos returns 0.
Usage The Pos function is case-sensitive.
Examples This expression returns the position of the letter a in the value of the last_name
column:
Pos(last_name, "a")
Pos("BABE RUTH", "RU")
Pos("BABE RUTH", "B")
This expression returns 0 (because the case does not match):
Pos("BABE RUTH", "be")
This expression returns 0 (because it starts searching at position 5, after the
occurrence of BE):
Pos("BABE RUTH", "BE", 5)
See also LastPos
Left
Mid
PosA
Right
Pos in the PowerScript Reference
PosA
Description Finds one string within another string.
118 PowerBuilder
Syntax PosA ( string1, string2 {, start } )

start A long indicating the position in bytes where the search will begin
(optional) in string. The default is 1.
Return value Long. Returns a long whose value is the starting position of the first occurrence
of string2 in string1 after the position in bytes specified in start. If string2 is
not found in string1 or if start is not within string1, PosA returns 0.
Usage PosA replaces the functionality that Pos had in DBCS environments in
PowerBuilder 9. In SBCS environments, Pos and PosA return the same results.
See also LastPos
LeftA
MidA
Pos
RightA
PosA in the PowerScript Reference
ProfileInt
Description Obtains the integer value of a setting in the specified profile file.
Syntax ProfileInt ( filename, section, key, default )
filename A string whose value is the name of the profile file. If you do not
specify a full path, ProfileInt uses the operating system’s standard
file search order to find the file.
section A string whose value is the name of a group of related values in the
profile file. In the file, section names are in square brackets. Do not
include the brackets in section. Section is not case-sensitive.
key A string specifying the setting name in section whose value you
want. The setting name is followed by an equal sign in the file. Do
not include the equal sign in key. Key is not case-sensitive.
default An integer value that ProfileInt returns if filename is not found, if
section or key does not exist in filename, or if the value of key
cannot be converted to an integer.

ProfileString
Return value Integer. Returns default if filename is not found, section is not found in
filename, key is not found in section, or the value of key is not an integer.
Returns –1 if an error occurs.
Usage Use ProfileInt and ProfileString to get configuration settings from a profile file
you have designed for your application. ProfileInt and ProfileString can read files
with ANSI or UTF16-LE encoding on Windows systems, and ANSI or
UTF16-BE encoding on UNIX systems.
Using a DataWindow object in different environments

PowerBuilder You can use PowerScript SetProfileString to change values in
the profile file to customize your application’s configuration at runtime. Before
you make changes, you can use ProfileInt and ProfileString to obtain the original
settings so you can optionally restore them when the user exits the application.
Web control ProfileInt always returns the value of default. It does not open a
file on the user’s machine; doing so would be a security violation.
Examples This example uses the following PROFILE.INI file:

[MyApp]
Maximized=1
[Security]
Class = 7
This expression tries to return the integer value of the keyword Minimized in
section MyApp of file C:\PROFILE.INI. It returns 3 if there is no MyApp
section or no Minimized keyword in the MyApp section. Based on the sample
file above, it returns 3:
ProfileInt("C:\PROFILE.INI", "MyApp", "minimized", 3)
See also ProfileString
ProfileInt in the PowerScript Reference
ProfileString
Description Obtains the string value of a setting in the specified profile file.
Syntax ProfileString ( filename, section, key, default )
120 PowerBuilder
filename A string whose value is the name of the profile file. If you do not
specify a full path, ProfileString uses the operating system’s
standard file search order to find the file.
section A string whose value is the name of a group of related values in the
profile file. In the file, section names are in square brackets. Do not
include the brackets in section. Section is not case-sensitive.
key A string specifying the setting name in section whose value you
want. The setting name is followed by an equal sign in the file. Do
not include the equal sign in key. Key is not case-sensitive.
default A string value that ProfileString returns if filename is not found, if
section or key does not exist in filename, or if the value of key
cannot be converted to an integer.
Return value String, with a maximum length of 4096 characters. Returns the string from key
within section within filename. If filename is not found, section is not found in
filename, or key is not found in section, ProfileString returns default. If an error
occurs, it returns the empty string (“”).
Usage Use ProfileInt and ProfileString to get configuration settings from a profile file
you have designed for your application. ProfileInt and ProfileString can read files
with ANSI or UTF16-LE encoding on Windows systems, and ANSI or UTF16-
BE encoding on UNIX systems.
Using a DataWindow object in different environments

PowerBuilder You can use PowerScript SetProfileString to change values in
the profile file to customize your application’s configuration at runtime. Before
you make changes, you can use ProfileInt and ProfileString to obtain the original
settings so you can optionally restore them when the user exits the application.
Web control ProfileString always returns the value of default. It does not
open a file on the user’s machine; doing so would be a security violation.
Examples This example uses the following section in the PROFILE.INI file:
[Employee]
Name="Smith"
[Dept]
Name="Marketing"
This expression returns the string for the keyword Name in section Employee
in file C:\PROFILE.INI. It returns None if the section or keyword does not
exist. In this case it returns Smith:

Rand
ProfileString("C:\PROFILE.INI", "Employee", "Name",

"None")
See also ProfileInt
ProfileString in the PowerScript Reference
SetProfileString in the PowerScript Reference
Rand
Description Obtains a random whole number between 1 and a specified upper limit.
Syntax Rand ( n )
n The upper limit of the range of random numbers you want returned.
The lower limit is always 1. The upper limit cannot exceed 32,767.
Return value A numeric datatype, the datatype of n. Returns a random whole number
between 1 and n.
Usage The sequence of numbers generated by repeated calls to the Rand function is a
computer-generated pseudorandom sequence.
You can control whether the sequence is different each time your application
runs by calling the PowerScript Randomize function to initialize the random
number generator.
Examples This expression returns a random whole number between 1 and 10:
Rand(10)
See also Rand in the PowerScript Reference
Randomize in the PowerScript Reference
Real
Description Converts a string value to a real datatype.
Syntax Real ( string )
string The string whose value you want to convert to a real
122 PowerBuilder
Return value Real. Returns the contents of a string as a real. If string is not a valid number,
Real returns 0.
Examples This expression converts 24 to a real:
Real("24")
This expression returns the value in the column temp_text as a real:
Real(temp_text)
See also Real in the PowerScript Reference
RelativeDate
Description Obtains the date that occurs a specified number of days after or before another
date.
Syntax RelativeDate ( date, n )
date A date value
n An integer indicating the number of days
Return value Date. Returns the date that occurs n days after date if n is greater than 0.
Returns the date that occurs n days before date if n is less than 0.
Examples This expression returns 2005-02-10:
RelativeDate(2005-01-31, 10)
This expression returns 2005-01-21:
RelativeDate(2005-01-31, -10)
See also DaysAfter
RelativeDate in the PowerScript Reference
RelativeTime
Description Obtains a time that occurs a specified number of seconds after or before
another time within a 24-hour period.
Syntax RelativeTime ( time, n )

Replace
time A time value
n A long number of seconds
Return value Time. Returns the time that occurs n seconds after time if n is greater than 0.
Returns the time that occurs n seconds before time if n is less than 0. The
maximum return value is 23:59:59.
Examples This expression returns 19:01:41:
RelativeTime(19:01:31, 10)
This expression returns 19:01:21:
RelativeTime(19:01:31, -10)
See also SecondsAfter
RelativeTime in the PowerScript Reference
Replace
Description Replaces a portion of one string with another.
Syntax Replace ( string1, start, n, string2 )
string1 The string in which you want to replace characters with string2.
start A long whose value is the number of the first character you want
replaced. (The first character in the string is number 1.)
n A long whose value is the number of characters you want to replace.
string2 The string that replaces characters in string1. The number of
characters in string2 can be greater than, equal to, or fewer than the
number of characters you are replacing.
Return value String. Returns the string with the characters replaced if it succeeds and the
empty string (“”) if it fails.
Usage If the start position is beyond the end of the string, Replace appends string2 to
string1. If there are fewer characters after the start position than specified in n,
Replace replaces all the characters to the right of character start.
If n is zero, then in effect Replace inserts string2 into string1.
124 PowerBuilder
Examples This expression changes the last two characters of the string David to e to make
it Dave:
Replace("David", 4, 2, "e")
This expression returns MY HOUSE:
Replace("YOUR HOUSE", 1, 4, "MY")
This expression returns Closed for the Winter:
Replace("Closed for Vacation", 12, 8, "the Winter")
See also ReplaceA
Replace in the PowerScript Reference
ReplaceA
Description Replaces a portion of one string with another.
Syntax ReplaceA ( string1, start, n, string2 )
string1 The string in which you want to replace bytes with string2.
start A long whose value is the number of the first byte you want
replaced. (The first byte in the string is number 1.)
n A long whose value is the number of bytes you want to replace.
string2 The string that replaces bytes in string1. The number of bytes in
string2 can be greater than, equal to, or fewer than the number of
bytes you are replacing.
Return value String. Returns the string with the bytes replaced if it succeeds and the empty
string (“”) if it fails.
Usage If the start position is beyond the end of the string, ReplaceA appends string2
to string1. If there are fewer bytes after the start position than specified in n,
ReplaceA replaces all the bytes to the right of character start.
If n is zero, then in effect ReplaceA inserts string2 into string1.

ReplaceA replaces the functionality that Replace had in DBCS environments in
PowerBuilder 9. In SBCS environments, Replace and ReplaceA return the
same results.
See also Replace
ReplaceA in the PowerScript Reference

RGB
RGB
Description Calculates the long value that represents the color specified by numeric values
for the red, green, and blue components of the color.
Syntax RGB ( red, green, blue )
red The integer value of the red component of the color
green The integer value of the green component of the color
blue The integer value of the blue component of the color
Return value Long. Returns the long that represents the color created by combining the
values specified in red, green, and blue. If an error occurs, RGB returns null.
Usage The formula for combining the colors is:
Red + (256 * Green) + (65536 * Blue)
Use RGB to obtain the long value required to set the color for text and drawing
objects. You can also set an object’s color to the long value that represents the
color. The RGB function provides an easy way to calculate that value.
Determining color components The value of a component color is an
integer between 0 and 255 that represents the amount of the component that is
required to create the color you want. The lower the value, the darker the color;
the higher the value, the lighter the color.
The following table lists red, green, and blue values for the 16 standard colors:
Color Red value Green value Blue value
Black 0 0 0
White 255 255 255
Light Gray 192 192 192
Dark Gray 128 128 128
Red 255 0 0
Dark Red 128 0 0
Green 0 255 0
Dark Green 0 128 0
Blue 0 0 255
Dark Blue 0 0 128
Magenta 255 0 255
Dark Magenta 128 0 128
Cyan 0 255 255
Dark Cyan 0 128 128
126 PowerBuilder
Color Red value Green value Blue value

Yellow 255 255 0
Brown 128 128 0
Examples This expression returns as a long 8421376, which represents dark cyan:
RGB(0,128,128)
This expression for the Background.Color property of a salary column returns
a long that represents red if an employee’s salary is greater than $50,000 and
white if salary is less than or equal to $50,000:
If(salary>50000, RGB(255,0,0), RGB(255,255,255))
RGB in the PowerScript Reference
RichText
Description Takes as argument a string expression interpreted as RTF and renders it as such.
If the argument is not RTF nothing is rendered.
Syntax RichText ( string )
string The string expression to render as RTF
Return value None.

Examples This expression displays the contents of the short_desc column’s as rich text.
RichText( short_desc )
RichTextFile
Description Takes as argument a string expression interpreted as a RTF file name and
renders the contents. If the argument is not a RTF file nothing is rendered.
Syntax RichTextFile ( string )

Right
string The string expression to render as RTF file
Return value None.

Examples This expression displays the contents of the richtext.rtf file as rich text.
RichTextFile("richtext.rtf")
Right
Description Obtains a specified number of characters from the end of a string.
Syntax Right ( string, n )
string The string from which you want characters returned
n A long whose value is the number of characters you want returned
from the right end of string
Return value String. Returns the rightmost n characters in string if it succeeds and the empty
If n is greater than or equal to the length of the string, Right returns the entire
Examples This expression returns HILL:
Right("CASTLE HILL", 4)
This expression returns CASTLE HILL:
Right("CASTLE HILL", 75)
See also Left
Mid
Pos
Right in the PowerScript Reference
RightA
Description Obtains a specified number of characters from the end of a string.
128 PowerBuilder
Syntax Right ( string, n )

string The string from which you want characters returned
n A long whose value is the number of characters you want returned
from the right end of string
Return value String. Returns the rightmost n characters in string if it succeeds and the empty
If n is greater than or equal to the length of the string, RightA returns the entire
Usage RightA replaces the functionality that Right had in DBCS environments in
PowerBuilder 9. In SBCS environments, Right and RightA return the same
results.
See also LeftA
MidA
PosA
Right
RightTrim
Description Removes spaces from the end of a string.
Syntax RightTrim ( string )
string The string you want returned with trailing blanks deleted
Return value String. Returns a copy of string with trailing blanks deleted if it succeeds and
Examples This expression returns RUTH:
RightTrim("RUTH ")
See also LeftTrim
Trim
RightTrim in the PowerScript Reference

Round
Round
Description Rounds a number to the specified number of decimal places.
Syntax Round ( x , n )
x The number you want to round.
n The number of decimal places to which you want to round x. Valid
values are 0 through 28.
Return value Decimal. If n is positive, Round returns x rounded to the specified number of
decimal places. If n is negative, it returns x rounded to (- n +1) places before
the decimal point. Returns –1 if it fails.
Round(9.624, 2)
Round(9.625, 2)
Round(9.6, 3)
This expression returns -9.63:
Round(-9.625, 2)
Round(-9.625, -1)
See also Ceiling
Int
Truncate
Round in the PowerScript Reference
RowCount
Description Obtains the number of rows that are currently available in the primary buffer.
Syntax RowCount ( )
Return value Long. Returns the number of rows that are currently available, 0 if no rows are
currently available, and –1 if an error occurs.
130 PowerBuilder
Examples This expression in a computed field returns a warning if no data exists and the
number of rows if there is data:
If(RowCount() = 0, "No Data", String(RowCount()))
See also RowCount on page 754
RowHeight
Description Reports the height of a row associated with a band in a DataWindow object.
Syntax RowHeight ( )
Return value Long. Returns the height of the row in the units specified for the DataWindow
object if it succeeds, and –1 if an error occurs.
Usage When you call RowHeight in a band other than the detail band, it reports on a
row in the detail band. See GetRow for a table specifying which row is
associated with each band for reporting purposes.
When a band has Autosize Height set to true, you should avoid using the
RowHeight DataWindow expression function to set the height of any element
in the row. Doing so can result in a logical inconsistency between the height of
the row and the height of the element. If you need to use RowHeight, you must
set the Y coordinate of the element to 0 on the Position page in the Properties
view, otherwise the bottom of the element might be clipped. You must do this
for every element that uses such an expression. If you move any elements in
the band, make sure that their Y coordinates are still set to 0.
You should not use an expression whose runtime value is greater than the value
returned by RowHeight. For example, you should not set the height of a column
to rowheight() + 30. Such an expression produces unpredictable results at
runtime.
Examples This expression for a computed field in the detail band displays the height of
each row:
RowHeight()
See also GetRow

Second
Second
Description Obtains the number of seconds in the seconds portion of a time value.
Syntax Second ( time )
time The time value from which you want the seconds
Return value Integer. Returns the seconds portion of time (00 to 59).
Second(19:01:31)
See also Hour
Minute
Second in the PowerScript Reference
SecondsAfter
Description Gets the number of seconds one time occurs after another.
Syntax SecondsAfter ( time1, time2 )
time1 A time value that is the start time of the interval being measured
time2 A time value that is the end time of the interval
Return value Long. Returns the number of seconds time2 occurs after time1. If time2 occurs
before time1, SecondsAfter returns a negative number.
SecondsAfter(21:15:30, 21:15:45)
SecondsAfter(21:15:45, 21:15:30)
SecondsAfter(21:15:45, 21:15:45)
See also DaysAfter
SecondsAfter in the PowerScript Reference
132 PowerBuilder
Sign
Description Reports whether the number is negative, zero, or positive by checking its sign.
Syntax Sign ( n )
n The number for which you want to determine the sign
Return value Integer. Returns a number (–1, 0, or 1) indicating the sign of n.

Examples This expression returns 1 (the number is positive):
Sign(5)
Sign(0)
This expression returns –1 (the number is negative):
Sign(-5)
See also Sign in the PowerScript Reference
Sin
Description Calculates the sine of an angle.
Syntax Sin ( n )
n The angle (in radians) for which you want the sine
Return value Double. Returns the sine of n if it succeeds and –1 if an error occurs.
Examples This expression returns .8414709848078965:
Sin(1)
Sin(0)
Sin(pi(1))
See also Cos
Pi

Small
Tan
Sin in the PowerScript Reference
Small
Description Finds a small value at a specified ranking in a column (for example, third-
smallest, fifth-smallest) and returns the value of another column or expression
based on the result.
Syntax Small ( returnexp, column, nbottom { FOR range { DISTINCT { expres1
{, expres2 {, ... } } } } } )
returnexp The value you want returned when the small value is found.
Returnexp includes a reference to a column, but not necessarily the
column that is being evaluated for the small value, so that a value is
returned from the same row that contains the small value.
column The column that contains the small value you are searching for.
Column can be a column name or a column number preceded by a
pound sign (#). Column can also be an expression that includes a
reference to the column. The datatype of column must be numeric.
nbottom The relationship of the small value to the column’s smallest value.
For example, when nbottom is 2, Small finds the second-smallest
value.
FOR range The data that will be included when finding the small value. For
• ALL – (Default) The small value of all rows in column.
• GROUP n – The small value of rows in column in the specified
• PAGE – The small value of the rows in column on a page.
• CROSSTAB – (Crosstabs only) The small value of all rows in
• GRAPH – (Graphs only) The small value in column in the range
specified for the Rows option.
• OBJECT – (OLE objects only) The small value in column in the
134 PowerBuilder
DISTINCT Causes Small to consider only the distinct values in column when
(optional) determining the small value. For a value of column, the first row
are ignored.
an expression.
Return value The datatype of returnexp. Returns the nbottom-smallest value if it succeeds
and -1 if an error occurs.
Usage If you specify range, Small returns the value in returnexp when the value in
column is the nbottom-smallest value in range. If you specify DISTINCT,
Small returns returnexp when the value in column is the nbottom-smallest value
of the distinct values in column, or if you specify expresn, the
nbottom-smallest for each distinct value of expresn.
that range.
Min might be faster If you do not need a return value from another column
and you want to find the smallest value (nbottom = 1), use Min; it is faster.
Not in validation rules or filter expressions You cannot use this or other
aggregate functions in validation rules or filter expressions.

retrieves all rows.
Examples These expressions return the names of the salespersons with the three smallest
sales (sum_sales is the sum of the sales for each salesperson) in group 2, which
might be the salesregion group. Note that sum_sales contains the values being
compared, but Small returns a value in the name column:

Space
Small(name, sum_sales, 1 for group 2)

This example reports the salesperson with the third-smallest sales, considering
only the first entry for each salesperson:
Small(name, sum_sales, 3 for all DISTINCT sum_sales)
See also Large
Space
Description Builds a string of the specified length whose value consists of spaces.
Syntax Space ( n )
n A long whose value is the length of the string you want filled with
spaces
Return value String. Returns a string filled with n spaces if it succeeds and the empty string
(“”) if an error occurs.
Examples This expression for a computed field returns 10 spaces in the computed field if
the value of the rating column is Top Secret; otherwise, it returns the value in
rating:
If(rating = "Top Secret", Space(10), rating)
See also Fill
Space in the PowerScript Reference
Sqrt
Description Calculates the square root of a number.
Syntax Sqrt ( n )
n The number for which you want the square root
Return value Double. Returns the square root of n.
136 PowerBuilder
Usage Sqrt(n) is the same as n ^.5.

Taking the square root of a negative number causes an execution error.
Sqrt(2)
This expression results in an error at execution time:
Sqrt(-2)
See also Sqrt in the PowerScript Reference
StDev
Description Calculates an estimate of the standard deviation for the specified column.
Standard deviation is a measurement of how widely values vary from average.
Syntax StDev ( column { FOR range { DISTINCT { expres1 {, expres2 {, ... } } } } } )
column The column for which you want an estimate for the standard
deviation of the values in the rows. Column can be the column name
or the column number preceded by a pound sign (#). Column can
also be an expression that includes a reference to the column. The
datatype of column must be numeric.
FOR range The data to be included in the estimate of the standard deviation.
(optional) For most presentation styles, values for range are:
• ALL – (Default) The estimate of the standard deviation for all
values in column.
• GROUP n – The estimate of the standard deviation for values in
column in the specified group. Specify the keyword GROUP
followed by the group number: for example, GROUP 1.
• PAGE – The estimate of the standard deviation for the values in
column on a page.
For Crosstabs, specify CROSSTAB for range to indicate the
standard deviation for all values in column in the crosstab.
For Graph objects specify GRAPH and for OLE objects specify
OBJECT to indicate the standard deviation for values in column in

StDev
DISTINCT Causes StDev to consider only the distinct values in column when
(optional) determining the standard deviation. For a value of column, the first
value are ignored.
an expression.
Return value Double. Returns an estimate of the standard deviation for column.
Usage If you specify range, StDev returns an estimate for the standard deviation of
column within range. If you specify DISTINCT, StDev returns an estimate of
the standard deviation for the distinct values in column, or if you specify
expresn, the estimate of the standard deviation of the rows in column where the
Data tab page (the Range property), and the aggregation function uses that
range. Settings for Rows include the following:
Estimating or calculating actual standard deviation StDev assumes that

the values in column are a sample of the values in the rows in the column in the
database table. If you selected all the rows in the column in the DataWindow
object’s SELECT statement, use StDevP to compute the standard deviation of
the population.

retrieves all rows.
Examples These examples all assume that the SELECT statement did not retrieve all the
rows in the database table. StDev is intended to work with a subset of rows,
which is a sample of the full set of data.
138 PowerBuilder
This expression returns an estimate for standard deviation of the values in the
StDev(salary)
This expression returns an estimate for standard deviation of the values in the
column named salary in group 1:
StDev(salary for group 1)
This expression returns an estimate for standard deviation of the values in
column 4 on the page:
StDev(#4 for page)
This expression entered in the Value box on the Data tab page in the graph’s
property sheet returns an estimate for standard deviation of the values in the
qty_used column in the graph:
StDev(qty_used for graph)
This expression for a computed field in a crosstab returns the estimate for
standard deviation of the values in the qty_ordered column in the crosstab:
StDev(qty_ordered for crosstab)
items for each order, this computed field returns the estimated standard
deviation of the order amount for the distinct order numbers:
StDev(order_amt for all DISTINCT order_nbr)
See also StDevP
Var
StDevP
Description Calculates the standard deviation for the specified column. Standard deviation
is a measurement of how widely values vary from average.
Syntax StDevP ( column { FOR range { DISTINCT { expres1 {, expres2 {, ... } } } } } )

StDevP
column The column for which you want the standard deviation of the values
in the rows. Column can be the column name or the column number
preceded by a pound sign (#). Column can also be an expression
that includes a reference to the column. The datatype of column
must be numeric.
FOR range The data to be included in the standard deviation. For most
• ALL – (Default) The standard deviation for all values in column.
• GROUP n – The standard deviation for values in column in the
• PAGE – The standard deviation for the values in column on a
page.
For Crosstabs, specify CROSSTAB for range to indicate the
standard deviation for all values in column in the crosstab.
For Graph objects specify GRAPH and for OLE objects specify
OBJECT to indicate the standard deviation for values in column in
DISTINCT Causes StDevP to consider only the distinct values in column when
(optional) determining the standard deviation. For a value of column, the first
value are ignored.
an expression.
Return value Double. Returns the standard deviation for column.

Usage If you specify range, StDevP returns the standard deviation for column within
range. If you specify DISTINCT, StDevP returns an estimate of the standard
deviation for the distinct values in column, or if you specify expresn, the
estimate of the standard deviation of the rows in column where the value of
Data tab page (the Range property), and the aggregation function uses that
range. Settings for Rows include the following:
140 PowerBuilder
Estimating or calculating actual standard deviation StDevP assumes that

the values in column are the values in all the rows in the column in the database
table. If you did not select all rows in the column in the SELECT statement, use
StDev to compute an estimate of the standard deviation of a sample.

retrieves all rows.
Examples These examples all assume that the SELECT statement retrieved all rows in the
database table. StDevP is intended to work with a full set of data, not a subset.
This expression returns the standard deviation of the values in the column
named salary:
StDevP(salary)
This expression returns the standard deviation of the values in group 1 in the
StDevP(salary for group 1)
This expression returns the standard deviation of the values in column 4 on the
page:
StDevP(#4 for page)
This expression entered in the Value box on the Data tab page in the graph’s
property sheet returns the standard deviation of the values in the qty_ordered
column in the graph:
StDevP(qty_ordered for graph)
This expression for a computed field in a crosstab returns the standard
deviation of the values in the qty_ordered column in the crosstab:
StDevP(qty_ordered for crosstab)
items for each order, this computed field returns the standard deviation of the
order amount for the distinct order numbers:
StDevP(order_amt for all DISTINCT order_nbr)

String
See also StDev

VarP
String
Description Formats data as a string according to a specified display format mask. You can
convert and format date, DateTime, numeric, and time data. You can also apply
a display format to a string.
Syntax String ( data {, format } )
data The data you want returned as a string with the specified formatting.
Data can have a date, DateTime, numeric, time, or string datatype.
format A string of the display masks you want to use to format the data.
(optional) The masks consist of formatting information specific to the
datatype of data. If data is type string, format is required.
The format string can consist of more than one mask, depending on
the datatype of data. Each mask is separated by a semicolon. See
Usage for details on each datatype.
Return value String. Returns data in the specified format if it succeeds and the empty string
(“”) if the datatype of data does not match the type of display mask specified
or format is not a valid mask.
Usage For date, DateTime, numeric, and time data, the system’s default format is used
for the returned string if you do not specify a format. For numeric data, the
default format is the [General] format.
For string data, a display format mask is required. (Otherwise, the function
would have nothing to do.)
The format can consist of one or more masks:
• Formats for date, DateTime, string, and time data can include one or two
masks. The first mask is the format for the data; the second mask is the
format for a null value.
• Formats for numeric data can have up to four masks. A format with a
single mask handles both positive and negative data. If there are additional
masks, the first mask is for positive values, and the additional masks are
for negative, zero, and null values.
A format can include color specifications.
142 PowerBuilder
If the display format does not match the datatype, the attempt to apply the mask
produces unpredictable results.
For information on specifying display formats, see the Users Guide.
When you use String to format a date and the month is displayed as text (for
example, when the display format includes “mmm”), the month is in the
language of the deployment files available when the application is run. If you
have installed localized files in the development environment or on a user’s
machine, then on that machine the month in the resulting string will be in the
language of the localized files.
For information about localized deployment files, see the chapter on
internationalizing an application in Application Techniques.
Examples This expression returns Jan 31, 2005:
String(2005-01-31, "mmm dd, yyyy")
This expression returns Jan 31, 2005 6 hrs and 8 min:
String(2005-01-31 06:08:00, 'mmm dd, yyyy, h "hrs
and" m "min"')
This expression:
String(nbr, "0000;(000);****;empty")
returns:
0123 if nbr is 123
(123) if nbr is -123
**** if nbr is 0
empty if nbr is null
This expression returns A-B-C:
String("ABC", "@-@-@")
This expression returns A*B:
String("ABC", "@*@")
This expression returns ABC:
String("ABC", "@@@")
This expression returns a space:
String("ABC", " ")
This expression returns 6 hrs and 8 min:
String(06:08:02,'h "hrs and" m "min"')

StripRTF
This expression returns 08:06:04 pm:

String(20:06:04, "hh:mm:ss am/pm")
This expression returns 8:06:04 am:
String(08:06:04, "h:mm:ss am/pm")
This expression returns 6:11:25.300000:
String(6:11:25.300000, "h:mm:ss.ffffff")
See also String in the PowerScript Reference
StripRTF
Description Removes the rich text formatting from the specified column
Syntax StripRTF ( string )
string The column to be stripped of rich text formatting.
Examples This expression is used in a compute field expression to remove the formatting
from a rich text edit column and display plain text in the compute field.
StripRTF(rte_description)
Sum
Description Calculates the sum of the values in the specified column.
Syntax Sum ( column { FOR range { DISTINCT { expres1 {, expres2 {, ... } } } } } )
column The column for which you want the sum of the data values. Column
can be the column name or the column number preceded by a pound
144 PowerBuilder
FOR range The data to be included in the sum. For most presentation styles,
(optional) values for range are:
• ALL – (Default) The sum of all values in column.
• GROUP n – The sum of values in column in the specified group.
example, GROUP 1.
• PAGE – The sum of the values in column on a page.
• CROSSTAB – (Crosstabs only) The sum of all values in column
in the crosstab.
• GRAPH – (Graphs only) The sum of values in column in the
range specified for the Rows option of the graph.
• OBJECT – (OLE objects only) The sum of values in column in
the range specified for the Rows option of the OLE object.
DISTINCT Causes Sum to consider only the distinct values in column when
(optional) determining the sum. For a value of column, the first row found
ignored.
an expression.
Return value The appropriate numeric datatype. Returns the sum of the data values in
column.
Usage If you specify range, Sum returns the sum of the values in column within
range. If you specify DISTINCT, Sum returns the sum of the distinct values in
column, or if you specify expresn, the sum of the values of column where the
Null values are ignored and are not included in the calculation.

Tan

expressions.

retrieves all rows.
Examples This expression returns the sum of the values in group 1 in the column named
salary:
Sum(salary for group 1)
This expression returns the sum of the values in column 4 on the page:
Sum(#4 for page)
items for each order, this computed field returns the sum of the order amount
for the distinct order numbers:
Sum(order_amt for all DISTINCT order_nbr)
Example 2: counting male and female employees on page 21
Tan
Description Calculates the tangent of an angle.
Syntax Tan ( n )
n The angle (in radians) for which you want the tangent
Return value Double. Returns the tangent of n if it succeeds and –1 if an error occurs.
Examples Both these expressions return 0:
Tan(0)
Tan(Pi(1))
Tan(1)
146 PowerBuilder
See also Cos

Pi
Sin
Tan in the PowerScript Reference
Time
Description Converts a string to a time datatype.
Syntax Time ( string )
string A string containing a valid time (such as 8 AM or 10:25) that you
want returned as a time datatype. Only the hour is required; you do
not have to include the minutes, seconds, or microseconds of the
time or AM or PM. The default value for minutes and seconds is 00
and for microseconds is 000000. AM or PM is determined
automatically.
Return value Time. Returns the time in string as a time datatype. If string does not contain a
valid time, Time returns 00:00:00.
Examples This expression returns the time datatype for 45 seconds before midnight
(23:59:15):
Time("23:59:15")
This expression for a computed field returns the value in the time_received
column as a value of type time if time_received is not the empty string.
Otherwise, it returns 00:00:00:
If(time_received = "" ,00:00:00,
Time(time_received))
This example is similar to the previous one, except that it returns 00:00:00 if
time_received contains a null value:
If(IsNull(time_received), 00:00:00,
Time(time_received))
See also Time in the PowerScript Reference

Today
Today
Description Obtains the system date and time.
Syntax Today ( )
Return value DateTime. Returns the current system date and time.
Usage To display both the date and the time, a computed field must have a display
format that includes the time.
The PowerScript and DataWindow painter versions of the Today function have
different datatypes. The return value of the PowerScript Today function is date.
Examples This expression for a computed field displays the date and time when the
display format for the field is "mm/dd/yy hh:mm":
Today()
See also Now
Today in the PowerScript Reference
Trim
Description Removes leading and trailing spaces from a string.
Syntax Trim ( string )
string The string you want returned with leading and trailing spaces
deleted
Return value String. Returns a copy of string with all leading and trailing spaces deleted if it
Usage Trim is useful for removing spaces that a user might have typed before or after
newly entered data.
Examples This expression returns BABE RUTH:
Trim(" BABE RUTH ")
See also LeftTrim
RightTrim
Trim in the PowerScript Reference
148 PowerBuilder
Truncate
Description Truncates a number to the specified number of decimal places.
Syntax Truncate ( x, n )
x The number you want to truncate.
n The number of decimal places to which you want to truncate x.
Valid values are 0 through 28.
Return value The datatype of x. If n is positive, returns x truncated to the specified number
of decimal places. If n is negative, returns x truncated to (- n +1) places before
the decimal point. Returns –1 if it fails.
Truncate(9.22, 1)
Truncate(9.28, 1)
Truncate(9.9, 0)
This expression returns -9.2:
Truncate(–9.29, 1)
Truncate(9.2, –1)
Truncate(54, –1)
See also Ceiling
Int
Round
Truncate in the PowerScript Reference
Upper
Description Converts all characters in a string to uppercase letters.
Syntax Upper ( string )

Var
string The string you want to convert to uppercase letters
Return value String. Returns string with lowercase letters changed to uppercase if it
Examples This expression returns BABE RUTH:
Upper("Babe Ruth")
See also Lower
Upper in the PowerScript Reference
Var
Description Calculates an estimate of the variance for the specified column. The variance
is the square of the standard deviation.
Syntax Var ( column { FOR range { DISTINCT { expres1 {, expres2 {, ... } } } } } )
column The column for which you want an estimate for the variance of the
values in the rows. Column can be the column name or the column
number preceded by a pound sign (#). Column can also be an
expression that includes a reference to the column. The datatype of
column must be numeric.
150 PowerBuilder
FOR range The data to be included in the estimate of the variance. For most
• ALL – (Default) The estimate of the variance for all rows in
column.
• GROUP n – The estimate of the variance for rows in column in
the specified group. Specify the keyword GROUP followed by
the group number: for example, GROUP 1.
• PAGE – The estimate of the variance for the rows in column on
a page.
• CROSSTAB – (Crosstabs only) The estimate of the variance for
all rows in column in the crosstab.
• GRAPH – (Graphs only) The estimate of the variance for rows
in column in the range specified for the Rows option.
• OBJECT – (OLE objects only) The estimate of the variance for
rows in column in the range specified for the Rows option.
DISTINCT Causes Var to consider only the distinct values in column when
(optional) determining the variance. For a value of column, the first row found
ignored.
an expression.
Return value Double or decimal if the arguments are decimal. Returns an estimate for the
variance for column. If you specify group, Var returns an estimate for the
variance for column within group.
Usage If you specify range, Var returns an estimate for the variance for column within
range. If you specify DISTINCT, Var returns the variance for the distinct
values in column, or if you specify expresn, the estimate for the variance of the
rows in column where the value of expresn is distinct.
that range.

Var

Estimating variance or calculating actual variance

Var assumes that the values in column are a sample of the values in rows in the
column in the database table. If you select all rows in the column in the
SELECT statement, use VarP to compute the variance of a population.

expressions.

retrieves all rows.
Examples These examples all assume that the SELECT statement did not retrieve all of
the rows in the database table. Var is intended to work with a subset of rows,
which is a sample of the full set of data.
This expression returns an estimate for the variance of the values in the column
named salary:
Var(salary)
This expression returns an estimate for the variance of the values in the column
named salary in group 1:
Var(salary for group 1)
This expression entered in the Value box on the Data property page in the
graph’s property sheet returns an estimate for the variance of the values in the
quantity column in the graph:
Var(quantity for graph)
This expression for a computed field in a crosstab returns an estimate for the
variance of the values in the quantity column in the crosstab:
Var(quantity for crosstab)
items for each order, this computed field returns the estimate for the variance
of the order amount for the distinct order numbers:
152 PowerBuilder
Var(order_amt for all DISTINCT order_nbr)

See also StDev
VarP
VarP
Description Calculates the variance for the specified column. The variance is the square of
the standard deviation.
Syntax VarP ( column { FOR range { DISTINCT { expres1 {, expres2 {, ... } } } } } )
column The column for which you want the variance of the values in the
rows. Column can be the column name or the column number
preceded by a pound sign (#). Column can also be an expression
that includes a reference to the column. The datatype of column
must be numeric.
FOR range The data that will be included in the variance. For most presentation
• ALL – (Default) The variance for all rows in column.
• GROUP n – The variance for rows in column in the specified
• PAGE – The variance for the rows in column on a page.
• CROSSTAB – (Crosstabs only) The variance for all rows in
• GRAPH – (Graphs only) The variance for rows in column in the
• OBJECT – (OLE objects only) The variance for rows in column
DISTINCT Causes VarP to consider only the distinct values in column when
(optional) determining the variance. For a value of column, the first row found
ignored.
an expression.

VarP
Return value Double or decimal if the arguments are decimal. Returns the variance for
column. If you specify group, Var returns the variance for column within range.
Usage If you specify range, VarP returns the variance for column within range. If you
specify DISTINCT, VarP returns the variance for the distinct values in column,
or if you specify expresn, the variance of the rows in column where the value
of expresn is distinct.
Estimating variance or calculating actual variance

VarP assumes that the values in column are the values in all rows in the column
in the database table. If you did not select all the rows in the column in the
SELECT statement, use Var to compute an estimate of the variance of a sample.

expressions.

retrieves all rows.
Examples These examples all assume that the SELECT statement retrieved all rows in the
database table. VarP is intended to work with a full set of data, not a subset.
This expression returns the variance of the values in the column named salary:
VarP(salary)
This expression returns the variance of the values in group 1 in the column
named salary:
VarP(salary for group 1)
This expression returns the variance of the values in column 4 on the page:
154 PowerBuilder
VarP(#4 for page)

This expression entered in the Value box on the Data property page in the
graph’s property sheet returns the variance of the values in the quantity column
in the graph:
VarP(quantity for graph)
This expression for a computed field in a crosstab returns the variance of the
values in the quantity column in the crosstab:
VarP(quantity for crosstab)
items for each order, this computed field returns the variance of the order
VarP(order_amt for all DISTINCT order_nbr)
See also StDevP
Var
WordCap
Description Sets the first letter of each word in a string to a capital letter and all other letters
to lowercase (for example, ROBERT E. LEE would be Robert E. Lee).
Syntax WordCap ( string )
string A string or expression that evaluates to a string that you want to
display with initial capital letters (for example, Monday Morning)
Return value String. Returns string with the first letter of each word set to uppercase and the
remaining letters lowercase if it succeeds, and null if an error occurs.
Examples This expression returns Boston, Massachusetts:
WordCap("boston, MASSACHUSETTS")
This expression concatenates the characters in the emp_fname and emp_lname
columns and makes the first letter of each word uppercase:
WordCap(emp_fname + " " + emp_lname)

Year
Year
Description Gets the year of a date value.
Syntax Year ( date )
date The date value from which you want the year
Return value Integer. Returns an integer whose value is a 4-digit year adapted from the year
portion of date if it succeeds and 1900 if an error occurs.
If the year is two digits, then the century is set as follows. If the year is between
00 to 49, the first two digits are 20; if the year is between 50 and 99, the first
two digits are 19.
Usage Obtains the year portion of date. Years from 1000 to 3000 inclusive are
handled.
If your data includes dates before 1950, such as birth dates, always specify a
4-digit year so that Year (and other functions, such as Sort) interpret the date as
intended.
Regional settings
To make sure you get correct return values for the year, you must verify that
yyyy is the Short Date Style for year in the Regional Settings of the user’s
Control Panel. Your program can check this with the RegistryGet function.
If the setting is not correct, you can ask the user to change it manually or to
have the application change it (by calling the RegistrySet function). The user

Year(2005-01-31)
See also Day
Month
Year in the PowerScript Reference
156 PowerBuilder
C H A P T E R 3 DataWindow Object Properties
About this chapter This chapter describes the properties that control the appearance and
behavior of a DataWindow object.
Contents
Topic Page
Overview of DataWindow object properties 157
Controls in a DataWindow and their properties 158
Alphabetical list of DataWindow object properties 179
Overview of DataWindow object properties

DataWindow object properties apply to the DataWindow object itself, not
to the DataWindow control or DataStore that contains it. There are several
ways you can affect the values of DataWindow object properties at
runtime:
• Use the general-purpose Describe and Modify methods to get and set
property values.
• Use methods that get and set specific properties.
• Use methods that get and set specific properties.
• For many properties, enter expressions in the painter that set
properties conditionally at runtime.
• You can use the SyntaxFromSQL method on a transaction object to
generate DataWindow source code that sets some DataWindow
properties. You can use the generated code in the Create method to
create new DataWindows.
Summary tables in the first The tables in Controls in a DataWindow and their properties on page 158
part of this chapter list the properties for each control within a DataWindow object, with short
descriptions. There are also tables for SyntaxFromSql object keywords.
After the first table of DataWindow properties, the tables are alphabetical
by control and keyword name.

Controls in a DataWindow and their properties
The tables include check mark columns that identify whether you can use that
property with Modify (M) or SyntaxFromSql (S). When (exp) is included in the
description, you can specify a DataWindow expression as the value for that
property. A DataWindow expression lets you specify conditions for
determining the property value.
You can get the value of all properties in all tables

At runtime, you can use Describe or dot notation to get the value of all
properties listed in all tables.
Alphabetical reference The second half of this chapter is an alphabetical list of properties with
list in the second part descriptions, syntax, and examples. When you find a property you want to use
of this chapter in the first part, look up the property in the alphabetical list to find the specific
syntax you need to use. In the tables that describe the property values, (exp)
again indicates that you can use a DataWindow expression for the value.
Accessing properties in different DataWindow environments The
property reference has syntax for Describe and Modify and for PowerBuilder dot
notation.
Examples and quoted strings The only examples given are PowerBuilder
examples. However, the arguments for Describe and Modify are quoted strings
that are generally valid in all environments. If the strings include nested quotes,
see Nested strings and special characters for DataWindow object properties on
page 454 for information on the appropriate escape character in each
environment.
For more information and examples of setting properties, see:
• Chapter 5, Accessing DataWindow Object Properties in Code
• Describe and Modify methods in Chapter 9, Methods for the DataWindow
Control
• SyntaxFromSql method in the PowerScript Reference

The tables in this section list the properties that apply to DataWindow objects
and SyntaxFromSql (Group, Style, and Title) keywords.
158 PowerBuilder
CHAPTER 3 DataWindow Object Properties
Topic for DataWindow objects and keywords Page

Properties for the DataWindow object 159
Properties for Button controls in DataWindow objects 164
Properties for Column controls in DataWindow objects 165
Properties for Computed Field controls in DataWindow objects 167
Properties for Graph controls in DataWindow objects 168
Properties for GroupBox controls in DataWindow objects 170
Properties for the Group keyword 171
Properties for InkPicture controls in DataWindow objects 171
Properties for Line controls in DataWindow objects 172
Properties for OLE Object controls in DataWindow objects 172
Properties for Oval, Rectangle, and RoundRectangle controls in 173
DataWindow objects
Additional properties for RoundRectangle controls in DataWindow 174
objects
Properties for Picture controls in DataWindow objects 174
Properties for Report controls in DataWindow objects 175
Properties for the Style keyword 176
Properties for TableBlob controls in DataWindow objects 177
Properties for Text controls in DataWindow objects 177
Title keyword 178
Properties for the DataWindow object

An x in the M (Modify) column means you can change the property. An x in
the S column means you can use the property with the SyntaxFromSql method.
When (exp) is included in the description, you can specify a DataWindow
expression as the value for that property.
Property for the DataWindow M S Description
Attributes All general properties.
Bands List of bands.
Bandname.property x Color, height, and so on for a band, where bandname is Detail,
Footer, Header, Summary, Trailer, or TreeView.Level.
Bandname x Rich text content where bandname is Detail, Footer, or Header.
Brushmode x Setting used for background or primary gradient.
Color x x Background color.
Column.Count Number of columns.
Crosstab.property x Settings for a crosstab DataWindow.


CSSGen.property x Settings that specify the physical path to which a generated CSS
style sheet is published and the URL where the style sheet is
located.
Obsolete property This property is obsolete because the Web
DataWindow technology is obsolete.
Data Description of data.
Data.HTML Description of the data and format of the DataWindow in HTML
format.
Data.HTMLTable Description of the data in the DataWindow in HTML table
format.
Data.XHTML A string containing the row data content of the DataWindow
object in XHTML format.
Data.XML A string containing the row data content of the DataWindow
object in XML format.
Data.XMLDTD A string containing the full document type definition (DTD) of
the XML output for a DataWindow object.
Data.XMLSchema A string containing the full schema of the XML output of a
DataWindow object.
Data.XMLWeb A string containing browser-specific JavaScript that performs the
XSLT transformation on the browser after the XML Web
DataWindow generator generates all necessary components.
Data.XSLFO A string containing XSL Formatting Objects (XSL-FO) that
represents the data and presentation of the DataWindow object.
Detail.property x Color, height, and so on for the detail band.
EditMask.property x Settings for EditMask edit style.
Export.PDF.Distill.CustomPostScript x Setting that enables you to specify the PostScript printer driver
settings used when data is exported to PDF using the Distill!
method.
Export.PDF.Method x Setting that determines whether data is exported to PDF from a
DataWindow object by printing to a PostScript file and distilling
to PDF, or by saving in XSL Formatting Objects (XSL-FO)
format and processing to PDF.
160 PowerBuilder

Export.PDF.NativePDF.CustomOrien x Setting that enables you to specify the page orientation when
tation using the PDFlib method to print data from a DataWindow object
to a PDF file.
Export.PDF.NativePDF.CustomSize x Setting that enables you to specify the page size when using the
PDFlib method to print data from a DataWindow object to a PDF
file.
Export.PDF.XSLFOP.Print x Setting that enables you to send a DataWindow object directly to
a printer using platform-independent Java printing when using
the XSL-FO method to export to PDF. This is an option of the
Apache FOP processor.
Export.XHTML.TemplateCount The number of XHTML export templates associated with a
DataWindow object.
Export.XHTML.Template[ ].Name The name of an XHTML export template associated with a
DataWindow object.
Export.XHTML.UseTemplate x Setting that optionally controls the logical structure of the
XHTML generated by a DataWindow object from a
DataWindow data expression using dot notation.
Export.XML.HeadGroups x Setting that causes elements, attributes, and all other items above
the Detail Start element in an XML export template for a group
DataWindow to be iterated for each group in the exported XML.
Export.XML.IncludeWhitespace x Setting that determines whether the XML document is formatted
by inserting whitespace characters (carriage returns, linefeeds,
tabs, and spacebar spaces).
Export.XML.MetaDataType x Setting that controls the type of metadata generated with the
XML exported from a DataWindow object using the SaveAs
method or a .Data.XML expression.
Export.XML.SaveMetaData x Setting that controls the storage format for the metadata
generated with the XML exported from a DataWindow object
using the SaveAs method or a .Data.XML expression.
Export.XML.TemplateCount The number of XML export templates associated with a
DataWindow object.
Export.XML.Template[ ].Name The name of an XML export template associated with a
DataWindow object.
Export.XML.UseTemplate x Setting that optionally controls the logical structure of the XML
exported from a DataWindow object using the SaveAs method or
the .Data.XML property.
FirstRowOnPage The row number of the first displayed row.
Font.Bias x Treat fonts as display or printer.
Footer.property x Color, height, and so on for the footer band (see
Bandname.property in this table).
Gradient.property x Settings that control the gradient display in a DataWindow
object.
Grid.ColumnMove x Whether the user can drag to reposition columns.


Grid.Lines x Options for lines in grid DataWindow and crosstab.
Header.#.property x Color, height, and so on for a group’s header band.
Header.property x Color, height, and so on for the header band.
Help.property x Help settings for DataWindow actions.
HideGrayLine x Whether a gray line displays at page boundaries.
HorizontalScrollMaximum Width of scroll box in the horizontal scroll bar.
HorizontalScrollMaximum2 Width of second scroll box when scroll bar is split.
HorizontalScrollPosition x Position of the scroll box in the scroll bar.
HorizontalScrollPosition2 x Position of scroll box in second split scroll bar.
HorizontalScrollSplit x The position of the split in the scroll bar.
HTMLDW x (exp) Whether HTML for the DataWindow is interactive and
coordinated with a server component for retrievals and updates.
HTMLGen.property x (exp) Settings for HTML generation.
HTMLTable.property x Settings for the display of DataWindow data when displayed in
HTML table format.
Import.XML.Trace x Setting that determines whether import trace information is
written to a log file.
Import.XML.TraceFile x Specifies the name and location of an import trace file.
Import.XML.UseTemplate x Setting that optionally controls the logical structure of the XML
imported from an XML file to a DataWindow object using the
ImportFile method.
JSGen.property x Settings that specify the physical path to which generated
JavaScript is published and the URL indicating the location of
the generated JavaScript.
Label.property x x Settings for the Label presentation style.
LastRowOnPage The last visible row on the page.
Message.Title x x The title of the dialog box that displays errors.
Nested Whether the DataWindow has nested reports.
NoUserPrompt x Determines whether an error message is displayed to the user.
Objects The controls in the DataWindow.
OLE.Client.property x Settings for the DataWindow as OLE client.
162 PowerBuilder

Picture.property x Settings that control the background picture display in a
DataWindow object.
Pointer x (exp) The pointer when over the DataWindow.
Print.Preview.property x Various settings for print preview.
Print.property x x Various settings for printing.
Printer x The currently selected printer.
Processing Processing required by the presentation style.
QueryMode x Whether the DataWindow is in query mode.
QuerySort x Whether to sort the result set from the query.
ReadOnly x Whether the DataWindow is read-only.
Retrieve.AsNeeded x Whether to retrieve data only as needed.
RichText.property x Settings for a RichText DataWindow.
Row.Resize x Whether user can change the height of rows.
Rows_Per_Detail x Number of rows in each column of N-Up style.
Selected x List of selected controls.
Selected.Data List of selected data.
Selected.Mouse x Whether user can use the mouse to select.
ShowBackColorOnXP x Whether the background color that you select for a button
displays on Windows XP.
ShowDefinition x (exp) Display column names instead of data.
Sparse x (exp) The repeating columns to be suppressed.
Storage The amount of storage used by DataWindow.
StoragePageSize The default page size for DataWindow storage.
Summary.property x Color, height, and so on for the summary band.
Syntax The syntax of the DataWindow.
Syntax.Data The data of the DataWindow in parse format.
Syntax.Modified x Whether the syntax has been modified.
Table.property x Various settings for the database.
Table.sqlaction.property x Stored procedures for update activity.
Timer_Interval x x The milliseconds between timer events.
Transparency (DataWindow objects) x Setting that controls the transparency of the background/primary
gradient color.
Trailer.#.property x Color, height, and so on for a group’s trailer band.
Tree.property x Settings for a TreeView DataWindow.
Tree.Leaf.TreeNodeIconName x The file name of the tree node icon in the detail band of a
TreeView DataWindow.
Tree.Level.#.property x The file name of the icon for a TreeView node in a TreeView
level band when the icon is in either the expanded or collapsed
state.
Units x The unit of measure for the DataWindow.


VerticalScrollMaximum The height of the scroll box in the scroll bar.
VerticalScrollPosition x The position of the scroll box in the scroll bar.
XHTMLGen.Browser x A string that identifies the browser in which XHTML generated
within an XSLT style sheet is displayed.
XMLGen.property x Settings that specify the physical path to which XML is
published and the URL referenced by the JavaScript that
transforms the XML to XHTML.
XSLTGen.property x Settings that specify the physical path to which the generated
XSLT style sheet is published and the URL referenced by the
JavaScript that transforms the XML to XHTML.
Zoom x The scaling percentage of the DataWindow.
Properties for Button controls in DataWindow objects

An x in the M (Modify) column means you can change the property. When
(exp) is included in the description, you can specify a DataWindow expression
as the value for that property.
Property for a Button M Description
AccessibleDescription x A description of the control for use by assistive technology tools.
AccessibleName x A descriptive label for the control.
AccessibleRole A description of the kind of user-interface element that the control
is.
Background.property x Background settings for the button.
Color x (exp) The text color.
DefaultPicture x Whether or not the action’s default picture is to be used on the
button (user-defined action has no default picture).
Enabled x (exp) Determines whether a button control on a DataWindow is
enabled.
Filename x (exp) Name of the file containing the picture to be used on the
button (if not specified, just the text is used).
Font.property x (exp) Font settings for the text.
HTextAlign x (exp) How the text in the button is horizontally aligned. Values
are: 0 (center), 1 (left), 2 (right).
164 PowerBuilder
Property for a Button M Description

Height x (exp) The height of the button control.
HideSnaked x Whether the button control appears once per page when printing
newspaper columns.
Moveable x Whether the user can move the button control.
Name The name of the button control.
OriginalSize x Whether the button image is shown in its original size.
Pointer x (exp) The pointer image when it is over the button control.
Resizeable x Whether the user can resize the button control.
SlideLeft x (exp) Whether the button control moves left to fill in empty space.
SlideUp x (exp) How the button control moves up to fill in empty space.
SuppressEventProcessing x Whether or not ButtonClicked and ButtonClicking events are fired
for this particular button.
TabSequence x The position of the button in the tab order.
Tag x (exp) The tag text for the button control.
Text x (exp) The displayed text.
Type The control’s type, which is button.
VTextAlign x (exp) How the text in the button is vertically aligned. Values are:
0 (center), 1 (top), 2 (bottom), 3 (multiline).
Visible x (exp) Whether the button control is visible.
Width x (exp) The width of the button control.
X x (exp) The x coordinate of the button control.
Y x (exp) The y coordinate of the button control.
Properties for Column controls in DataWindow objects

the S column means you can use the property with the SyntaxFromSQL
method. When (exp) is included in the description, you can specify a
DataWindow expression as the value for that property.
Property for a Column M S Description
AccessibleDescription x A description of the control for use by assistive technology
tools.
AccessibleRole A description of the kind of user-interface element that the
control is.
Accelerator x (exp) The accelerator key for the column.
Alignment x (exp) The alignment of the column’s text.
Attributes A list of the properties of the column.
Background.property x x (exp) Background settings for the column.


Band The band containing the column.
BitmapName Whether the column’s content names a picture that will be
displayed instead of the text.
Border x x (exp) The type of border around the column.
CheckBox.property x Settings for CheckBox edit style.
Color x x (exp) The text color.
ColType The column’s datatype.
Criteria.property x Settings for column in Prompt for Criteria dialog box.
dbAlias x An alias for the name of the database column.
dbName x The name of the database column.
dddw.property x Settings for DropDownDataWindow edit style.
ddlb.property x Settings for DropDownListBox edit style.
Edit.property x x Settings for Edit edit style.
EditMask.property x Settings for EditMask edit style.
Font.property x x (exp) Font settings for the column text.
Format x (exp) The column’s display format.
Height x (exp) The height of the column.
Height.AutoSize x Whether column height is adjusted to fit the data.
HideSnaked x Whether the control appears once per page when printing
newspaper columns.
HTML.property x (exp) Settings for creating hyperlinks for column data.
Identity x Whether the DBMS sets the column’s value.
ID The number of the column.
Ink.property x Settings for Ink attributes of the InkEdit edit style.
InkEdit.property x Settings for InkEdit edit style.
Initial x The initial value in the column for a new row.
Key x Whether column is part of the table’s primary key.
Moveable x Whether the user can move the column.
Name The name of the column.
Pointer x (exp) The pointer’s image when it is over the column.
Protect x (exp) Whether the column is protected from changes.
RadioButtons.property x Settings for RadioButton edit style.
Resizeable x Whether the user can resize the column.
RichEdit.property x Settings for RichText edit style.
RightToLeft x Whether the column is set for right-to-left reading.
SlideLeft x (exp) Whether the column moves left to fill in space.
SlideUp x (exp) How the column moves up to fill in space.
TabSequence x The position of the column in the tab order.
Tag x (exp) The tag text for the column.
Type The control’s type, which is Column.
166 PowerBuilder

Update x Whether the column is updatable.
Validation x (exp) The validation expression for the column.
ValidationMsg x (exp) The message displayed when validation fails.
Values (for columns) x The values in the column’s code table.
Visible x (exp) Whether the column control is visible.
Width x (exp) The width of the column.
Width.Autosize x In Grid style DataWindows, determines whether the column’s
width adjusts according to the data it contains.
X x (exp) The x coordinate of the column.
Y x (exp) The y coordinate of the column.
Properties for Computed Field controls in DataWindow objects

Property for a computed field M Description
is.
Alignment x (exp) The alignment of the computed field’s text.
Attributes A list of the properties of the computed field.
Background.property x (exp) Background settings for the computed field.
Band The band containing the computed field.
Border x (exp) The type of border around the computed field.
ColType The column’s datatype.
enabled.
Expression x The expression for the computed field.
FocusRectangle x Determines whether a rectangle displays around the selected
control.
Font.property x (exp) Font settings for the computed field.
Format x (exp) The computed field’s display format.
Height x (exp) The height of the computed field.
Height.AutoSize x Whether the computed field’s height is adjusted to fit the data.
newspaper columns.

Property for a computed field M Description

HTML.property x (exp) Settings for creating hyperlinks for the computed field.
Moveable x Whether the user can move the computed field.
Name The name of the computed field.
Pointer x (exp) The pointer image when it is over the computed field.
Resizeable x Whether the user can resize the computed field.
SlideLeft x (exp) Whether the computed field moves left to fill in space.
SlideUp x (exp) How the computed field moves up to fill in empty space.
TabSequence x The position of the computed field in the tab order.
Tag x (exp) The tag text for the computed field.
Type The control’s type, which is Compute.
Visible x (exp) Whether the computed field control is visible.
Width x (exp) The width of the computed field.
X x (exp) The x coordinate of the computed field.
Y x (exp) The y coordinate of the computed field.
Properties for Graph controls in DataWindow objects

Property for a Graph M Description
is.
Attributes A list of the properties of the graph.
Axis x (exp) List of items (categories, series, or values) for the axis.
Axis.property x (exp) Properties for a graph axis.
Axis.DispAttr x (exp) Display properties for an axis (see DispAttr.fontproperty in
this table).
BackColor x (exp) The background color of the graph.
Band The band containing the graph.
Border x (exp) The type of border around the graph.
Category x (exp) List of categories for the axis (see Axis in this table).
Category.property x (exp) Properties for the Category axis (see Axis.property in this
table).
Category.DispAttr x (exp) Display properties for the Category axis (see
DispAttr.fontproperty in this table).
168 PowerBuilder

Depth x (exp) The depth of a 3D graph.
DispAttr.fontproperty x Font settings for various components of the graph.
Elevation x (exp) The elevation of a 3D graph.
enabled.
control.
GraphType x (exp) The type of graph (pie, bar, and so on).
Height x (exp) The height of the graph.
newspaper columns.
Legend x (exp) The location of the legend.
Legend.DispAttr.fontproperty x (exp) Display properties for the legend.
Moveable x Whether the user can move the graph.
Name The name of the graph control.
OverlapPercent x (exp) The overlap between data markers in different series.
Perspective x (exp) The distance of the graph from the front of the window.
Pie.DispAttr.fontproperty x (exp) Display properties for the pie slice labels.
PlotNullData x Whether a continuous line is drawn in a line graph when there is
no data.
Pointer x (exp) The pointer image when it is over the graph.
Range The rows in the DataWindow that are included in the graph.
Render3D x Whether the graph is rendered in the DirectX 3D style.
Resizeable x Whether the user can resize the graph.
Rotation x (exp) The left-to-right rotation of a 3D graph.
Series x (exp) List of series for the axis (see Axis in the table).
Series.property x (exp) Properties for the Series axis (see Axis.property in this table).
Series.DispAttr x (exp) Display properties for the Series axis (see
DispAttr.fontproperty in this table).
ShadeColor x (exp) The color of the back edge for 3D data markers.
SizeToDisplay x (exp) Whether to size the graph to the display area.
SlideLeft x (exp) Whether the graph moves left to fill in empty space.
SlideUp x (exp) How the graph moves up to fill in empty space.
Spacing x (exp) The gap between categories.
TabSequence x The position of the graph in the tab order.
Tag x (exp) The tag text for the graph.
Title x (exp) The graph’s title.
Title.DispAttr.fontproperty x (exp) Display properties for the title.
Type The control’s type, which is graph.
Values x (exp) List of values for the axis (see Axis in the table).


Values.property x (exp) Properties for the Values axis (see Axis.property in the table).
Values.DispAttr x (exp) Display properties for the Values axis (see
DispAttr.fontproperty in the table).
Visible x (exp) Whether the graph control is visible.
Width x (exp) The width of the graph.
X x (exp) The x coordinate of the graph.
Y x (exp) The y coordinate of the graph.
Properties for GroupBox controls in DataWindow objects

Property for a GroupBox M Description
is.
Attributes A list of the properties of the GroupBox control.
Background.property x (exp) Background settings for the GroupBox control.
Band The band containing the GroupBox control.
Border x (exp) Border style: 2 (box), 5 (3D lowered), 6 (3D raised).
Font.property x (exp) Font settings for the text.
Height x (exp) The height of the GroupBox control.
HideSnaked x Whether the GroupBox control appears once per page when
printing newspaper columns.
Moveable x Whether the user can move the GroupBox control.
Name The name of the GroupBox control.
Pointer x (exp) The pointer image when it is over the GroupBox control.
Resizeable x Whether the user can resize the GroupBox control.
SlideLeft x (exp) Whether the GroupBox control moves left to fill in empty
space.
SlideUp x (exp) How the GroupBox control moves up to fill in empty space.
Tag x (exp) The tag text for the GroupBox control.
Type The control’s type, which is GroupBox.
Visible x (exp) Whether the GroupBox control is visible.
Width x (exp) The width of the GroupBox control.
170 PowerBuilder
Property for a GroupBox M Description

X x (exp) The x coordinate of the GroupBox control.
Y x (exp) The y coordinate of the GroupBox control.
Properties for the Group keyword

You use these properties when generating DataWindow source code with the
SyntaxFromSql method.
Property Description
NewPage (Group keywords) Whether a change in a group column’s value causes a page break.
ResetPageCount Whether a new value in a group column restarts page numbering.
Properties for InkPicture controls in DataWindow objects

Property for an InkPicture M Description
BackImage The column containing the background image for the InkPicture.
Band The band containing the InkPicture.
Border x (exp) The type of border around the InkPicture.
Enabled x (exp) Whether the control is enabled.
Height x (exp) The height of the InkPicture.
Ink.property x (exp) Attributes of the ink in the InkPicture.
InkPic.property x (exp) Properties that specify the behavior of the InkPicture.
KeyClause x (exp) The key clause used when retrieving the blob.
Moveable x Whether the user can move the InkPicture.
Name The name of the InkPicture control.
Pointer x (exp) The pointer image when it is over the InkPicture.
Resizeable x Whether the user can resize the InkPicture.
SlideLeft x (exp) Whether the InkPicture moves left to fill in empty space.
Table (for InkPicture and TableBlobs) x (exp) The table that contains large binary columns used in the
control.
Tag x (exp) The tag text for the InkPicture.
Visible x (exp) Whether the InkPicture control is visible.
Width x (exp) The width of the InkPicture.
X x (exp) The x coordinate of the InkPicture.
Y x (exp) The y coordinate of the InkPicture.

Properties for Line controls in DataWindow objects

Property for a Line M Description
Attributes A list of the properties of the line.
Background.property x (exp) Background settings for the line.
Band The band containing the line.
newspaper columns.
Moveable x Whether the user can move the line.
Name The name of the line control.
Pen.property x (exp) Appearance settings of the line.
Pointer x (exp) The pointer image when it is over the line.
Resizeable x Whether the user can resize the line.
SlideLeft x (exp) Whether the line moves left to fill empty space.
SlideUp x (exp) How the line moves up to fill empty space.
Tag x (exp) The tag text for the line.
Type The control’s type, which is Line.
Visible x (exp) Whether the Line control is visible.
X1, X2 x (exp) The x coordinate of each end of the line.
Y1, Y2 x (exp) The y coordinate of each end of the line.
Properties for OLE Object controls in DataWindow objects

Property for OLE Object control M Description
Activation x The way the OLE Object control is activated.
Attributes A list of the properties of the OLE Object control.
Band The band containing the OLE Object control.
BinaryIndex An internal pointer.
Border x (exp) The type of border around the OLE Object control.
ClientName x The name of the OLE client in the server window.
ContentsAllowed x Whether the control can be embedded, linked, or both.
DisplayType x Whether the control displays an icon or contents.
enabled.
172 PowerBuilder
Property for OLE Object control M Description

control.
GroupBy x (exp) The grouping columns for the transferred data.
Height x (exp) The height of the OLE Object control.
newspaper columns.
LinkUpdateOptions x How a linked control is updated.
Moveable x Whether the user can move the OLE Object control.
Name The name of the OLE Object control.
enabled.
Pointer x (exp) The pointer image when it is over the control.
Range Method for choosing the rows transferred to the OLE control.
Resizeable x Whether the user can resize the OLE Object control.
SizeToDisplay x (exp) Whether the OLE Object control is automatically sized to
the display area.
SlideLeft x (exp) Whether the control moves left to fill in space.
SlideUp x (exp) How the control moves up to fill in space.
TabSequence x The position of the control the tab order.
Tag x (exp) The tag text for the control.
Target x (exp) The columns or expressions whose data you want to transfer
to the OLE Object control.
Type The control’s type, which is OLE.
Visible x (exp) Whether the control is visible.
Width x (exp) The width of the control.
X x (exp) The x coordinate of the control.
Y x (exp) The y coordinate of the control.
Properties for Oval, Rectangle, and RoundRectangle controls in

DataWindow objects
Property M Description
Attributes A list of the properties of the control.
Background.property x (exp) Background settings for the control.
Band The band containing the control.
Brush.property x (exp) Settings for fill pattern and color.

Height x (exp) The height of the control.
newspaper columns.
Moveable x Whether the user can move the control.
Name The name of the control.
Pen.property x (exp) Appearance settings of the control.
Pointer x (exp) The pointer image when it is over the control.
Resizeable x Whether the user can resize the control.
SlideLeft x (exp) Whether the control moves left to fill empty space.
SlideUp x (exp) How the control moves up to fill empty space.
Type The control’s type, which is ellipse, rectangle, or roundrectangle.
X x (exp) The x coordinate of the control.
Y x (exp) The y coordinate of the control.
Additional properties for RoundRectangle controls in DataWindow objects

Properties for Oval, Rectangle, and RoundRectangle controls in DataWindow
objects also apply to RoundRectangle controls.
EllipseHeight x (exp) The radius of the vertical part of the rounded corner.
EllipseWidth x (exp) The radius of the horizontal part of the rounded corner.
Properties for Picture controls in DataWindow objects

Property for a Picture M Description
is.
Attributes A list of the properties of the picture.
174 PowerBuilder
Property for a Picture M Description

Band The band containing the picture.
Border x (exp) The type of border around the picture.
enabled.
Filename x (exp) The file containing the picture.
control.
Height x (exp) The height of the picture.
newspaper columns.
HTML.property x (exp) Settings for creating a hyperlink for the picture.
Invert x (exp) Whether the colors are displayed inverted.
Moveable x Whether the user can move the picture.
Name The name of the picture control.
OriginalSize x Whether the picture is shown in its original size.
Pointer x (exp) The pointer image when it is over the picture.
Resizeable x Whether the user can resize the picture.
SlideLeft x (exp) Whether the picture moves left to fill in empty space.
SlideUp x (exp) How the picture moves up to fill in empty space.
TabSequence x The position of the picture in the tab order.
Tag x (exp) The tag text for the picture.
Type The control’s type, which is picture.
Visible x (exp) Whether the picture control is visible.
Width x (exp) The width of the picture.
X x (exp) The x coordinate of the picture.
Y x (exp) The y coordinate of the picture.
Properties for Report controls in DataWindow objects

Property for a Report M Description
Attributes A list of the properties of the report.
Band The band containing the report.
Border x (exp) The type of border around the report.
Criteria x The search condition of the WHERE clause that relates the report
to the main DataWindow.
DataObject x The name of the DataWindow that is the nested report.

Property for a Report M Description

Height x (exp) The height of the report.
Height.AutoSize x Whether the height of the control will be adjusted to display all the
data.
newspaper columns.
Moveable x Whether the user can move the report.
Name The name of the Report control.
Nest_Arguments x Retrieval arguments for the report.
NewPage (Report controls) x Whether to start the report on a new page (composite only).
Pointer x (exp) The pointer image when it is over the report.
Resizeable x Whether the user can resize the report.
SlideLeft x (exp) Whether the report moves left to fill in empty space.
SlideUp x (exp) How the report moves up to fill in empty space.
ShowBackground x Whether the background settings of the report display.
Tag x (exp) The tag text for the report.
Trail_Footer x Where to print the footer (composite only).
Type The control’s type, which is report.
Visible x (exp) Whether the Report control is visible.
Width x (exp) The width of the report.
X x (exp) The x coordinate of the report.
Y x (exp) The y coordinate of the report.
Properties for the Style keyword

You use these properties when generating DataWindow source code with the
Detail_Bottom_Margin Bottom margin of the detail area.
Detail_Top_Margin Top margin of the detail area.
Header_Bottom_Margin Bottom margin of the header area.
Header_Top_Margin Top margin of the header area.
Horizontal_Spread Horizontal space between columns in the detail area.
Left_Margin The left margin of the DataWindow.
Report Whether the DataWindow is a read-only report.
Type The presentation style.
Vertical_Size The height of the columns in the detail area.
Vertical_Spread The vertical space between columns in the detail area.
176 PowerBuilder
Properties for TableBlob controls in DataWindow objects

Property for a TableBlob M Description
Attributes A list of the properties of the TableBlob.
Band The band containing the TableBlob.
Border x (exp) The type of border around the TableBlob.
ClientName x The name of the OLE client in the server window.
Height x (exp) The height of the TableBlob.
newspaper columns.
ID The number of the TableBlob.
KeyClause x (exp) The key clause used when retrieving the blob.
Moveable x Whether the user can move the TableBlob.
Name The name of the TableBlob.
OLEClass x (exp) The name of the TableBlob’s OLE column.
Pointer x (exp) The pointer image when it is over the TableBlob.
Resizeable x Whether the user can resize the TableBlob.
SlideLeft x (exp) Whether the TableBlob moves left to fill empty space.
SlideUp x (exp) How the TableBlob moves up to fill empty space.
Template x (exp) The file used to start the OLE application.
Type The control’s type, which is TableBlob.
Visible x (exp) Whether the TableBlob is visible.
Width x (exp) The width of the TableBlob.
X x (exp) The x coordinate of the TableBlob.
Y x (exp) The y coordinate of the TableBlob.
Properties for Text controls in DataWindow objects

the S column means you can use the property with the SyntaxFromSQL
method. When (exp) is included in the description, you can specify a
DataWindow expression as the value for that property.
Property for text M S Description
AccessibleDescription x A description of the control for use by assistive technology
tools.

Property for text M S Description

AccessibleRole A description of the kind of user-interface element that the
control is.
Alignment x x The alignment of the text.
Attributes A list of the properties of the text control.
Background.property x x (exp) Background settings for the text control.
Band The band containing the text control.
Border x x (exp) The type of border around the text control.
Color x x (exp) The text color.
Enabled x (exp) Determines whether a button control on a DataWindow
is enabled.
FocusRectangle x Determines whether a rectangle displays around the select
control.
Font.property x x (exp) Font settings for the text.
Height x (exp) The height of the text control.
Height.AutoSize x Whether the control’s height is adjusted to fit the data.
newspaper columns.
HTML.property x (exp) Settings for creating a hyperlink for the text.
Moveable x Whether the user can move the text control.
Name The name of the text control.
Pointer x (exp) The pointer image when it is over the text control.
Resizeable x Whether the user can resize the text control.
SlideLeft x (exp) Whether the text control moves left to fill space.
SlideUp x (exp) How the text control moves up to fill empty space.
TabSequence x The position of the text in the tab order.
Tag x (exp) The tag text for the text control.
Type The control’s type, which is Text.
Width x (exp) The width of the text control.
X x (exp) The x coordinate of the text control.
Y x (exp) The y coordinate of the text control.
Title keyword
You use this property when generating DataWindow source code with the
Title(“string”) The title for the DataWindow.
178 PowerBuilder
Alphabetical list of DataWindow object properties

The properties for DataWindow objects and controls within a DataWindow
object follow in alphabetical order.
The simple Visual Basic example shown for most properties can be used in C#
by adding a semicolon to the end of each statement.
To see the properties organized by type of control or syntax keyword, see
Controls in a DataWindow and their properties on page 158.
Accelerator
Description The accelerator key that a user can press to select a column in the DataWindow
object.
Applies to Column controls
Syntax PowerBuilder dot notation:
dw_control.Object.columnname.Accelerator
Describe and Modify argument:
"columnname.Accelerator { = 'acceleratorkey ' }"
Parameter Description
columnname The name of the column for which you want to get or set the
accelerator key.
acceleratorkey (exp) A string expression whose value is the letter that will be
the accelerator key for columnname. Acceleratorkey can be a
quoted DataWindow expression.
Usage An accelerator key for a column allows users to select a column (change focus)
with a keystroke rather than with the mouse. The user changes focus by
pressing the accelerator key in combination with the Alt key.
In the painter Select the control and set the value in the Properties view, Edit
tab.
Displaying the accelerator The column does not display the key. To let
users know what key to use, you can include an underlined letter in a text
control that labels the column. When you enter the text control’s label, precede
the character you want underlined with an ampersand (&).
Accelerator keys and edit styles To use an accelerator key with the
CheckBox or RadioButton edit style, select the Edit edit style and specify the
accelerator there.

Examples dw1.Object.emp_name.Accelerator = 'A'

ls_data = dw1.Describe("emp_name.Accelerator")
dw1.Modify("emp_name.Accelerator='A'")
AccessibleDescription
Description A description of the control and/or its purpose for use by accessibility tools
such as readers for visually-impaired users.
Applies to Column, computed field, picture, text, graph, group box, and button controls
dw_control.Object.controlname.AccessibleDescription
"controlname.AccessibleDescription { = 'description ' }"
columnname The name of the control for which you want to get or set the
accessible description
description (exp) A string that describes the control’s purpose or appearance
Usage You do not need to supply a description if the AccessibleName and

AccessibleRole properties adequately describe the control, as in the case of a
button with the label OK. You should provide a description for a picture or
report control.
In the painter In the Other tab in the Properties view, type a description in the
AccessibleDescription text box.
Examples dw1.Object.b_1.AccessibleDescription = 'Scrolls to Next
Row'
strData = dw1.Describe("b_1.AccessibleDescription")
dw1.Modify("b_1.AccessibleDescription='Scrolls to next
row'")
AccessibleName
Description A label that briefly describes the control for use by accessibility tools such as
readers for visually-impaired users.
180 PowerBuilder
dw_control.Object.controlname.AccessibleName
"controlname.AccessibleName { = 'description ' }"
description (exp) A string that briefly describes the control
Usage The AccessibleName property is a brief description, such as the text in a button
or the name of a menu item.
In the painter In the Other tab in the Properties view, type a name in the
AccessibleName text box.
Examples dw1.Object.b_1.AccessibleName = 'Next'
ls_data = dw1.Describe("b_1.AccessibleName")
dw1.Modify("b_1.AccessibleName='Next'")
AccessibleRole
Description A description of the kind of user-interface element that the control is, for use
by accessibility tools such as readers for visually-impaired users.
dw_control.Object.controlname.AccessibleRole
"controlname.AccessibleRole { = 'enumeratedvalue ' }"
description (exp) A number specifying the type of AccessibleRole as a
numeric value of the AccessibleRole DataWindow constant.
Usage The description is a member of the AccessibleRole enumerated variable. The

default role is defaultrole! and is used when the role cannot be determined.

Table 3-1: AccessibleRole values for DataWindow controls

Control AccessibleRole
Button pushbuttonrole!
Column textrole!
Computed field statictextrole!
Graph diagramrole!
Group box groupingrole!
Picture graphicrole!
Text statictextrole!
In the painter In the Other tab in the Properties view, select a value in the
AccessibleRole drop-down list.
Examples ls_data = dw1.Object.b_1.AccessibleRole
ls_data = dw1.Describe("b_1.AccessibleRole")
Action
Description The action a user can assign to a button control.
Applies to Button controls
dw_control.Object.buttonname.Action
"buttonname.Action { = ' value ' }"
buttonname The name of the button for which you want to assign an action.
value The action value assigned to the button. Values are listed in the
following table.
Value returned to
Value Action Description ButtonClicked event
0 UserDefined (Default) Allows for programming of the Return code from the user’s
ButtonClicked and ButtonClicking events with coded event script.
no intervening action occurring.
182 PowerBuilder
Value returned to
1 Retrieve (Yield) Retrieves rows from the database. Before Number of rows retrieved.
retrieval actually occurs, option to yield is turned
on. This allows the Cancel action to take effect
during a long retrieve.
2 Retrieve Retrieves rows from the database. The option to Number of rows retrieved.
yield is not automatically turned on.
3 Cancel Cancels a retrieval that has been started with the 0
option to yield.
4 PageNext Scrolls to the next page. The row displayed at the top of
the DataWindow control when
the scrolling is complete or
attempts to go past the first row.
-1 if an error occurs.
5 PagePrior Scrolls to the prior page. The row displayed at the top of
6 PageFirst Scrolls to the first page. 1 if successful.
7 PageLast Scrolls to the last page. The row displayed at the top of
8 Sort Displays Sort dialog box and sorts as specified. 1 if successful.
9 Filter Displays Filter dialog box and filters as specified. Number of rows filtered.
Number < 0 if an error occurs.
10 DeleteRow If button is in detail band, deletes row associated 1 if successful.
with button; otherwise, deletes the current row. -1 if an error occurs.
11 AppendRow Inserts row at the end. Row number of newly inserted
row.
12 InsertRow If button is in detail band, inserts row using row Row number of newly inserted
number associated with the button; otherwise, row.
inserts row using the current row.
13 Update Saves changes to the database. If the update is 1 if successful.
successful, a COMMIT is issued. If the update -1 if an error occurs.
fails, a ROLLBACK is issued

Value returned to
14 SaveRowsAs Displays Save As dialog box and saves rows in Number of rows filtered.
the format specified.
15 Print Prints one copy of the DataWindow object. 0
16 Preview Toggles between preview and print preview. 0
17 PreviewWithRu Toggles between rulers on and off. 0
lers
18 QueryMode Toggles between query mode on and off. 0
19 QuerySort Specifies sorting criteria (forces query mode on). 0
20 QueryClear Removes the WHERE clause from a query (if 0
one was defined).
Usage In the painter Select the control and set the value in the Properties view,
General tab.
Examples dw1.Object.b_retrieve.Action = "2"
setting = dw1.Describe("b_retrieve.Action")
dw1.Modify("b_retrieve.Action = '2'")
Activation
Description The way the server for the OLE object in the OLE Object control is activated.
Choices include letting the user activate the object by double-clicking or
putting activation under program control.
Applies to OLE Object controls
dw_control.Object.olecontrolname.Activation
"olecontrolname.Activation { = ' activationtype ' }"
olecontrolname The name of the OLE Object control for which you want to get or
set the activation method.
184 PowerBuilder
activationtype (exp) A number specifying the method of activation for the OLE
object. Activationtype can be a quoted DataWindow expression.
Values are:
0 – The object has to be activated with the Activate method.
1 – The user can activate the object by double-clicking on it.
2 – The object activates when the container gets focus.
Options tab.
Examples dw1.Object.ole_report.Activation
ls_data = dw1.Describe("ole_report.Activation")
dw1.Modify("ole_report.Activation='2'")
Alignment
Description The alignment of the control’s text within its borders.
Applies to Column, Computed Field, and Text controls
dw_control.Object.controlname.Alignment
"controlname.Alignment { = ' alignmentvalue ' }"
SyntaxFromSql:
Text ( ... Alignment = alignmentvalue ... )
controlname The name of the control for which you want to get or set the
alignment.

alignmentvalue (exp) A number specifying the type of alignment for the text of
controlname. Alignmentvalue can be a quoted DataWindow
expression.
Values are:
0 – (Default) Left
1 – Right
2 – Center
3 – Justified
When generating DataWindow syntax with SyntaxFromSql,
the setting for Alignment applies to all text controls used as
column labels.
Usage When you select justified, the last line of text is not stretched to fill the line.
Controls with only one line of text look left aligned.
In the painter Select the control and set the value using:
• Properties view, General tab
• StyleBar
Examples dw1.Object.emp_name_t.Alignment = 2
ls_data = dw1.Describe("emp_name.Alignment")
dw1.Modify("emp_name_t.Alignment='2'")
Arguments
Description The retrieval arguments required by the data source. You specify retrieval
arguments in the DataWindow’s SELECT statement and you provide values for
the retrieval arguments when you call the Retrieve method.
Applies to Database table for the DataWindow object
Not settable in PowerScript. Used in DataWindow syntax.
Syntax Table(Arguments = ( (name1, type), (name2, type) ... ) ... )
name The name of the retrieval argument
186 PowerBuilder
type The type of the argument:
• Date or a Date list
• DateTime or a DateTime list
• Number or a Number list
• String or a String list
• Time or a Time list
Usage In the painter Set the value in the SQL Select painter or Query painter.
Open the SQL Select painter by selecting Design>Data Source from the menu
bar in the DataWindow painter, or create or open a query in the Query painter.
Then select Design>Retrieval Arguments.
Attributes
Description A tab-separated list of all the properties that apply to a control.
Applies to DataWindow, Button, Column, Computed Field, Graph, GroupBox, Line,
OLE, Oval, Picture, Rectangle, Report, RoundRectangle, TableBlob, and Text
controls
dw_control.Object.controlname.Attributes
Describe argument:
"controlname.Attributes"
Examples ls_data = dw1.Object.emp_name_t.Attributes
ls_data = dw1.Describe("DataWindow.Attributes")
ls_data = dw1.Describe("emp_name_t.Attributes")
Axis
Description The list of items or the expression associated with an axis of a graph. Each item
is separated by a comma. You can ask for the list of categories on the Category
axis, the series on the Series axis, or the values on the Values axis.
Applies to Graph controls
dw_control.Object.graphname.axis


"graphname.axis { = ' list ' }"
graphname The name of the graph within the DataWindow object for which
you want to get or set the list of items for axis.
axis An axis name.
Values are:
• Category
• Series
• Values
list A string listing the categories, series, or values for the graph.
The content of the list depends on the axis you specify. The
items in the list are separated by commas. List is quoted.
Usage In the painter Select the graph control and set the value by selecting a
column or expression for each axis in the Properties view, Data tab.
Examples ls_data = dw1.Object.gr_1.Values
dw1.Object.gr_1.Series = "Actual, Budget"
ls_data = dw1.Describe("gr1.Category")
ls_data = dw1.Describe("gr1.Series")
ls_data = dw1.Describe("gr1.Values")
dw1.Modify("gr1.Series='Actual, Budget'")
Axis.property
Description Settings that control the appearance of an axis on a graph.
dw_control.Object.graphname.axis.property
"graphname.axis.property { = value }"
graphname The name of the graph within the DataWindow object for which
you want to get or set a property value for an axis.
188 PowerBuilder
axis An axis name.
Values are:
• Category
• Series
• Values
property A property for the axis. Properties and their settings are listed in
the table that follows.
value The value to be assigned to the property. For axis properties,
value can be a quoted DataWindow expression.
Property for Axis Value

AutoScale (exp) A boolean number specifying whether PowerBuilder scales the axis
automatically. Enabled when the axis displays nonstring data.
Values are:
0 – No, do not automatically scale the axis.
1 – Yes, automatically scale the axis.
Painter: Axis tab, Scale group.
DispAttr. (exp) Properties that control the appearance of the text that labels the axis divisions.
fontproperty For a list of font properties, see the main entry for DispAttr.fontproperty.
Painter: Text tab. Choose Category Axis Text, Series Axis Text, or Values Axis Text,
and set font properties.
DisplayEvery (exp) An integer specifying which major axis divisions to label. For example, 2
NLabels means label every other tick mark. Values 0 and 1 both mean label every tick mark.
If the labels are too long, they are clipped.
Painter: Axis tab, Major Divisions group (not available for all graph types).
DropLines (exp) An integer indicating the type of drop line for the axis.
Values are:
0 – None
1 – Solid
2 – Dash
3 – Dot
4 – DashDot
5 – DashDotDot
Painter: Axis tab, Major Divisions group (not available for all graph types).
Not supported by Render3D graph style.


Frame (exp) An integer indicating the type of line used for the frame. Values are 0–5. See
DropLines in this table for their meaning. Available for 3D graph types.
Painter: Axis tab, Line Style group.
Label (exp) A string whose value is the axis label.
Painter: Axis tab.
LabelDispAttr. (exp) Properties that control the appearance of the axis label.
fontproperty For a list of font properties, see the main entry for DispAttr.fontproperty.
Painter: Text tab. Choose Category Axis Label, Series Axis Label, or Values Axis
Label, and set font properties.
MajorDivisions (exp) An integer specifying the number of major divisions on the axis.
Painter: Axis tab, Major Divisions group.
MajorGridLine (exp) An integer specifying the type of line for the major grid. Values are 0–5. See
DropLines in this table for their meaning.
MajorTic (exp) An integer specifying the type of the major tick marks.
Values are:
1 – None
2 – Inside
3 – Outside
4 – Straddle
MaximumValue (exp) A double specifying the maximum value for the axis.
MinimumValue (exp) A double specifying the minimum value for the axis.
MinorDivisions (exp) An integer specifying the number of minor divisions on the axis.
Painter: Axis tab, Minor Divisions group.
MinorGridLine (exp) An integer specifying the type of line for the minor grid. Values are 0–5. See
190 PowerBuilder

MinorTic (exp) An integer specifying the type of the minor tick marks.
Values are:
1 – None
2 – Inside
3 – Outside
4 – Straddle
OriginLine (exp) An integer specifying the type of origin line for the axis. Values are 0–5. See
DropLines in this table for their meaning. Enabled for numeric data axes.
PrimaryLine (exp) An integer specifying the type of primary line for the axis. Values are 0–5. See
RoundTo (exp) A double specifying the value to which you want to round the axis values.
Specify both a value and a unit (described next).
RoundToUnit (exp) An integer specifying the units for the rounding value. The units must be
appropriate for the axis datatype.
Values are:
0 – Default, for an axis of any datatype
1 – Years, for an axis of type date or DateTime
2 – Months, for an axis of type date or DateTime
3 – Days, for an axis of type date or DateTime
4 – Hours, for an axis of type time or DateTime
5 – Minutes, for an axis of type time or DateTime
6 – Seconds, for an axis of type time or DateTime
7 – Microseconds, for an axis of type time or DateTime
ScaleType (exp) An integer specifying the type of scale used for the axis.
Values are:
1 – Scale_Linear
2 – Scale_Log10
3 – Scale_Loge


ScaleValue (exp) An integer specifying the scale of values on the axis.
Values are:
1 – Scale_Actual
2 – Scale_Cumulative
3 – Scale_Percentage
4 – Scale_CumPercent
SecondaryLine (exp) An integer specifying the type of secondary line for the axis. The line is parallel
to and opposite the primary line and is usually not displayed in 2D graphs. Values are
0–5. See DropLines in this table for their meaning.
ShadeBackEdge (exp) A boolean number specifying whether the back edge of the axis is shaded.
Values are:
0 – No, the back edge is not shaded
1 – Yes, the back edge is shaded
Painter: Axis tab. Enabled for 3D graphs only.
Sort (exp) An integer specifying the way the axis values should be sorted. (Does not apply
to the Values axis.)
Values are:
0 – Unsorted
1 – Ascending
2 – Descending
Usage In the painter Select the graph control or the Graph DataWindow object and
set the value in the Properties view. To set most axis properties, select the Axis
tab and an axis in the Axis drop-down list. Font properties are set on the Text
tab.
Examples string ls_data
ls_data = dw1.Object.gr_1.Category.AutoScale
dw1.Object.Category.LabelDispAttr.Alignment = 2
ls_data = dw1.Describe("gr_1.Category.AutoScale")
dw1.Modify("gr_1.Series.AutoScale=0")
dw1.Modify("gr_1.Values.Label='Cities'")
dw1.Modify("gr_1.Category.LabelDispAttr.Alignment=2")
192 PowerBuilder
BackColor
Description The background color of a graph in a DataWindow.
dw_control.Object.graphname.BackColor
"graphname.BackColor { = long }"
graphname The graph whose background color you want to get or set.
long (exp) A long expression specifying the color (red, green, and
blue values) to be used as the graph’s background color. Long
can be a quoted DataWindow expression.
Usage In the painter Select the graph control and set the value in the Properties
view, General tab.
Examples dw1.Object.graph_1.BackColor = 250
setting = dw1.Describe("graph_1.BackColor")
dw1.Modify("graph_1.BackColor=250")
Background.property
Description Settings for the color and transparency of a control.
Applies to Button, Column, Computed Field, GroupBox, Line, Oval, Rectangle,
RoundRectangle, and Text controls
dw_control.Object.controlname.Background.property
"controlname.Background.property { = ' value ' }"
SyntaxFromSql:
Column ( Background.property = value )
Text ( Background.property = value )
controlname The control whose Background properties you want to get or set.
When generating DataWindow syntax with SyntaxFromSql, the
Background settings apply to all columns or all text controls.

property A property that applies to the background of a control, as listed in
the Property table below.
value Values for the properties are shown below. Value can be a quoted
DataWindow expression.
Property for
Background Value
Brushmode (exp) An integer indicating the type of “brush” to use for the gradient.
Values are:
Painter: Background tab, Gradient group (not available in RichText, Graph, or OLE
DataWindow objects).
Color (exp) A long expression specifying the color (the red, green, and blue values) to be
used as the control’s background color.
Painter: Background tab
Mode (exp) A number expression specifying the mode of the background of controlname.
Values are:
0 – Make the control’s background opaque
1 – make the control’s background transparent
Transparency (exp) An integer in the range 0 to 100, where 0 means that the column or control’s
primary background is opaque and 100 that it is completely transparent.
Painter: Background tab.
Gradient.Angle (exp) An integer indicating the angle in degrees (values are 0 to 360) used to offset
the color and transparency gradient. This property is used only when the column’s or
control’s background.gradient.mode takes values of 3 or 4.
Painter: Background tab, Gradient group.
Gradient.Color (exp) A long specifying the color (the red, green, and blue values) to be used as the
column or control’s secondary background color. The gradient defines transitions
between the primary and secondary background colors.
Gradient.Focus (exp) An integer in the range 0 to 100, specifying the distance (as a percentage) from
the center where the background color is at its maximum. (For example, if the radial
gradient is used and the value is set to 0, the color will be at the center of the
background; if the value is set to 100, the color will be at the edges of the
background.)
Painter: Background tab, Gradient group
194 PowerBuilder
Property for
Background Value
Gradient.Repetition.Mode (exp) Specifies the mode for determining the number of gradient transitions for the
column’s or control’s background color and transparency.
Permitted values and their meanings are:
• 0 Gradient.repetition.count determines the number of gradient transitions
• 1 Gradient.repetition.length determines the number of gradient transitions
Gradient.Repetition.Count (exp) An integer specifying the number of gradient transitions for background color
and transparency. A value of 0 indicates 1 transition. A value of 3 indicates 4
transitions. This property is used only when the gradient.repetition.mode property for
the column or control takes the value of 0 (by count).
Gradient.Repetition.Length (exp) A long specifying the number of gradient transitions. This property is used only
when the gradient.repetition.mode property for the column or control takes the value
of 1 (by length). The units for the length that you assign for gradient transitions are
set by the DataWindow object’s Units property.
Gradient.Scale (exp) An integer in the range 0 to 100 specifying the rate of transition to the gradient
color (as a percentage).
Gradient.Spread (exp) An integer in the range 0 to 100 indicating the contribution of the second color
to the blend (as a percentage).
Gradient.Transparency (exp) An integer in the range 0 to 100, where 0 means that the column or control’s
secondary (gradient) background is opaque and 100 that it is completely transparent.
The gradient defines transitions between the primary and secondary transparency
settings.
Usage In the painter Select the control and set the value in the Properties view, Font
tab for controls that have text and in the General tab for drawing controls
(choose Transparent or a color).
When you choose a Brush Hatch fill pattern other than Solid for an Oval,
Rectangle, or RoundRectangle control, the Background Color and the Brush
Color are used for the pattern colors.
Background color of a button The Background.Color property is not
supported on Windows XP by default because the current XP theme controls
the appearance of the button. Set the ShowBackColorOnXP property of the
DataWindow object to force the color change to take effect.

Background color of a line The background color of a line is the color that
displays between the segments of the line when the pen style is not solid.
Transparent background If Background.Mode is transparent (1),
Background.Color is ignored.
Background gradient properties Background gradient and transparency
properties do not apply to DataWindow objects with the RichText, Graph, or
OLE presentation style, and do not apply to the Line control.
DropDownDataWindows and GetChild When you set Background.Color
and Background.Mode for a column with a DropDownDataWindow,
references to the DropDownDataWindow become invalid. Call GetChild again
after changing these properties to obtain a valid reference.
Examples dw1.Object.oval_1.Background.Color = RGB(255, 0, 128)
ls_data = dw1.Describe("oval_1.Background.Color")
dw1.Modify("emp_name.Background.Color='11665407'")
ls_data = dw1.Describe("emp_name.Background.Mode")
dw1.Modify("emp_name.Background.Mode='1'")
dw1.Modify("rndrect_1.Background.Mode='0'")
SQLCA.SyntaxFromSQL(sql_syntax, &
"Style(...) Column(Background.Mode=1 ...) ...", &
ls_Errors)
"Style(...) Column(Background.Color=11665407 ...)", &
ls_Errors)
BackImage
Description The column that contains the background image for an InkPicture control in a
DataWindow.
Applies to InkPicture controls
dw_control.Object.inkpicname.BackImage
"inkpicname.BackImage{ = colname }"
inkpicname The graph whose background color you want to get or set.
colname A string value specifying the name of the long binary column
that contains the background image for the control.
196 PowerBuilder
Usage In the painter Select the InkPicture control and set the value in the Properties
view, Definition tab, Col for Image property. The image format can be JPEG,
GIF, BMP, or ICO. If you change the image, call the Retrieve method to force
the DataWindow to retrieve the new image.
Examples sval = dw1.Object.inkpic_1.backimage
dw1.Object.inkpic_1.backimage = 'InkImg'
Band
Description The band or layer in the DataWindow object that contains the control. The
returned text is one of the following, where # is the level number of a group:
detail, footer, header, header.#, summary, trailer.#, tree.level.#, foreground,
background.
Changing a control’s band

Use the SetPosition method to change a control’s band at runtime.
Applies to Button, Column, Computed Field, Graph, GroupBox, Line, OLE, Oval,
Picture, Rectangle, Report, RoundRectangle, TableBlob, and Text controls
dw_control.Object.controlname.Band
"controlname.Band"
controlname The name of the control within the DataWindow for which you
want the band it occupies
Position tab, Layer option. When the control’s layer is Band, you can drag the
control into another band.
Examples ls_data = dw1.Object.emp_title.Band
ls_data = dw1.Describe("emp_title.Band")
Bandname.property
Description Settings for the color, size, and pointer of a band in the DataWindow object.
The gradient settings do not work in reports.

Applies to DataWindows
dw_control.Object.DataWindow.bandname.property
"DataWindow.bandname{.#}.property { = value }"
bandname The identifier of a band in the DataWindow object.
Values are:
• Detail
• Footer
• Summary
• Header
• Trailer
• Tree.Level
Setting the header.#, trailer.#, and tree.level.# bands

You cannot use dot notation to set the header.#, trailer.#, and
tree.level.# bands.
# The number of the group or TreeView level you want when

bandname is Header, Trailer, or Tree.Level. The group must
exist.
property A property that applies to the band, as listed in the table below.
value Values for the properties are shown in the following table.
Property for Bandname Value

Brushmode (exp) An integer indicating the type of “brush” to use for the gradient.
Values are:
0 – Solid
1 – Horizontal
2 – Vertical
3 – Angle
4 – ScaledAngle
5 – Radial
Painter: Background tab, Gradient group (not available for RichText, Graph, or OLE
DataWindow objects).
198 PowerBuilder

Color (exp) A long specifying the color (the red, green, and blue values) to be used as the
band’s background color. Value can be a quoted DataWindow expression.
Painter: General tab.
Height An integer specifying the height of the detail area in the unit of measure specified for
the DataWindow.
Painter: General tab.
For another way of setting the height of the detail band, see the SetDetailHeight
method.
Height.AutoSize Allows the band to grow to display a row, picture, or nested report without cutting off
any of its content. In the detail band, selecting this property sets the minimum height
for all rows to the size specified by the Height property for the band.
Values are:
No – Fixes the band height to the size set for the Height property of the band.
Yes – Adjusts the band height to accommodate the full content of a row or the
controls in the band. However, the band height cannot be reduced below the value
set for the Height property of the band.
This property can be especially useful to set on the detail band when it contains rows
with a text column that you want to display without cutting off any of the text. The
height of the detail band must not grow larger than a page, except when it contains
nested DataWindows with the Report.Height.AutoSize property set to Yes.
You can set this property on individual columns and controls as well as on the band
itself. For more information, see the Height.AutoSize property for DataWindow
objects.
There are some limitations on the use of this property:
• The Height.Autosize property is not supported on DataWindows with Graph,
Label, OLE, or Rich Text presentation styles.
• Nested report overflow to the next page is supported in detail bands only.
• Bands cannot be autosized if autosizing would preclude the display of at least one
detail band row per page.
Painter: General tab when the band is selected.
Pointer (exp) A string specifying a value of the Pointer enumerated datatype or the name of
a cursor file (.CUR) to be used for the pointer. See the SetPointer method for a list
of Pointer values. Pointername can be a quoted DataWindow expression.
Painter: Pointer tab.


Suppress A boolean that lets you suppress group headers after page breaks. You can set this
property on group header bands only. When a group listing straddles a page break, all
group headers for which you set this property will be suppressed. The suppressed
headers do not display at the top of the page. However, if the page break coincides
with the start of a new group, only headers above the current group header can be
suppressed.
Values are:
No – Does not suppress group headers.
Yes – Suppresses group headers.
Painter: General tab when a group header band is selected.
Transparency (exp) An integer in the range 0 to 100, where 0 means that the background is opaque
and 100 that it is completely transparent.
Gradient.Angle (exp) An integer indicating the angle in degrees (values are 0 to 360) used to offset
the color and transparency gradient. This property is used only when the
DataWindow band gradient.mode takes values of 3 or 4.
Gradient.Color (exp) A long specifying the color (the red, green, and blue values) to be used as the
band object’s secondary background color. The gradient defines transitions between
the primary and secondary background colors. Value can be a quoted DataWindow
expression.
Gradient.Focus (exp) An integer in the range 0 to 100, specifying the distance (as a percentage) from
the center where the background color is at its maximum. (For example, if the radial
background.)
Gradient.Scale (exp) An integer in the range 0 to 100 specifying the rate of transition to the gradient
color (as a percentage).
Gradient.Spread (exp) An integer in the range 0 to 100 indicating the contribution of the second color
to the blend (as a percentage).
Gradient.Repetition.Mode (exp) Specifies the mode for determining the number of gradient transitions for band
background color and transparency.
200 PowerBuilder

Gradient.Repetition.Count (exp) An integer specifying the number of gradient transitions for background color
and transparency. A value of 0 indicates 1 transition. A value of 3 indicates 4
transitions. This property is used only when the gradient.repetition.mode property for
the DataWindow band takes the value of 0 (by count).
Gradient.Repetition.Length (exp) A long specifying the number of gradient transitions. This property is used only
when the gradient.repetition.mode property for the DataWindow band takes the value
of 1 (by length). The units for the length that you assign for the band’s gradient
transitions are set by the DataWindow object’s Units property.
Gradient.Transparency (exp) An integer in the range 0 to 100, where 0 means that the band’s secondary
(gradient) background is opaque and 100 that it is completely transparent. The
gradient defines transitions between the primary and secondary transparency settings.
Usage In the painter Select the band by clicking the gray divider for the band. Set
the value in the Properties view.
ls_data = dw1.Object.DataWindow.Detail.Height
dw1.Object.DataWindow.Detail.Pointer = "hand.cur"
ls_data = dw1.Describe("DataWindow.Detail.Height")
ls_data = &
dw1.Describe("DataWindow.Detail.Height.AutoSize")
dw1.Modify("DataWindow.Detail.Pointer='hand.cur'")
dw1.Modify("DataWindow.Detail.Pointer='~"Cross!~" ~t
if(emp_status=~"a~", ~"HourGlass!~", ~"Cross!~")'")
dw1.Modify("DataWindow.Footer.Height=250")
ll_color = RGB(200, 200, 500)
dw1.Modify("DataWindow.Header.2.Color=" &
+ String(ll_color))
dw1.Modify("DataWindow.Trailer.2.Height=500")
dw1.Modify( &
"DataWindow.Summary.Pointer='c:\pb\total.cur'")

Bandname.Text
Description (RichText presentation style only) The rich text content of the specified band
as an ASCII string.
Applies to DataWindows in the RichText presentation style
dw_control.Object.DataWindow.bandname.Text
"DataWindow.bandname.Text { = rtfstring }"
bandname The identifier of a band in the DataWindow object that has the
RichText presentation style. Values are:
• Detail
• Header
• Footer
rtfstring A string whose value is the rich text content of the band. The
string includes the rich text formatting codes, text, and input
fields.
Text assigned to the header or footer band is ignored if
RichText.HeaderFooter is set to no.
When you assign text using the Modify method or dot notation,
nested quotes must be represented with tildes and quotes. If
your data is a pure RTF string, use the PasteRTF method.
Usage In the painter Set the value by editing the content of each band in the painter
workspace.
Examples ls_footertext = dw1.Object.DataWindow.Footer.Text
ls_data = dw1.Describe("DataWindow.Detail.Text")
Bands
Description A list of the bands in the DataWindow object. The list can include one or more
of the following band identifiers, where # is the level number of a group:
Detail, Footer, Header, Header.#, Summary, Trailer.#, Tree.Level.#. The items
in the list are separated by tabs.
202 PowerBuilder
dw_control.Object.DataWindow.Bands
Describe argument:
"DataWindow.Bands"
Examples ls_data = dw1.Object.DataWindow.Bands
ls_data = dw1.Describe("DataWindow.Bands")
BinaryIndex
Description An internal index that PowerBuilder uses to manage the OLE Object control in
the library. There is no reason to get this value; the value has no external
significance.
Syntax "olecontrolname.BinaryIndex"
BitmapName
Description Whether PowerBuilder interprets the column’s value as the name of a picture
file and displays the picture instead of the text. BitmapName’s value is either
Yes or No.
dw_control.Object.columnname.BitmapName
Describe argument:
"columnname.BitmapName"
General tab, Display As Pic option.
Examples ls_data = dw1.Object.emp_name.BitmapName
ls_data = dw1.Describe("emp_name.BitmapName")
Border
Description The type of border for the control.

Applies to Column, Computed Field, Graph, GroupBox, OLE, Picture, Report,

TableBlob, and Text controls
dw_control.Object.controlname.Border
"controlname.Border { = ' value ' }"
SyntaxFromSql:
Column ( ... Border = value ... )
Text ( ... Border = value ... )
controlname The name of the control whose border you want to get or set.
Border setting applies to all columns or all text controls.
value (exp) A number specifying the type of border.
Values are:
0 – None
1 – Shadow
2 – Rectangle
3 – Resize
4 – Line
5 – 3D Lowered
6 – 3D Raised
The value can be a quoted DataWindow painter expression.
When you change between Resize and another border, change
the Resizeable property too so that the control’s appearance and
behavior match.
For columns, you can access the Border property with the
GetBorderStyle and SetBorderStyle methods.
General tab.
Changing the Border setting between Resize and another border affects the
Resizeable option on the Position tab. To make another border resizable,
choose the border then reset Resizeable.
On Windows XP, to display the border of a text column with the XP style (by
default, a blue box), set the Border property to Lowered and the
BackgroundColor of the font to Window Background.
204 PowerBuilder
For examples of other ways to set properties, using Border as an example, see
What you can do with DataWindow object properties on page 447.
ls_data = dw1.Object.emp_name_t.Border
dw1.Object.emp_name_t.Border='6'
ls_data = dw1.Describe("emp_name_t.Border")
dw1.Modify("emp_name_t.Border='6'")
"Style(...) Column(Border=5 ...) ...",
ls_Errors)
Brush.property
Description Settings for the fill pattern and color of a graphic control.
Applies to Oval, Rectangle, and RoundRectangle controls
dw_control.Object.controlname.Brush.property
"controlname.Brush.property { = ' value ' }"
controlname The name of the Line, Oval, Rectangle, RoundRectangle, or
Text control whose Brush property you want to get or set.
property A property that applies to the Brush characteristics of a control,
as listed in the table below.
value Values for the properties are shown in the next table. Value can
be a quoted DataWindow expression.

Property for Brush Value

Color (exp) A long expression specifying the color (the red, green, and blue values) to be
used to fill the control.
Hatch (exp) A number expression specifying the fill pattern of controlname.
Values are:
0 – Horizontal
1 – Bdiagonal (lines from lower left to upper right)
2 – Vertical
3 – Cross
4 – Fdiagonal (lines from upper left to lower right)
5 – DiagCross
6 – Solid
7 – Transparent
8 - Background (use the settings on the Background tab)
General tab.
When you choose a Brush Hatch fill pattern other than Solid or Transparent,
the Background Color and the Brush Color are used for the pattern colors.
ls_data = dw1.Object.oval_1.Brush.Hatch
dw1.Object.oval_1.Brush.Hatch = 5
ls_data = dw1.Describe("oval_1.Brush.Hatch")
dw1.Modify("oval_1.Brush.Hatch='5'")
dw1.Modify("oval_1.Brush.Color='16731766'")
Brushmode
Description Setting that controls the type of “brush” used for the background or primary
gradient.
dw_control.brushmode
“DataWindow (brushmode = { integer } )”
206 PowerBuilder
integer The value to be assigned to the property:
0 – Solid
1 – HorizontalGradient
2 – VerticalGradient
3 – AngleGradient
4 – ScaledAngleGradient
5 – RadialGradient
6 – Picture
Usage In the painter Set the brushmode value on the Background tab of the
Properties view.
If you save to an EMF or WMF, the properties on the Background tab are not
saved with the DataWindow.
The following table explains the possible values for Brushmode:
Value Description
0 - Solid The background is a solid color as selected
1 - HorizontalGradient The color changes horizontally from the primary color
(and transparency) to the secondary color (and
transparency). The primary values are defined by the
datawindow.color and datawindow.transparency, and
the secondary values are defined by
datawindow.gradient.color and
datawindow.gradient.transparency. The gradient can be
repeated using the
datawindow.gradient.repetition.mode property.
2 - VerticalGradient The color changes vertically from the background color
(and transparency) to the secondary color (and
transparency). The primary values are defined by the
datawindow.color and datawindow.transparency, and
the secondary values are defined by
datawindow.gradient.color and
repeated using the

Value Description
3 - AngleGradient The color changes at a specific angle off the horizontal
from the background color (and transparency) to the
secondary color (and transparency). The angle is
specified in datawindow.gradient.angle. The primary
values are defined by the datawindow.color and
datawindow.transparency, and the secondary values are
defined by datawindow.gradient.color and
repeated using the
4 - ScaledAngleGradient The color changes at an angle, which adjusts according
to the changes in the aspect ratio of the DataWindow
control. The starting angle is specified in
datawindow.gradient.angle. The primary values are
defined by the datawindow.color and
repeated using the
5 - RadialGradient The background color (and transparency) starts at the
center and slow changes to the gradient color (and
transparency) at the boundaries of the DataWindow. The
primary values are defined by the datawindow.color and
datawindow.gradient.transparency.
6 - Picture A picture is used as the background. The image is
specified in datawindow.picture.file.
See also Color

Transparency (DataWindow objects)
Gradient.property
Picture.property
Category
See Axis, Axis.property, and DispAttr.fontproperty.
208 PowerBuilder
CheckBox.property
Description Settings for a column whose edit style is CheckBox.
dw_control.Object.columnname.CheckBox.property
"columnname.CheckBox.property { = value }"
columnname The column whose edit style is CheckBox for which you want
to get or set property values.
property A property for the CheckBox edit style, as listed in the table
below.
value Values for the properties are shown in the table below. For
CheckBox properties, value cannot be a DataWindow
expression.
Property for CheckBox Value

LeftText Whether the CheckBox label is to the left or right of the CheckBox.
Values are:
Yes – Display the label on the left.
No – Display the label on the right.
Painter: Edit tab, Left Text option.
Off A string constant specifying the column value when the CheckBox is off
(unchecked). The resulting value must be the same datatype as the column.
Painter: Edit tab, Data Value for Off option.
On A string constant specifying the value that will be put in the column when the
CheckBox is on (checked). The resulting value must be the same datatype as the
column.
Painter: Edit tab, Data Value for On option.
Other A string constant specifying the value that will be put in the column when the
CheckBox is in the third state (neither checked nor unchecked). The value must be
the same datatype as the column.
Painter: Edit tab, This option is available when ThreeStates is True.

Property for CheckBox Value

Scale Whether you want to scale the 2D CheckBox. Takes effect only when the ThreeD
property is No.
Values are:
Yes – Scale the CheckBox.
No – Do not scale the CheckBox.
Painter: Edit tab,Scale option.
Text A string specifying the CheckBox’s label text.
Painter: Edit tab, Text option.
ThreeD Whether the CheckBox should be 3D.
Values are:
Yes – Make the CheckBox 3D
No – Do not make the CheckBox 3D
Painter: Edit tab, 3D Look option.
ThreeStates Whether the CheckBox should have three states.
Values are:
Yes – The CheckBox has three states
No – The CheckBox does not have three states
Painter: Edit tab, 3 States option.
Usage In the painter Select the control and set values in the Properties view, Edit
tab, when Style Type option is CheckBox.
Examples dw1.Modify("emp_gender.CheckBox.3D=no")
IF dw1.Describe("emp_status.CheckBox.LeftText") &
= "yes" THEN
dw1.Modify("emp_status2.CheckBox.LeftText=yes")
END IF
dw1.Modify("emp_status.CheckBox.Off='Terminated'")
dw1.Modify("emp_status.CheckBox.On='Active'")
dw1.Modify("emp_status.CheckBox.Other='Unknown'")
dw1.Object.emp_gender.CheckBox.ThreeD = "no"
IF dw1.Object.emp_status.CheckBox.LeftText = "yes" THEN
dw1.Object.emp_status2.CheckBox.LeftText = "yes"
END IF
ClientName
Description The name of the OLE client. The default is “Untitled.” ClientName is used by
some applications in the server window’s title.
210 PowerBuilder
Applies to OLE Object and TableBlob controls

dw_control.Object.controlname.ClientName
"controlname.ClientName { = ’ clientname ' }"
controlname The name of a blob column or an OLE Object control.
clientname (exp) A string expression to be used in the title of the server
application’s window. For a blob, the string usually includes
data from the current row so that the window title can identify
the blob’s row.
Begin the string with a tab (~t) when you modify the value so
that PowerBuilder evaluates the expression instead of
displaying it.
Options tab.
Examples cname = dw1.Object.emppict_blob.ClientName
dw1.Object.emppict_blob.ClientName = &
"~t'Data for ' String(emp_id)"
cname = dw1.Describe("emppict_blob.ClientName")
dw1.Modify("emppict_blob.ClientName='" + &
"~t~"Data for ~" + String(emp_id)'")
Color
Description The text color of the column or the background color of the DataWindow.
The color affected by the Color property depends on the control:
• For the DataWindow, Color specifies the background color
• For columns, computed fields, and text, Color specifies the text color
• For graphs, Color specifies the line color used for axes, borders around
data markers, tick marks, and the outline of the box for 3D graphs
Applies to DataWindow, Button, Column, Graph, and GroupBox controls
dw_control.Object.DataWindow.Color

dw_control.Object.controlname.Color
"DataWindow.Color { = long }"
"controlname.Color { = long }"
SyntaxFromSql:
DataWindow ( Color = long )
Column ( Color = long )
controlname The column whose text color you want to set or the graph whose
line color you want to set.
long (exp for columns only) A long value specifying the color of the
column text or the DataWindow background. When you are
specifying the text color of a column, you can specify a
DataWindow expression in quotes. You cannot specify an
expression for the DataWindow background color.
Color setting for Column applies to all columns.
Usage In the painter For the DataWindow background, click the DataWindow to
deselect all controls and set the value in the Properties view, Background tab,
Color option. If you save to an EMF or WMF, the properties on the Background
tab are not saved with the DataWindow.
For a column’s text color, select the column and set the value in the Properties
view, Font tab, Text Color option.
For a graph’s line color, select the graph and set the value in the Properties
view, General tab, Text Color option.
Examples string column_text_color
column_text_color = dw1.Object.emp_name.Color
dw1.Object.salary.Color = &
"0~tIf(salary>90000,255,65280)"
dw_back_color = dw1.Describe("DataWindow.Color")
column_text_color = dw1.Describe("emp_name.Color")
dw1.Modify( &
"salary.Color='0~tIf(salary>90000,255,65280)'")
See also BackColor
Background.property
212 PowerBuilder
ColType
Description The datatype of the column or computed field.
Applies to Column and Computed Field controls
dw_control.Object.controlname.ColType
Describe argument:
"controlname.ColType"
controlname The column for which you want the datatype. Possible
datatypes are:
• Char (n) – n is the number of characters
• Date
• DateTime
• Decimal (n) – n is the number of decimal places
• Int
• Long
• Number
• Real
• Time
• Timestamp
• ULong
Usage In the painter The value of ColType is derived from the data or expression
you specify for the control. The value is displayed in the Column
Specifications view.
Date column types

If you define a DataWindow with a column of type Date and deploy it with a
DBMS that uses the DateTime datatype, set the StaticBind database parameter
to 0 or No. This forces PowerBuilder to get a result set description before
retrieving data and adjust the bind information if necessary.
For more information, see the StaticBind DBParm parameter in the online
Help.
Examples string ls_coltype

ls_coltype = dw1.Object.emp_id.ColType
ls_coltype = dw1.Describe("emp_id.ColType")

Column.Count
Description The number of columns in the DataWindow object.
dw_control.Object.DataWindow.Column.Count
Describe argument:
"DataWindow.Column.Count"
Usage In the painter The value is determined by the number of columns you select
in the SQL Select painter, whether or not they are displayed.
Column limit
There is a limit of 1000 on the number of columns in a DataWindow object.
Examples string ls_colcount

ls_colcount = dw1.Object.DataWindow.Column.Count
ls_colcount = dw1.Describe("DataWindow.Column.Count")
ContentsAllowed
Description The way the OLE Object control holds the OLE object. You can restrict the
container to only embedded or only linked objects, or you can allow either
type.
dw_control.Object.olecontrolname.ContentsAllowed
"olecontrolname.ContentsAllowed { = ' contentstype ' }"
214 PowerBuilder
olecontrolname The name of the OLE Object control for which you want to get or
set the type of contents.
contentstype A number specifying whether the OLE object in the control has to
be embedded, has to be linked, or can be either embedded or
linked.
Values are:
0 – Embedded
1 – Linked
2 – Any
Options tab, Contents option.
ls_data = dw1.Object.ole_report.ContentsAllowed
dw1.Object.ole_report.ContentsAllowed = 2
ls_data = dw1.Describe("ole_report.ContentsAllowed")
dw1.Modify("ole_report.ContentsAllowed='2'")
Criteria
Description The search condition of the WHERE clause for a related report. The Criteria
property defines the connection between the related report and the
DataWindow.
Applies to Report controls
dw_control.Object.reportname.Criteria
"reportname.Criteria { = string }"
reportname The name of the report control for which you want to get or set
Criteria.
string An expression that will be the search condition of the WHERE
clause for the related report.
Examples ls_colcount = dw1.Object.rpt_1.Criteria

dw1.Object.rpt_1.Criteria = "emp_id=:emp_id"
ls_colcount = dw1.Describe("rpt_1.Criteria")
dw1.Modify("rpt_1.Criteria='emp_id=:emp_id'")
See also Nest_Arguments DataWindow object property
Criteria.property
Description Settings for the Prompt for Criteria dialog box. When Prompt for Criteria is
enabled, PowerBuilder prompts the user to specify criteria for retrieving data
whenever the Retrieve method is called. Note that the Required property also
affects query mode.
dw_control.Object.columnname.Criteria.property
"columnname.Criteria.property { = value }"
columnname The name of the column for which you want to get or set Prompt
for Criteria properties.
property A property for the Prompt for Criteria dialog box. Properties and
their settings are listed in the table below.
value A Yes or No value to be assigned to the property. For Criteria
properties, value cannot be a DataWindow expression.
Property for Criteria Value

Dialog Whether Prompt for Criteria is on for columnname.
Values are:
Yes – Include columnname in the Prompt for Criteria dialog box.
No – (Default) Do not include columnname in the Prompt for Criteria dialog box.
If the Dialog property is Yes for at least one column in the DataWindow, then
PowerBuilder displays the Prompt for Criteria dialog box when the Retrieve method
is called.
Painter: Column Specifications view, Prompt check box.
216 PowerBuilder
Property for Criteria Value

Override_Edit Whether the user must enter data in the Prompt for Criteria dialog box according to
the edit style defined for the column in the DataWindow object or be allowed to enter
any specifications in a standard edit control.
Values are:
Yes – Allow the user to override the column’s edit style and enter data in a standard
edit control.
No – (Default) Constrain the user to the edit style for the column.
Painter: Properties view, General Tab, Override Edit option.
Required Whether the user is restricted to the equality operator (=) when specifying criteria in
query mode and in the Prompt for Criteria dialog box.
Values are:
Yes – Require the user to use the equality operator only.
No – (Default) Allow the user to use any relational operator, including =, <>, <, >,
>=, and <=.
Painter: Properties view, General tab, Equality Required option.
Usage In the painter Set the values using the menus and Properties view as
described in the table above.
Examples string setting
setting = dw1.Object.empname.Criteria.Dialog
dw1.Object.empname.Criteria.Dialog= "Yes"
setting = dw1.Describe("empname.Criteria.Dialog")
dw1.Modify("empname.Criteria.Dialog=Yes")
dw1.Modify("empname.Criteria.Override_Edit=Yes")
dw1.Modify("empname.Criteria.Required=No")
IF dw1.Describe("empname.Edit.Style") = "dddw" THEN
dw1.Modify("empname.Criteria.Override_Edit=Yes")
END IF
Crosstab.property
Description Settings for a DataWindow object whose presentation style is Crosstab.
dw_control.Object.DataWindow.Crosstab.property

"DataWindow.Crosstab.property { = value }"

property A property for a Crosstab DataWindow. Properties and their
settings are listed in the table below.
value A string expression listing the items to be assigned to the
property. For Crosstab properties, value is always quoted and
can be a DataWindow expression.
Property for Crosstab Value

Columns (exp) A string containing a comma- or tab-separated list of the names of columns that
make up the columns of the crosstab. These are the columns that display across the
top of the crosstab.
Painter: Columns option.
Rows (exp) A string containing a comma- or tab-separated list of the names of columns that
make up the rows of the crosstab.
Painter: Rows option.
SourceNames (exp) A string containing a comma-separated list of column names to be displayed in
the Crosstab Definition dialog box. The default names are the column names from the
database.
Painter: Source Data option.
StaticMode A string indicating whether a dynamic crosstab should be put into a static mode. The
dynamic crosstab remains in static mode until you set StaticMode to No. While the
dynamic crosstab is in static mode, you can manipulate the properties of individual
columns.
Values are:
Yes – StaticMode is enabled
No – (Default) StaticMode is disabled
Painter: Not set in painter.
Values (exp) A string containing a comma- or tab-separated list of expressions that will be
used to calculate the values of the crosstab.
Painter: Values option.
Usage In the painter For DataWindow objects with the Crosstab presentation style,
set the values in the Crosstab Definition dialog box. To display the dialog box,
right-click in the Design view to display the pop-up menu and select Crosstab.
Examples setting = dw1.Object.DataWindow.Crosstab.Columns
dw1.Object.DataWindow.Crosstab.Columns = "dept_id"
setting = dw1.Describe("DataWindow.Crosstab.Columns")
dw1.Modify("DataWindow.Crosstab.Columns='dept_id'")
218 PowerBuilder
dw1.Modify("DataWindow.Crosstab.Rows='salary'")
dw1.Modify("DataWindow.Crosstab.SourceNames=" &
+ "'Order Number, Item Number, Price'")
dw1.Modify("DataWindow.Crosstab.Values='empname'")
dw1.Modify("DataWindow.Crosstab.StaticMode='yes'")
See also CrosstabDialog function in the PowerScript Reference
Table.property
CSSGen.property
Description Settings that specify the physical path to which a generated CSS style sheet is
published and the URL where the style sheet is located.
Obsolete property
CSSGen.property is obsolete and should not be used, because the Web
Applies to DataWindow objects

dw_control.Object.DataWindow.CSSGen.property
"DataWindow.CSSGen.property { = ' value ' }"
property One of the following:
• PublishPath
• ResourceBase
• SessionSpecific
value (exp) PublishPath – a string that specifies the physical path of the Web
site folder to which PowerBuilder publishes the generated CSS style
sheet
(exp) ResourceBase – a string that specifies the URL of the generated
CSS style sheet to be referenced in a link element in the XHTML page
(exp) SessionSpecific – a boolean that when set to “yes” forces a
session-specific ID to be applied to any generated document names
that would otherwise be shared

Usage The PublishPath folder must correspond to the URL specified in the
ResourceBase property. At runtime, after PowerBuilder generates the CSS
style sheet to the PublishPath folder, it includes it in the final XHTML page by
referencing it with the ResourceBase property in a <link> element.
Typically you share style (CSS), layout (XSLT), and control definitions (JS) for
use by all clients; however, if you use dynamic DataWindow objects
customized for specific clients, you can force generation of the DataWindow
presentation-related document names to be specific to each client. You do this
by setting the CSSGen.SessionSpecific property to “yes”. This eliminates the
possibility of server-side contention for presentation formats when the
DataWindow generation is specific to the client.
In the painter In the Web Generation tab in the Properties view for the
DataWindow object, select CSS from the Format to Configure list, specify the
Resource Base and Publish Path locations, and check the Session-specific CSS,
XSLT and JS file names check box if you want to force generation of
client-specific names.
Examples These statements set the CSSGen.ResourceBase and CSSGen.PublishPath
properties:
dw1.Object.DataWindow.CSSGen.ResourceBase= &
'http://www.myserver.com/xmlsource'
dw1.Object.DataWindow.CSSGen.PublishPath= &
'C:\work\outputfiles\xmlsource'
This statement sets the CSSGen.SessionSpecific property for a JSP page:
dwGen.Modify
("DataWindow.CSSGen.SessionSpecific='Yes'");
Data
Description A tab-separated list describing the data in the DataWindow object.
dw_control.Object.DataWindow.Data
Describe argument:
"DataWindow.Data"
setting = dw1.Object.DataWindow.Data
220 PowerBuilder
setting = dw1.Describe("DataWindow.Data")
Data.HTML
Description A string containing HTML and JavaScript that represents data and presentation
of the DataWindow object.
The data is presented in a read-only HTML table or data-entry form, depending
on settings of other properties.
Obsolete property
Data.HTML is obsolete and should not be used, because the Web DataWindow
technology is obsolete.
dw_control.Object.DataWindow.Data.HTML
Describe argument:
"DataWindow.Data.HTML"
Usage When HTMLDW is set to False, the value of Data.HTML is the same as the
value of HTMLTable—a read-only HTML table that displays all retrieved
rows.
When the HTMLDW property is set to True, the value of Data.HTML is a form
that supports data input with client scripts for data validation and events. The
generated string for Data.HTML includes:
• HTML input elements
• JavaScript for validating newly entered data based on validation rules in
the DataWindow object
• HTML and JavaScript for navigation based on DataWindow Button
controls with scrolling actions
• State information about the modification status of data items
JavaScript for navigation passes the state of the DataWindow back to the page
server in two variables: objectname_action and objectname_context. It also
passes back any page parameters defined in the HTMLGen.SelfLinkArgs
property. All the HTMLGen.property values affect the way HTML is
generated.

The resulting Web DataWindow is a client-side control for a Web page with
events and methods that can cooperate with a server component for a
Web-based data entry application.
Exceptions If the DataWindow is in print preview mode, or there are no
columns with non-zero tab order, the setting of HTMLDW is ignored and the
generated HTML is a read-only table, not a data-entry form.
To generate a simple form without data entry methodality, you can use the
GenerateHTMLForm method.
Examples strHtml = dw1.Object.DataWindow.Data.HTML
strHtml = dw1.Describe("DataWindow.Data.HTML")
Data.HTMLTable
Description The data in the DataWindow object described in HTML table format. This
property is used in the process of dynamically creating Web pages from a
database.
Obsolete property
Data.HTMLTable is obsolete and should not be used, because the Web
dw_control.Object.DataWindow.Data.HtmlTable
Describe argument:
"DataWindow.Data.HtmlTable"
Usage Some presentation styles translate better into HTML than others. The Tabular,
Group, Freeform, Crosstab, and Grid presentation styles produce good results.
The Composite, RichText, OLE 2.0, TreeView, and Graph presentation styles
produce HTML tables based on the result set only and not on the presentation
style. DataWindows with overlapping controls in them might not produce the
desired results. Nested reports are ignored; they are not included in the
generated HTML.
The generated HTML for Data.HTMLTable is a read-only HTML Table
element that includes:
• All retrieved rows
222 PowerBuilder
• Hyperlinks for text, pictures, computed fields, and columns as defined in

the HTML.property settings
Data.HTMLTable is not affected by the HTMLDW property and does not
generate a client control with events and support for scripting in the Web page.
The values of HTMLGen.Browser and HTMLGen.Version affect the
generated HTML. Setting these properties causes the generated HTML to be
optimized for a specific level of HTML support or specific browser using style
sheets and absolute positioning, if possible. For more information, see
HTMLGen.property.
The resulting HTML table does not allow data entry. To produce HTML forms,
see the Data.HTML property and the GenerateHTMLForm method.
An easy way to see a DataWindow in a Web browser The HTML string
that the Data.HTMLTable property returns is equivalent to the string that is
saved when you use either the FileSave Rows As HTML Table option in the
DataWindow painter workspace or the SaveAs method.
To see what a DataWindow will look like, save it as an HTML file and open
the file in a Web browser such as Netscape.
In the painter When HTMLDW is not selected, the Design>HTML Preview
displays the value of Data.HTMLTable. Save an HTML file that you can use
later in a browser with File>Save Rows As; set the Save As Type to HTML
Table.
Examples ls_html = dw1.Object.DataWindow.Data.HTMLTable
ls_html = dw1.Describe("DataWindow.Data.HTMLTable")
Data.XHTML
Description A string containing the row data content of the DataWindow object in XHTML
format.
Obsolete property
Data.XHTML is obsolete and should not be used, because the Web DataWindow
dw_control.Object.DataWindow.Data.XHTML

Describe argument:
"DataWindow.Data.XHTML"
Usage If any of the Export.XHTML properties have been set, the string that is generated
reflects the values of these properties.
The resulting XHTML string contains a <form> element that supports data
input, which works with separate client scripts for data validation and events.
This JavaScript is either dynamically generated and/or statically deployed. To
generate static JavaScript, select HTML/XHTML from the Format to
Configure drop-down list on the JavaScript Generation page in the
DataWindow painter Properties view, specify names for the files you want to
generate, and click the Generate File button.
The generated XHTML string also includes:
• XHTML input elements
• XHTML and JavaScript for navigation based on DataWindow button
property. All applicable HTMLGen.property values also affect the way the
XHTML is generated.
The resulting XML Web DataWindow is a client-side control for a Web page,
such as a JSP page, with events and methods that can cooperate with a server
component for a Web-based data entry application.
Examples The following statements set the template used by the DataWindow dw1 to
t_report and return the generated XHTML document to the string ls_XHTML. To
generate the string, the final statement invokes the XML Web DataWindow
generator to generate the XHTML, CSS, and JavaScript components, applying
the t_report template to the generated XHTML and CSS style sheet.
string strXHTML
dw1.Modify("DataWindow.Export.XHTML.UseTemplate =
't_report'")
strXHTML = dw1.Describe("DataWindow.Data.XHTML")
224 PowerBuilder
Data.XML
Description A string containing the row data content of the DataWindow object in XML
format.
dw_control.Object.DataWindow.Data.XML
Describe argument:
"DataWindow.Data.XML"
Usage If any of the Export.XML properties have been set, the string that is generated
Note If Export.XML.SaveMetaData is set to MetaDataExternal!, no metadata is

generated in the string.
t_report, specify that metadata in the XMLSchema! format should be included
in the generated XML, and return the generated XML document to the string
ls_xml.
string ls_xml
dw1.Modify("DataWindow.Export.XML.UseTemplate =
't_report'")
dw1.Modify("DataWindow.Export.XML.SaveMetaData =
MetaDataInternal!")
dw1.Modify
("DataWindow.Export.XML.MetaDataType = XMLSchema!")
ls_xml = dw1.Object.DataWindow.Data.XML
Data.XMLDTD
Description A string containing the full document type definition (DTD) of the XML
output for a DataWindow object.
dw_control.Object.DataWindow.Data.XMLDTD
Describe argument:
"DataWindow.Data.XMLDTD"

Usage Use this property to return the full DTD of the XML output of a DataWindow
object separately from the generated XML document itself. The export
template used affects the generated DTD.
t_report and return the generated DTD to the string ls_xml_dtd.
string ls_xml_dtd
dw1.Object.DataWindow.Export.XML.UseTemplate =
't_report'
ls_xml_dtd = dw1.Object.DataWindow.Data.XMLDTD
Data.XMLSchema
Description A string containing the full schema of the XML output of a DataWindow
object.
dw_control.Object.DataWindow.Data.XMLSchema
Describe argument:
"DataWindow.Data.XMLSchema"
Usage Use this property to return the full schema of the XML output of a
DataWindow object separately from the generated XML document itself. The
export template used affects the generated schema.
t_report and return the XML schema to the string ls_xml_schema.
string ls_xml_schema
dw1.Object.DataWindow.Export.XML.UseTemplate =
't_report'
ls_xml_schema = dw1.Object.DataWindow.Data.XMLSchema
Data.XMLWeb
Description A string containing browser-specific JavaScript that performs the XSLT
transformation on the browser after the XML Web DataWindow generator
generates all necessary components.
226 PowerBuilder
Obsolete property
Data.XMLWeb is obsolete and should not be used, because the Web
dw_control.Object.DataWindow.Data.XMLWeb
Describe argument:
"DataWindow.Data.XMLWeb"
Usage If any of the Export.XHTML properties have been set, the string that is generated
The resulting XHTML string contains a <form> element that supports data
input, which works with separate client scripts for data validation and events.
This JavaScript is either dynamically generated and/or statically deployed. To
generate static JavaScript, select HTML/XHTML from the Format to
Configure drop-down list on the JavaScript Generation page in the
DataWindow painter Properties view, specify names for the files you want to
generate, and click the Generate File button.
The generated XHTML string also includes:
• XHTML input elements
• XHTML and JavaScript for navigation based on DataWindow button
property. All applicable HTMLGen.property values also affect the way the
XHTML is generated.
The resulting XML Web DataWindow is a client-side control for a Web page,
such as a JSP page, with events and methods that can cooperate with a server
component for a Web-based data entry application.

t_report and return the generated XSLT transformation to the string
ls_transform. To generate the string, the final statement invokes the XML Web
DataWindow generator to generate the XML, XSLT, CSS, and JavaScript
components, applying the t_report template to the generated XSLT and CSS
style sheet.
string ls_transform
't_report'")
ls_transform = dw1.Object.DataWindow.Data.XMLWeb
Data.XSLFO
Description A string containing XSL Formatting Objects (XSL-FO) that represents the data
and presentation of the DataWindow object.
dw_control.Object.DataWindow.Data.XSLFO
Describe argument:
"DataWindow.Data.XSLFO"
Usage Use this property to return the data and presentation of a DataWindow object
in XSL-FO format. The export template associated with the DataWindow
object does not affect the generated string.
Examples The following statements return the data and presentation of the DataWindow
object dw1 to the string ls_xslfo in XSL-FO format.
string ls_xslfo
ls_xslfo = dw1.Object.DataWindow.Data.XSLFO
DataObject
Description The name of the DataWindow object that is the nested report within the main
DataWindow object.
dw_control.Object.reportname.DataObject
228 PowerBuilder

"reportname.DataObject = ' dwname ' "
reportname The name of the Report control in the main DataWindow object
for which you want to get or set the nested DataWindow object
dwname A string naming a DataWindow object in the application’s
libraries that is the DataWindow object for the report within the
main DataWindow object
General tab, Report option.
Examples setting = dw1.Object.rpt_1.DataObject
dw1.Object.rpt_1.DataObject = "d_empdata"
setting = dw1.Describe("rpt_1.DataObject")
dw1.Modify("rpt_1.DataObject='d_empdata'")
dbAlias
Description The name of the database column but with the table alias in place of the table
name, if any. This value can be used to construct the update DataWindow
syntax dynamically when an alias name is used for a table.
dw_control.Object.columnname.dbAlias
"columnname.dbAlias { = ' dbcolumnname ' }"
columnname The name of the column for which you want the name of the
corresponding database column qualified with the table alias
name
dbcolumnname The name of the database column associated with columnname
qualified with the alias of the table name
Usage DbAlias is the name of the database column in the format

tablealiasname.columnname. The value of dbAlias does not include the quotes
that can be part of the SQL syntax. This property can be used to construct
update DataWindow syntax dynamically when an alias is used for a column
name.

In the painter You can specify an alias for a table in the SQL Select painter
if you convert the SQL statement for a DataWindow object to syntax. Select
Design>Data Source to open the SQL Select painter, then select
Design>Convert to Syntax. In the text window that displays, add the alias name
to the FROM clause using the syntax:
FROM tablename tablealiasname
Examples Suppose a DataWindow object has the following SQL Select syntax, with the
alias “emp” for the table “employee”:
SELECT "emp"."emp_id",
"emp"."emp_fname",
"emp"."emp_lname"
"emp"."dept_id"
"emp"."salary"
FROM "employee" "emp"
WHERE ( "emp"."salary" > 50000 )
Then the following statements would return the string “employee.emp_id” in
ls_name and the string “emp.emp_id” in ls_alias:
string strAlias, strName
strName = dw1.Object.emp_id.dbName
strAlias = dw1.Object.emp_id.dbAlias
strName = dw1.Describe("emp_id.dbName")
strName = dw1.Describe("emp_id.dbAlias")
See also dbName
dbName
Description The name of the database column. PowerBuilder uses this value to construct
the update syntax.
dw_control.Object.columnname.dbName
"columnname.dbName { = ' dbcolumnname ' }"
columnname The name of the column for which you want the name of the
corresponding database column
230 PowerBuilder
dbcolumnname The name of the database column associated with columnname
Usage DbName is the name of the database column in the format

tablename.columnname. The value of dbName does not include the quotes that
can be part of the SQL syntax.
In the painter The Syntax view in the SQL Select painter displays the
database column names (they can be shown with quotes).
Examples dbcol = dw1.Object.emp_id.dbName
dw1.Object.emp_id.dbName = "emp_id"
dbcol = dw1.Describe("emp_id.dbName")
dw1.Modify("emp_id.dbName='emp_id'")
See also dbAlias
dddw.property
Description Properties that control the appearance and behavior of a column with the
DropDownDataWindow edit style.
dw_control.Object.columnname.dddw.property
"columnname.dddw.property { = value }"
columnname The name of a column that has the DropDownDataWindow edit
style.
property A property for the DropDownDataWindow column. Properties
and their settings are listed in the table below.
value The value to be assigned to the property. For dddw properties,
value cannot be a DataWindow expression.

Property for dddw Value

AllowEdit Whether the user can type a value as well as choose from the
DropDownDataWindow’s list.
Values are:
Yes – Typing is allowed.
No – (Default) Typing is not allowed.
Call GetChild after setting dddw.AllowEdit to get a valid reference to the column’s
DropDownDataWindow.
Painter: Allow Editing option.
AutoHScroll Whether the DropDownDataWindow automatically scrolls horizontally when the
user enters or deletes data.
Values are:
Yes – (Default) Scroll horizontally automatically.
No – Do not scroll automatically.
Painter: Auto Horizontal Scroll option.
AutoRetrieve Whether the DropDownDataWindow data is retrieved when the parent DataWindow
data is retrieved.
Values are:
Yes – (Default) Data is automatically retrieved.
No – Data must be retrieved separately.
Painter: AutoRetrieve option.
Case The case of the text in the DropDownDataWindow.
Values are:
Any – Character of any case allowed.
Upper – Characters converted to uppercase.
Lower – Characters converted to lowercase.
Call GetChild after setting dddw.Case to get a valid reference to the column’s
DropDownDataWindow.
Painter: Case option.
DataColumn A string whose value is the name of the data column in the associated
DropDownDataWindow. Value is quoted.
Call GetChild after setting dddw.DataColumn to get a valid reference to the column’s
DropDownDataWindow.
Painter: Data Column option, visible after selecting a DataWindow.
DisplayColumn A string whose value is the name of the display column in the associated
DropDownDataWindow. Value is quoted.
Call GetChild after setting dddw.DisplayColumn to get a valid reference to the
column’s DropDownDataWindow.
Painter: Display Column option, visible after selecting a DataWindow.
232 PowerBuilder

HScrollBar Whether a horizontal scroll bar displays in the DropDownDataWindow.
Values are:
Yes – Display a horizontal scroll bar.
No – Do not display a horizontal scroll bar.
Painter: Horizontal Scroll Bar option.
HSplitScroll Whether the horizontal scroll bar is split. The user can adjust the split position.
Values are:
Yes – Split the horizontal scroll bar so the user can scroll the display and data
columns separately.
No – The horizontal scroll bar is not split.
Painter: Split Horizontal Scroll Bar option.
Limit An integer from 0 to 32767 specifying the maximum number of characters that can
be entered in the DropDownDataWindow. Zero means unlimited.
Painter: Limit option.
Lines An integer from 0 to 32767 specifying the number of lines (values) to display in the
DropDownDataWindow. This property does not apply in Web pages because the
browser controls how the DropDownDataWindow displays.
Painter: Lines in DropDown option.
Name A string whose value is the name of the DropDownDataWindow associated with the
column.
Call GetChild after setting dddw.Name to get a valid reference to the column’s
DropDownDataWindow.
Painter: DataWindow option.
NilIsNull Whether to set the data value of the DropDownDataWindow to null when the user
leaves the edit box blank.
Values are:
Yes – Make the Empty string null.
No – Do not make the empty string null.
Painter: Empty String is null option.
PercentWidth An integer specifying the width of the drop-down portion of the
DropDownDataWindow as a percentage of the column’s width. For example, 300
sets the display width to three times the column width.
Call GetChild after setting dddw.PercentWidth to get a valid reference to the
column’s DropDownDataWindow.
Painter: Width of DropDown option.


Required Whether the column is required.
Values are:
Yes – Required.
No – (Default) Not required.
Painter: Required option.
ShowList Whether the ListBox portion of the DropDownDataWindow displays when the
column has focus. A down arrow does not display at the right end of the
DropDownDataWindow when dddw.ShowList is yes.
Values are:
Yes – Display the list whenever the column has the focus.
No – Do not display the list until the user selects the column.
Painter: Always Show List option.
UseAsBorder Whether a down arrow displays at the right end of the DropDownDataWindow.
Values are:
Yes – Display the arrow.
No – Do not display the arrow.
Note that if ShowList is set to Yes, the column ignores the UseAsBorder property and
the arrow never displays.
Painter: Always Show Arrow option.
VScrollBar Whether a vertical scroll bar displays in the DropDownDataWindow for long lists.
Values are:
Yes – Display a vertical scroll bar.
No – Do not display a vertical scroll bar..
Painter: Vertical Scroll Bar option.
Usage DropDownDataWindows and GetChild When you set some of the dddw
properties, as noted in the table, references to the DropDownDataWindow
become invalid. Call GetChild again after changing these properties to obtain a
valid reference.
To retrieve a DropDownDataWindow when the AutoRetrieve property is set to
“false”, you can access the object data as follows:
DataWindowChild mgr_id
dw1.GetChild ("dept_head_id", mgr_id)
mgr_id.SetTransObject (SQLCA)
mgr_id.Retrieve ( )
You can also pass a retrieval argument for the retrieve on the child
DataWindow object.
234 PowerBuilder
Doing a reset to clear the data When a DropDownDataWindow is

retrieved, its data is kept with its own Data Object. If you retrieve the
DropDownDataWindow and then set the AutoRetrieve property on the parent
to “false”, the data for the child is not cleared on a reset and re-retrieve of the
parent.
To clear data from a DropDownDataWindow, you must call Reset on the child
DataWindow object:
dw1.GetChild ("dept_head_id", mgr_id)
mgr_id.reset ( )
In the painter Select the control and set values in the Properties view, Edit
tab, when Style Type is DropDownDW.
Examples ls_data = dw1.Describe("emp_status.dddw.AllowEdit")
dw1.Modify("emp_status.dddw.Case='Any'")
dw1.Modify("emp_status.dddw.DataColumn='status_id'")
dw1.Modify("emp_status.dddw.Limit=30")
dw1.Modify("emp_status.dddw.Name='d_status'")
dw1.Modify("emp_status.dddw.PercentWidth=120")
dw1.Object.emp_status.dddw.Case = "Any"
string ls_data
ls_data = dw1.Object.emp_status.dddw.AllowEdit")
ddlb.property
DropDownListBox edit style.
dw_control.Object.columnname.ddlb.property
"columnname.ddlb.property { = value }"
columnname The name of a column that has the DropDownListBox edit style.
property A property for the DropDownListBox column. Properties and
value The value to be assigned to the property. For ddlb properties,

Property for ddlb Value

AllowEdit Whether the user can type a value as well as choose from the DropDownListBox’s
list.
Values are:
Yes – Typing is allowed.
No – (Default) Typing is not allowed.
Painter: Allow Editing option.
AutoHScroll Whether the DropDownListBox automatically scrolls horizontally when the user
enters or deletes data.
Values are:
Yes – (Default) Scroll horizontally automatically.
No – Do not scroll automatically.
Case The case of the text in the DropDownListBox.
Values are:
Limit An integer from 0 – 32767 specifying the maximum number of characters that can be
entered in the DropDownListBox. Zero means unlimited.
NilIsNull Whether to set the data value of the DropDownListBox to null when the user leaves
the edit box blank.
Values are:
Yes – Make the empty string null.
Painter: Empty string is null option.
Values are:
Yes – Required.
236 PowerBuilder
Property for ddlb Value

ShowList Whether the ListBox portion of the DropDownListBox displays when the column has
focus. A down arrow does not display at the right end of the DropDownListBox when
ddlb.ShowList is yes.
Values are:
Yes – Display the list whenever the column has focus.
No – Do not display the list until the user selects the column.
Painter: Always Show List option.
Sorted Whether the list in the DropDownListBox is sorted.
Values are:
Yes – The list is sorted.
No – The list is not sorted.
Painter: Sorted option.
UseAsBorder Whether a down arrow displays at the right end of the DropDownListBox.
Values are:
Yes – Display the arrow.
No – Do not display the arrow.
Note that if ShowList is set to Yes, the column ignores the UseAsBorder property and
the arrow never displays.
Painter: Always Show Arrow option.
VScrollBar Whether a vertical scroll bar displays in the DropDownListBox for long lists.
Values are:
No – Do not display a vertical scroll bar.
Usage In the painter Select the control and set the value in the Properties view, Edit
tab, when Style Type is DropDownListBox.
Examples ls_data = dw1.Describe("emp_status.ddlb.AllowEdit")
dw1.Modify("emp_status.ddlb.Case='Any'")
dw1.Modify("emp_status.ddlb.Limit=30")
string ls_data
ls_data = dw1.Object.emp_status.ddlb.AllowEdit
dw1.Object.emp_status.ddlb.Case = "Any"
DefaultPicture
Description Specifies whether a button displays a default picture for the button’s action.


dw_control.Object.buttonname.DefaultPicture
"buttonname.DefaultPicture { = ' value ' }"
buttonname The name of the button to which you want to assign an action.
value Whether the action’s default picture is used.
Values are:
Yes – Use the default picture.
No – Do not use the default picture.
Usage Default pictures can be associated with all button action types.
You can add your own action pictures by setting the DefaultPicture property to
False and setting the Filename property to the file name for the picture you
want. You can use a URL instead of a complete path to qualify the file name,
and you can leave off the URL server name, mapping prefix, and folder name
if you set them in the HTMLGen.ResourceBase property.
A user-defined action does not have a default picture associated with it.
In the painter Select the control and set the value in the Properties view,
General tab, Action Default Picture option. When the DefaultPicture is not set,
you can specify a picture file name in the Picture File property. Button pictures
can be BMP, GIF, or JPEG files.
Examples dw1.Object.b_name.DefaultPicture = "Yes"
setting = dw1.Describe("b_name.DefaultPicture")
dw1.Modify("b_name.DefaultPicture ='No'")
See also HTMLGen.property
DefaultPicture
Filename
Depth
Description The depth of a 3D graph.
238 PowerBuilder
dw_control.Object.graphname.Depth
"graphname.Depth { = ' depthpercent ' }"
graphname The graph control within the DataWindow for which you want
to set the depth.
depthpercent (exp) An integer whose value is the depth of the graph, specified
as a percentage of the graph’s width. Depthpercent can be a
General tab, Depth slider.
setting = dw1.Object.graph_1.Depth
dw1.Object.graph_1.Depth = 70
setting = dw1.Describe("graph_1.Depth")
dw1.Modify("graph_1.Depth='70'")
Detail_Bottom_Margin
Description The size of the bottom margin of the DataWindow’s detail area.
Applies to Style keywords
Syntax SyntaxFromSql:
Style ( Detail_Bottom_Margin = value )
value An integer specifying the size of the bottom margin of the detail
area in the units specified for the DataWindow.
Examples SQLCA.SyntaxFromSQL(sqlstring, &

'Style(...Detail_Bottom_Margin = 25 ...)', &
errstring)
Detail_Top_Margin
Description The size of the top margin of the DataWindow’s detail area.

Style ( Detail_Top_Margin = value )
value An integer specifying the size of the top margin of the detail
area in the units specified for the DataWindow.

'Style(...Detail_Top_Margin = 25 ...)', &
errstring)
Detail.property
See Bandname.property.
DispAttr.fontproperty
Description Settings for the appearance of various text components of a graph.
Applies to Properties of Graph controls, as noted throughout this discussion
dw_control.Object.graphname.property.DispAttr.fontproperty
"graphname.property.DispAttr.fontproperty { = value }"
graphname The Graph control in a DataWindow for which you want to get
or set font appearance values.
property A text component of the graph, such as an Axis keyword
(Category, Series, or Values), Legend, Pie, or Title, specifying
the graph component whose appearance you want to get or set.
These properties have their own entries. These values are
listed in the following table.
You can also set font properties for the label of an axis with the
following syntax:
"graphname.axis.LabelDispAttr.fontproperty { = value }"
fontproperty A property that controls the appearance of text in the graph.
Properties and their settings are listed in the table below.
value The value to be assigned to fontproperty. Value can be a quoted
240 PowerBuilder
Property for DispAttr Value

Alignment (exp) The alignment of the text.
Values are:
0 – Left
1 – Right
2 – Center
Painter: Alignment option.
Alignment for axis labels and text not supported by Render3D graph style.
AutoSize (exp) Whether the text element should be autosized according to the amount of text
being displayed.
Values are:
0 – Do not autosize
1 – Autosize
Painter: Autosize check box.
BackColor (exp) A long value specifying the background color of the text.
Painter: BackColor option.
DisplayExpression An expression whose value is the label for the graph component. The default
expression is the property containing the text for the graph component. The
expression can include the text property and add other variable text.
Painter: Display Expression option.
Font.CharSet (exp) An integer specifying the character set to be used.
Values are:
0 – ANSI
1 – The default character set for the specified font
2 – Symbol
128 – Shift JIS
255 – OEM
Painter: FontCharSet option.
Font.Escapement (exp) An integer specifying the rotation for the baseline of the text in tenths of a
degree. For example, a value of 450 rotates the text 45 degrees. 0 is horizontal.
Painter: Escapement option.
Font.Face (exp) A string specifying the name of the font face, such as Arial or Courier.
Painter: FaceName option.


Font.Family (exp) An integer specifying the font family (Windows uses both face and family to
determine which font to use).
Values are:
0 – AnyFont
1 – Roman
2 – Swiss
3 – Modern
4 – Script
5 – Decorative
Painter: Family option.
Font.Height (exp) An integer specifying the height of the text in the unit of measure for the
DataWindow. To specify size in points, specify a negative number. Not available
when AutoSize is checked.
Painter: Size option, specified in points.
Font.Italic (exp) Whether the text should be italic.
Values are:
0 – Not italic (default)
1 – Italic
Painter: Italic option.
Font.Orientation Same as Escapement.
Font.Pitch (exp) The pitch of the font.
Values are:
0 – The default pitch for your system
1 – Fixed
2 – Variable
Painter: Pitch option.
Font.Strikethrough (exp) Whether the text should be crossed out.
Values are:
0 – Not crossed out (default)
1 – Crossed out
Painter: Strikeout option.
Font.Underline (exp) Whether the text should be underlined.
Values are:
0 – Not underlined (default)
1 – Underlined
Painter: Underline option.
242 PowerBuilder

Font.Weight (exp) An integer specifying the weight of the text, for example, 400 for normal or 700
for bold.
Painter: Set indirectly using the Bold option.
Font.Width (exp) An integer specifying the width of the font in the unit of measure specified for
the DataWindow. Width is usually unspecified, which results in a default width based
on the other properties.
Painter: Width option.
Format (exp) A string containing the display format for the text.
Painter: Format option.
TextColor (exp) A long specifying the color to be used for the text.
Painter: TextColor option.
Usage In the painter Select the control and set values in the Properties view, Text
tab. Settings apply to the selected item in the Text Object list box.
Examples setting = dw1.Object.Category.LabelDispAttr.Font.Face
dw1.Object.Category.LabelDispAttr.Font.Face = "Arial"
setting = &
dw1.Describe("Category.LabelDispAttr.Font.Face")
dw1.Modify("gr_1.Category.LabelDispAttr.Font.Face= &
'Arial'")
dw1.Modify("gr_1.Title.DispAttr.DisplayExpression=" &
"'Title + ~"~n~" + Today()'")
DisplayType
Description The way the OLE Object control displays the OLE object it contains. It can
display an icon or an image of the object’s contents. The image is reduced to
fit inside the OLE container.
Both the icon and the image are provided by the OLE server. If the OLE server
does not support a contents view, PowerBuilder displays an icon even if
DisplayType is set to contents.
dw_control.Object.olecontrolname.DisplayType

"olecontrolname.DisplayType { = ' type ' }"

olecontrolname The name of the OLE Object control for which you want to get
or set the type of display.
type A number specifying whether the user will see an icon or an
image of the OLE object’s contents. Type can be a quoted
Values are:
0 – Icon
1 – Content
Options tab.
ls_data = dw1.Object.ole_report.DisplayType
dw1.Object.ole_report.DisplayType = 1
ls_data = dw1.Describe("ole_report.DisplayType")
dw1.Modify("ole_report.DisplayType='1'")
Edit.property
Description Settings that affect the appearance and behavior of columns whose edit style is
Edit.
dw_control.Object.columnname.Edit.property
"columnname.Edit.property { = value }"
SyntaxFromSql:
Column ( Edit.property = value )
columnname The column with the Edit edit style for which you want to get
or set property values. You can specify the column name or a
pound sign (#) and the column number.
property A property for the column’s Edit style. Properties and their
settings are listed in the table below. The table identifies the
properties you can use with SyntaxFromSql.
244 PowerBuilder
value The value to be assigned to the property. For most Edit
properties, you cannot specify a DataWindow expression. The
exception is Edit.Format.
Property for Edit Value

AutoHScroll Whether the edit control scrolls horizontally automatically when data is entered or
deleted.
Values are:
Yes – Scroll horizontally automatically.
No – Do not scroll horizontally automatically.
You can use AutoHScroll with SyntaxFromSql. The setting applies to all the columns
in the generated syntax.
AutoSelect Whether to select the contents of the edit control automatically when it receives
focus.
Values are:
Yes – Select automatically.
No – Do not select automatically.
You can use AutoSelect with SyntaxFromSql. The setting applies to all the columns
Painter: Auto Selection option.
AutoVScroll Whether the edit box scrolls vertically automatically when data is entered or deleted.
Values are:
Yes – Scroll vertically automatically.
No – Do not scroll vertically automatically.
You can use AutoVScroll with SyntaxFromSql. The setting applies to all the columns
Painter: Auto Vertical Scroll option.
Case The case of the text in the edit control.
Values are:


CodeTable Whether the column has a code table.
Values are:
Yes – Code table defined.
No – No code table defined.
Painter: Use Code Table option.
DisplayOnly Whether the column is display only.
Values are:
Yes – Do not allow the user to enter data; make the column display only.
No – (Default) Allow the user to enter data.
Painter: Display Only option.
For conditional control over column editing, use the Protect property.
FocusRectangle Whether a dotted rectangle (the focus rectangle) surrounds the current row of the
column when the column has focus.
Values are:
Yes – Display the focus rectangle.
No – Do not display the focus rectangle.
You can use FocusRectangle with SyntaxFromSql. The setting applies to all the
columns in the generated syntax.
Painter: Show Focus Rectangle option.
Format (exp) A string containing the display format of the edit control. The value for Format
is quoted and can be a DataWindow expression.
Painter: Format option (do not use quotes around the value).
HScrollBar Whether a horizontal scroll bar displays in the edit control.
Values are:
Yes – Display the horizontal scroll bar.
No – Do not display the horizontal scroll bar.
Limit A number specifying the maximum number of characters (0 to 32,767) that the user
can enter. 0 means unlimited.
Name A string whose value is the name of the predefined edit style associated with the
column. Named styles are defined in the Database painter and can be reused.
Specifying a name that has not been previously defined associates the name with the
column but does not define a new edit style.
Painter: Style Name option.
246 PowerBuilder

NilIsNull Whether to set the value of the edit control to null when the user leaves it blank.
Values are:
Painter: Empty String is Null option.
Password Whether to assign secure display mode to the column. When the user enters
characters, they display as asterisks (*).
Values are:
Yes – Assign secure display mode to the column.
No – Do not assign secure-display mode to the column.
If you change the Password property, you should also change the Format property to
display the results you want (for example, *****).
Painter: Password option.
Values are:
Yes – It is required.
No – It is not required.
Style (Describe only) Returns the edit style of the column.
Painter: Style Type option.
UseEllipsis Whether an ellipsis (three dots) displays when a column with the Edit edit style
contains character data that is too long for the display column in the DataWindow.
The ellipsis does not display when the column has focus.
Values are:
Yes – Truncate the data and add an ellipsis.
No – Truncate the data. Do not add an ellipsis.
The property is ignored if you:
• Check Autosize Height on the Position page or set the Height.Autosize property
in a script.
• Specify an expression for the Escapement property on the Font page or set the
Font.Escapement property in a script to rotate the text.
Painter: Use Ellipsis check box on the Format page.
ValidateCode Whether the code table will be used to validate user-entered values.
Values are:
Yes – Use the code table.
No – Do not use the code table.
Painter: Validate option, available when Use Code Table is selected.


VScrollBar Whether a vertical scroll bar displays in the line edit.
Values are:
Yes – Display vertical scroll bars.
No – Do not display vertical scroll bars.
tab, when Style Type is Edit.
setting = dw1.Object.emp_name.Edit.AutoHScroll
dw1.Object.emp_name.Edit.Required = "no"
setting = dw1.Describe("emp_name.Edit.AutoHScroll")
dw1.Modify("emp_name.Edit.Required=no")
dw1.Object.col1.Edit.UseEllipsis = Yes
dw1.Modify("col1.Edit.UseEllipsis=Yes")
EditMask.property
Description Settings that affect the appearance and behavior of columns with the EditMask
edit style.
dw_control.Object.columnname.EditMask.property
"columnname.EditMask.property { = value }"
columnname The column with the EditMask edit style for which you want to
get or set property values. You can specify the column name or
a pound sign (#) and the column number.
property A property for the column’s EditMask style. Properties and
value The value to be assigned to the property. For EditMask
properties, you cannot specify a DataWindow expression.
248 PowerBuilder
Property for EditMask Value

AutoSkip Whether the EditMask will automatically skip to the next field when the maximum
number of characters has been entered.
Values are:
Yes – Skip automatically.
No – Do not skip automatically.
Painter: AutoSkip option.
CodeTable Whether the column has a code table.
Values are:
Yes – Code table defined.
No – No code table defined.
Painter: Code Table option. When selected, Display Value and DataValue are
displayed for specifying code table entries.
DDCalendar Whether a drop-down calendar control displays when a user clicks in a column with
a Date or DateTime edit mask.
Values are:
Yes – Drop-down calendar control displays.
No – (Default) Drop-down calendar control does not display.
Painter: Drop-down Calendar option.
DDCal_AlignRight Whether the drop-down calendar is aligned with the right side of the column.
Values are:
Yes – Column is right aligned.
No – (Default) Column is left aligned.
Painter: Drop Align Right option on Other page.
DDCal_BackColor The background color of the drop-down calendar. The default is Window
Background. This property is not supported on the Windows 7/8.1/10 operating
system.
Painter: CalendarBackColor option on Other page.
DDCal_TextColor The color of text in the drop-down calendar. The default is Window Text. This
property is not supported on the Windows 7/8.1/10 operating system.
Painter: CalendarTextColor option on Other page.
DDCal_TitleBackColor The background color of the title in the drop-down calendar. The default is Highlight.
This property is not supported on the Windows 7/8.1/10 operating system.
Painter: CalendarTitleBackColor option on Other page.
DDCal_TitleTextColor The color of text in the title of the drop-down calendar. The default is Highlight Text.
This property is not supported on the Windows 7/8.1/10 operating system.
Painter: CalendarTitleTextColor option on Other page.


DDCal_TrailingTextColor The color of trailing text (days in the previous and next months) in the drop-down
calendar. The default is Disabled Text. This property is not supported on the Windows
7/8.1/10 operating system.
Painter: CalendarTrailingTextColor option on Other page.
FocusRectangle Whether a dotted rectangle (the focus rectangle) will surround the current row of the
Values are:
Yes – (Default) Display the focus rectangle.
Mask A string containing the edit mask for the column.
Painter: Mask option.
ReadOnly Whether the column is read-only. This property is valid only if EditMask.Spin is set
to Yes.
Values are:
Yes – Do not allow the user to enter data; make the column read-only.
No – (Default) Allow the user to enter data.
Painter: Read Only option.
Values are:
Spin Whether the user can scroll through a list of possible values for the column with a
spin control.
Values are:
Yes – Display a spin control.
No – (Default) Do not display a spin control.
Painter: Spin Control option.
SpinIncr An integer indicating the amount to increment the spin control’s values. The default
for numeric values is 1; for dates, 1 year; and for time, 1 minute. Available for
numeric, date, and time columns.
For columns that are not numeric, date, or time, the spin control scrolls through
values in an associated code table. If the EditMask.CodeTable property is No, the spin
increment has no effect for these columns.
Painter: Spin Increment option.
250 PowerBuilder

SpinRange A string containing the maximum and minimum values for the column that will
display in the spin control. The two values are separated by a tilde (~). This property
is effective only if EditMaskSpin is True. Available for numeric, date, and time
columns.
Because the SpinRange string is within another quoted string, the tilde separator
becomes four tildes in PowerBuilder, which reduces to a single tilde when parsed.
The format for the string is:
"EditMask.SpinRange = ' minval~~~~maxval ' "
Painter: Spin Range group, Spin Min and Spin Max options.
UseEllipsis Whether an ellipsis (three dots) displays when a column with the EditMask edit style
contains character data that is too long for the display column in the DataWindow.
The ellipsis does not display when the column has focus.
Values are:
Yes – Truncate the data and add an ellipsis.
No – Truncate the data. Do not add an ellipsis.
The property is ignored if you:
• Check Autosize Height on the Position page or set the Height.Autosize property
in a script.
• Specify an expression for the Escapement property on the Font page or set the
Font.Escapement property in a script to rotate the text.
Painter: Use Ellipsis check box on the Format page.
UseFormat Whether a Format Display mask is used for a column’s display. A Format Display
mask is used only when the column does not have focus.
Values are:
Yes – Use a Format Display mask.
No – (Default) Do not use a Format Display mask.
Painter: Use Format option.
tab, when Style is EditMask.
Examples setting = dw1.Describe("emp_status.EditMask.Spin")
dw1.Modify("empBonus.EditMask.SpinIncr=1000")
dw1.Modify("empBonus.EditMask.SpinRange='0~~~~5000'")
string setting
setting = dw1.Object.emp_status.EditMask.Spin
dw1.Object.emp_bonus.EditMask.SpinIncr = 1000
dw1.Object.id.EditMask.SpinRange = "0~~~~10"
dw1.Object.col1.EditMask.UseEllipsis = Yes
dw1.Modify("col1.EditMask.UseEllipsis=Yes")

Elevation
Description The elevation in a 3D graph.
dw_control.Object.graphname.Elevation
"graphname.Elevation { = ' integer ' }"
graphname The name of the graph control in the DataWindow for which
you want to get or set the elevation.
integer (exp) An integer specifying the elevation of the graph. Elevation
General tab, Elevationscroll bar (enabled when a 3D graph type is selected).
setting = dw1.Object.graph_1.Elevation
dw1.Object.graph_1.Elevation = 35
setting = dw1.Describe("graph_1.Elevation")
dw1.Modify("graph_1.Elevation=35")
dw1.Modify("graph_1.Elevation='10~tIf(...,20,30)'")
EllipseHeight
Description The radius of the vertical part of the corners of a RoundRectangle.
Applies to RoundRectangle controls
dw_control.Object.rrectname.EllipseHeight
"rrectname.EllipseHeight { = ' integer ' }"
252 PowerBuilder
rrectname The name of the RoundRectangle control in the DataWindow
for which you want to get or set the ellipse height.
integer (exp) An integer specifying the radius of the vertical part of the
corners of a RoundRectangle in the DataWindow’s unit of
measure. EllipseHeight can be a quoted DataWindow
expression.
General tab.
setting = dw1.Object.rrect_1.EllipseHeight
dw1.Object.rrect_1.EllipseHeight = 35
setting = dw1.Describe("rrect_1.EllipseHeight")
dw1.Modify("rrect_1.EllipseHeight=35")
dw1.Modify("rrect_1.EllipseHeight='10~tIf(...,20,30)'"
)
EllipseWidth
Description The radius of the horizontal part of the corners of a RoundRectangle.
Applies to RoundRectangle controls
dw_control.Object.rrectname.EllipseWidth
"rrectname.EllipseWidth { = ' integer ' }"
rrectname The name of the RoundRectangle control in the DataWindow
for which you want to get or set the ellipse width.
integer (exp) An integer specifying the radius of the horizontal part of
the corners of a RoundRectangle in the DataWindow’s unit of
measure. EllipseWidth can be a quoted DataWindow
expression.
General tab.
setting = dw1.Object.rrect_1.EllipseWidth

dw1.Object.rrect_1.EllipseWidth = 35
setting = dw1.Describe("rrect_1.EllipseWidth")
dw1.Modify("rrect_1.EllipseWidth=35")
dw1.Modify("rrect_1.EllipseWidth='10~tIf(...,20,30)'")
Enabled
Description Determines whether a control in a DataWindow is enabled.
Applies to Button, Computed Field, Graph, InkPicture, OLE Database Blob, OLE Object,
Picture, and Text controls
dw_control.Object.buttonname.Enabled
"buttonname.Enabled { = ' value ' }"
buttonname The name of the button that you want to enable or disable.
value Whether the button is enabled.
Values are:
Yes – (Default) The button is enabled.
No – The button is disabled.
Usage In the painter Select the control and set the value in the Properties view
General tab, Enabled option.
When the Enabled check box is cleared, or the Enabled property is otherwise
set to false, the button control is grayed and its actions are not performed.
Examples dw1.Object.b_name.Enabled = "No"
setting = dw1.Describe("b_name.Enabled")
dw1.Modify("b_name.Enabled ='No'")
Export.PDF.Distill.CustomPostScript
Description Setting that enables you to specify the PostScript printer driver settings used
when data is exported to PDF using the Distill! method.
254 PowerBuilder
dw_control.Object.DataWindow.Export.PDF.Distill.CustomPostScript
"DataWindow.Export.PDF.Distill.CustomPostScript { = 'value' }"
value (exp) Whether the printer specified in the DataWindow.Printer
property is used when data is exported to PDF.
Values are:
• 1 – The printer specified in DataWindow.Printer is used for
PDF export.
• 0 – The default printer is used for PDF export (default).
Usage The Distill! method performs a PostScript “print to file” before distilling to
PDF. This property can be set to specify that you want to use a custom
PostScript printer before you call the SaveAs method with PDF! as the
SaveAsType or select File>Save Rows As with the file type PDF in the
DataWindow painter.
Set this property if you want to use a PostScript printer driver for which you
have set specific print options such as options for font and graphic handling. If
this property is not set, a default PostScript printer driver specifically designed
for distilling purposes is used.
This property has no effect if the Export.PDF.Method property is set to
NativePDF! or XSLFOP!.
In the painter In the Data Export tab in the Properties view for the
DataWindow object, select PDF from the Format to Configure list and Distill!
from the Method list, and then select Distill Custom PostScript.
Examples This example specifies an HP LaserJet PostScript printer as the printer to be
used to export PDF with customized settings, and saves the data to a file called
custom.pdf:
int li_ret
dw1.Object.DataWindow.Export.PDF.Method = Distill!
dw1.Object.DataWindow.Printer = &
"HP LaserJet 4Si/4Si MX PostScript"
dw1.Object.DataWindow.Export.PDF. &
Distill.CustomPostScript="1"
li_ret = dw1.SaveAs("custom.pdf", PDF!, true)

This example uses Modify to set the PDF export properties and specify a
network printer:
dw1.Modify("DataWindow.Export.PDF.Method = Distill!")
dw1.Modify("Printer = '\\print-server\pr-18' ")
dw1.Modify &
("DataWindow.Export.PDF.Distill.CustomPostScript='1'")
See also Export.PDF.Method
Export.PDF.Method
Description Setting that determines whether data is exported to PDF from a DataWindow
object by printing to a PostScript file and distilling to PDF, by saving to PDF
via PDFlib, or by saving in XSL Formatting Objects (XSL-FO) format and
processing to PDF.
dw_control.Object.DataWindow.Export.PDF.Method
"DataWindow.Export.PDF.Method { = 'value' }"
value A string specifying a value of the PDFMethod enumerated
datatype
Usage This property can be set to specify the method used to export data to PDF
before you call the SaveAs method with PDF! as the SaveAsType or select
File>Save Rows As with the file type PDF in the DataWindow painter. If this
property is not set, the distill method is used by default.
PDFMethod is an enumerated datatype that can hold the following values:
Enumerated value Numeric value Meaning

Distill! 0 Data is printed to a PostScript file and
distilled to PDF (default).
XSLFOP! 1 Data is saved as XSL-FO and
processed to PDF.
NativePDF! 2 Data is saved to PDF using PDFlib.
256 PowerBuilder
The distill method and the PDFlib method provides a robust solution that can
save all types of DataWindow objects on the Windows platform. The XSL-FO
method uses a platform-independent Java process, and is particularly useful for
printing DataWindow objects in the server on a UNIX operating system.
Saving as XSL-FO
You can also save the data in a DataWindow object in XSL-FO format and
customize the filters used to convert it to PDF and other output formats. To do
so, use XSLFO! as the SaveAsType parameter when you call SaveAs, or select
XSL-FO as the file type when you save rows in the DataWindow painter.
Deployment requirements If your application uses the distill method, you

must distribute the GNU Ghostscript files and default PostScript printer driver
and related files (if using the default printer) with your application. If your
application uses the XSL-FO method, you must distribute Apache FOP files
and the Java Runtime Environment (JRE) with your application. For more
information, see the chapter on deploying your application in Application
Techniques.
In the painter On the Data Export page in the Properties view for the
DataWindow object, select PDF from the Format to Configure list and Distill!,
NativePDF!, or XSLFOP! from the Method list.
Examples This statement specifies that data is exported to PDF using XSL-FO:
dw1.Modify("DataWindow.Export.PDF.Method = XSLFOP! ")
See also Export.PDF.Distill.CustomPostScript
Export.PDF.XSLFOP.Print
Export.PDF.NativePDF.CustomOrientation
Export.PDF.NativePDF.CustomSize
Description Setting that enables you to specify the page orientation when you use the
PDFlib method to save data from a DataWindow object to a PDF file.
dw_control.Object.DataWindow.Export.PDF.NativePDF.CustomOrientatio
n
Describe argument:

"DataWindow.Export.PDF.NativePDF.CustomOrientation { = 'value' }"

value (exp) An integer indicating the page orientation.
Values are:
• 0 - The orientation which is set in the Print Specification
page in the DataWindow object’s Properties view.
• 1 - Landscape
• 2 - Portrait
Examples This example exports PDF in portrait mode, and saves the data to a file called
custom.pdf:
int li_ret
dw1.Object.DataWindow.Export.PDF.Method = NativePDF!
dw1.Object.DataWindow.Export.PDF.NativePDF.CustomOrien
tation=2
Description Setting that enables you to specify the paper size when you use the PDFlib
method to save data from a DataWindow object to a PDF file.
dw_control.Object.DataWindow.Export.PDF.NativePDF.CustomSize
Describe argument:
"DataWindow.Export.PDF.NativePDF.CustomSize { = 'value' }"
258 PowerBuilder
value (exp) An integer indicating the paper size.
Values are:
• 0 - Default paper size which is A4 by default.
• 1 - A1 594 x 841 mm
• 2 - A2 420 x 594 mm
• 3 - A3 297 x 420 mm
• 4 - A4 210 x 297 mm
• 5 - Letter 8 1/2 x 11 in
• 6 - Legal 8 1/2 x 14 in
Examples This example exports PDF with A4 paper size, and saves the data to a file
called custom.pdf:
int li_ret
dw1.Object.DataWindow.Export.PDF.Method = NativePDF!
dw1.Object.DataWindow.Export.PDF.NativePDF.CustomSize=
0
This example uses Modify to set the PDF export properties:
dw1.Modify("DataWindow.Export.PDF.Method =
NativePDF!")
dw1.Modify("DataWindow.Export.PDF.NativePDF.CustomOrie
ntation = 1")
dw1.Modify("DataWindow.Export.PDF.NativePDF.CustomSize
= 1")
Export.PDF.XSLFOP.Print
Description Setting that enables you to send a DataWindow object directly to a printer using
platform-independent Java printing when using the XSL-FO method to export
to PDF. This is an option of the Apache FOP processor.
dw_control.Object.DataWindow.Export.PDF.XSLFOP.Print

Describe argument:
"DataWindow.Export.PDF.XSLFOP.Print { = 'value' }"
value (exp) Whether the exported PDF is sent directly to the default
printer.
Values are:
• Yes – The DataWindow object is exported to a PDF file and
sent directly to a printer.
• No – The DataWindow object is exported to a PDF file but
is not printed (default).
Usage Set this property if you are using the XSL-FO method to export a DataWindow
object to a PDF file and you want to send the PDF file directly to a printer. The
PDF file is always printed to the default system printer. The
DataWindow.Printer property setting is ignored.
This property has no effect if the Export.PDF.Method property is set to
NativePDF! or Distill!.
In the painter On the Data Export page in the Properties view for the
DataWindow object, select PDF from the Format to Configure list and
XSLFOP! from the Method list, and then select Print Using XSLFOP.
Examples This example specifies the XSLFOP! method for PDF export, sets the
XSLFOP.Print property, and saves the data to a file called printed.pdf, which
is sent directly to the default printer:
int li_ret
dw1.Object.DataWindow.Export.PDF.Method = XSLFOP!
dw1.Object.DataWindow.Export.PDF.xslfop.print='Yes'
li_ret = dw1.SaveAs("printed.pdf", PDF!, true)
Export.XHTML.TemplateCount
Description The number of XHTML export templates associated with a DataWindow
object.
dw_control.Object.DataWindow.Export.XHTML.TemplateCount
260 PowerBuilder
Describe argument:
"DataWindow.Export.XHTML.TemplateCount"
Usage This property is used to get a count of the XHTML export templates associated
with a DataWindow object. It returns a long specifying the number of XHTML
export templates previously saved in the DataWindow painter for the specified
DataWindow object. The count is used with the
DataWindow.Export.XHTML.Template[ ].Name property to enable an application
to select an export template at runtime.
Examples This code in the open event of a window uses the TemplateCount property to
get the number of templates associated with dw1. It then uses the number
returned as the upper limit in a FOR loop that populates a drop-down list box
with the template names, using the
DataWindow.Export.XHTML.Template[ ].Name property.
string ls_template_name
long l_template_count, i
l_template_count = Long &

(dw1.Object.DataWindow.Export.XHTML.TemplateCount)
for i=1 to l_template_count)

ls_template_name = &
dw1.Object.DataWindow.Export.XHTML.Template[i].Name
ddlb_1.AddItem(ls_template_name)
next
Before generating the XHTML, set the export template using the text in the
drop-down list box:
dw1.Object.DataWindow.Export.XHTML.UseTemplate=
ddlb_1.text
See also Export.XHTML.Template[ ].Name
Export.XHTML.UseTemplate
Export.XHTML.Template[ ].Name
Description The name of an XHTML export template associated with a DataWindow
object.
dw_control.Object.DataWindow.Export.XHTML.Template[ num ].Name

Describe argument:
"DataWindow.Export.XHTML.Template[ num ]Name"
num (exp) A long specifying the index of the export template
Usage This property returns the names of the XHTML export templates associated
with a DataWindow object by index. The index can range from 1 to the value
of the DataWindow.Export.XHTML.TemplateCount property. The order reflects
the serialized storage order of all templates, which is a read-only setting. These
properties, with DataWindow.Export.XHTML.UseTemplate, enable an
application to select an export template dynamically at runtime.
Examples See Export.XHTML.TemplateCount.
See also Export.XHTML.TemplateCount
Description Setting that optionally controls the logical structure of the XHTML generated
by a DataWindow object from a DataWindow data expression using dot
notation.
dw_control.Object.DataWindow.Export.XHTML.UseTemplate
"DataWindow.Export.XHTML.UseTemplate { = 'value ' }"
value (exp) A string specifying the name of an XHTML export
template previously saved in the DataWindow painter for the
specified DataWindow object
Usage This property uses a template defined in the DataWindow painter to specify the
logical structure and attribute overrides that PowerBuilder should use to
generate XHTML from a DataWindow object. It is designed to be used with
the data expression for the DataWindow object, and should be set before a data
expression statement.
262 PowerBuilder
DataWindow object, select XHTML from the Format to Configure list and
select a template from the Use Template list.
Examples This example stores the name of the export template used in dw1 in the string
ls_template. If no template is selected in dw1, an empty string is returned.
ls_template_name =
dw1.Describe("DataWindow.Export.XHTML.UseTemplate")
This example sets the name of the current XHTML export template used in dw1
to t_report. If t_report does not exist, the current template is not changed.
't_report' ")
See also Export.XHTML.TemplateCount
Export.XHTML.Template[ ].Name
Export.XML.HeadGroups
Description Setting that causes elements, attributes, and all other items above the Detail
Start element in an XML export template for a group DataWindow to be
iterated for each group in the exported XML.
dw_control.Object.DataWindow.Export.XML.HeadGroups
"DataWindow.Export.XML.HeadGroups { = 'value ' }"
value (exp) Whether the contents of the header section in an export
template iterate in the generated XML.
Values are:
• Yes – The header section is repeated for each group (default).
• No – The header section is not repeated.

Usage This property must be set for group DataWindow objects if you want elements
and other items added to the header section of an XML export template to be
repeated before each group in the exported XML. For DataWindow objects
with multiple groups, each XML fragment in the header section between a
Group Header element and the next Group Header element or Detail Start
element is iterated.
DataWindow object, select XML from the Format to Configure list and select
Iterate header for Groups.
Examples dw1.Object.DataWindow.Export.XML.HeadGroups = "Yes"
dw1.Modify("DataWindow.Export.XML.HeadGroups = 'No' ")
Export.XML.IncludeWhitespace
Description Setting that determines whether the XML document is formatted by inserting
whitespace characters (carriage returns, linefeeds, tabs, and spacebar spaces).
dw_control.Object.DataWindow.Export.XML.IncludeWhitespace
"DataWindow.Export.XML.IncludeWhitespace { = 'value ' }"
value (exp) Whether the generated XML is formatted with whitespace
characters.
Values are:
• Yes – Whitespace characters are inserted.
• No – Whitespace characters are not inserted (default).
Usage This property should be set before you export a DataWindow object if you want
to view or verify the exported XML using a text editor.
Include Whitespace.
Examples dw1.Object.DataWindow.Export.XML.IncludeWhitespace =
"No"
dw1.Modify("DataWindow.Export.XML.IncludeWhitespace =
'Yes' ")
264 PowerBuilder
Export.XML.MetaDataType
Description Setting that controls the type of metadata generated with the XML exported
from a DataWindow object using the SaveAs method or a .Data.XML
expression.
dw_control.Object.DataWindow.Export.XML.MetaDataType
"DataWindow.Export.XML.MetaDataType { = 'value ' }"
value (exp) A string specifying a value of the
Export.XML.MetaDataType enumerated datatype
Usage This property must be set to specify the type of metadata generated before you
call the SaveAs method with XML! as the SaveAsType to save data as an XML
document, or use the .Data.XML expression to save data as an XML string. The
metadata is saved into the exported XML itself or into an associated file,
depending on the value of the Export.XML.SaveMetaData property.
The Export.XML.MetaDataType property is an enumerated datatype that can
hold the following values:
Enumerated value Numeric value Meaning
XMLNone! 0 Metadata (XML Schema or DTD) is
not generated when XML is exported
XMLSchema! 1 XML Schema is generated when
XML is exported
XMLDTD! 2 DTD is generated when XML is
exported
If the data item for a column is null or an empty string, an empty element is
created when you export XML. If you select XMLSchema!, child elements with
null data items are created with the content "xsi:nil='true'".
a value from the Meta Data Type list.
Examples This statement specifies that no metadata will be generated when the
DataWindow is exported to XML:
dw1.Object.DataWindow.Export.XML.MetaDataType =

XMLNone!
These statements export the contents of dw1 to the file c:\myxml.xml using the
XML export template called t_schema, and generate an external XML schema
file at c:\myxml.xsd:
't_schema'")
dw1.Modify("DataWindow.Export.XML.MetaDataType = 1")
dw1.Modify("DataWindow.Export.XML.SaveMetaData = 1")
dw1.SaveAs("c:\myxml.xml", XML!, false)
See also Export.XML.SaveMetaData
Export.XML.SaveMetaData
Description Setting that controls the storage format for the metadata generated with the
XML exported from a DataWindow object using the SaveAs method or a
.Data.XML expression.
dw_control.Object.DataWindow.Export.XML.SaveMetaData
"DataWindow.Export.XML.SaveMetaData { = 'value ' }"
value (exp) A string specifying a value of the
Export.XML.SaveMetaData enumerated datatype
Usage This property must be set to specify how to store the generated metadata before
you call the SaveAs method with XML! as the SaveAsType to save data as an
XML document, or use the .Data.XML expression to save data as an XML
string. The metadata can be saved into the exported XML document or string
or into an associated file.
Note
If Export.XML.MetaDataType is set to XMLNone!, the value of the
Export.XML.SaveMetaData property is not used.
The Export.XML.SaveMetaData property is an enumerated datatype that can

hold the following values:
266 PowerBuilder
Enumerated Numeric
value value Meaning
MetaDataInternal! 0 The metadata is saved into the generated XML
document or string. To save metadata using the
.Data.XML expression syntax, you must use this
value.
MetaDataExternal! 1 With the SaveAs method, metadata is saved as an
external file with the same name as the XML
document but with the extension .xsd (for
XMLSchema! type) or .dtd (for XMLDTD! type).
A reference to the name of the metadata file is
included in the output XML document.
With .Data.XML, no metadata is generated in the
XML string.
a value from the Save Meta Data list.
Examples dw1.Object.DataWindow.Export.XML.SaveMetaData = 0
dw1.Modify("DataWindow.Export.XML.SaveMetaData = &
MetaDataExternal!")
See also Export.XML.MetaDataType
Export.XML.TemplateCount
Description The number of XML export templates associated with a DataWindow object.
dw_control.Object.DataWindow.Export.XML.TemplateCount
Describe argument:
"DataWindow.Export.XML.TemplateCount"
Usage This property is used to get a count of the XML export templates associated
with a DataWindow object. It returns a long specifying the number of XML
export templates previously saved in the DataWindow painter for the specified
DataWindow object. The count is used with the
DataWindow.Export.XML.Template[ ].Name property to enable an application to
select an export template at runtime.

Examples This code in the open event of a window uses the TemplateCount property to
get the number of templates associated with dw1. It then uses the number
returned as the upper limit in a FOR loop that populates a drop-down list box
with the template names, using the DataWindow.Export.XML.Template[ ].Name
property.
string ls_template_count, ls_template_name
long i
ls_template_count=dw1.Describe
("DataWindow.Export.XML.TemplateCount")
for i=1 to Long(ls_template_count)

ls_template_name=
dw1.Object.DataWindow.Export.XML.Template[i].Name
ddlb_1.AddItem(ls_template_name)
next
Before generating the XML, set the export template using the text in the drop-
down list box:
dw1.Object.DataWindow.Export.XML.UseTemplate=
ddlb_1.text
See also Export.XML.Template[ ].Name
Export.XML.UseTemplate
Export.XML.Template[ ].Name
Description The name of an XML export template associated with a DataWindow object.
dw_control.Object.DataWindow.Export.XML.Template[num ].Name
Describe argument:
"DataWindow.Export.XML.Template[num ]Name"
num (exp) A long specifying the index of the export template
268 PowerBuilder
Usage This property is used to get the names of the XML export templates associated
with a DataWindow object. It returns a string specifying the name of an export
template previously saved in the DataWindow painter for the specified
DataWindow object. The property is used with the
DataWindow.Export.XML.TemplateCount property to enable an application to
select an export template at runtime.
Examples See Export.XML.TemplateCount.
See also Export.XML.TemplateCount
Description Setting that optionally controls the logical structure of the XML exported from
a DataWindow object using the SaveAs method or the .Data.XML property.
dw_control.Object.DataWindow.Export.XML.UseTemplate
"DataWindow.Export.XML.UseTemplate { = 'value ' }"
value (exp) A string specifying the name of an export template
previously saved in the DataWindow painter for the specified
DataWindow object
Usage This property should be set to specify the logical structure of the XML
generated before you call the SaveAs method with XML! as the SaveAsType to
save data as an XML document, or use the .Data.XML expression to save data
as an XML string.
a template from the Use Template list.
Examples This example stores the name of the export template used in dw1 in the string
ls_template. If no template is selected in dw1, an empty string is returned.
ls_template_name =
dw1.Describe("DataWindow.Export.XML.UseTemplate")

This example sets the name of the current XML export template used in dw1 to
t_report. If t_report does not exist, the current template is not changed.
't_report' ")
See also Export.XML.MetaDataType
Export.XML.SaveMetaData
Expression
Description The expression for a computed field control in the DataWindow. The
expression is made up of calculations and DataWindow expression functions.
The DataWindow evaluates the expression to get the value it will display in the
computed field.
Applies to Computed field controls
dw_control.Object.computename.Expression
"computename.Expression { = ’string ' }"
computename The name of the computed field control in the DataWindow for
which you want to get or set the expression
string A string whose value is the expression for the computed field
General tab, Expression option. The More button displays the Modify
Expression dialog, which provides help in specifying the expression. The
Verify button tests the expression.
Examples setting = dw1.Object.comp_1.Expression
dw1.Object.comp_1.Expression = "avg(salary for all)"
setting = dw1.Describe("comp_1.Expression")
dw1.Modify("comp_1.Expression='avg(salary for all)'")
270 PowerBuilder
Filename
Description The file name containing the image for a Picture or Button control in the
DataWindow. If no image is specified for a Button control, only text is used for
the button label.
Applies to Picture and Button controls
dw_control.Object.controlname.Filename
"controlname.Filename { = ' filestring ' }"
controlname The name of the Picture or Button control in the DataWindow
for which you want to get or set the image file name.
filestring (exp) A string containing the name of the file that contains the
image. Filestring can be a quoted DataWindow expression.
Button pictures can be BMP, GIF, or JPEG files. You can use a
URL instead of a full path name, and if you set the
HTMLGen.ResourceBase property to the URL address, you
need to specify only a relative file name for this string.
If you include the name of the file containing the image in the
executable for the application, PowerBuilder will always use
that image; you cannot use Modify to change the image.
Usage In the painter For a Picture control, select the control and set the value in the
Properties view, General tab, File Name option. For a Button control, select the
control and set the value in the Properties view, General tab, Picture File
option. The Action Default Picture check box must be cleared to set the value
for the picture file.
Examples Example for a Picture control:
setting = dw1.Object.bitmap_1.Filename
dw1.Object.bitmap_1.Filename = "exclaim.bmp"
setting = dw1.Describe("bitmap_1.Filename")
dw1.Modify("bitmap_1.Filename='exclaim.bmp'")
Example for a Button control:
dw1.Object.b_name.FileName = "logo.gif"
ls_data = dw1.Describe("b_name.FileName")
dw1.Modify("b_name.FileName = 'logo.jpg'")
See also DefaultPicture

FirstRowOnPage
Description The first row currently visible in the DataWindow.
dw_control.Object.DataWindow.FirstRowOnPage
Describe argument:
"DataWindow.FirstRowOnPage"
setting = dw1.Object.DataWindow.FirstRowOnPage
setting = dw1.Describe("DataWindow.FirstRowOnPage")
FocusRectangle
Description Whether a rectangle displays around the selected control.
Applies to Column, Computed Field, Graph, OLE Object, OLE Database Blob, Picture,
and Text controls
dw_control.Object.controlname.FocusRectangle
“controlname.FocusRectangle = value”
controlname The name of the control for which you want to show or hide the
focus rectangle
value Whether the focus rectangle appears when the control has focus.
Values are:
• Yes – The focus rectangle displays
• No – The focus rectangle does not display
tab, Show Focus Rectangle option.
Examples String ls_DataObject
string ls_focus, ls_focus1
ls_DataObject= dw_1.DataObject
If ls_DataObject = "d_dept" Then
272 PowerBuilder
dw_1.Modify("t_1.focusrectangle = " + "yes")

ls_focus = dw_1.describe("t_1.focusrectangle")
ls_focus1 = dw_1.object.t_1.focusrectangle
Else
dw_1.Modify("gr_1.focusrectangle = " + "yes")
ls_focus = dw_1.describe("gr_1.focusrectangle")
ls_focus1 = dw_1.object.gr_1.focusrectangle
End If
messagebox(ls_focus, ls_focus1)
Font.Bias
Description The way fonts are manipulated in the DataWindow at runtime.
dw_control.Object.DataWindow.Font.Bias
"DataWindow.Font.Bias { = biasvalue }"
biasvalue An integer indicating how the fonts will be manipulated at
execution. Biasvalue cannot be a DataWindow expression.
Values are:
0 – As display fonts
1 – As printer fonts
2 – Neutral; no manipulation will take place

setting = dw1.Object.DataWindow.Font.Bias
dw1.Object.DataWindow.Font.Bias = 1
setting = dw1.Describe("DataWindow.Font.Bias")
dw1.Modify("DataWindow.Font.Bias=1")
Font.property
Description Settings that control the appearance of fonts within a DataWindow, except for
graphs, which have their own settings (see DispAttr).
Applies to Button, Column, Computed Field, GroupBox, and Text controls


dw_control.Object.controlname.Font.property
"controlname.Font.property { = ' value ' }"
SyntaxFromSql:
Column(Font.property = value)
Text(Font.property = value)
controlname The name of a column, computed field, or text control for which
you want to get or set font properties. For a column, you can
specify the column name or a pound sign (#) followed by the
column number.
When you generate DataWindow syntax with SyntaxFromSql,
the Font settings apply to all columns or all text controls.
property A property of the text. The properties and their values are listed
in the table below.
value The value to be assigned to the property. Value can be a quoted
Property for Font Value

CharSet (exp) An integer specifying the character set to be used.
Values are:
0 – ANSI
1 – The default character set for the specified font
2 – Symbol
128 – Shift JIS
255 – OEM
Painter: Font tab, CharSet option.
Escapement (exp) An integer specifying the rotation for the baseline of the text in tenths of a
degree. For example, a value of 450 rotates the text 45 degrees. 0 is horizontal.
Painter: Font tab, Escapement option.
Face (exp) A string specifying the name of the font face, such as Arial or Courier.
Painter: Font tab, FaceName option or StyleBar.
274 PowerBuilder
Property for Font Value

Family (exp) An integer specifying the font family (Windows uses both face and family to
determine which font to use).
Values are:
0 – AnyFont
1 – Roman
2 – Swiss
3 – Modern
4 – Script
5 – Decorative
Painter: Font tab, Family option.
Height (exp) An integer specifying the height of the text in the unit measure for the
DataWindow. To specify size in points, specify a negative number.
Painter: Font tab, Size option (specified in points) or StyleBar or Expressions tab.
Italic (exp) Whether the text should be italic. The default is no.
Painter: Font tab, Italic check box or StyleBar.
Pitch (exp) The pitch of the font.
Values are:
0 – The default pitch for your system
1 – Fixed
2 – Variable
Painter: Font tab, Pitch option.
Strikethrough (exp) Whether the text should be crossed out. The default is no.
Painter: Font tab, Strikeout check box.
Underline (exp) Whether the text should be underlined. The default is no.
Painter: Font tab, Underline check box or StyleBar.
Weight (exp) An integer specifying the weight of the text; for example, 400 for normal or 700
for bold.
Painter: Set indirectly using the Font tab, Bold option or the StyleBar, Bold button.
Width (exp) An integer specifying the average character width of the font in the unit of
measure specified for the DataWindow. Width is usually unspecified, which results
in a default width based on the other properties.
Painter: Set indirectly using the font selection.
Usage In the painter Select the control and set the value using the:
• Properties view, Font tab
• For some font settings, StyleBar
Examples dw1.Object.emp_name_t.Font.Face
dw1.Object.emp_name_t.Font.Face = "Arial"

dw1.Describe("emp_name_t.Font.Face")
dw1.Modify("emp_name_t.Font.Face='Arial'")
See also Transparency (columns and controls)
Footer.property
Format
Description The display format for a column.
You can use the GetFormat and SetFormat methods instead of Describe and
Modify to get and change a column’s display format. The advantage to using
Modify is the ability to specify an expression.
Applies to Column and Computed Field controls
dw_control.Object.controlname.Format
"controlname.Format { = ' value ' }"
controlname The name of the column or computed field for which you want
to get or set the display format.
value (exp) A string specifying the display format. See the Users
Guide for information on constructing display formats. Value
Format tab.
If you want to add text to a numeric display format and use a color attribute,
you must include the escape character (\) before each literal in the mask. For
example:
[red]\D\e\p\t\: ###
Examples setting = dw1.Object.phone.Format
dw1.Object."phone.Format = "[red](@@@)@@@-@@@@;'None'"
setting = dw1.Describe("phone.Format")
276 PowerBuilder
dw1.Modify( &
"phone.Format='[red](@@@)@@@-@@@@;~~~'None~~~''")
See also GetFormat function in the PowerScript Reference
SetFormat function in the PowerScript Reference
Gradient.property
Description Settings that control the gradient display in a DataWindow object. Gradient
display properties are not supported in RichText, Graph, or OLE DataWindow
presentation styles.
dw_control.Object.datawindow.gradient.property
"DataWindow.gradient.property { = value }"
property A property for the gradient. Properties and their settings are
listed in the table that follows.
value The value to be assigned to the property. For gradient
properties, value can be a quoted DataWindow expression.
Property for Gradient Value

Angle An integer indicating the angle in degrees (values are 0 to 360) used to offset the color
and transparency gradient. This property is used only when datawindow.brushmode
takes values of 3 or 4.
Color The gradient color of the DataWindow. This property is only in effect when
datawindow.brushmode takes values 1 through 5.
Focus An integer in the range 0 to 100, specifying the distance (as a percentage) from the
center where the background color is at its maximum. (For example, if the radial
background.)

Property for Gradient Value

Repetition.Mode Specifies the mode for determining the number of gradient transitions.
Repetition.Count An integer specifying the number of gradient transitions for background color and
transparency. A value of 0 indicates 1 transition. A value of 3 indicates 4 transitions.
This property is used only when the datawindow.brushmode property takes values
from 1 to 4 and when the when the datawindow.gradient.repetition.mode value is 0
(by count). The maximum is 10,000.
Repetition.Length A long specifying the number of gradient transitions. This property is used only when
the datawindow.brushmode property takes values from 1 to 4 and the
datawindow.gradient.repetition.mode property takes the value of 1 (by length). The
units for the length that you assign for gradient transitions are set by the
datawindow.units property.
Scale An integer in the range 0 to 100 specifying the rate of transition to the gradient color
(as a percentage).
Spread An integer in the range 0 to 100 indicating the contribution of the second color to the
blend (as a percentage).
Tranparency An integer in the range 0 to 100, where 0 means that the secondary (gradient)
background is opaque and 100 that it is completely transparent. The gradient defines
transitions between the primary and secondary transparency settings.
Usage In the painter Select the DataWindow object and set the value on the
Background tab of the Properties view.
ls_data = dw_1.Object.datawindow.brushmode
dw_1.Object.datawindow.Brushmode = 5
ls_data = dw_1.Describe("datawindow.brushmode")
dw_1.Modify("datawindow.Brushmode=6")
dw_1.Modify("datawindow.Gradient.Transparency=75")
See also Brushmode
278 PowerBuilder
Picture.property
GraphType
Description The type of graph, such as bar, pie, column, and so on.
dw_control.Object.graphname.GraphType
"graphname.GraphType { = ' typeinteger ' }"
graphname The graph control for which you want to get or change the type.
typeinteger (exp) An integer identifying the type of graph in the
DataWindow object. Typeinteger can be a quoted DataWindow
expression.
Values are:
1 – Area 10 – ColStacked
2 – Bar 11 – ColStacked3DObj
3 – Bar3D 12 – Line
4 – Bar3DObj 13 – Pie
5 – BarStacked 14 – Scatter
6 – BarStacked3DObj 15 – Area3D
7 – Col 16 – Line3D
8 – Col3D 17 – Pie3D
9 – Col3DObj
General tab.
setting = dw1.Object.graph_1.GraphType
dw1.Object.graph_1.GraphType = 17
setting = dw1.Describe("graph_1.GraphType")
dw1.Modify("graph_1.GraphType=17")
Grid.ColumnMove
Description Whether the user can rearrange columns by dragging.

dw_control.Object.DataWindow.Grid.ColumnMove
"DataWindow.Grid.ColumnMove { = value } "
value Whether the user can rearrange columns.
Values are:
Yes – The user can drag columns.
No – The user cannot drag columns.
Usage In the painter Select the DataWindow object by deselecting all controls; then
set the value in the Properties view, General tab, Grid group, Column Moving
check box (available when the presentation style is Grid, Crosstab, or
TreeView with the Grid Style option selected).
setting = dw1.Object.DataWindow.Grid.ColumnMove
dw1.Object.DataWindow.Grid.ColumnMove = No
setting = dw1.Describe("DataWindow.Grid.ColumnMove")
dw1.Modify("DataWindow.Grid.ColumnMove=No")
Grid.Lines
Description The way grid lines display and print in a DataWindow whose presentation style
is Grid, Crosstab, or TreeView.
dw_control.Object.DataWindow.Grid.Lines
"DataWindow.Grid.Lines { = value }"
280 PowerBuilder
value An integer specifying whether grid lines are displayed on the
screen and printed.
Values are:
0 – Yes, grid lines are displayed and printed.
1 – No, grid lines are not displayed and printed.
2 – Grid lines are displayed, but not printed.
3 – Grid lines are printed, but not displayed.
set the value in the Properties view, General tab, Grid group, Display option
(available when the presentation style is Grid, Crosstab, or TreeView with the
Grid Style option selected).
setting = dw1.Object.DataWindow.Grid.Lines
dw1.Object.DataWindow.Grid.Lines = 2
setting = dw1.Describe("DataWindow.Grid.Lines")
dw1.Modify("DataWindow.Grid.Lines=2")
GroupBy
Description A comma-separated list of the columns or expressions that control the grouping
of the data transferred from the DataWindow to the OLE object. When there is
more than one grouping column, the first one is the primary group and the
columns that follow are nested groups.
dw_control.Object.olecontrolname.GroupBy
"olecontrolname.GroupBy { = ' columnlist ' }"
or set the grouping columns.
columnlist (exp) A list of the columns or expressions that control the
grouping. If there is more than one, separate them with
commas. Columnlist can be a quoted DataWindow expression.
Usage Target and Range also affect the data that is transferred to the OLE object.

In the painter Select the control and set the value in the Properties view, Data
tab, Group By option.
Examples ls_data = dw1.Object.ole_report.GroupBy
dw1.Object.ole_report.GroupBy = "emp_state, emp_office"
dw1.Object.ole_report.GroupBy = "year"
ls_data = dw1.Describe("ole_report.GroupBy")
dw1.Modify(" &
ole_report.GroupBy='emp_state, emp_office'")
dw1.Modify("ole_report.GroupBy='year'")
Header_Bottom_Margin
Description The size of the bottom margin of the DataWindow’s header area.
Header_Bottom_Margin is meaningful only when type is Grid or Tabular.
Style ( Header_Bottom_Margin = value )
value An integer specifying the size of the bottom margin of the
header area in the units specified for the DataWindow. The
bottom margin is the distance between the bottom of the header
area and the last line of the header.

'Style(...Header_Bottom_Margin = 25 ...)', &
errstring)
Header_Top_Margin
Description The size of the top margin of the DataWindow’s header area.
Header_Top_Margin is meaningful only when type is Grid or Tabular.
Style ( Header_Top_Margin = value )
282 PowerBuilder
value An integer specifying the size of the top margin of the header area
in the units specified for the DataWindow. The top margin is the
distance between the top of the header area and the first line of the
header.

'Style(...Header_Top_Margin = 500 ...)', errstring)
Header.property
Header.#.property
Height
Description The height of a control in the DataWindow.
Applies to Button, Column, Computed Field, Graph, GroupBox, OLE, Oval, Picture,
Rectangle, Report, RoundRectangle, TableBlob, and Text controls
dw_control.Object.controlname.Height
"controlname.Height { = ' value ' }"
controlname The control within the DataWindow whose height you want to get
or set.
value (exp) An integer specifying the height of the control in the unit of
measure specified for the DataWindow. Value can be a quoted
Position tab.

setting = dw1.Object.empname.Height
dw1.Object.empname.Height = 50
setting = dw1.Describe("empname.Height")
dw1.Modify("empname.Height=50")
Height.AutoSize
Description Whether the control’s width should be held constant and its height adjusted so
that all the data is visible. This property is for use with read-only controls and
printed reports. It should not be used with data entry fields or controls.
Applies to Column, Computed Field, Report, and Text controls
dw_control.Object.controlname.Height.AutoSize
"controlname.Height.AutoSize { = value }"
controlname The control for which you want to get or set the AutoSize
property.
value Whether the width or height of the control will be adjusted to
display all the data. The height is limited to what can fit on the
page.
Values are:
No – Use the height defined in the painter.
Yes – Calculate the height so that all the data is visible.
Position tab, Autosize Height check box.
Minimum height The height of the column, computed field, or text will never
be less than the minimum height (the height selected in the painter).
When the band has Autosize Height set to true, you should avoid using the
RowHeight DataWindow expression function to set the height of any element
in the row. Doing so can result in a logical inconsistency between the height of
the row and the height of the element. For more information, see the
RowHeight function description.
setting = dw1.Object.empname.Height.AutoSize
dw1.Object.empname.Height.AutoSize = "Yes"
284 PowerBuilder
setting = dw1.Describe("empname.Height.AutoSize")
dw1.Modify("empname.Height.AutoSize=Yes")
See also Bandname.property
Help.property
Description Settings for customizing the Help topics associated with DataWindow dialog
boxes.
For more information about Help, see the ShowHelp function in the
dw_control.Object.DataWindow.Help.property
"DataWindow.Help.property { = value }"
property A property for specifying DataWindow Help. Help properties
and their settings are listed in the table below. The File property
must have a valid file name before the rest of the Help property
settings can become valid.
value The value to be assigned to the property. For Help properties,
Property for Help Value

Command An integer specifying the type of Help command that is specified in the following
TypeID properties.
Values are:
0 – Index
1 – TopicID
2 – Search keyword
File A string containing the fully qualified name of the compiled Help file (for example,
C:\proj\MYHELP.HLP). When this property has a value, Help buttons display on the
DataWindow dialog boxes at runtime.
TypeID A string specifying the default Help command to be used when a Help topic is not
specified for the dialog using one of the following eight dialog-specific properties
listed in this table.

Property for Help Value

TypeID. ImportFile A string specifying the Help topic for the Import File dialog box, which might display
when the ImportFile method is called in code.
TypeID.Retrieve. A string specifying the Help topic for the Retrieval Arguments dialog box, which
Argument displays when retrieval arguments expected by the DataWindow’s SELECT
statement are not specified for the Retrieve method in code.
TypeID.Retrieve. Criteria A string specifying the Help topic for the Prompt for Criteria dialog box, which
displays when the Criteria properties have been turned on for at least one column and
the Retrieve method is called in code.
TypeID.SaveAs A string specifying the Help topic for the Save As dialog box, which might display
when the SaveAs method is called in code.
TypeID. SetCrosstab A string specifying the Help topic for the Crosstab Definition dialog box, which
might display when the CrosstabDialog method is called in code.
TypeID.SetFilter A string specifying the Help topic for the Set Filter dialog box, which might display
when the SetFilter and Filter methods are called in code.
TypeID.SetSort A string specifying the Help topic for the Set Sort dialog box, which might display
when the SetSort and Sort methods are called in code.
TypeID. SetSortExpr A string specifying the Help topic for the Modify Expression dialog, which displays
when the user double-clicks on a column in the Set Sort dialog.
Usage In the painter Can be set only in code, not in the painter.
setting = dw1.Object.DataWindow.Help.Command
dw1.Object.DataWindow.Help.File = "myhelp.hlp"
dw1.Object.DataWindow.Help.Command = 1
setting = dw1.Describe("DataWindow.Help.Command")
dw1.Modify("DataWindow.Help.File='myhelp.hlp'")
dw1.Modify("DataWindow.Help.Command=1")
dw1.Modify( "DataWindow.Help.TypeID.SetFilter =
'filter_topic'")
dw1.Modify("DataWindow.Help.TypeID.Retrieve.Criteria =
'criteria_topic'")
HideGrayLine
Description Shows or hides a gray line to indicate that a fixed page has been crossed when
scrolling in a DataWindow with group headers.
Applies to DataWindow control
dw_control.Object.DataWindow.HideGrayLine
286 PowerBuilder

"DataWindow.HideGrayLine { = ' value ' }"
value (exp) Whether a gray line displays in the Preview view and at
runtime.
Values are:
Yes – The gray line is hidden.
No – The gray line displays (default).
Value can be a quoted DataWindow expression.
Usage This property can be set in the open event for the window in which the
DataWindow displays. Note that you cannot suppress the display of repeating
group headers.
In the painter Select the DataWindow object by deselecting all controls; then
set the value in the Properties view, General tab. This option is enabled only for
DataWindows with group headers.
Examples dw1.Object.DataWindow.HideGrayLine = yes
HideSnaked
Description Whether the control appears only once per page when you print the
DataWindow using the newspaper columns format.
dw_control.Object.controlname.HideSnaked
"controlname.HideSnaked { = ' value ' }"

HideSnaked setting.
value (exp) Whether the control appears once or multiple times in the
printed output when the output has multiple columns (like a
newspaper).
Values are:
1 – The control will appear only once on a page.
0 – The control will appear in each column on a page.
General tab, HideSnaked check box.
setting = dw1.Object.graph_1.HideSnaked
dw1.Object.text_title.HideSnaked = "1"
setting = dw1.Describe("graph_1.HideSnaked")
dw1.Modify("text_title.HideSnaked=1")
Horizontal_Spread
Description The space between columns in the detail area of the DataWindow object.
Horizontal_Spread is meaningful only when type is Grid or Tabular.
Style ( Horizontal_Spread = value )
value An integer specifying the space between columns in the detail
area of the DataWindow object area in the units specified for the
DataWindow

'Style(...Horizontal_Spread = 25 ...)', errstring)
288 PowerBuilder
HorizontalScrollMaximum
Description The maximum width of the scroll box of the DataWindow’s horizontal scroll
bar. This value is set by PowerBuilder based on the layout of the DataWindow
object and the size of the DataWindow control. Use HorizontalScrollMaximum
with HorizontalScrollPosition to synchronize horizontal scrolling in multiple
DataWindow objects.
dw_control.Object.DataWindow.HorizontalScrollMaximum
Describe argument:
"DataWindow.HorizontalScrollMaximum"
setting =
dw1.Object.DataWindow.HorizontalScrollMaximum
setting =
dw1.Describe("DataWindow.HorizontalScrollMaximum")
HorizontalScrollMaximum2
Description The maximum width of the second scroll box when the horizontal scroll bar is
split (HorizontalScrollSplit is greater than 0). This value is set by
PowerBuilder based on the content of the DataWindow. Use
HorizontalScrollMaximum2 with HorizontalScrollPosition2 to synchronize
horizontal scrolling in multiple DataWindow objects.
dw_control.Object.DataWindow.HorizontalScrollMaximum2
Describe argument:
"DataWindow.HorizontalScrollMaximum2"
setting =
dw1.Object.DataWindow.HorizontalScrollMaximum2
setting =
dw1.Describe("DataWindow.HorizontalScrollMaximum2")

HorizontalScrollPosition
Description The position of the scroll box in the horizontal scroll bar. Use
HorizontalScrollMaximum with HorizontalScrollPosition to synchronize
dw_control.Object.DataWindow.HorizontalScrollPosition
"DataWindow.HorizontalScrollPosition { = scrollvalue }"
scrollvalue An integer specifying the position of the scroll box in the
horizontal scroll bar of the DataWindow
Examples string spos1

spos1 = dw1.Object.DataWindow.HorizontalScrollPosition
string smax1, smax2, spos1, modstring
integer pos2
smax1 = dw1.Describe( &
"DataWindow.HorizontalScrollMaximum")
spos1 = dw1.Describe( &
"DataWindow.HorizontalScrollPosition")
smax2 = dw_2.Describe( &
"DataWindow.HorizontalScrollMaximum")
pos2 = Integer(spos1) * Integer(smax2) / Integer(smax1)
modstring = "DataWindow.HorizontalScrollPosition=" &
+ String(pos2)
dw1.Modify(modstring)
HorizontalScrollPosition2
Description The position of the scroll box in the second portion of the horizontal scroll bar
when the scroll bar is split (HorizontalScrollSplit is greater than 0). Use
HorizontalScrollMaximum2 with HorizontalScrollPosition2 to synchronize
dw_control.Object.DataWindow.HorizontalScrollPosition2
290 PowerBuilder

"DataWindow.HorizontalScrollPosition2 { = scrollvalue }"
scrollvalue An integer specifying the position of the scroll box in the
second portion of a split horizontal scroll bar of the
DataWindow
Examples string spos

spos =dw1.Object.DataWindow.HorizontalScrollPosition2
dw1.Object.DataWindow.HorizontalScrollPosition2 = 200
spos = dw1.Describe( &
"DataWindow.HorizontalScrollPosition2")
dw1.Modify( &
"DataWindow.HorizontalScrollPosition2=200")
HorizontalScrollSplit
Description The position of the split in the DataWindow’s horizontal scroll bar. If
HorizontalScrollSplit is zero, the scroll bar is not split.
dw_control.Object.DataWindow.HorizontalScrollSplit
"DataWindow.HorizontalScrollSplit { = splitdistance }"
splitdistance An integer indicating where the split will occur in the
horizontal scroll bar in a DataWindow object in the unit of
measure specified for the DataWindow object

setting = dw1.Object.DataWindow.HorizontalScrollSplit
dw1.Object.DataWindow.HorizontalScrollSplit = 250
str = dw1.Describe("DataWindow.HorizontalScrollSplit")
dw1.Modify("DataWindow.HorizontalScrollSplit=250")

HTextAlign
Description The way text in a button is horizontally aligned.
dw_control.Object.buttonname.HTextAlign
"buttonname.HTextAlign { = ' value ' }"
buttonname The name of the button for which you want to align text.
value An integer indicating how the button text is horizontally
aligned.
Values are:
0 – Center
1 – Left
2 – Right
General tab, Horizontal Alignment option.
Examples dw1.Object.b_name.HTextAlign = "1"
setting = dw1.Describe("b_name.HTextAlign")
dw1.Modify("b_name.HTextAlign ='1'")
HTML.property
Description Settings for adding user-defined HTML syntax and hyperlinks to controls in a
Web DataWindow.
Obsolete property
HTML.property is obsolete and should not be used, because the Web
Applies to Column, Computed Field, Picture, and Text controls

dw_control.Object.controlname.HTML.property
292 PowerBuilder
"controlname.HTML.property { = ' value ' }"

controlname The name of the control whose HTML properties you want to get
or set.
property A property for generating HTML syntax and hyperlinks in a Web
DataWindow. Properties and their values are listed in the table
below.
DataWindow expression only where noted.
Property for HTML Value

AppendedHTML HTML you want to append to the generated syntax for the rendering of a
DataWindow control before the closing bracket of the HTML element for that
control.
Link (exp) A URL that is the target of a link (HTML anchor element) generated for each
data item in the column or for the specified control. The text or user-visible part of
the link will be the data value in the column, the value of the computed field, the text
in the Text control, or the image of a Picture control.
The URL can include parameters. Other properties, such as LinkArgs, can cause
additional parameters to be added when the HTML is generated.
LinkArgs A string in the form:
argname='exp'{ | argname = 'exp' } ...
Argname is a page parameter to be passed to the server.
Exp is a DataWindow expression whose value is a string. It is evaluated and
converted using URL encoding and included in the linkargs string.
The evaluated LinkArgs string is appended to the HTML.Link property when HTML
is generated to produce a hyperlink for each data item in a column or other
DataWindow control.
LinkTarget (exp) The name of a target frame or window for the hyperlink (HTML A element)
specified in the Link property. The target is included using the TARGET attribute.
You can use the LinkTarget property to direct the new page to a detail window or
frame in a master/detail page design.
If LinkTarget is null or an empty string (“”), then no TARGET attribute is generated.
ValueIsHTML (exp) A boolean that, if true, allows the control contents (data value in a read-only
(does not apply to Picture column, the value of a computed field that is not calculated on the client, or the text
controls) in a Text control) to be generated as HTML. For XHTML, the control contents must
be well-formed XHTML.

Usage The Link properties are typically used to create master/detail Web pages where
a link on a data item jumps to a detail DataWindow for that item. LinkArgs is
used to pass a retrieval argument identifying the particular item.
The AppendedHTML property is used to specify attributes and event actions
to add to the HTML rendered for Web DataWindow controls.
ScrollToRow emulation The ValueIsHTML property allows you to include
standalone HTML syntax or tags in the generated Web DataWindow. You can
use this feature to add horizontal rules (<HR>) and anchor tags (<A
HREF="home.htm">home</A>) to Web DataWindows. If you add
row-specific anchor tags, you can use the Modify method or DataWindow
expressions to generate conditional HTML for each row.
The HTML generator does not validate the HTML you append to or include in
controls in DataWindow objects. If the HTML is invalid, the DataWindow
might not display correctly. You must also be careful not to append an event
name that is already generated for the control as a coded client-side event.
HTML tab.
Examples // EMPID and PAGE are page parameters for the
// page server’s session object
dw1.Object.empid.HTML.Link = "empform.html"
dw1.Object.empid.HTML.LinkArgs = "EMPID = ’empid’"
dw1.Object.empid.HTML.LinkTarget = "detail_win"
dw1.Object.empid.HTML.ValueIsHTML = "true"
dw1.Object.helpicon.HTML.Link = "help.html"
dw1.Object.helpicon.LinkArgs = "PAGE = ’empform’"
setting = dw1.Describe("DataWindow.HTML.Link")
dw1.Modify("empid.HTML.Link = 'empform.html'")
HTMLDW
Description Specifies whether HTML generated for the DataWindow object provides
updates and interactivity.
Obsolete property
HTMLDW is obsolete and should not be used, because the Web DataWindow
294 PowerBuilder

dw_control.Object.DataWindow.HTMLDW = value
"DataWindow.HTMLDW { = ' value ' }"
value The value to be assigned to the property. Value can be a
Values are:
• Yes – DataWindow HTML generation uses the
HTMLGen properties.
• No – DataWindow HTML generation is a read-only.
table as described for the Data.HTMLTable property.
Usage When HTMLDW is set to Yes, the generated HTML supports data entry and
takes advantage of browser features that enable user interaction when used
with a page server (as described for the Data.HTML property). The generated
HTML can be used to produce a page that displays a subset of retrieved rows
and can include JavaScript code requesting additional pages with other subsets
of the retrieved rows.
The resulting HTML can be used as a Web DataWindow control, which is a
cooperation between a server component, a page server, and a client Web
browser. The server component produces the HTML and the page server
incorporates it into a Web page.
The user interacts with the DataWindow in the client browser, and actions
produced by buttons in the DataWindow object are sent back to the page server.
The page server calls methods of the server component to request processing
for the data in the DataWindow object, including applying actions, updating
data, and scrolling to other subsets.
To affect the level of DataWindow features in the resulting HTML, or to
produce master/detail links between two Web DataWindow controls, see
HTMLGen.property.
DataWindow features that will not be rendered into HTML include:
• Graph, OLE, and RichText presentation styles and controls.
• Client-side expressions that include aggregate functions. Aggregate
functions cannot be evaluated in the browser. Instead, they will be
evaluated on the server and the resulting value included in the HTML.
• Resizable and movable controls.

• Sliding of controls to fill empty space.

• Autosizing of height or width.
• EditMasks for column data entry.
select or clear the Web DataWindow check box on the General tab in the
Properties view.
Examples dw1.Object.DataWindow.HTMLDW = "yes"
setting = dw1.Describe
("DataWindow.HTMLDW")
dw1.Modify("DataWindow.HTMLDW = 'yes'")
HTMLGen.property
Description Settings that control the level of features incorporated into HTML generated
for the DataWindow.
Obsolete property
HTMLGen.property is obsolete and should not be used, because the Web

dw_control.Object.DataWindow.HTMLGen.property
"DataWindow.HTMLGen.property { = ' value ' }"
property A property that controls how HTML is generated for a
DataWindow. Properties and their values are listed in the
table below.
value The value to be assigned to the property. Value can be a
quoted DataWindow expression where noted.
296 PowerBuilder
Property for HTMLGen Value

Browser (exp) A string identifying the browser in which you want to display the generated
HTML. The value should match the browser identifier part of the text string that the
browser specifies in the HTTP header it sends to the server. This property is usually
set dynamically on the server according to the HTTP header returned from the client.
Recognized strings are listed in Browser recognition on page 300.
ClientComputedFields (exp) Whether computed fields that reference column data are translated into
JavaScript and computed in the client browser.
Values are:
• Yes – (Default) Computed fields are translated to JavaScript where possible.
• No – Computed fields are always calculated on the server.
Regardless of this setting, if the computed field includes aggregation functions, the
computed field is calculated on the server. For more information about this and the
following properties, see Client properties on page 301
ClientEvents (exp) Whether JavaScript code to trigger events is included in the generated HTML.
Values are:
• Yes – (Default) JavaScript for triggering events is generated.
• No – JavaScript for events is not generated.
ClientFormatting (exp) Whether display formats are applied to data items that do not have focus.
JavaScript for formatting the data is translated from display formats specified in the
DataWindow painter. If you want to use regional settings, such as a period as a date
separator and a comma as a decimal separator, you must set ClientFormatting to Yes.
Values are:
• Yes – (Default) Display formats are applied to data.
• No – Display formats are not used.
ClientScriptable (exp) Whether client-side JavaScript can interact with the control.
Values are:
• Yes – Client-side JavaScript can call methods of the control.
• No – (Default) Client-side JavaScript cannot call methods.
This option adds approximately 20K to the size of the generated HTML.
ClientValidation (exp) Whether JavaScript code to perform validation of user-entered data is included
in the generated HTML. The validation code is translated from validation expressions
specified in the DataWindow painter.
Values are:
• Yes – (Default) Validation expressions are generated.
• No – Validation expressions are not generated.


CommonJSFile (exp) Cache file name for common JavaScript functions required by Web
DataWindows at runtime. If you set this property, the file is downloaded to the
browser client once per session for use by all Web DataWindows. You can prefix the
file name to a URL, or you can use the URL that you set with the
HTMLGen.ResourceBase property. See JavaScript caching on page 301.
DateJSFile (exp) Cache file name for common Web DataWindow functions that use a date
format. If you set this property, the file is downloaded to the browser client once per
session for use by all Web DataWindows. You can prefix the file name with a URL,
or you can use the URL that you set with the HTMLGen.ResourceBase property. See
JavaScript caching on page 301.
EncodeSelfLinkArgs (exp) A switch to disable HTML 4 encoding of the evaluated
HTMLGen.SelfLinkArgs expressions that are generated as hidden fields. The
standard encoding limits character replacement to: ", &, <, and >.
Disabling the standard encoding allows you to encode additional characters, but you
must encode the argument expressions yourself.
Values are:
• Yes – (Default) Encoding performed by PowerBuilder.
• No – Encoding not performed.
GenerateDDDWFrames (exp) Specifies whether drop-down DataWindows are generated using inline frames
(iFrames). The use of iFrames enhances the display so that the drop-down
DataWindow displays in a Web application as it would in a Windows application.
Using iFrames increases the volume of markup generated.
Values are:
• Yes – (Default) Drop-down DataWindows are generated in formatted div elements
over an iFrame.
• No – Drop-down DataWindows are generated in HTML select elements.
The use of the GenerateDDDWFrames option for drop-down DataWindows is
supported only in the Internet Explorer browser. In other browsers, the HTML select
element is always used.
GenerateJavaScript (exp) Specifies whether to generate JavaScript if the browser is not recognized. Keep
in mind that without JavaScript, updating of data is not available. Navigation links
are still supported.
Values are:
• Yes – (Default) JavaScript is generated even if the browser is not recognized. The
resulting JavaScript is portable and does not use browser-specific features.
• No – JavaScript is not generated unless the browser is recognized
298 PowerBuilder

HTMLVersion (exp) The version of HTML to generate.
Values are:
• 3.2 – (Default) The HTML will include style sheets, but no absolute positioning
or regular expressions.
• 4.0 – The HTML will include style sheets, absolute positioning, and regular
expressions.
If the browser is recognized, this property is ignored and browser-specific HTML is
generated.
NetscapeLayers (exp) Formats the Web DataWindow for Netscape 4.0 or later using absolute
positioning (in a manner similar to the formatting for Internet Explorer). See
NetscapeLayers property on page 303.
NumberJSFile (exp) Cache file name for common Web DataWindow functions that use a number
ObjectName (exp) A string specifying a name used in generated code for the Web DataWindow
client control, page parameters, and client-side events.
You must specify a unique object name when there will be more than one Web
DataWindow on a Web page so that names will not conflict.
PageSize (exp) The number of rows of data to include in a generated Web page. If the Web page
does not include all available rows, you can include button controls to navigate to the
rest of the data. To include all available rows in the page, specify 0 for PageSize.
If the HTMLDW property is set to Yes, PageSize is used.
If it is set to No, PageSize is ignored and all rows in the result set are generated in a
single page.
PagingMethod A value of the WebPagingMethod enumerated variable that determines how paging
is handled.
Values are:
PostBack! (0) – (default) The control posts back to the server to perform paging
operations.
Callback! (1) – The control calls a service on the client to perform paging
operations.
XMLClientSide! (2) – The control retrieves the entire XML result set and performs
paging operations on the client. This option is only available when the XML
rendering format is used.
See PagingMethod on page 302.
ResourceBase (exp) The URL for included JavaScript files. If you set this property, you do not need
to include a URL in the values for these other HTMLGen properties: CommonJSFile,
DateJSFile, NumberJSFile, and StringJSFile.


SelfLink (exp) A string specifying the URL for the current page. It cannot include parameters.
Parameters specified in SelfLinkArgs can be added when HTML is generated.
SelfLink is used to generate URLs for navigation buttons that obtain additional rows
from the result set and for other buttons that reload the page, such as Update and
Retrieve.
SelfLinkArgs A string in the form:
Exp is a DataWindow expression whose value is a string. The DataWindow in the
server component evaluates it, converts it using URL encoding, and includes it in the
SelfLinkArgs string.
The evaluated SelfLinkArgs expressions are included in the generated HTML as
hidden fields. The arguments supply information that the server needs to render
additional pages of the result set, such as retrieval arguments.
StringJSFile (exp) Cache file name for common Web DataWindow functions that use a string
TabIndexBase (exp) Sets the starting tab order number for a Web DataWindow. This property is
useful for a Web page with multiple Web DataWindows when you can tab between
columns of the DataWindows. Setting this property has no effect on page
functionality when the page is viewed in a browser that does not support the tab index
attribute. The maximum tab index allowed for a page is 32767. See TabIndexBase
property on page 303.
UserJSFile (exp) Cache file name for user-defined Web DataWindow functions. If you set this
property, the file is downloaded to the browser client once per session for use by all
Web DataWindows. You can prefix the file name to a URL, or you can use the URL
that you set with the HTMLGen.ResourceBase property. See JavaScript caching on
page 301.
Usage Most of these properties are considered only when the HTMLDW property is
set to Yes.
Browser recognition The Browser and HTMLVersion properties are always
considered when HTML is generated, regardless of the HTMLDW setting.
Browser identification strings are sent by the client to the server in the HTTP
header. The server component can assign the HTTP_USER_AGENT value
from the HTTP header to the Browser property. If the string specifies a browser
that the DataWindow engine supports, the DataWindow will generate HTML
optimized for that browser. Browser-specific HTML is generated only for
Microsoft Internet Explorer and Netscape browsers.
300 PowerBuilder
If the browser is not recognized or not specified, then the generated HTML will
use the HTMLVersion and GenerateJavaScript properties to decide what
features to include. DataWindow HTML generation recognizes these
browsers:
Browser HTTP header string HTML features used
Netscape Mozilla/1.x ( No style sheets, no absolute positioning, no
JavaScript.
Mozilla/2.x ( JavaScript.
Mozilla/3.x ( No style sheets, no absolute positioning, no
regular expressions.
Mozilla/4.x ( Style sheets, JavaScript, regular expressions.
No absolute positioning.
Microsoft Internet Explorer Mozilla/1.22 (compatible; MSIE No style sheets, no absolute positioning, no
2.x; tab order, no JavaScript.
Mozilla/2.0 (compatible; MSIE 3.x; Style sheets, tab order, JavaScript.
No absolute positioning, no regular
expressions.
Mozilla/4.0 (compatible; MSIE 4.x, Style sheets, absolute positioning, tab order,
Mozilla/4.0 (compatible; MSIE 5.x; regular expressions.
Mozilla/4.0 (compatible; MSIE 6.x;
Opera Mozilla/3.0 (compatible; Opera 3.x; JavaScript, regular expressions.
No style sheets, no absolute positioning.
Columns with RichText edit style

To save rich text formatting in columns with the RichText edit style, the
HTMLGen.Browser property must be set to "Microsoft Internet Explorer" and
the HTMLGen.HTMLVersion property to "4.0".
Client properties The ClientEvents, ClientFormatting, ClientValidation,

ClientComputedFields, and ClientScriptable properties control the amount of
JavaScript that is generated for the Web DataWindow, which impacts the size
of the page that is downloaded to the browser. You can reduce the size of the
generated HTML by setting one or more of the properties to No.
JavaScript caching You can also reduce the size of the generated HTML by
setting up cache files for common Web DataWindow client-side methods. You
can generate these files using the JavaScript Generation wizard that you launch
from a button on the JavaScript Generation tab of the Properties view in the
DataWindow painter.

Once you generate these files, you can set the file names as values for the
CommonJSFile, DateJSFile, NumberJSFile, and/or StringJSFile properties.
When you set these properties, the methods defined in the referenced files will
not be generated with the HTML in any Web DataWindow pages that are sent
to the page server and client browser.
With JavaScript caching, you improve performance after the first Web
DataWindow page is generated—as long as the browser on the client computer
is configured to use cached files. With caching enabled, the browser loads the
JS files from the Web server into its cache, and these become available for all
the Web DataWindow pages in your application. There is no performance gain
if the browser does not find the JS files in its cache since, in this case, it reloads
the files from the Web server.
PagingMethod The PagingMethod property determines whether the control
uses the client-side script callback mechanism introduced in the .NET
Framework 2.0 to execute server-side code without posting and refreshing the
current page.
The default is to post back to the server (PostBack!).
The Callback! option uses script callbacks to retrieve the next page of XML
data. It corresponds to the Microsoft GridView control’s
EnableSortingAndPagingCallback property, but applies only to paging.
Client-side sorting is handled by another mechanism.
For the XML rendering format, the design of the Callback! option requires that
a reusable XSLT stylesheet be generated so that the browser can cache it. The
benefit from this requirement is that only the XML data for the next requested
page need be returned by the callback. This XML data is always trivial in size
(about a 1 to 20 ratio), resulting in significant bandwidth savings. This is unlike
other implementations, where the entire presentation is always regenerated and
downloaded again from every callback.
The generated XSLT stylesheet is not reusable, and therefore cannot be cached
by the browser, if the DataWindow layout is inconsistent page-to-page, or it
does not contain a complete first page of data. In these scenarios, the Callback!
option defers to PostBack! until a stylesheet can be generated that is reusable,
and can therefore be cached in the browser.
The XMLClientSide! option is only available with the XML rendering format.
It retrieves the entire XML result set and uses XSLT re-transformation of the
cached stylesheet to perform paging on the client. This option can currently be
used only if the presentation style is uniform from page to page. For example,
it cannot handle a summary band on the last page.
302 PowerBuilder
When PagingMethod is set to XMLClientSide!, InsertRow, AppendRow, and

DeleteRow actions do not require a postback or callback to the server. However,
computed fields in the DataWindow that are dependent on the RowCount
method are not refreshed until an action such as Update or Retrieve forces a
postback to the server.
NetscapeLayers property Even if you set the NetscapeLayers property to
true, certain functionality in a Netscape browser using absolute positioning
might not be identical to the functionality available with Internet Explorer. For
example, you cannot tab between DataWindow columns using a Netscape
browser on an NT machine (although you can do this using a Netscape browser
on a Solaris machine).
TabIndexBase property If you add Web DataWindows to a page that already
has a Web DataWindow on it, you can set the TabIndexBase property for each
Web DataWindow you add.
For a page with two Web DataWindows, setting the tab index base for the
second DataWindow to a number greater than the tab index for the last column
of the first DataWindow allows the user (using an Internet Explorer browser)
to tab through all the columns of the first DataWindow before tabbing to the
second DataWindow. Otherwise, pressing the Tab key could cause the cursor
and focus to jump from one DataWindow to another instead of tabbing to the
next column in the DataWindow that initially had focus.
set the values in the Properties view, Web Generation tab or JavaScript
Generation tab. Select HTML/XHTML from the Format to Configure list to
display the properties.
Examples dw1.Object.DataWindow.HTMLGen.HTMLVersion = "4.0"
("DataWindow.HTMLGen.Browser")
dw1.Modify("DataWindow.HTMLGen.ClientValidation =
'no'")
dw1.Modify("DataWindow.HTMLGen.PublishPath=
'C:\Inetpub\wwwroot\MyWebApp\generatedfiles'")
dw1.Modify("DataWindow.HTMLGen.ResourceBase=
'/MyWebApp/generatedfiles'")
This statement sets the XMLGen.Paging property so that the complete result
set is downloaded to the client and paging takes place on the client:
dw1.Modify("DataWindow.HTMLGen.PagingMethod=XMLClientS
ide!")

This statement sets the HTMLGen.PagingMethod property to use script

callbacks:
dw1.Object.DataWindow.HTMLGen.PagingMethod=1
HTMLTable.property
Description Settings for the display of DataWindow data when displayed in HTML table
format. These settings simplify the transfer of data from a database to an
HTML page. They are particularly useful when used to create HTML pages
dynamically.
Obsolete property
HTMLTable.property is obsolete and should not be used, because the Web

dw_control.Object.DataWindow.HTMLTable.property
"DataWindow.HTMLTable.property { = ' value ' }"
property A property for a DataWindow to be displayed in HTML table
format. Properties and their values are listed in the table below.
Property for
HTMLTable Value
Border (exp) Border attribute for the HTMLTable element. The default is 1 (line around the
table).
CellPadding (exp) CellPadding attribute for the HTMLTable element. The default is 0.
CellSpacing (exp) CellSpacing attribute for the HTMLTable element. The default is 0.
GenerateCSS (exp) Controls whether the DataWindow HTMLTable property’s Table element
contains border, cellpadding, cellspacing, nowrap, and width attributes. Also controls
whether elements within the table contain CLASS references that control style sheet
use. The default is no.
304 PowerBuilder
Property for
HTMLTable Value
NoWrap (exp) NoWrap attribute for the HTMLTable element. The default is to include this
attribute.
StyleSheet (exp) HTML cascading style sheet generated for the DataWindow.
Width Width attribute for the HTMLTable element. The default is 0.
Usage In the painter Set the value using the Properties view, HTML Table tab.
Examples dw1.Object.DataWindow.HTMLTable.Border = "2"
("DataWindow.HTMLTable.StyleSheet")
dw1.Modify("DataWindow.HTMLTable.NoWrap = 'yes'")
ID
Description The number of the column or TableBlob.
Applies to Column and TableBlob controls
dw_control.Object.controlname.ID
"controlname.ID"
controlname The name of the column or TableBlob for which you want
the ID number
Examples setting = dw1.Object.empname.ID

setting = dw1.Describe("empname.ID")
Identity
Description Whether the database is to supply the value of the column in a newly inserted
row. If so, the column is not updatable; the column is excluded from the
INSERT statement.
Not all DBMSs support the identity property. For more information see the
documentation for your DBMS.


dw_control.Object.columnname.Identity
"columnname.Identity { = ' value ' }"
columnname A string containing the name of the column for which you
want to get or set the identity property.
value A string indicating whether a column’s value in a newly
inserted row is supplied by the DBMS:
Yes – The DBMS will supply the value of the column
in a newly inserted row; the column is not updatable.
No – The column is updatable.
Examples dw1.Object.empid.Identity = "yes"

dw1.Modify("empid.Identity='yes'")
Import.XML.Trace
Description Setting that determines whether import trace information is written to a log file.
dw_control.Object.DataWindow.Import.XML.Trace
"DataWindow.Import.XML.Trace { = ' value ' }"
value Whether trace information is written to a log file.
Values are:
• Yes – Trace information is written to a log file.
• No – Trace information is not written to a log file (default).
Usage If you want to collect trace information, this property should be set before you
call the ImportClipboard, ImportFile, or ImportString method to import data from
an XML document. The trace information is appended to the file you specify
using the Import.XML.TraceFile property. If no trace file is specified, trace
information is appended to a file named pbxmltrc.log in the current directory.
306 PowerBuilder
In the painter In the Data Import tab in the Properties view for the
DataWindow object, select XML from the Format to Configure list, and type a
file name in the Trace File Name text box.
Examples This example specifies that trace information should be written to a file called
xmltrace.log in the C:\temp directory.
dw1.Modify("DataWindow.Import.XML.Trace = 'yes' ")
dw1.Modify("DataWindow.Import.XML.TraceFile =
'C:\temp\xmltrace.log' ")
See also Import.XML.TraceFile
Import.XML.TraceFile
Description Specifies the name and location of an import trace file.
dw_control.Object.DataWindow.Import.XML.TraceFile
"DataWindow.Import.XML.TraceFile { = ' value ' }"
value A string whose value is the name of the trace output file. If the
file does not exist, it is created.
Usage If you want to collect trace information, the Import.XML.Trace property

should be set before you call the ImportClipboard, ImportFile, or ImportString
method to import data from an XML document. The trace information is
appended to the file you specify using the Import.XML.TraceFile property. If
no trace file is specified, trace information is appended to a file named
pbxmltrc.log in the current directory.
DataWindow object, select XML from the Format to Configure list, and type a
file name in the Trace File Name text box.
Examples This example specifies that trace information should be written to a file called
xmltrace.log in the C:\temp directory.
dw1.Object.DataWindow.Import.XML.Trace = 'yes'
dw1.Object.DataWindow.Import.XML.TraceFile =
'C:\temp\xmltrace.log'

See also Import.XML.Trace
Import.XML.UseTemplate
Description Setting that optionally controls the logical structure of the XML imported from
an XML file into a DataWindow object using the ImportFile method.
dw_control.Object.DataWindow.Import.XML.UseTemplate
"DataWindow.Import.XML.UseTemplate { = ' value ' }"
value (exp) A string specifying the name of an import template
previously saved in the DataWindow painter for the specified
DataWindow object
Usage This property should be set to specify the logical structure of the XML
imported before you call the ImportFile method to import data from an XML
document. An import template is not required if the XML document from
which data is imported corresponds to the DataWindow column definition.
If an export template for a DataWindow object exists, it can be used as an
import template. Only the mapping of column names to element attribute
names is used for import. The order of elements within the template is not
significant, because import values are located by name match and nesting
depth within the XML document. All other information in the template, such
as controls and comments, is ignored.
a template from the Use Template list.
Examples This example sets the name of the current XML import template used in dw1
to t_import_report. If t_import_report does not exist, the current template is not
changed.
dw1.Modify("DataWindow.Import.XML.UseTemplate =
't_import_report' ")
See also Import.XML.UseTemplate
308 PowerBuilder
Initial
Description The initial value of the column in a newly inserted row.
dw_control.Object.columnname.Initial
"columnname.Initial { = ' initialvalue ' }"
columnname A string containing the name of the column for which you
want to get or set the initial property.
initialvalue A string containing the initial value of the column. Special
values include:
Empty – A string of length 0
Null – No value
Spaces – All blanks
Today – Current date, time, or date and time
Examples setting = dw1.Object.empname.Initial

dw1.Object.empname.Initial = "empty"
setting = dw1.Describe("empname.Initial")
dw1.Modify("empname.Initial='empty'")
dw1.Modify("empstatus.Initial='A'")
Ink.property
Description Properties that control the attributes of ink in an InkPicture control or a column
with the InkEdit edit style.
Applies to Column and InkPicture controls
dw_control.Object.inkpicname.Ink.property
dw_control.Object.columnname.Ink.property
"inkpicname.Ink.property { = value }"
"columnname.Ink.property { = value }"

inkpicname The name of an InkPicture control.
columnname The name of a column that has the InkEdit edit style.
property A property for the InkPicture control or InkEdit column.
Properties and their settings are listed in the table below.
value The value to be assigned to the property.
Property for Ink Value

AntiAliased A drawing attribute that specifies whether the foreground and background colors
along the edge of the drawn ink are blended (antialiased) to make the stroke smoother
and sharper.
Values are:
true – The ink stroke appears smoother and sharper (default)
false – The ink stroke is not antialiased
Painter: InkAntiAliased option.
Color A drawing attribute that specifies the current ink color. The default color is black.
Painter: InkColor option.
Height A drawing attribute that specifies the height of the side of the rectangular pen tip in
HIMETRIC units (1 HIMETRIC unit = .01mm). The default is 1.
Painter: InkHeight option.
IgnorePressure A drawing attribute that specifies whether the drawn ink gets wider as the pressure of
the pen tip on the tablet surface increases.
Values are:
true – Pressure from the pen tip is ignored
false – The width of the ink increases with the pressure of the pen tip (default)
Painter: IgnorePressure option.
Pentip A drawing attribute that specifies whether the pen tip is round or rectangular.
Values are:
Ball (0) – The pen tip is round (default)
Rectangle (1) – The pen tip is rectangular
Painter: PenTip option.
Transparency A drawing attribute that specifies the transparency of drawn ink. The range of values
is from 0 for totally opaque (the default) to 255 for totally transparent.
Painter: InkTransparency option.
Width A drawing attribute that specifies the width of the side of the rectangular pen tip in
HIMETRIC units (1 HIMETRIC unit = .01mm). The default is 53.
Painter: InkWidth option.
310 PowerBuilder
Usage In the painter Select the control and set values in the Properties view, Ink or
InkPicture tab, InkAttributes section.
Examples dw1.Object.inkpic1.Ink.Antialiased = true
li_color = dw1.Describe("emp_status.Ink.Color")
See also InkEdit.property
InkPic.property
InkEdit.property
Description Properties that control the behavior of a column with the InkEdit edit style.
dw_control.Object.columnname.InkEdit.property
"columnname.InkEdit.property { = value }"
columnname The name of a column that has the InkEdit edit style.
property A property for the InkEdit column. Properties and their settings
are listed in the table below.
Property for InkEdit Value

AutoSelect Whether to select the contents of the edit control automatically when it receives
focus. Values are:
Yes – Select automatically (default).
Painter: Auto Selection option.
DisplayOnly Specifies whether the text is display-only and cannot be changed by the user. Values
are:
true – Text cannot be changed by user.
false – Text can be changed by user (default).


Factoid Specifies a context for ink recognition. Set this property if the input data is of a known
type, such as a date or Web address, to constrain the search for a recognition result.
Possible values include digit, e-mail, Web, date, time, number, currency, percent, and
telephone. For a list of values, see the table that follows.
Painter: Factoid option.
FocusRectangle Whether a dotted rectangle (the focus rectangle) will surround the current row of the
column when the column has focus. Values are:
Yes – (Default) Display the focus rectangle.
No – Do not display the focus rectangle (default).
HScrollbar Whether a horizontal scroll bar displays in the edit control. Values are:
Yes – Display the horizontal scroll bar.
No – Do not display the horizontal scroll bar (default).
InkMode Specifies whether ink collection is enabled and whether ink only or ink and gestures
are collected. Values are:
InkDisabled (0) – Ink collection is disabled.
CollectInkOnly (1) – Only ink is collected.
CollectInkAndGestures (2) – Ink and gestures are collected (default).
Painter: InkMode option.
NilIsNull Whether to set the data value of the InkEdit to null when the user leaves the edit box
blank. Values are:
Yes – Make the Empty string null.
No – Do not make the empty string null (default).
Painter: Empty String is null option.
RecognitionTimer Specifies the time period in milliseconds between the last ink stroke and the start of
text recognition. The default is 2000 (two seconds).
Painter: RecognitionTimer option.
Required Whether the column is required. Values are:
Yes – Required.
312 PowerBuilder

UseMouseForInput Specifies whether the mouse can be used for input on a Tablet PC. Values are:
true – The mouse can be used for input
false – The mouse cannot be used for input (default)
Painter: UseMouseForInput option.
VScrollbar Whether a vertical scroll bar displays in the edit control. Values are:
No – Do not display a vertical scroll bar (default).
Usage The following values for Factoid are available. After the Default and None
factoids, the drop-down list in the Properties view displays factoids for special
formats in alphabetical order, followed by single-character factoids and
Asian-language factoids. You can set multiple factoids by separating them with
the pipe ( | ) character.
Factoid Description
Default Returns recognizer to the default setting. For Western
languages, the default setting includes the user and system
dictionaries, various punctuation marks, and the Web and
Number factoids. For Eastern languages, the default setting
includes all characters supported by the recognizer.
None Disables all factoids, dictionaries, and the language model.
Currency Currency in pounds, dollars, euros, and yen.
Date Dates written in English; for example 8/19/2005, Aug 19,
2005, or Friday, August 19, 2005.
E-mail E-mail addresses.
Filename Windows file name paths. The name cannot include the
following characters: / : " < > |
Number Numeric values, including ordinals, decimals, separators,
common suffixes, and mathematical symbols. This factoid
includes the Currency and Time factoids.
Percent A number followed by the percent symbol.
Postal Code Postal codes as written in English, for example 01730 or
CT17 9PW.
System Dictionary Words in the system dictionary only.
Telephone Telephone numbers as written in English, for example
(555) 555 5555 or +44 1234 123456.
Time Times as written in English, for example 15:05 or 3:05 pm.
Web Various URL formats.

Factoid Description
Word List Words on the word list associated with the recognizer
context only.
Digit A single digit (0–9).
One Char A single ANSI character.
Upper Char A single uppercase character.
In addition, the following Asian-language factoids are available:

Bopomofo Kanji Common
Hangul Common Katakana
Hiragana Korean Common
Jamo Simplified Chinese Common
Japanese Common Traditional Chinese Common
In the painter Select the control and set values in the Properties view, Ink tab
for properties relating to Ink, or the Edit tab for properties common to other edit
styles. The Style Type on the Edit tab must be set to InkEdit.
Examples string str
str = dw1.Object.emp_name.InkEdit.Factoid
dw1.Object.emp_name.InkEdit.Factoid = EMAIL
str = dw1.Describe("emp_bd.InkEdit.Factoid")
dw1.Modify("emp_bd.InkEdit.Factoid=EMAIL")
string str
str = dw1.Object.emp_name.InkEdit.AutoHScroll
dw1.Object.emp_name.InkEdit.Required = "no"
See also Ink.property
InkPic.property
Description Properties that control the behavior of ink in an InkPicture control.
Applies to InkPicture controls
dw_control.Object.inkpicname.InkPic.property
"inkpicname.InkPic.property { = value }"
314 PowerBuilder
inkpicname The name of an InkPicture control.
property A property for the InkPicture control. Properties and their
Property for InkPic Value

AutoErase Specifies whether the auto erase feature available on some styluses is turned on.
Values are:
true – AutoErase is turned on.
false – AutoErase is turned off (default).
Painter: AutoErase option.
BackColor Specifies the numeric value of the background color: –2 to 16,777,215. For more
information about color, see the RGB function.
Painter: BackColor option.
CollectionMode Specifies whether ink only, gestures only, or ink and gestures are collected. Values
are:
InkOnly (0) – Only ink is collected (default).
GestureOnly (1) – Only gestures are collected.
InkAndGesture (2) – Ink and gestures are collected.
Painter: CollectionMode option.
DynamicRendering Specifies whether the ink is rendered (displayed in the control) as it is drawn. The
default is true.
Painter: DynamicRendering option.
EditMode Specifies whether the editing mode of the control is set for drawing, deleting, or
selecting ink. Values are:
InkMode (0) – Ink is drawn (default).
DeleteMode (1) – Ink is deleted.
SelectMode (2) – Ink is selected.
Painter: EditMode option.
EraserMode Specifies whether ink is removed by stroke or point. Values are:
StrokeErase (0) – The entire ink stroke under the stylus is removed (default).
PointErase (1) – Only the ink under the stylus is removed.
Painter: EraserMode option.
EraserWidth Specifies the width of the eraser pen tip in HIMETRIC units (1 HIMETRIC unit =
.01mm). The default is 212. This property applies when EditMode is set to
DeleteMode and EraserMode is set to PointErase.
Painter: EraserWidth option.

Property for InkPic Value

HighContrastInk Specifies whether ink is rendered in a single color when the system is in high contrast
mode and draws the selection rectangle and handles in high contrast. Values are:
true – Ink is rendered in a single color in high contrast mode (default).
false – Ink is not rendered in a single color in high contrast mode.
Painter: HighContrastInk option.
InkEnabled Specifies whether the InkPicture control collects pen input. Values are:
true – The control collects pen input (default).
false – The control does not collect pen input and no pen-related events fire.
Painter: InkEnabled option.
MarginX Specifies the x-axis margin around the control in PowerBuilder units. The default
value is 0.
Painter: MarginX option.
MarginY Specifies the y-axis margin around the control in PowerBuilder units. The default
value is 0.
Painter: MarginY option.
PictureSizeMode Specifies how the picture is displayed in the control. Values are:
Center Image (1) – The picture is centered in the control.
Normal (2) – The picture is displayed in the upper-left corner of the control and
any part of the picture that does not fit in the control is clipped (default).
Stretch (3) – The picture is stretched to fill the control.
Painter: PictureSizeMode option.
Usage In the painter Select the control and set values in the Properties view,
InkPicture tab.
Examples dw1.Object.inkpic1.InkPic.InkEnabled = true
li_color = dw1.Describe("inkpic1.InkPic.BackColor")
See also Ink.property
Invert
Description The way the colors in a Picture control are displayed, either inverted or normal.
Applies to Picture controls
dw_control.Object.bitmapname.Invert
"bitmapname.Invert { = ' number ' }"
316 PowerBuilder
bitmapname The name of the Picture control in the DataWindow for which
you want to invert the colors.
number (exp) A boolean number indicating whether the colors of the
picture will display inverted. Values are:
0 – (Default) No; do not invert the picture’s colors.
1 – Yes; display the picture with colors inverted.
Number can be a quoted DataWindow expression.
General tab, Invert Image check box.
setting = dw1.Object.bitmap_1.Invert
dw1.Object.bitmap_1.Invert="0~tIf(empstatus='A',0,1)"
setting = dw1.Describe("bitmap_1.Invert")
dw1.Modify( &
"bitmap_1.Invert='0~tIf(empstatus=~~~'A~~~',0,1)'")
JSGen.property
Description Settings that specify the physical path to which generated JavaScript is
published and the URL indicating the location of the generated JavaScript.
Obsolete property
JSGen.property is obsolete and should not be used, because the Web

dw_control.Object.DataWindow.JSGen.property
"DataWindow.JSGen.property { = ' value ' }"
• PublishPath
• ResourceBase

value (exp) PublishPath – A string that specifies the physical path of
the Web site folder to which PowerBuilder publishes the
generated JavaScript.
(exp) ResourceBase – A string that specifies the URL of the
generated JavaScript for performing client-side XSLT
transformation and instantiation of client-side data.
ResourceBase property. At runtime, after PowerBuilder generates JavaScript
to the PublishPath folder, it includes it in the final XHTML page by referencing
it with the value of the ResourceBase property in a <script> element.
In the painter In the JavaScript Generation tab in the Properties view for the
specify the ResourceBase and Publish Path locations.
Examples These statements set the JSGen.ResourceBase and JSGen.PublishPath
properties:
dw1.Object.DataWindow.JSGen.ResourceBase= &
dw1.Object.DataWindow.JSGen.PublishPath= &
Key
Description Whether the column is part of the database table’s primary key.
dw_control.Object.columnname.Key
"columnname.Key { = value }"
columnname The column for which you want to get or set primary key status.
value Whether the column is part of the primary key. Values are:
Yes – The column is part of the primary key
No – The column is not part of the key
Usage In the painter Set the value using the Rows menu, Update Properties.
318 PowerBuilder

setting = dw1.Object.empid.Key
dw1.Object.empid.Key = "Yes"
setting = dw1.Describe("empid.Key")
dw1.Modify("empid.Key=Yes")
KeyClause
Description An expression to be used as the key clause when retrieving the blob.
Applies to TableBlob controls
dw_control.Object.tblobname.KeyClause
"tblobname.KeyClause { = ' keyclause ' }"
tblobname The name of the TableBlob for which you want to specify
a key clause.
keyclause (exp) A string that will be built into a key clause using the
substitutions provided. The key clause can be any valid
WHERE clause. Keyclause can be a quoted DataWindow
expression.
Definition tab, Key Clause option.
Examples With the following setting, the value of key_col will be put in col2 when
PowerBuilder constructs the WHERE clause for the SELECTBLOB statement:
dw1.Modify(blob_1.KeyClause='Key_col = :col2'")
Label.property
Description Settings for a DataWindow whose presentation style is Label.
dw_control.Object.DataWindow.Label.property

"DataWindow.Label.property { = value }"

SyntaxFromSql:
DataWindow(Label.property = value)
property A property for the Label presentation style. Properties and their
value The value to be assigned to the property. For Label properties,
Property for Label Value

Columns An integer indicating the number of columns of labels on a sheet.
Painter: Label group, Labels Across option.
Columns.Spacing An integer indicating the space between columns of labels in the units specified for
the DataWindow object.
Painter: Arrangement group, Between Columns option.
Ellipse_Height An integer specifying the height of the rounded corners of a RoundRectangle label.
This property is not valid for any other label shape. This value uses the same unit of
measure specified for the DataWindow object.
Ellipse_Width An integer specifying the width of the rounded corners of a RoundRectangle label.
This property is not valid for any other label shape. This value uses the same unit of
measure specified for the DataWindow object.
Height An integer specifying the height of a label in the units specified for the DataWindow
object.
Painter: Label group, Height option.
Name A string containing the name of a label.
Painter: Predefined Label option.
Rows An integer indicating the number of rows of labels on a sheet.
Painter: Label group, Labels Down option.
Rows.Spacing An integer indicating the space between rows of labels on a sheet in the units
specified for the DataWindow object.
Painter: Arrangement group, Between Rows option.
320 PowerBuilder
Property for Label Value

Shape A string specifying the shape of a label.
Values are:
Rectangle
RoundRectangle
Oval
Sheet (Describe only) Whether the paper is sheet fed or continuous.
Values are:
Yes – Sheet fed
No – Continuous
Painter: Arrangement group, Paper option.
TopDown (Describe only) Whether the labels will be printed from the top to the bottom or
across the page.
Values are:
No – Print labels across the page.
Yes – Print labels from top to bottom.
Painter: Arrangement group, Arrange option.
Width An integer specifying the width of a label in the units specified for the DataWindow
object.
Painter: Label group, Width option.
set the value in the Properties view, General tab (when presentation style is
Label).
setting = dw1.Object.DataWindow.Label.Sheet
dw1.Object.DataWindow.Label.Width = 250
setting = dw1.Describe("DataWindow.Label.Sheet")
dw1.Modify("DataWindow.Label.Width=250")
dw1.Modify("DataWindow.Label.Height=150")
dw1.Modify("DataWindow.Label.Columns=2")
dw1.Modify("DataWindow.Label.Width=250")
dw1.Modify("DataWindow.Label.Name='Address1'")
LabelDispAttr.fontproperty
See DispAttr.fontproperty.

LastRowOnPage
Description The last row currently visible in the DataWindow.
dw_control.Object.DataWindow.LastRowOnPage
Describe argument:
"DataWindow.LastRowOnPage"
setting = dw1.Object.DataWindow.LastRowOnPage
setting = dw1.Describe("DataWindow.LastRowOnPage")
Left_Margin
Description The size of the left margin of the DataWindow object.
Style ( Left_Margin = value )
value An integer specifying the size of the left margin in the units
specified for the DataWindow

'Style( ... LeftMargin = 500 ... )', errstring)
Legend
Description The location of the legend in a Graph control in a DataWindow.
dw_control.Object.graphname.Legend
"graphname.Legend { = ' value ' }"
322 PowerBuilder
graphname The name of the graph control for which you want to specify the
location of the legend.
value (exp) A number indicating the location of the legend of a graph.
Values are:
0 – None
1 – Left
2 – Right
3 – Top
4 – Bottom
General tab, Legend option (applicable when the graph has more than one
series).
setting = dw1.Object.graph_1.Legend
dw1.Object.graph_1.Legend = 2
setting = dw1.Describe("graph_1.Legend")
dw1.Modify("graph_1.Legend=2")
dw1.Modify("graph_1.Legend='2~tIf(dept_id=200,0,2)'")
Legend.DispAttr.fontproperty
Level
Description The grouping level.
Level is used in DataWindow syntax only for the Create method.
Applies to Group keywords
Syntax Group ( BY( colnum1, colnum2, ... ) ... Level = n ... )

LineRemove
Description (RichText presentation style only) Whether the line of text that contains the
input field for the column or computed field is removed when the input field is
empty. LineRemove is similar to the SlideUp property for controls in other
presentation styles.
Applies to Column and Computed Field controls in the RichText presentation style
dw_control.Object.controlname.LineRemove
"controlname.LineRemove { = ' value ’ }"
controlname The name of the column or computed field whose line of text
you want removed when the input field is empty.
value (exp) Whether the line of text is removed so that the rest of the
text slides up when the input field for controlname is empty.
Values are:
• Yes – The line of text will be removed when the input field
is empty.
• No – The line of text will not be removed.

setting = dw1.Object.emp_street2.LineRemove
dw1.Object.emp_street2.LineRemove = true
setting = dw1.Describe("emp_street2.LineRemove")
dw1.Modify("emp_street2.LineRemove=yes")
LinkUpdateOptions
Description When the OLE Object control is linked, the method for updating the link
information. If the user tries to activate the OLE object and PowerBuilder
cannot find the linked file, which breaks the link, LinkUpdateOptions controls
whether PowerBuilder automatically displays a dialog box prompting the user
to find the file. If you turn off the automatic dialog box, you can reestablish the
link by calling the LinkTo or LinkUpdateDialog in code.
324 PowerBuilder

dw_control.Object.olecontrolname.LinkUpdateOptions
"olecontrolname.LinkUpdateOptions { = ' updatetype ' }"
or set the link update method.
updatetype A number specifying how broken links will be reestablished.
Updatetype can be a quoted DataWindow expression.
Values are:
• LinkUpdateAutomatic!
• LinkUpdateManual!
Options tab, Link Update option.
ls_data = dw1.Object.ole_report.LinkUpdateOptions
dw1.Object.ole_report.LinkUpdateOptions = 0
ls_data = dw1.Describe("ole_report.LinkUpdateOptions")
dw1.Modify("ole_report.LinkUpdateOptions='0'")
Message.Title
Description The title of the dialog box that displays when an error occurs.
dw_control.Object.DataWindow.Message.Title
"DataWindow.Message.Title { = ' titlestring ' }"
SyntaxFromSql:
DataWindow(Message.Title = ' titlestring ' )
titlestring A string containing the title for the title bar of the DataWindow
dialog box that displays when an error occurs

Examples setting = dw1.Object.DataWindow.Message.Title

dw1.Object.DataWindow.Message.Title = "Mistake!"
setting = dw1.Describe("DataWindow.Message.Title")
dw1.Modify("DataWindow.Message.Title='Bad, Bad, Bad'")
"Style(...) &
DataWindow(Message.Title='Sales Report' ...) ...", &
ls_Errors)
Moveable
Description Whether the specified control in the DataWindow can be moved at runtime.
Moveable controls should be in the DataWindow’s foreground.
dw_control.Object.controlname.Moveable
"controlname.Moveable { = number }"
controlname The control within the DataWindow for which you want to get
or set the Moveable property that governs whether the user can
move the control
number A boolean number specifying whether the control is moveable.
Values are:
0 – False, the control is not moveable.
1 – True, the control is moveable.
Position tab.
setting = dw1.Object.bitmap_1.Moveable
dw1.Object.bitmap_1.Moveable = 1
setting = dw1.Describe("bitmap_1.Moveable")
dw1.Modify("bitmap_1.Moveable=1")
326 PowerBuilder
Multiline
Description (RichText presentation style) Whether the column or computed field can
contain multiple lines. Multiline is effective only when Width.Autosize is set
to No.
dw_control.Object.controlname.Multiline
"controlname.Multiline { = ' value ' }"
controlname The name of the column or computed field that will contain
multiple lines.
value (exp) Whether the input field can contain multiline lines. Values
are:
• Yes – The input field can contain multiple lines.
• No – The input field cannot contain multiple lines.
Input Field or Compute tab, MultiLine option.
To display the property sheet, click the input field (column or computed field)
to select it. Then right-click and select Properties from the pop-up menu.
setting = dw1.Object.emp_street2.Multiline
dw1.Object.emp_street2.Multiline = true
setting = dw1.Describe("emp_street2.Multiline")
dw1.Modify("emp_street2.Multiline=yes")
Name
Description The name of the control.
Applies to Button, Column, Computed Field, Graph, GroupBox, InkPicture, Line, OLE,
Oval, Picture, Rectangle, Report, RoundRectangle, TableBlob, and Text
controls


dw_control.Object.controlname.Name
Describe argument:
"controlname.Name"
controlname The control for which you want the name. For columns, you can
specify the column number preceded by #.
General tab, Name option.
Examples setting = dw1.Object.#4.Name
setting = dw1.Describe("#4.Name")
Nest_Arguments
Description The values for the retrieval arguments of a nested report. The number of values
in the list should match the number of retrieval arguments defined for the
nested report.
dw_control.Object.reportname.Nest_Arguments
"reportname.Nest_Arguments { = list } "
reportname The name of the nested report for which you want to supply retrieval
argument values.
list A list of values for the retrieval arguments of the nested report. The
format for the list is:
( ("arg1") {,("arg2") {,("arg3") {,... } } } )
Usage The list is not a quoted string. It is surrounded by parentheses, and each
argument value within the list is parenthesized, surrounded with double quotes,
and separated by commas. If an argument is a literal string, use single quotes
within the double quotes.
328 PowerBuilder
When changing the values for the retrieval arguments, you must supply values
for all the retrieval arguments defined for the report. If you specify fewer or
more arguments, an error will occur at runtime when the DataWindow retrieves
its data.
To remove the report’s retrieval arguments, specify empty parentheses. If no
arguments are specified, the user is prompted for the values at runtime.
General tab.
Examples setting = dw1.Object.rpt_1.Nest_Arguments
dw1.Object.rpt_1.Nest_Arguments = &
"((~"cust_id~"),(~"'Eastern'~"))"
setting = dw1.Describe("rpt_1.Nest_Arguments")
dw1.Modify("rpt_1.Nest_Arguments" "=((~"cust_id~"),
(~"'Eastern'~"))")
dw1.Modify("rpt_1.Nest_Arguments=()")
Nested
Description Whether the DataWindow contains nested DataWindows. Values returned are
Yes or No.
dw_control.Object.DataWindow.Nested
Describe argument:
"DataWindow.Nested"
setting = dw1.Object.DataWindow.Nested
setting = dw1.Describe("DataWindow.Nested")
NewPage (Group keywords)

Description Whether a change in the value of a group column causes a page break.
Group ( colnum1, colnum2 NewPage )

Examples SQLCA.SyntaxFromSQL(sql_syntax, &

"Style(Type=Group) " + &
"Group(#3 NewPage ResetPageCount)", &
ls_Errors)
NewPage (Report controls)

Description Whether a nested report starts on a new page. NewPage applies only to reports
in a composite DataWindow. Note that if the Trail_Footer property of the
preceding report is set to No, the current report will be forced to begin on a new
page regardless of the NewPage value.
dw_control.Object.reportname.NewPage
"reportname.NewPage { = value } "
reportname The name of the report control for which you want to get
or set the NewPage property.
value Whether the report begins a new page.
Values are:
Yes – Start the report on a new page.
No – Do not start the report on a new page.
Usage In the painter Select the Report control in the Composite presentation style
and set the value in the Properties view, General tab, New Page check box.
Examples string newpage_setting
newpage_setting = dw1.Object.rpt_1.NewPage
dw1.Object.rpt_1.NewPage = "Yes"
newpage_setting = dw1.Describe("rpt_1.NewPage")
dw1.Modify("rpt_1.NewPage=Yes")
NoUserPrompt
Description Determines whether message boxes are displayed to the user during
DataWindow processing.
330 PowerBuilder
dw_control.Object.DataWindow.NoUserPrompt
"DataWindow.NoUserPrompt { = ' value ' }"
value A string specifying whether any message box requiring user
intervention displays during DataWindow processing.
Values are:
Yes – No message box displays.
No – (Default) Message boxes display when invoked during
DataWindow processing.
Usage Set the NoUserPrompt property to yes if the DataWindow is to be used in a

batch process when there is no possibility of end-user intervention. Dialog
boxes you can prevent from displaying include the Error, Print, Retrieve,
CrossTab, Expression, SaveAs, Import, Query, RichText, Filter, and Sort
dialog boxes.
Examples dw1.Object.DataWindow.NoUserPrompt = "yes"
dw1.Modify("DataWindow.NoUserPrompt=no")
Objects
Description A list of the controls in the DataWindow object. The names are returned as a
tab-separated list.
dw_control.Object.DataWindow.Objects
Describe argument:
"DataWindow.Objects"
Examples setting = dw1.Describe("DataWindow.Objects")

OLE.Client.property
Description Settings that some OLE server applications use to identify the client’s
information. The property values can be used to construct the title of the server
window.
dw_control.Object.DataWindow.OLE.Client.property
"DataWindow.OLE.Client.property { = ' value ' }"
property An OLE client property, as shown in the table below.
value Values for the properties are shown in the table below. Value
cannot be a DataWindow expression.
Property for
OLE.Client Value
Class The client class for the DataWindow. The default is DataWindow.
Name The client name for the DataWindow. The default is Untitled.
Definition tab.
Examples ls_data = dw1.Object.DataWindow.OLE.Client.Class
dw1.Object.DataWindow.OLE.Client.Class = "PB"
ls_data = dw1.Describe("DataWindow.OLE.Client.Class")
dw1.Modify("DataWindow.OLE.Client.Class = 'PB'")
OLEClass
Description The name of the OLE class for the TableBlob control.
dw_control.Object.tblobname.OLEClass
"tblobname.OLEClass { = ' oleclassname ' }"
332 PowerBuilder
tblobname The TableBlob column for which you want to get or set the class
of server application.
oleclassname (exp) A string specifying a class of an OLE server application
installed on your system. Oleclassname is quoted and can be a
Definition tab, OLE Class: Description option.
Examples setting = dw1.Object.blob_1.OLEClass
dw1.Object.blob_1.OLEClass = 'Word.Document'
setting = dw1.Describe("blob_1.OLEClass")
dw1.Modify("blob_1.OLEClass='Word.Document'")
OriginalSize
Description The property specifies whether the width and height of the picture are set to
their original values.
Applies to Button and Bitmap controls
dw_control.Object.controlname.OriginalSize
"controlname.OriginalSize { = ‘value’} "
controlname The control for which you want to set the value.
value A string specifying whether the control’s image is set to its
original size.
Values are:
True – The image displays at its original size.
False – The image height and width can be set to other
measurements.
Usage In the painter Select the control and then set the value in the Properties view,
General tab, Original Size check box.
In scripts The OriginalSize property takes a boolean value. The following
line sets the OriginalSize property to false:
dw_1.Object.p_empphoto.originalsize="false"

You should not try to change the width or height of a picture control when
OriginalSize is set to true, because it can lead to unexpected behavior.
Examples dw_1.Modify("p_empphoto.originalsize='true'")
dw_1.Modify("p_product.originalsize='false'")
dw_1.Modify("p_product.height='250'")
dw_1.Modify("p_product.width='250'")
OverlapPercent
Description The percentage of overlap for the data markers (such as bars or columns) in
different series in a graph.
dw_control.Object.graphname.OverlapPercent
"graphname.OverlapPercent { = ' integer ' }"
graphname The name of the graph control in the DataWindow object for
which you want to get or set the percentage of overlap.
integer (exp) An integer specifying the percent of the width of the data
markers that will overlap. Integer can be a quoted DataWindow
expression.
General tab, OverlapPercent option (applicable when a series has been
specified).
setting = dw1.Object.graph_1.OverlapPercent
dw1.Object.graph_1.OverlapPercent = 25
setting = dw1.Describe("graph_1.OverlapPercent")
dw1.Modify("graph_1.OverlapPercent=25")
Pen.property
Description Settings for a line or the outline of a control.
Applies to Line, Oval, Rectangle, and RoundRectangle controls
334 PowerBuilder

dw_control.Object.controlname.Pen.property
"controlname.Pen.property { = value }"
controlname The name of the control whose Pen property you want to get or set.
property A property that applies to the Pen characteristics of controlname, as
listed in the table below.
value The value of the property, as shown in the table below. Value can be
a quoted DataWindow expression.
Property for Pen Value

Color (exp) A long specifying the color (the red, green, and blue values) to be used as the
control’s line color.
Painter: Pen Color option.
Style (exp) A number specifying the style of the line.
Values are:
0 – Solid
1 – Dash
2 – Dotted
3 – Dash-dot pattern
4 – Dash-dot-dot pattern
5 – Null (no visible line)
Painter: Pen Style option.
Width (exp) A number specifying the width of the line in the unit of measure specified for
the DataWindow.
Painter: Pen Width option (not available when Style is a value other than Solid).
General tab.
setting = dw1.Object.line_1.Pen.Width
dw1.Object.line_1.Pen.Width = 10
setting = dw1.Describe("line_1.Pen.Width")
dw1.Modify("line_1.Pen.Width=10")

Perspective
Description The distance from the front of the window at which the graph appears.
dw_control.Object.graphname.Perspective
"graphname.Perspective { = ' integer ' }"
which you want to get or set the perspective.
integer (exp) An integer between 1 and 100 specifying how far away the
graph appears. The larger the number, the greater the distance
and the smaller the graph appears. Integer can be a quoted
General tab, Perspective scroll bar (available when a 3D graph type is
selected).
setting = dw1.Object.graph_1.Perspective
dw1.Object.graph_1.Perspective = 20
setting = dw1.Describe("graph_1.Perspective")
dw1.Modify("graph_1.Perspective=20")
Picture.property
Description Settings that control the background picture displayed in a DataWindow
object. Picture properties are not supported in RichText, Graph, or OLE
DataWindow presentation styles.
dw_control.Object.datawindow.picture.property
"DataWindow.picture.property { = value }"
336 PowerBuilder
property A property for the picture background. Properties and their
settings are listed in the table that follows. Picture properties are
used only when the datawindow.brushmode value is 6. These
properties are not available for RichText, Graph, or OLE
DataWindow objects.
value The value to be assigned to the property. For picture properties,
value can be a quoted DataWindow expression.
Property for Picture Value

Clip.Bottom An integer specifying the percentage to clip from the bottom edge of the background
picture.
Painter: Background tab, Picture group.
Clip.Left An integer specifying the percentage to clip from the left edge of the background
picture.
Clip.Right An integer specifying the percentage to clip from the right edge of the background
picture.
Clip.Top An integer specifying the percentage to clip from the top edge of the background
picture.
File Painter: Background tab, Picture group.
A string indicating the pathname for the picture file to be used for the DataWindow
background. Supported formats are BMP, GIF, JPEG, RLE, WMF, and PNG.
Mode An integer indicating the orientation and size of the background picture, and whether
it is tiled. Tiling also depends on the Scale.X and Scale.Y values.
Values are:
0 – Original Size
1 – Fit to Width
2 – Fit to Height
3 – Preserve Aspect Ratio/Max to Rect
4 – Stretch to Fit
5 – Tile
6 – Flip X
7 – Flip Y
8 – Flip XY

Property for Picture Value

Scale.X An integer from 0 to 100 that indicates the horizontal size of the bitmap in relation to
the horizontal size of the DataWindow object. If you set the Scale.X and Scale.Y
properties to 100, the background picture will cover the entire DataWindow object.
This property is used only when picture.tilemode is set to 5, 6, 7, or 8.
Scale.Y An integer from 0 to 100 that indicates the vertical size of the bitmap in relation to
the vertical size of the DataWindow object. If you set the Scale.X and Scale.Y
properties to 100, the background picture will cover the entire DataWindow object.
This property is used only when picture.tilemode is set to 5, 6, 7, or 8.
Tranparency An integer in the range 0 to 100, where 0 means that the background bitmap is opaque
and 100 that it is completely transparent.
This table explains the values for Picture.Mode:
Value Description
0 - Original Size The image is centered and not tiled to fit the DataWindow.
1 - Fit to Width The image is stretched or compressed (depending on the
aspect ratio) until its width matches that of the
DataWindow control).
2 - Fit to Height The image is stretch or compressed (depending on the the
aspect ratio) until its height matches that of the
DataWindow control.
3 - Preserve Aspect The image is stretched or compressed (without distortion)
Ratio/Max to Rect until its width or height matches that of the DataWindow
control without either of them exceeding the bounds of the
DataWindow control.
4 - Stretch to Fit The image is stretched to fill the DataWindow control,
without preserving the aspect ratio.
5 - Tile The image is tiled to fill the DataWindow. The number of
repetitions will be affected by the values of picture.scale.x,
picture.scale.y, and the picture.clip properties.
338 PowerBuilder
Value Description
6 - Flip X The image is used to fill the DataWindow by tiling and
then it is flipped horizontally as you move from one tile to
the next in a row. The number of repetitions will be
affected by the values of picture.scale.x, picture.scale.y,
and the picture.clip properties.
7 - Flip Y The image is used to fill the DataWindow by tiling and
then it is flipped vertically as you move from one tile to the
next in a column. The number of repetitions will be
affected by the values of picture.scale.x, picture.scale.y,
and the picture.clip properties.
8 - Flip XY The image is used to fill the DataWindow by tiling and
then it is flipped horizontally as you move along the rows
and vertically as you move along the columns. The number
of repetitions will be affected by the values of
picture.scale.x, picture.scale.y, and the picture.clip
properties.
Examples dw_1.Modify("datawindow.brushmode=6")
dw_1.Object.datawindow.picture.File="MyPic.bmp"
Pie.DispAttr.fontproperty
PlotNullData
Description Whether a continuous line is drawn between tics in a line graph when there is
no data on the X and Y axes.
Applies to Graph controls, Graph DataWindow objects
dw_control.Object.graphname.PlotNullData
"graphname.PlotNullData { = ' value ' }"
which you want to get or set the perspective.

value A boolean number indicating whether a continuous line is
drawn between tics in a line graph when there is no data.
Values are:
0 – (False) The line is broken when there is no data.
1 – (True) The line is continuous.
Usage In the painter Set the value in the Properties view, General tab, PlotNullData
check box (available when a line graph type is selected).
setting = dw1.Object.graph_1.PlotNullData
dw1.Object.graph_1.PlotNullData = 1
setting = dw1.Describe("graph_1.PlotNullData")
dw1.Modify("graph_1.PlotNullData=1")
Pointer
Description The image to be used for the mouse pointer when the pointer is over the
specified control. If you specify a pointer for the whole DataWindow,
PowerBuilder uses that pointer except when the pointer is over a control that
also has a Pointer setting.
Applies to DataWindow, Button, Column, Computed Field, Graph, GroupBox, Line,
OLE, Oval, Picture, Rectangle, Report, RoundRectangle, TableBlob, and Text
controls
dw_control.Object.controlname.Pointer
"controlname.Pointer { = ' pointername ' }"
controlname The name of the control in the DataWindow for which you want
to get or set the pointer. Specify DataWindow to specify the
pointer for the whole DataWindow.
pointername (exp) A string specifying a value of the Pointer enumerated
datatype or the name of a cursor file (.CUR) to be used for the
pointer. (See the SetPointer method for a list of Pointer values.)
Pointername can be a quoted DataWindow expression.
340 PowerBuilder
Pointer tab.
Examples setting = dw1.Object.graph_1.Pointer
dw1.Object.graph_1.Pointer = 'Cross!'
setting = dw1.Describe("graph_1.Pointer")
dw1.Modify("graph_1.Pointer = 'Cross!'")
dw1.Modify("graph_1.Pointer = 'c:\pb040\mycurs.cur'")
Print.Preview.property
Description Properties that control the print preview of a DataWindow.
dw_control.Object.DataWindow.Print.Preview.property
"DataWindow.Print.Preview.property { = value }"
SyntaxFromSql:
DataWindow ( Print.Preview.property = value )
property A property for print preview. Properties and their settings are
value The value to be assigned to the property. Value cannot be a
Property for
Print.Preview Value
Buttons Whether buttons display in print preview.
Values are:
Yes – Buttons are displayed.
No – (Default) Buttons are not displayed.
Painter: Display Buttons – Print Preview.

Property for
Print.Preview Value
Outline Whether a blue line displays to show the location of the margins.
Values are:
Yes – (Default) Margin outline is displayed.
No – Margin outline is not displayed.
Painter: Print Preview Shows Outline
Rulers Whether the rulers display when the DataWindow object displays in preview mode.
Values are:
Yes – Display the rulers.
No – (Default) Do not display the rulers.
You can view rulers in Preview mode in the DataWindow painter. With the Preview
view selected, select File>Print Preview, then File>Print Preview Rulers. However,
the setting is not used at runtime. To see rulers at runtime, set Print.Preview.Rulers in
code..
Zoom An integer indicating the zoom factor of the print preview. The default is 100%.
You can view different zoom percentages in Preview mode in the DataWindow
painter. With the Preview view selected, select File>Print Preview, then File>Print
Preview Zoom. However, the setting is not used at runtime. To change the zoom
factor at runtime, set Print.Preview.Zoom in code..
Usage In the painter Select the DataWindow by deselecting all controls; then set
values in the Properties view, Print Specifications tab.
Examples dw1.Object.DataWindow.Print.Preview.Buttons = 'Yes'
("DataWindow.Print.Preview.Buttons")
dw1.Modify("DataWindow.Print.Preview.Buttons = 'Yes'")
dw1.Object.DataWindow.Print.Preview.Rulers = 'Yes'
("DataWindow.Print.Preview.Rulers")
dw1.Modify("DataWindow.Print.Preview.Rulers = 'Yes'")
See also Print.property
Print.property
Description Properties that control the printing of a DataWindow.
342 PowerBuilder

dw_control.Object.DataWindow.Print.property
"DataWindow.Print.property { = value }"
SyntaxFromSql:
DataWindow ( Print.property = value )
property A property for printing. Properties and their settings are listed
in the table below.
value The value to be assigned to the property. Value cannot be a
Property for Print Value

Background Whether the background settings of the DataWindow and controls display on the
printed report.
Values are:
Yes – Display background on report. This feature is not supported when you use a
picture as the DataWindow background.
No – (Default) Do not display background on report.
Painter: Print Shows Background option.
Buttons Whether buttons display on the printed output.
Values are:
Yes – Buttons are displayed.
No – Buttons are not displayed.
Painter: Display Buttons – Print.
CanUseDefault Whether a report can be printed on the default system printer if the printer specified
Printer by the PrinterName property is not valid.
Painter: Can Use Default Printer option.
ClipText Whether the text of a static text field on a printed page is clipped to the dimensions
of the text field when the text field has no visible border setting.
Values are:
Yes – The printed text does not overrun the text field.
No – (Default) The entire text can overrun the text field.
Text is automatically clipped for text fields with visible border settings even if this
property is not set.
Painter: Clip Text option.


Collate Whether printing is collated. Note that collating is usually slower since the print is
repeated to produce collated sets.
Values are:
Yes – (Default) Collate the pages of the print job.
No – Do not collate.
Painter: Collate Copies option.
Color An integer indicating whether the printed output will be color or monochrome.
Values are:
1 – Color
2 – Monochrome
The user can specify the value in the system’s Print dialog box if the printer driver
supports it.
Columns An integer specifying the number of newspaper-style columns the DataWindow will
print on a page. For purposes of page fitting, the whole DataWindow is a single
column. The default is 1.
Painter: Newspaper Columns Across option.
Columns.Width An integer specifying the width of the newspaper-style columns in the units specified
for the DataWindow.
Painter: Newspaper Columns Width option.
Copies An integer indicating the number of copies to be printed.
The user can also specify this value in the system’s Print Setup dialog box if the
printer driver supports it.
If you use both the Print.Copies property and the Print Setup dialog box to indicate
that multiple copies should be printed, the total number of copies printed is the
product of the two values.
CustomPage.Length A long indicating the desired length of a custom paper size for printing. Use this
property in conjunction with Print.CustomPage.Width and with Paper.Size set to 256.
CustomPage.Width A long indicating the desired width of a custom paper size for printing. Use this
property in conjunction with Print.CustomPage.Length and with Paper.Size set to
256.
DocumentName A string containing the name that will display in the print queue when the user sends
the contents of the DataWindow object to the printer.
Painter: Document Name option.
344 PowerBuilder

Duplex An integer indicating duplex or double-sided printing for printers capable of duplex
printing.
Values are:
0 – Default
1 – Normal (nonduplex) printing
2 – Short-edge binding (the long edge of the page is horizontal)
3 – Long-edge binding (the long edge of the page is vertical)
supports it.
Filename A string containing the name of the file to which you want to print the report. An
empty string means send to the printer.
Painter: Cannot be set in painter.
Margin.Bottom An integer indicating the width of the bottom margin on the printed page in the units
specified for the DataWindow.
You can set Margin.Bottom when using SyntaxFromSql to generate DataWindow
syntax.
Painter: Bottom Margin option.
Margin.Left An integer indicating the width of the left margin on the printed page in the units
You can set Margin.Left when using SyntaxFromSql to generate DataWindow
syntax.
Painter: Left Margin option.
Margin.Right An integer indicating the width of the right margin on the printed page in the units
You can set Margin.Right when using SyntaxFromSql to generate DataWindow
syntax.
Painter: Right Margin option.
Margin.Top An integer indicating the width of the top margin on the printed page in the units
You can set Margin.Top when using SyntaxFromSql to generate DataWindow syntax.
Painter: Top Margin option.
Orientation An integer indicating the print orientation. This property has no effect if the computer
has no default printer.
Values are:
0 – The default orientation for your printer
1 – Landscape
2 – Portrait
Painter: Paper Orientation option.


OverridePrintJob Whether you want to override the print job print settings defined in the PrintOpen
method with the print specifications of the DataWindow.
Values are:
Yes – Override the print job print settings.
No – (Default) Do not override the print job print settings.
Painter: Override Print Job option.
Page.Range A string containing the numbers of the pages you want to print, separated by commas.
You can also specify a range with a dash. For example, to print pages 1, 2, and 5
through 10, enter: "1,2, 5-10". The empty string means print all.
supports it.
Page.RangeInclude An integer indicating what pages to print within the desired range.
Values are:
0 – Print all.
1 – Print all even pages.
2 – Print all odd pages.
supports it.
346 PowerBuilder

Paper.Size An integer indicating the size of the paper used for the output:
0 – Default paper size for the printer
1 – Letter 8 1/2 x 11 in
2 – LetterSmall 8 1/2 x 11 in
3 – Tabloid 17 x 11 in
4 – Ledger 17 x 11 in
5 – Legal 8 1/2 x 14 in
6 – Statement 5 1/2 x 8 1/2 in
7 – Executive 7 1/4 x 10 1/2 in
8 – A3 297 x 420 mm
9 – A4 210 x 297 mm
10 – A4 Small 210 x 297 mm
11 – A5 148 x 210 mm
12 – B4 250 x 354 mm
13 – B5 182 x 257 mm
14 – Folio 8 1/2 x 13 in
15 – Quarto 215 x 275 mm
16 – 10x14 in
17 – 11x17 in
18 – Note 8 1/2 x 11 in
19 – Envelope #9 3 7/8 x 8 7/8
20 – Envelope #10 4 1/8 x 9 1/2
21 – Envelope #11 4 1/2 x 10 3/8
22 – Envelope #12 4 x 11 1/276
23 – Envelope #14 5 x 11 1/2
24 – C size sheet
25 – D size sheet
26 – E size sheet
27 – Envelope DL 110 x 220 mm
28 – Envelope C5 162 x 229 mm
33 – Envelope B4 250 x 353 mm
36 – Envelope 110 x 230 mm
37 – Envelope Monarch 3.875 x 7.5 in
38 – 6 3/4 Envelope 3 5/8 x 6 1/2 in
39 – US Std Fanfold 14 7/8 x 11 in
40 – German Std Fanfold 8 1/2 x 12 in
41 – German Legal Fanfold 8 1/2 x 13 in
255, 256 – User-defined paper size (see "Usage" below)
Painter: Paper Size option.


Paper.Source An integer indicating the bin that will be used as the paper source. The integer you
use depends on the tray number used by the printer. (To determine the actual bin
setting, you can query the printer with a utility that makes API calls to the printer
driver.)
Typical values are:
0 – Default
1 – Upper
2 – Lower
3 – Middle
4 – Manual
5 – Envelope
6 – Envelope manual
7 – Auto
8 – Tractor
9 – Smallfmt
10 – Largefmt
11 – Large capacity
14 – Cassette
Painter: Paper Source option.
Preview Whether the DataWindow object is displayed in preview mode.
Values are:
Yes – Display in preview mode.
No – (Default) Do not display in preview mode.
Preview.Background Whether the background settings of the DataWindow and controls display in the print
preview.
Values are:
Yes – Display in preview mode.
No – (Default) Do not display in preview mode.
Painter: Preview Shows Background option.
PrinterName A string containing the name of the printer you want to use to print the DataWindow
report. If the printer name is not specified or if the named printer cannot be found at
runtime, print output can be directed to the default printer for the user’s machine by
setting the CanUseDefaultPrinter property. Otherwise, an error is returned.
Painter: Printer Name option.
348 PowerBuilder

Prompt Whether a Printer Setup dialog displays before a job prints so the user can change the
paper or other settings for the current printer.
Values are:
Yes – (Default) Display a Printer Setup dialog.
No – Do not display a Printer Setup dialog.
Choosing Cancel in the Printer Setup dialog dismisses the Setup dialog; it does not
cancel printing. To allow the user to cancel printing, see the Print method.
For DataStores, this property is ignored; a dialog is never displayed.
Painter: Prompt Before Printing check box.
Quality An integer indicating the quality of the output.
Values are:
0 – Default
1 – High
2 – Medium
3 – Low
4 – Draft
supports it.
Scale An integer specifying the scale of the printed output as a percent.
The scaling percentage is passed to the print driver. If you have problems with
scaling, you might be using a driver that does not support scaling.
supports it.
For more information, see your print driver documentation.
values in the Properties view, Print Specifications tab.
To specify a user-defined paper size, set the Paper.Size property to 255 or 256,
then set the Print.CustomPage.Length and Print.Custom.Page.Width properties
to the desired size. With Paper.Size set to 255, Length and Width are in the
units specified for the DataWindow on the General page in the Properties view.
For example:
// DataWindow Units set to 1/1000 inch
dw1.Modify("DataWindow.Print.Paper.Size=255")
//9.875 inches long
dw1.Modify("DataWindow.Print.CustomPage.Length=9875")
//7.375 inches wide
dw1.Modify("DataWindow.Print.CustomPage.Width=7375")
With Paper.Size set to 256, Length and Width are in millimeters:

dw1.Modify("DataWindow.Print.Paper.Size=256")
//25.4 centimeters long
dw1.Modify("DataWindow.Print.CustomPage.Length=254")
//19.5 centimeters wide
dw1.Modify("DataWindow.Print.CustomPage.Width=195")
Examples strData = dw1.Object.DataWindow.Print.Scale
dw1.Object.DataWindow.Print.Paper.Size = 3
strData = dw1.Describe("DataWindow.Print.Scale")
dw1.Modify("DataWindow.Print.Paper.Size = 3")
dw1.Modify("DataWindow.Print.Margin.Top=500")
dw1.Object.DataWindow.Print.Buttons = 'Yes'
setting = dw1.Describe("DataWindow.Print.Buttons")
dw1.Modify("DataWindow.Print.Buttons = 'Yes'")
See also Print.Preview.property
Printer
Description The name of the printer for printing the DataWindow as specified in the
system’s printer selection dialog box.
dw_control.Object.DataWindow.Printer = "printername"
"DataWindow.Printer" { = printername }"
printername Name of the printer you want to use for your DataWindow
Usage The printer you select for a DataWindow does not affect the PowerBuilder
default printer or the system default printer. To specify a network-connected
printer, you must use a fully specified network printer name:
dw1.Object.DataWindow.Printer = "\\net-print\pr-6"
If you specify a DataWindow printer, but the printer is not found, the
DataWindow engine does not attempt to print to a default device.
350 PowerBuilder
Examples The following example changes the DataWindow printer (but does not affect
the system default printer device):
dw1.Modify ('DataWindow.Printer="My LaserJet 3" ')
You can display the DataWindow printer with either of the following calls:
string ls_dwprinter
ls_dwprinter = dw1.Object.DataWindow.Printer
ls_dwprinter = dw1.Describe("DataWindow.Printer")
Processing
Description The type of processing required to display the data in the selected presentation
style.
dw_control.Object.DataWindow.Processing
Describe argument:
"DataWindow.Processing"
Return values are:
0 – (Default) Form, group, n-up, or tabular
1 – Grid
2 – Label
3 – Graph
4 – Crosstab
5 – Composite
6 – OLE
7 – RichText
8 – TreeView
9 – TreeView with Grid
setting = dw1.Object.DataWindow.Processing
setting = dw1.Describe("DataWindow.Processing")

Protect
Description The protection setting of a column. The Protect property overrides tab order
settings. When a column is protected, the user cannot edit it even if the
column’s tab order is greater than 0.
Applies to A column
dw_control.Object.columnname.Protect
"columnname.Protect { = ' integer ' }"
columnname The name of the column for which you want to get or set the
protection.
integer (exp) A boolean integer specifying whether the column is
protected.
Values are:
0 – False, the column is not protected.
1 – True, the column is protected.
Integer can be a quoted DataWindow expression.
Usage A user cannot change a column value if any one of these conditions is true:
• TabSequence is 0
• Edit.DisplayOnly is Yes when the column has the Edit edit style
• Protect is 1
Only the Protect property allows you to specify a conditional expression that
protects some values in the column but not others.
General tab (using a conditional expression).
setting = dw1.Object.emp_stat.Protect
dw1.Object.emp_stat.Protect=1
setting = dw1.Describe("emp_stat.Protect")
dw1.Modify("emp_stat.Protect=1")
dw1.Modify("emp_stat.Protect='1~tIf(IsRowNew(),0,1)'")
352 PowerBuilder
QueryClear
Description Removes the WHERE clause from a query. Note that the only valid setting is
Yes.
dw_control.Object.DataWindow.QueryClear
Modify argument:
"DataWindow.QueryClear { = value }"
value Remove the WHERE clause from a query.
Yes is the only valid value.
Examples dw1.Object.DataWindow.QueryClear = "yes"

dw1.Modify("DataWindow.QueryClear=yes")
QueryMode
Description Whether the DataWindow is in query mode. In query mode, the user can
specify the desired data by entering WHERE criteria in one or more columns.
DataWindow presentation styles

You cannot use QueryMode with DataWindow objects that use any of the
following presentation styles: N-Up, Label, Crosstab, RichText, and Graph.
dw_control.Object.DataWindow.QueryMode
"DataWindow.QueryMode { = value }"
value Whether the DataWindow is in query mode.
Values are:
Yes – Query mode is enabled.
No – Query mode is disabled.

Usage After the user specifies retrieval criteria in query mode, subsequent calls to
Retrieve can use the new criteria. To retrieve data based on user selection,
change the query mode back to No and use AcceptText to accept the user’s
specification before the next call to Retrieve.
Setting QuerySort to Yes also puts the DataWindow into query mode, changing
the QueryMode property’s value to Yes.
Query mode and secondary DataWindows When you are sharing data,
you cannot turn on query mode for a secondary DataWindow. Trying to set the
QueryMode or QuerySort properties results in an error.
Buffer manipulation and query mode A DataWindow cannot be in query
mode when you call the RowsCopy method.
setting = dw1.Object.DataWindow.QueryMode
dw1.Object.DataWindow.QueryMode = "yes"
setting = dw1.Describe("DataWindow.QueryMode")
dw1.Modify("DataWindow.QueryMode=yes")
QuerySort
Description Whether the result set is sorted when the DataWindow retrieves the data
specified in query mode. When query sort is on, the user specifies sorting
criteria in the first row of the query form.

You cannot use QuerySort with DataWindow objects that use any of the
following presentation styles: N-Up, Label, Crosstab, RichText, and Graph.
dw_control.Object.DataWindow.QuerySort
"DataWindow.QuerySort { = value }"
354 PowerBuilder
value Whether the data retrieved from query mode specifications is
sorted.
Values are:
Yes – Sorting is enabled.
No – Sorting is disabled.
Usage If the DataWindow is not already in query mode, setting QuerySort to Yes also
sets QueryMode to Yes, putting the DataWindow in query mode.
When you set QuerySort to No, the DataWindow remains in query mode until
you also set QueryMode to No.
Query mode and secondary DataWindows When you are sharing data,
you cannot turn on query mode for a secondary DataWindow. Trying to set the
QueryMode or QuerySort properties results in an error.
setting = dw1.Object.DataWindow.QuerySort
dw1.Object.DataWindow.QuerySort = "yes"
setting = dw1.Describe("DataWindow.QuerySort")
dw1.Modify("DataWindow.QuerySort=yes")
RadioButtons.property
RadioButton edit style.
dw_control.Object.columnname.RadioButtons.property
"columnname.RadioButtons.property { = value }"
columnname The name of the column that has the RadioButton edit style.
property A property for the RadioButton column. Properties and their
value The value to be assigned to the property. For RadioButton
properties, value cannot be a DataWindow expression.

Property for
RadioButtons Value
3D or ThreeD Whether the radio buttons are 3D. Values are:
Yes – Make the buttons 3D.
No – Do not make the buttons 3D.
Painter: 3D Look option.
When using dot notation, use the term ThreeD instead of 3D.
Columns An integer constant specifying the number of columns of radio buttons.
Painter: Columns Across option.
LeftText Whether the text labels for the radio buttons are on the left side.
Values are:
Yes – The text is on the left of the radio buttons.
No – The text is on the right of the radio buttons.
Painter: Left Text option.
Scale Whether the circle is scaled to the size of the font. Scale has an effect only when 3D
is No.
Values are:
Yes – Scale the circles.
No – Do not scale the circles.
Painter: Scale Circles option.
tabwhen Style Type is RadioButtons.
Examples setting = dw1.Describe("empg.RadioButtons.LeftText")
dw1.Modify("emp_gender.RadioButtons.LeftText=no")
dw1.Modify("emp_gender.RadioButtons.3D=Yes")
dw1.Modify("emp_gender.RadioButtons.Columns=2")
string setting
setting = &
dw1.Object.emp_gender.RadioButtons.LeftText
dw1.Object.emp_gender.RadioButtons.LeftText = "no"
Range
Description The rows in the DataWindow used in the graph or OLE Object control. Range
can be all rows, the rows on the current page, a group that you have defined for
the DataWindow, or the current row (OLE Object controls only).
356 PowerBuilder
Applies to Graph and OLE Object controls

dw_control.Object.controlname.Range
Describe argument:
"controlname.Range"
controlname The name of the graph control within the DataWindow that will
display the graphed rows or the name of the OLE Object control
that holds an OLE object to which the specified range of rows will
be transferred.
Usage Possible values are:

-2 – The current row (OLE Object controls only)
-1 – The rows on a single page in the DataWindow object
0 – All the rows in the DataWindow object
n – The number of a group level in the DataWindow object
GroupBy and Target also affect the data that is transferred to the OLE object.
tab, Rows option.
Examples string strRange
strRange = dw1.Object.graph_salary.Range
strRange = dw1.Object.ole_report.Range
strRange = dw1.Describe("graph_salary.Range")
strRange = dw1.Describe("ole_report.Range")
ReadOnly
Description Whether the DataWindow is read-only.
dw_control.Object.DataWindow.ReadOnly
"DataWindow.ReadOnly { = value }"

value Whether the DataWindow is read-only.
Values are:
Yes – Make the DataWindow read-only.
No – (Default) Do not make the DataWindow read-only.

setting = dw1.Object.DataWindow.ReadOnly
dw1.Object.DataWindow.ReadOnly="Yes"
setting = dw1.Describe("DataWindow.ReadOnly")
dw1.Modify("DataWindow.ReadOnly=Yes")
Render3D
Description Whether the GraphType is rendered in the DirectX 3D style.
Applies to Graph controls and Graph DataWindows
dw_control.Object.graphname.Render3D
"graphname.Render3D { = ' boolean ' }
graphname The graph control for which you want to get or change the type.
Graph types that can use the new 3D rendering style are:
3 – Bar 3D 15 – Area3D
8 – Col3D 16 – Line3D
17 – Pie3D
boolean 0 = Original 3D style
1 = New 3D rendering style
General tab.
Examples The following statement sets a graph control to the DirectX 3D style.
gr_1.Render3D=true
The following statement sets a DataWindow in the graph presentation style to
the DirectX 3D style.
358 PowerBuilder
dw_1.Object.gr_1.Render3D=true
ReplaceTabWithSpace
Description Whether tab characters embedded in the data for a DataWindow display as
square boxes when the row is not the current row.
dw_control.Object.DataWindow.ReplaceTabWithSpace
"DataWindow.ReplaceTabWithSpace { = value }"
value Whether tab characters embedded in the data for a DataWindow
are replaced with spaces.
Values are:
Yes – Replace each tab character with four spaces.
No – (Default) Do not replace tab characters.
Examples string str

str = dw1.Object.DataWindow.ReplaceTabWithSpace
dw1.Object.DataWindow.ReplaceTabWithSpace="Yes"
str = dw1.Describe("DataWindow.ReplaceTabWithSpace")
dw1.Modify("DataWindow.ReplaceTabWithSpace=Yes")
Report
Description Whether the DataWindow is a read-only report.
Style ( Report = value )

value Whether the DataWindow is a read-only report, similar to a
DataWindow created in the Report painter.
Values are:
Yes – The DataWindow is a read-only report.
No – The DataWindow is not read-only.

'Style(...Report = yes ...)', errstring)
ResetPageCount
Description Specifies that a change in the value of the group column causes the page count
to begin again at 0.
Group (col1 {col2 ...} ... ResetPageCount )
Examples SQLCA.SyntaxFromSQL(sql_syntax, &
"Style(Type=Group) " + &
"Group(#3 NewPage ResetPageCount)", &
errorvar)
Resizeable
Description Whether the user can resize the specified control.
dw_control.Object.controlname.Resizeable
"controlname.Resizeable { = value }"
controlname The control within the DataWindow whose Resizeable setting
you want to get or set.
360 PowerBuilder
value A boolean number indicating whether controlname can be
resized.
Values are:
0 – (False) The control cannot be resized.
1 – (True) The control can be resized.
Position tab.
When you make the control resizable, set the Border property to the resizable
border so the user knows it is resizable.
setting = dw1.Object.graph_1.Resizeable
dw1.Object.graph_1.Resizeable = 1
setting = dw1.Describe("graph_1.Resizeable")
dw1.Modify("graph_1.Resizeable=1")
dw1.Modify("bitmap_1.Resizeable=0")
Retrieve
Description The SQL statement for the DataWindow.
Retrieve is set in DataWindow syntax only for the Create method.
Applies to Table keywords
Syntax Table ( ... Retrieve = selectstatement ... )
Retrieve.AsNeeded
Description Whether rows will be retrieved only as needed from the database. After the
application calls the Retrieve method to get enough rows to fill the visible
portion of the DataWindow, additional rows are “needed” when the user scrolls
down to view rows that have not been viewed yet.
dw_control.Object.DataWindow.Retrieve.AsNeeded

"DataWindow.Retrieve.AsNeeded { = ' value ' }"

value Whether rows will be retrieved only as needed from the
database.
Values are:
• Yes – Rows will be retrieved only as needed.
• No – All rows will be retrieved when the Retrieve method is
called.
Usage In the painter Set the value using Rows>Retrieve Options>Rows As

Needed.
setting = dw1.Object.DataWindow.Retrieve.AsNeeded
dw1.Object.DataWindow.Retrieve.AsNeeded= "Yes"
setting = dw1.Describe("DataWindow.Retrieve.AsNeeded")
dw1.Modify("DataWindow.Retrieve.AsNeeded=Yes")
RichEdit.property
Description Settings that affect the appearance and behavior of columns whose edit style is
RichText.
dw_control.Object.columnname.RichEdit.property
"columnname.RichEdit.property { = value }"
SyntaxFromSql:
Column ( RichEdit.property = value )
columnname The column with the RichText edit style for which you want to
get or set property values. You can specify the column name or
a pound sign (#) and the column number.
property A property for the column’s Edit style. Properties and their
settings are listed in the table below. The table identifies the
properties you can use with SyntaxFromSql.
362 PowerBuilder
Property for RichEdit Value

AutoSelect Whether to select the contents of the column control automatically when it receives
focus.
Values are:
Yes – Select automatically.
Painter: Auto Selection option
DisplayOnly Whether the column is display only.
Values are:
Yes – Do not allow the user to enter data; make the column display only.
No – Allow the user to enter data.
Painter: Display Only option
For conditional control over column editing, use the Protect property.
FocusRectangle Whether a dotted rectangle (the focus rectangle) surrounds the current row of the
Values are:
Yes – Display the focus rectangle.
Painter: Show Focus Rectangle option
NilIsNull Whether to set the value of the column control to null when the user leaves it blank.
Values are:
Painter: Empty String is Null option.
Values are:

Property for RichEdit Value

VScrollBar Whether a vertical scroll bar displays in the column control.
Values are:
Yes – Display vertical scroll bars.
No – Do not display vertical scroll bars.
tab, when Style Type is RichText.
setting = &
dw_1.Object.rte_description.RichEdit.AutoSelect
dw_1.Object.rte_description.RichEdit.VScrollBar="yes"
setting = dw_1.Describe(&
"rte_description.RichEdit.VScrollBar")
dw_1.Modify("rte_description.RichEdit.Required=no")
RichText.property
Description Properties for the DataWindow RichText presentation style.
dw_control.Object.DataWindow.RichText.property
"DataWindow.RichText.property { = value }"
property A property for the DataWindow RichText presentation style.
Properties and appropriate values are listed in the table below.
value A value to be assigned to the property.
Property for RichText Value

BackColor A long specifying the numeric value of the background color of the text editing area.
Values are -2 to 16,777,215.
For more information about color, see RGB.
Painter: Background Color group, General option.
364 PowerBuilder

ControlCharsVisible Specifies whether control characters (carriage returns, spaces, and tabs) are visible.
Values are:
• Yes – Control characters are visible.
• No – Control characters are hidden.
Painter: RichText Presentation group, ControlChars Visible option.
DisplayOnly Specifies whether users can make changes to the contents. Values are:
• Yes – The content, including text and input files, is protected (the user cannot edit
it).
• No – The user can edit the content.
HeaderFooter (Read-only) Specifies whether the RichTextEdit DataWindow has a header/footer
section. This property must be set in the painter and cannot be changed at runtime.
Values are:
• Yes – The control has a header/footer section.
• No – The control does not have a header/footer section.
If a document has a header or footer and the HeaderFooter property is set to no, then
header/footer information in the document is ignored. If the document is then saved
in the same file, the header/footer information is lost.
Painter: Header/Footer option.
InputField BackColor A long specifying the default background color for all input fields: –2 to 16,777,215.
Painter: Background Color group, Input Field option.
InputField NamesVisible Specifies whether input field names are displayed in input fields, rather than the input
field values. Values are:
• Yes – Input fields display.
• No – Input fields do not display.
The value you specify is ignored when the InputFieldsVisible property is set to false.
Painter: RichText Presentation group, Input Field Names Visible option.
InputFields Visible Specifies whether input fields display in the DataWindow object. Values are:
• Yes – Input fields display their names.
• No – Input fields display their data.
Painter: RichText Presentation group, Input Fields Visible option.
PictureFrame (obsolete) (Obsolete) This property is no longer supported since PowerBuilder 12.6.
Specifies whether pictures are displayed as empty frames. Values are:
• Yes – Pictures are displayed as empty frames.
• No – The pictures are displayed.
Painter: Pictures As Frame option.


PopMenu Specifies whether the user has access to a pop-up menu by clicking the right mouse
button on the DataWindow. The menu allows the user to cut and paste, insert a file,
and select formatting options. Values are:
• Yes – Pop-up menu is enabled.
• No – Pop-up menu is disabled.
Painter: PopUp Menu option.
ReadOnly Specifies whether the user can change the data and the text in the DataWindow.
Values are:
• Yes – The DataWindow is read-only (text and data cannot be modified).
• No – The text and the data can be modified.
ReturnsVisible (obsolete) Replaced by RichText.ControlCharsVisible property.
RulerBar Specifies whether a ruler bar is visible above the editing area. If visible, the user can
use it to see measurements while setting tabs and margins on the tab bar (see the
TabBar property in this table). Values are:
• Yes – Ruler bar is visible.
• No – Ruler bar is hidden.
If the RichTextEdit pop-up menu is enabled, the user can use it to turn ruler bar
display on and off (see the PopMenu property in this table).
Painter: RichText Bars group, Ruler option.
SpacesVisible Specifies whether spaces are visible. Values are:
• Yes – Spaces are visible.
• No – Spaces are hidden.
Painter: RichText Presentation group, Spaces Visible option.
TabBar (obsolete) (Obsolete) This property is no longer supported since PowerBuilder 12.6.
Specifies whether a bar for setting tabs is visible above the editing area. Values are:
• Yes – Tab bar is visible.
• No – Tab bar is hidden.
If the pop-up menu is enabled, the user can use it to turn tab bar display on and off
(see the PopMenu property in this table).
Painter: RichText Bars group, Tab option.
TabsVisible Specifies whether tabs are visible. Values are:
• Yes – Spaces are visible.
• No – Spaces are hidden.
Painter: RichText Presentation group, Tabs Visible option.
366 PowerBuilder

ToolBar Specifies whether a tool bar for formatting text is visible above the editing area.
Values are:
• Yes – Tool bar is visible.
• No – Tool bar is not visible.
If the pop-up menu is enabled, the user can use it to turn tool bar display on and off
(see the PopMenu property in this table).
Painter: RichText Bars group, Tool option.
WordWrap Determines whether large blocks of text that do not contain spaces wrap
automatically to the next line when the line reaches the margin. Values are:
• Yes – Automatic word wrap is enabled.
• No – Automatic word wrap is disabled. Users cannot enter characters beyond the
right margin, and must move the cursor to a new line to continue entering text. If
an inserted document conatins a block of text too large to fit on a line, the
nonfitting characters are hidden.
Painter: Word Wrap option
the value in the Properties view, General tab, when the presentation style is
RichText.
setting = &
dw1.Object.DataWindow.RichText.DisplayOnly
dw1.Object.DataWindow.RichText.PopMenu = "yes"
setting = &
dw1.Describe("DataWindow.RichText.DisplayOnly")
dw1.Modify("DataWindow.RichText.PopMenu = 'yes'")
RightToLeft
Description The RightToLeft property is used to set controls to read right-to-left. This
property is for use when you are developing an application for a language that
has right-to-left reading order.
Applies to Column
dw_control.Object.controlname.RightToLeft
“controlname.RightToLeft { = integer }”

right-to-left property.
integer Whether the control is set to right-to-left:
• 0 – (False) The control is not set to right-to-left
• 1 – (True) The control is set to right-to-left
General tab.
Examples dw_1.Object.fname.RightToLeft=1
Rotation
Description The degree of left-to-right rotation for the graph control within the
DataWindow when the graph has a 3D type.
dw_control.Object.graphname.Rotation
"graphname.Rotation = { ' integer ' }"
graphname The name of the Graph control for which you want to get or set
the rotation.
integer (exp) The degree of rotation for the graph. Effective values
range from -90 to 90. Integer can be a quoted DataWindow
expression.
General tab, Rotation scroll bar (enabled when a 3D graph type is selected).
setting = dw1.Object.graph_1.Rotation
dw1.Object.graph_1.Rotation=25
setting = dw1.Describe("graph_1.Rotation")
dw1.Modify("graph_1.Rotation=25")
dw1.Modify("graph_1.Rotation='1~tHour(Now())'")
368 PowerBuilder
Row.Resize
Description Whether the user can use the mouse to change the height of the rows in the
detail area of the DataWindow.
dw_control.Object.DataWindow.Row.Resize
"DataWindow.Row.Resize { = value } "
value Whether the user can resize the rows in the detail area. Values are:
• 1 – Yes, the user can resize the rows.
• 0 – No, the user cannot resize the rows.
the value in the Properties view, General tab, Row Resize option (available
when the presentation style is Grid or Crosstab).
setting = dw1.Object.DataWindow.Row.Resize
dw1.Object.DataWindow.Row.Resize = 0
setting = dw1.Describe("DataWindow.Row.Resize")
dw1.Modify("DataWindow.Row.Resize=0")
Rows_Per_Detail
Description The number of rows in the detail area of an n-up DataWindow object. This
property should be 1 unless the Type property for the Style keyword is Tabular.
dw_control.Object.DataWindow.Rows_Per_Detail
Describe argument:
"DataWindow.Rows_Per_Detail"
SyntaxFromSql:
DataWindow ( ... Rows_Per_Detail = n ... )

n A long specifying the number of rows in each column
Examples SQLCA.SyntaxFromSQL(sqlselect, &

'DataWindow(...Rows_Per_Detail = 12 ...)', &
errstring)
Selected
Description A list of selected controls within the DataWindow.
dw_control.Object.DataWindow.Selected
"DataWindow.Selected = ' list ' "
list A list of the controls you want to select. In the list you designate a
group of controls by specifying a range of row numbers and a range
of controls in the format:
startrow/endrow/startcontrol/endcontrol
To specify more than one group, separate each group with a
semicolon:
startrow1/endrow1/startobj1/endobj1;startrow2/endrow2/starto
bj2/endobj2;...
Do not include spaces in the string. You must use column names, not
column numbers.
Examples setting = dw1.Object.DataWindow.Selected

dw1.Object.DataWindow.Selected = &
"1/10/emp_id/emp_name;12/23/salary/status"
setting = dw1.Describe("DataWindow.Selected")
dw1.Modify("DataWindow.Selected=" &
"'1/10/emp_id/emp_name;12/23/salary/status'")
370 PowerBuilder
Selected.Data
Description A list describing the selected data in the DataWindow. Each column’s data is
separated by a tab and each row is on a separate line.
Applies to DataWindows (Crosstab and Grid presentation styles only)
dw_control.Object.DataWindow.Selected.Data
Describe argument:
"DataWindow.Selected.Data"
setting = dw1.Object.DataWindow.Selected.Data
setting = dw1.Describe("DataWindow.Selected.Data")
Selected.Mouse
Description Whether the user can use the mouse to select columns.
dw_control.Object.DataWindow.Selected.Mouse
"DataWindow.Selected.Mouse { = value }"
value Whether the user can use the mouse to select columns.
Values are:
• Yes – The mouse can be used.
• No – The mouse cannot be used.
the value in the Properties view, General tab, Mouse Selection option
(available when the presentation style is Grid or Crosstab).
setting = dw1.Object.DataWindow.Selected.Mouse
dw1.Object.DataWindow.Selected.Mouse = "Yes"
setting = dw1.Describe("DataWindow.Selected.Mouse")
dw1.Modify("DataWindow.Selected.Mouse = Yes")

Series
ShadeColor
Description The color used for shading the back edge of the series markers when the
graph’s type is 3D. ShadeColor has no effect unless Series.ShadeBackEdge is
1 (Yes). If ShadeBackEdge is 0, the axis plane is the same color as the
background color of the graph.
dw_control.Object.graphname.ShadeColor
"graphname.ShadeColor { = ' long ' }"
graphname The Graph control in the DataWindow for which you want to
shade color.
long (exp) A long number converted to a string specifying the color
of the shading for axes of a 3D graph.
You can use the RGB function in a DataWindow expression or
in PowerScript to calculate the desired color value. However, be
sure to convert the return value of the PowerScript function to
a string.
Long can be a quoted DataWindow expression.
Usage To set the shade color for individual series markers, such as bars or pie slices,
use the method SetDataStyle.
General tab, Shade Color option.
setting = dw1.Object.graph_1.ShadeColor
dw1.Object.graph_1.ShadeColor = 16600000
setting = dw1.Describe("graph_1.ShadeColor")
dw1.Modify("graph_1.ShadeColor=16600000")
dw1.Modify("graph_1.ShadeColor=String(RGB(90,90,90)))
dw1.Modify("graph_1.ShadeColor='0~t" &
372 PowerBuilder
+ If(salary>50000," &
+ String(RGB(100,90,90)) &
+ "," &
+ String(RGB(90,90,100)) &
+ ")'")
ShowBackColorOnXP
Description Whether the background color that you select for a button displays on
Windows XP.
dw_control.Object.DataWindow.ShowBackColorOnXP
"DataWindow.ShowBackColorOnXP{ = value }"
value A boolean value that indicates whether the background color
that you select for a button displays on Windows XP.
Values are:
Yes – Display the background color.
No – Do not display the background color (default).
Usage The Background.Color property is not supported for buttons on Windows XP

by default because the current XP theme controls the appearance of the button.
In the painter Set the Show Backcolor on XP property on the General tab of
the Properties view for the DataWindow object. The background color you
selected will display in Preview mode.
Examples dw1.Modify("DataWindow.ShowBackColorOnXP = yes")
dw1.Object.DataWindow.ShowBackColorOnXP = "yes"
ShowBackground
Description Whether the background settings of the report display.

dw_control.Object.controlname.ShowBackground
"controlname.ShowBackground{ = ' value ' }"
value A boolean value that indicates whether the report’s background
color settings display.
Values are:
Yes – Display the background settings.
No – Do not display the background settings (default).
General tab, Show Background check box.
Examples dw1.Modify("r_orders_nested.ShowBackground = yes")
dw1.Object.DataWindow.ShowBackground = "yes"
ShowDefinition
Description Whether the DataWindow definition will display. The DataWindow will
display the column names instead of data.
dw_control.Object.DataWindow.ShowDefinition
"DataWindow.ShowDefinition { = ' value ' }"
value (exp) Whether the column names will display.
Values are:
• Yes – Display the column names.
• No – Display the data, if any.

setting = dw1.Object.DataWindow.ShowDefinition
dw1.Object.DataWindow.ShowDefinition = "Yes"
setting = dw1.Describe("DataWindow.ShowDefinition")
dw1.Modify("DataWindow.ShowDefinition=Yes")
374 PowerBuilder
SizeToDisplay
Description Whether the graph should be sized automatically to the display area.
dw_control.Object.graphname.SizeToDisplay
"graphname.SizeToDisplay { = ' value ' }"
graphname The graph control in the DataWindow for which you want to get
or set adjustability.
value (exp) A boolean number specifying whether to adjust the size of
the graph to the display.
Values are:
• 0 – False, do not adjust the size of the graph.
• 1 – True, adjust the size of the graph.
General tab, Size To Display option.
setting = dw1.Object.graph_1.SizeToDisplay
dw1.Object.graph_1.SizeToDisplay = 0
setting = dw1.Describe("graph_1.SizeToDisplay")
dw1.Modify("graph_1.SizeToDisplay=0")
SlideLeft
Description Whether the control moves to the left when other controls to the left leave
empty space available. This property is for use with read-only controls and
printed reports. It should not be used with data entry fields or controls.
Applies to Button, Column, Computed Field, Graph, GroupBox, Line, Oval, Picture,
dw_control.Object.controlname.SlideLeft

"controlname.SlideLeft { = ' value ' }"

Slide setting.
value (exp) Whether the control slides left when there is empty space
to its left.
Values are:
• Yes – The control will slide left into available space.
• No – The control will remain in position.
Position tab, Slide Left check box.
setting = dw1.Object.graph_1.SlideLeft
dw1.Object.emp_lname.SlideLeft = "yes"
setting = dw1.Describe("graph_1.SlideLeft")
dw1.Modify("emp_lname.SlideLeft=yes")
SlideUp
Description Whether the control moves up when other controls above it leave empty space
available. This property is for use with read-only controls and printed reports.
It should not be used with data entry fields or controls.
Applies to Button, Column, Computed Field, Graph, GroupBox, Line, Oval, Picture,
dw_control.Object.controlname.SlideUp
"controlname.SlideUp { = ' value ' }"
376 PowerBuilder
Slide setting.
value (exp) How the control slides up when there is empty space
above it.
Values are:
• AllAbove – Slide the control up if all the controls in the row
above it are empty.
• DirectlyAbove – Slide the column or control up if the
controls directly above it are empty.
• No – The control will not slide up.
Position tab, Slide Up check box.
setting = dw1.Object.graph_1.SlideUp
dw1.Object.emp_lname.SlideUp = "no"
setting = dw1.Describe("graph_1.SlideUp")
dw1.Modify("emp_lname.SlideUp=no")
Sort
Description Sort criteria for a newly created DataWindow. To specify sorting for existing
DataWindows, see the SetSort and Sort methods.
Applies to Table keywords in DataWindow syntax
Syntax DataWindow syntax for Create method:
Table ( ... Sort = stringexpression ... )
stringexpression A string whose value represents valid sort criteria. See the
SetSort method for the format for sort criteria. If the criteria
string is null, PowerBuilder prompts for a sort specification
when it displays the DataWindow.
Spacing
Description The gap between categories in a graph.


dw_control.Object.graphname.Spacing
"graphname.Spacing { = ' integer ' }"
graphname The name of the graph control in the DataWindow for which
you want to get or set the spacing.
integer (exp) An integer specifying the gap between categories in the
graph. You specify the value as a percentage of the width of the
data marker. For example, in a bar graph, 100 is the width of one
bar, 50 is half a bar, and so on. Integer can be a DataWindow
expression.
General tab, Spacing option.
setting = dw1.Object.graph_1.Spacing
dw1.Object.graph_1.Spacing = 120
setting = dw1.Describe("graph_1.Spacing")
dw1.Modify("graph_1.Spacing=120")
Sparse
Description The names of repeating columns that will be suppressed in the DataWindow.
dw_control.Object.DataWindow.Sparse
"DataWindow.Sparse { = ' list ' }"
list (exp) A tab-separated list of column names to be suppressed.
List can be a quoted DataWindow expression.
Create method (include at the end of the DataWindow syntax):

Sparse ( names = "col1~tcol2~tcol3 ...")
378 PowerBuilder
Usage In the painter Set the value using Rows>Suppress Repeating Values.
setting = dw1.Object.DataWindow.Sparse
dw1.Object.DataWindow.Sparse = 'col1~tcol2'
setting = dw1.Describe("DataWindow.Sparse")
dw1.Modify("DataWindow.Sparse='col1~tcol2'")
Storage
Description The amount of virtual storage in bytes that has been allocated for the
DataWindow object.
dw_control.Object.DataWindow.Storage
Describe argument:
"DataWindow.Storage"
Usage Canceling a query that uses too much storage You can check this
property in the script for the RetrieveRow event in the DataWindow control
and cancel a query if it is consuming too much storage.
setting = dw1.Object.DataWindow.Storage
setting = dw1.Describe("DataWindow.Storage")
IF Long(setting) > 50000 THEN RETURN 1
StoragePageSize
Description The default page size for DataWindow storage.
dw_control.Object.DataWindow.StoragePageSize
"DataWindow.StoragePageSize { = ' size ' }"

size Two values are provided to enable the DataWindow to use the
available virtual memory most efficiently in the current
environment:
• LARGE (Recommended)
• MEDIUM
Usage Set this property to avoid out of memory errors when performing large retrieve,
import, or RowsCopy operations. The property must be set before the operation
is invoked.
Examples dw1.Modify("datawindow.storagepagesize='LARGE'")
dw1.object.datawindow.storagepagesize='large'
Summary.property
SuppressEventProcessing
Description Whether the ButtonClicked or ButtonClicking event is fired for this particular
button.
dw_control.Object.buttonname.SuppressEventProcessing
"buttonname.SuppressEventProcessing { = ' value ' }"
buttonname The name of the button control for which you want to suppress
event processing.
value Whether event processing is to occur.
Values are:
Yes – The event should not be fired.
No – The event should be fired (default).
General tab.
380 PowerBuilder

dw1.Object.b_name.SuppressEventProcessing = "Yes"
setting =
dw1.Describe("b_name.SuppressEventProcessing")
dw1.Modify("b_name.SuppressEventProcessing ='No'")
Syntax
Description The complete syntax for the DataWindow.
dw_control.Object.DataWindow.Syntax
Describe argument:
"DataWindow.Syntax"
Examples setting = dw1.Object.DataWindow.Syntax
setting = dw1.Describe("DataWindow.Syntax")
Syntax.Data
Description The data in the DataWindow object described in parse format (the format
required by the DataWindow parser).
dw_control.Object.DataWindow.Syntax.Data
Describe argument:
"DataWindow.Syntax.Data"
Usage Use this property with the Syntax property to obtain the description of the
DataWindow object and the data. Using this information, you can create a
syntax file that represents both the structure and data of a DataWindow at an
instant in time. You can then use the syntax file as a DropDownDataWindow
containing redefined data at a single location or to mail this as a text object.

Syntax.Modified
Description Whether the DataWindow syntax has been modified by a function call or user
intervention. Calling the Modify, SetSort, or SetFilter method or changing the
size of the DataWindow grid automatically sets Syntax.Modified to Yes.
dw_control.Object.DataWindow.Syntax.Modified
"DataWindow.Syntax.Modified { = value }"
value Whether the DataWindow syntax has been modified.
Values are:
• Yes – DataWindow syntax has been modified.
• No – DataWindow has not been modified.
Usage Use this property in Modify to set Syntax.Modified to No after you cause a
change in the syntax that does not affect the user (such as setting preview on).
setting = dw1.Object.DataWindow.Syntax.Modified
dw1.Object.DataWindow.Syntax.Modified = "No"
setting = dw1.Describe("DataWindow.Syntax.Modified")
dw1.Modify("DataWindow.Syntax.Modified=No")
Table (for Create)

Description The section of the DataWindow syntax that specifies information about the
DataWindow’s database table, including the name of the update table.
Use Table in DataWindow syntax for the Create method.
Syntax Does not apply.
Usage Use this property to redefine a DataWindow result set. You can add a column,
change the datatype of a column, or make other changes to the table section of
your DataWindow involving properties that are not accessible through Modify
calls or dot notation.
382 PowerBuilder
Caution
When you use this property to redefine the result set, you must redefine the
table section in its entirety.
You can call the GetItem and SetItem methods to access columns added using
this property, but the columns do not display in the DataWindow unless you
call Modify("create column(...)") to add them.
To redefine your table section:
1 Export your DataWindow object to a DOS file.
2 Copy only the table section into your script.
3 Modify the table section to meet your needs.
4 Put the new table definition into a string variable. Change existing double
quotation marks (") in the string to single quotation marks (') and change
the tilde quotation marks to tilde tilde single quotation marks (~~').
5 Call Modify. Modifying the table section of your DataWindow causes the
DataWindow to be reset.
6 (Optionally) Call Modify to add the column to the DataWindow display.
Table (for InkPicture and TableBlobs)

Description The name of the database table that contains the blob(s).
Applies to InkPicture and TableBlob controls
dw_control.Object.controlname.Table
"controlname.Table { = ' tablename ' }"
controlname The name of the control in the DataWindow.
tablename (exp) A string specifying the name of the table that contains the
blob data. Tablename can be a quoted DataWindow expression.

Definition tab, Table option. For InkPicture controls, the table contains a large
binary column to store ink overlay data and a large binary column to hold a
background image for the InkPicture control. For TableBlob controls, the table
contains the large binary database object you want to insert into the
DataWindow.
Examples setting = dw1.Object.inkpic_1.Table
dw1.Object.inkpic_1.Table = "inkpictable"
setting = dw1.Describe("inkpic_1.Table")
dw1.Modify("inkpic_1.Table='inkpictable'")
setting = dw1.Object.blob_1.Table
dw1.Object.blob_1.Table = "emp_pictures"
setting = dw1.Describe("blob_1.Table")
dw1.Modify("blob_1.Table='emp_pictures'")
Table.property
Description Properties for the DataWindow’s DBMS connection.
You can also specify stored procedures for update activities. For information,
see Table.sqlaction.property.
dw_control.Object.DataWindow.Table.property
"DataWindow.Table.property { = value }"
property A property for the DataWindow’s DBMS connection.
Properties and appropriate values are listed in the table below.
Property for Table Value

Arguments (Read only) A string containing retrieval argument names and types for the
DataWindow.
384 PowerBuilder

CrosstabData A string containing a tab-separated list of the expressions used to calculate the values
of columns in a crosstab DataWindow.
Data.Storage A string indicating whether table data is to be kept in memory or offloaded to disk.
Values are:
• Memory (Default) – Table data is to be kept in memory.
• Disk – Table data is to be offloaded to disk.
Painter: Rows>Retrieve Options>Rows to Disk.
Delete.Argument (Internal use only) A string containing arguments to pass to the delete method.
Delete.Method (Internal use only) The name of the method.
Delete.Type (Internal use only) Currently stored procedure is the only type implemented.
Filter (exp) A string containing the filter for the DataWindow. Filters are expressions that
can evaluate to true or false. The Table.Filter property filters the data before it is
retrieved. To filter data already in the DataWindow’s buffers, use the Filter property
or the SetFilter and Filter methods.
The filter string can be a quoted DataWindow expression.
Painter: Rows>Filter.
GridColumns (Read-only) The grid columns of a DataWindow.
Insert.Argument (Internal use only) A string containing arguments to pass to the insert method.
Insert.Method (Internal use only) The name of the method.
Insert.Type (Internal use only) Currently stored procedure is the only type implemented.
Procedure A string that contains the number of the result set returned by the stored procedure to
populate the DataWindow object.
You can use this property only if your DBMS supports stored procedures.
Use this property to change the stored procedure or to change the data source from a
SELECT statement or script to a stored procedure (see the example).
Painter: Set when Stored Procedure is selected as a data source.


Select A string containing the SQL SELECT statement that is the data source for the
DataWindow.
Use this property to specify a new SELECT statement or change the data source from
a stored procedure or Script to a SELECT statement.
Table.Select has several advantages over the SetSqlSelect method:
• It is faster. PowerBuilder does not validate the statement until retrieval.
• You can change data source for the DataWindow. For example, you can change
from a SELECT to a Stored Procedure.
• You can use none or any of the arguments defined for the DataWindow object in
the SELECT. You cannot use arguments that were not previously defined for the
DataWindow object.
•Describe always tries to return a SQL SELECT statement. If the database is not
connected and the property’s value is a PBSELECT statement, Describe will
convert it to a SQL SELECT statement if a SetTransObject method has been
executed.
If you are using describeless retrieval (the StaticBind database parameter is set to 1),
you cannot use the Select property.
Painter: Set when Select or Quick Select is selected as a data source.
Select.Attribute (Read-only) A string containing the PBSELECT statement for the DataWindow.
Sort (exp) A string containing the sort criteria for the DataWindow, for example, “1A,2D”
(column 1 ascending, column 2 descending). The Table.Sort property sorts the data
before it is retrieved. To sort data already in the DataWindow’s buffers, use the
SetSort and Sort methods.
The value for Sort is quoted and can be a DataWindow expression.
Painter: Rows>Sort.
SQLSelect The most recently executed SELECT statement. Setting this has no effect. See Select
in this table.
Update.Argument (Internal use only) A string containing arguments to pass to the update method.
Update.Method (Internal use only) The name of the method.
Update.Type (Internal use only) Currently stored procedure is the only type implemented.
386 PowerBuilder

UpdateKey InPlace Whether the key column can be updated in place or the row has to be deleted and
reinserted. This value determines the syntax PowerBuilder generates when a user
modifies a key field:
• Yes – Use the UPDATE statement when the key is changed so that the key is
updated in place.
• No – Use a DELETE and an INSERT statement when the key is changed.
Caution
When there are multiple rows in a DataWindow object and the user switches keys or
rows, updating in place might fail due to DBMS duplicate restrictions.
Painter: Rows>Update Properties, Key Modification.

UpdateTable A string specifying the name of the database table used to build the Update syntax.
Painter: Rows>Update Properties, Table to Update.
UpdateWhere An integer indicating which columns will be included in the WHERE clause of the
Update statement. The value of UpdateWhere can impact performance or cause lost
data when more than one user accesses the same tables at the same time.
Values are:
• 0 – Key columns only (risk of overwriting another user’s changes, but fast).
• 1 – Key columns and all updatable columns (risk of preventing valid updates; slow
because SELECT statement is longer).
• 2 – Key and modified columns (allows more valid updates than 1 and is faster, but
not as fast as 0).
For more about the effects of this setting, see the discussion of the Specify Update
Characteristics dialog box in the Users Guide.
Painter: Rows>Update Properties, Where Clause for Update/Delete.
Examples setting = dw1.Object.DataWindow.Table.Sort

dw1.Object.DataWindow.Table.Data.Storage = "disk"
dw1.Object.DataWindow.Table.Filter = "salary>50000"
setting = dw1.Describe("DataWindow.Table.Sort")
dw1.Modify("DataWindow.Table.Filter='salary>50000'")
dw_l.Modify (" DataWindow.Table.Procedure= &
'1 Execute MyOwner MyProcName;1 &
@NameOfProcArg=:NameOfDWArg, &
@NameOfProcArg=:NameOfDWArg...' ")
sqlvar = 'SELECT ... WHERE ...'
dw1.Modify("DataWindow.Table.Select='" + sqlvar + "'")

Table.sqlaction.property
Description The way data is updated in the database. When the Update method is executed,
it can send UPDATE, INSERT, and DELETE SQL statements to the DBMS. You
can specify that a stored procedure be used instead of the default SQL
statement for each type of data modification.
dw_control.Object.DataWindow.Table.sqlaction.property
"DataWindow.Table.sqlaction.property { = value }"
sqlaction The SQL statement that would ordinarily be executed as part of
a database update.
Values are:
• UPDATE
• INSERT
• DELETE
property A property for sqlaction. Properties and appropriate values are

Arguments A string specifying the arguments used in the stored procedure. The string takes this
format:
("argname", valuetype { =("valuesrc" {, datasrc, paramtype } )
Argname is the name of the stored procedure parameter.
Valuetype is one of the keywords described below. Datasrc and paramtype apply to
the COLUMN keyword.
Valuesrc is the column, computed field, or expression that produces the value to be
passed to the stored procedure.
Method A string specifying the name of the stored procedure. The stored procedure is used
only if the value of Type is SP.
Type Specifies whether the database update is performed using a stored procedure.
Values are:
• SP – The update is performed using a stored procedure.
• SQL – The update is performed using standard SQL syntax (default).
388 PowerBuilder
Keyword for
valuetype Description
COLUMN The argument value will be taken from the table and column
named in valuesrc. Valuesrc has the form:
"tablename.column"
For COLUMN, you must also specify whether the data is the new
or original column value. Values for datasrc are:
• NEW The new column value that is being sent to the
database.
• ORIG The value that the DataWindow originally read from
the database.
You can also specify the type of stored procedure parameter.
Values for paramtype are:
• IN (Default) An input parameter for the procedure.
• OUT An output parameter for the procedure. The
DataWindow will assign the resulting value to the current row
and column (usually used for identity and timestamp columns).
• INOUT An input and output parameter.
A sample string for providing a column argument is:
("empid", COLUMN=("employee.empid", ORIG,
IN))
COMPUTE The computed field named in valuesrc is the source of the value
passed to the stored procedure.
A sample string for providing a computed field argument is:
("newsalary", COMPUTE=("salary_calc"))
EXPRESSION The expression specified in valuesrc is evaluated and passed to the
stored procedure.
A sample string for providing an expression argument is:
("dept_name",
EXPRESSION=("LookUpDisplay(dept_id)"))
UNUSED No value is passed to the stored procedure.
Usage In the painter Set the values using Rows>Stored Procedure Update. Select
the tab page for the SQL command you want to associate with a stored
procedure.

In code If you enable a DataWindow object to use stored procedures to

update the database when it is not already using stored procedures, you must
change Type to SP first. Setting Type ensures that internal structures are built
before you set Method and Arguments. If you do not change Type to SP, then
setting Method or Arguments will fail.
When the values you specify in code are nested in a longer string, you must use
the appropriate escape characters for quotation marks.
Examples Each is all on one line:
dw_x.Describe("DataWindow.Table.Delete.Method")
dw_x.Describe("DataWindow.Table.Delete.Arguments")
dw_x.Modify("DataWindow.Table.Delete.Type=SP")
dw_x.Modify("DataWindow.Table.Delete.Arguments=
((~"id~", COLUMN=(~"department.dept_id!~", ORIG)))")
dw_x.Modify("DataWindow.Table.Delete.Method=
~"spname~"")
TabSequence
Description The number assigned to the specified control in the DataWindow’s tab order.
Applies to Button, Column, Computed Field, Graph, OLE Object, OLE Database Blob,
Picture, and Text controls
dw_control.Object.columnname.TabSequence
"columnname.TabSequence { = number }"
columnname The name of the column whose tab order you want to get or set.
number A number from 0 to 32000 specifying the position of the
column in the tab order. A value of 0 takes the column out of the
tab order and makes it read-only.
Usage In the painter Set the value using Format>Tab Order.

setting = dw1.Object.emp_name.TabSequence
dw1.Object.emp_name.TabSequence = 10
390 PowerBuilder
setting = dw1.Describe("emp_name.TabSequence")
dw1.Modify("emp_name.TabSequence = 10")
Tag
Description The tag value of the specified control. The tag value can be any text you see fit
to use in your application.
Applies to Button, Column, Computed Field, Graph, GroupBox, Oval, Picture, Rectangle,
Report, RoundRectangle, TableBlob, and Text controls
dw_control.Object.controlname.Tag
"controlname.Tag { = ' string ' }"
controlname The name of a control in the DataWindow.
string (exp) A string specifying the tag for controlname. String is quoted
and can be a DataWindow expression.
General tab, Tag option.
Examples setting = dw1.Object.blob_1.Tag
dw1.Object.graph_1.Tag = 'Graph of results'
setting = dw1.Describe("blob_1.Tag")
dw1.Modify("graph_1.Tag = 'Graph of results'")
Target
Description The columns and expressions whose data is transferred from the DataWindow
to the OLE object.
dw_control.Object.oleobjectname.Target
"oleobjectname.Target { = ' columnlist ' }"

oleobjectname The name of the OLE Object control for which you want to get or
set the data to be transferred.
columnlist (exp) A list of the columns or expressions whose data is
transferred to the OLE object. If there is more than one, separate
them with commas. Columnlist can be a quoted DataWindow
expression.
Usage GroupBy and Range also affect the data that is transferred to the OLE object.
tab, Target Data option.
Examples setting = dw1.Object.ole_1.Target
dw1.Object.ole_1.Target = 'lname, Len(companyname)'
setting = dw1.Describe("ole_1.Target")
dw1.Modify("ole_1.Target = 'lname, Len(companyname)'")
Template
Description The name of a file that will be used to start the application in OLE.
dw_control.Object.tblobname.Template
"tblobname.Template { = ' string ' }"
tblobname The name of a TableBlob control in the DataWindow.
string (exp) A string whose value is the file name of an application that
is to be the OLE template. String is quoted and can be a
Definition tab, File Template option.
Examples setting = dw1.Object.blob_1.Template
dw1.Object.blob_1.Template='Excel.xls'
setting = dw1.Describe("blob_1.Template")
dw1.Modify("blob_1.Template='Excel.xls'")
392 PowerBuilder
Text
Description The text of the specified control.
Applies to Button, GroupBox, and Text controls
dw_control.Object.textname.Text
"textname.Text { = ' string ' }"
textname The name of a control in the DataWindow.
string (exp) A string specifying the text for textname. To specify an
accelerator key in the text, include an ampersand before the
desired letter. The letter will display underlined. String is
quoted and can be a DataWindow expression.
General tab, Text option.
Examples setting = dw1.Object.text_1.Text
dw1.Object.text_1.Text = "Employee &Name"
setting = dw1.Describe("text_1.Text")
dw1.Modify("text_1.Text='Employee &Name'")
Timer_Interval
Description The number of milliseconds between the internal timer events. When you use
time in a DataWindow, an internal timer event is triggered at the interval
specified by Timer_Interval. This determines how often time fields are
updated.
dw_control.Object.DataWindow.Timer_Interval
"DataWindow.Timer_Interval { = number }"
SyntaxFromSql:
DataWindow ( Timer_Interval = number )

number An integer specifying the interval between timer events in
milliseconds. The default is 60,000 milliseconds or one minute.
The maximum value is 65,535 milliseconds.
Usage When a computed field uses Now as its expression value, it refreshes the
displayed value every time the timer interval period elapses.
In the painter Select the DataWindow by deselecting all controls; then set
the value in the Properties view, General tab, Timer Interval option.
setting = dw1.Object.DataWindow.Timer_Interval
dw1.Object.DataWindow.Timer_Interval = 10000
setting = dw1.Describe("DataWindow.Timer_Interval")
dw1.Modify("DataWindow.Timer_Interval=10000")
Title
Description The title of the graph.
dw_control.Object.graphname.Title
"graphname.Title { = ' titlestring ' }"
graphname In the DataWindow object, the name of the Graph control for
which you want to get or set the title
titlestring A string specifying the graph’s title
General tab, Title option.
The default expression for the Title.DispAttr.DisplayExpression property is
"title", which refers to the value of the Title property. The display expression
can combine the fixed text of the Title property with other text, functions, and
operators. If the expression for Title.DispAttr.DisplayExpression does not
include the Title property, then the value of the Title property will be ignored.
For an example, see DispAttr.fontproperty.
394 PowerBuilder
Examples setting = dw1.Object.gr_1.Title

dw1.Object.gr_1.Title = 'Sales Graph'
setting = dw1.Describe("gr_1.Title")
dw1.Modify("gr_1.Title = 'Sales Graph'")
Title.DispAttr.fontproperty
Tooltip.property
Description Settings for tooltips for a column or control.
Applies to Button, Column, Computed Field, Graph, GroupBox, InkPicture, Line, OLE,
Blob OLE, Oval, Picture, Rectangle, Report, RoundRectangle, and Text
controls
dw_control.Object.controlname.Tooltip.property
"controlname.Tooltip.property { = ' value ' }"
SyntaxFromSql:
Column ( Tooltip.property = value )
Text ( Tooltip.property = value )
controlname The control whose Tooltip properties you want to get or set.
Tooltip settings apply to all columns or all text controls.
property A property that applies to the tooltip of a control, as listed in the
Property table below.
value Values for the properties are shown below. Value can be a quoted
Property for Tooltip Value

Backcolor (exp) A long specifying the color (the red, green, and blue values) to be used for the
background color of the tooltip box.

Property for Tooltip Value

Delay.initial (exp) An integer specifying the time in milliseconds before the tooltip box displays
(minimum zero, maximum 32767). Default value is 0.
Delay.visible (exp) An integer specifying the time in milliseconds that the tootip box remains
visible (minimum zero, maximum 32767). Default value is 32000.
Enabled (exp) Whether the tooltip is enabled. Values are:
Yes – The tooltip is enabled.
No – (Default) The tooltip is disabled.
HasCloseButton Reserved for future use only
Icon (exp) A string for the icon to display to the left of the title in the tooltip box. The
default is for no icon to display. Three stock icons are available for display in the
tooltip box: Info, Warning, and Error.
0 – None
1 – Info
2 – Warning
3 – Error
Isbubble (exp) Whether the tooltip box displays as a basic rectangle or a callout bubble.
Values are:
0 – Displays the standard tooltip shape.
1 – Displays the tooltip as a rounded callout bubble.
MaxWidth Reserved for future use only
Position Reserved for future use only
Tip (exp) A string specifying the text for the tooltip. If you use an expression, make sure
the result is converted to a string.
Title (exp) A string specifying the tooltip box title. If you use an expression, make sure the
result is converted to a string.
Textcolor (exp) A long expression specifying the color (the red, green, and blue values) to be
used as the control’s tooltip color.
Usage In the painter Select the control and set the value on the Tooltip tab of the
Properties view.
Not available for columns or controls in RichText, Graph, or OLE
DataWindow objects. If you want to add a tooltip to an InkPicture in a
DataWindow, that InkPicture must not be enabled.
Examples dw_1.Object.oval_1.Tooltip.Color = RGB(255, 0, 128)
ls_data = dw_1.Describe("oval_1.Tooltip.Color")
dw_1.Modify("emp_name.Tooltip.Color='11665407'")
"Style(...) Column(Tooltip.Delay.Visible=15 ...) &
...", ls_Errors)
396 PowerBuilder
"Style(...) Column(Tooltip.TextColor=11665407 ...)"&
, ls_Errors)
Trail_Footer
Description Whether the footer of a nested report is displayed at the end of the report or at
the bottom of the page. Trail_Footer applies only to reports in a composite
DataWindow. Setting Trail_Footer to No forces controls following the report
onto a new page.
dw_control.Object.reportname.Trail_Footer
"reportname.Trail_Footer { = value }"
reportname The name of the report control for which you want to get or set
Trail_Footer.
value Whether the report’s footer trails the last line of the report or
appears at the bottom of the page.
Values are:
Yes – The footer appears right after the last line of data in the
report.
No – The footer appears at the bottom of the page, forcing
any data following the report onto the following page.

setting = dw1.Object.rpt_1.Trail_Footer
dw1.Object.rpt_1.Trail_Footer = "Yes"
setting = dw1.Describe("rpt_1.Trail_Footer")
dw1.Modify("rpt_1.Trail_Footer = Yes")
Trailer.#.property

Transparency (columns and controls)

Description Settings for the transparency of the text in a control.
Applies to Button, Column, Computed Field, GroupBox, and Text controls
dw_control.Object.controlname.Transparency
"controlname.Transparency { = ' value ' }"
controlname The name of the column or control in the DataWindow for
which you want to specify the percentage transparency for the
text of the column or control.
value (exp) An integer in the range 0 to 100, where 0 means that the
text background is opaque and 100 that it is completely
transparent.
Usage In the painter Select the control and set the value in the Font tab of the
Properties view.
Using Transparency with fonts

The Transparency property works with fonts, but only on screen. Text with
transparent properties appears blurry in PDF files. The transparent text does
not display in print unless you use True Type fonts.
In Windows Vista, ClearType anti-aliasing conflicts with the transparency
settings and causes the fonts to appear blurred. Turn off ClearType to avoid this
problem; font transparency will work, but the fonts will not be smoothed. You
can also avoid using ClearType fonts.
Examples setting = dw_1.Object.cb_1.Transparency

dw_1.Object.cb_1.Transparency = 50
Transparency (picture controls in DataWindows)

Description Settings for the transparency of a picture control. This feature is not supported
in the RichText and OLE processing styles.
Applies to Picture controls
398 PowerBuilder
dw_control.Object.controlname.Transparency
"controlname.Transparency { = ' value ' }"
controlname The name of the picture control in the DataWindow for which
you want to specify the percentage transparency.
value (exp) An integer in the range 0 to 100, where 0 means that the
picture is opaque and 100 that it is completely transparent.
Usage In the painter Select the control and set the value in the General tab of the
Properties view.
Examples dw_1.Object.p_1.Transparency = 50
Transparency (DataWindow objects)

Description Setting that controls the transparency of the background/primary gradient
color.
dw_control.transparency
"DataWindow (transparency = { integer } )"
integer An integer in the range 0 to 100, where 0 means that the primary
color (background) is opaque and 100 that it is completely
transparent.
See also Brushmode
Color

Tree.property
Description Settings for a TreeView DataWindow.
Applies to TreeView DataWindows
dw_control.Object.DataWindow.Tree.property
"DataWindow.Tree.property { = value } “
property A property that controls the appearance or behavior of the
TreeView DataWindow. Properties and their settings are listed
in the table below.
value (exp) A string value for the file name of the tree node icon in the
detail band.
Property for Tree Value

DefaultExpandToLevel A long value that is the default level of expansion for the TreeView DataWindow.
For example, if the default level is 2, only data with a level less than or equal to
2 is expanded by default.The value must represent a valid level.
Painter: Expand To Level By Default drop-down list on the General page in the
Properties view. The list displays the levels that have been created for the
DataWindow.
Indent A long value in the units specified for the DataWindow that defines the position
of the state icon. The state icon is a plus (+) or minus (-) sign that indicates
whether the tree node is in a collapsed or expanded state. The icon’s indent
indicates the level of the node in the tree. The X position of the state icon is the
X position of its parent plus value.
Painter: Select or enter a value in the Indent Value box on the General page.
SelectNodeByMouse A boolean value that indicates whether you can select a tree node by clicking the
node with the mouse.
Values are:
Yes – You can select a tree node with a mouse-click (default).
No – You cannot select a tree node with a mouse-click.
Painter: Node By Mouse check box.
400 PowerBuilder
Property for Tree Value

ShowConnectLines A boolean value that indicates whether lines connecting parents and children
display in the DataWindow object. If you want to show lines connecting rows in
the detail band to their parent, you must also set ShowLeafNodeConnectLines.
Values are:
Yes – Display connecting lines (default).
No – Do not display connecting lines.
Painter: Show Lines check box.
ShowLeafNodeConnectLines A boolean value that indicates whether lines connecting rows in the detail band
to their parent display in the DataWindow object. This property is disabled if
Show Lines box is not set.
Values are:
Yes – Display connecting lines (default).
No – Do not display connecting lines.
Painter: Connect Leaf Nodes check box.
ShowTreeNodeIcon A boolean value that indicates whether tree node icons for level and detail bands
display. If this property is not set, the Expanded and Collapsed Tree Node Icon
File properties on the General properties page for each TreeView level are
disabled.
Values are:
No – Do not display tree node icons (default).
Yes – Display tree node icons.
Painter: Use Tree Node Icon check box.
StateIconAlignMode A long value that indicates how the state icon is aligned vertically with respect to
the TreeView level band.
Values are:
0 – Middle (default).
1 – Top.
2 – Bottom.
Painter: State Icon Align Mode drop-down list.
General tab.
Examples The following code sets and gets the long value that determines how many
levels of the TreeView are expanded by default:
long ll_expandlevel
dw1.Object.datawindow.tree.DefaultExpandToLevel = 1
ll_expandlevel = &
dw1.Object.DataWindow.Tree.DefaultExpandToLevel
The following code gets and sets the Indent value:

indentVal = dw1.Object.DataWindow.Tree.indent
dw1.Object.DataWindow.Tree.indent = 80
The following examples manipulate the SelectNodeByMouse property:
if cbx_selectnodebymouse.checked then
ls_selectnodebymouse='yes'
else
ls_selectnodebymouse='no'
end if
ls_ret=dw1.modify("datawindow.tree.selectnodebymouse='
"+ls_selectnodebymouse+"'")
if len(ls_ret)>0 then Messagebox("",ls_ret)

end if
ls_selectnodebymouse=dw1.Describe("datawindow.tree.
selectnodebymouse")
if lower(ls_selectnodebymouse)='no' then
cbx_selectnodebymouse.checked=false
else
cbx_selectnodebymouse.checked=true
end if
dw1.modify("datawindow.tree.selectnodebymouse='yes'")
dw1.Describe("datawindow.tree.selectnodebymouse")
The following examples manipulate the show connecting lines properties:
boolean lb_ShowLines, lb_ShowLeafLines
lb_ShowLines = &
dw1.Object.DataWindow.Tree.ShowConnectLines
dw1.Object.DataWindow.Tree.ShowConnectLines='yes'
lb_ShowLeafLines = dw1.Object.DataWindow.Tree.
ShowLeafNodeConnectLines
dw1.Object.DataWindow.Tree.ShowLeafNodeConnectLines =&
'yes'
The following example gets the current value of the StateIconAlignMode
property and sets it to be aligned at the top:
ls_StateIconAlignMode =
dw1.Object.DataWindow.Tree.StateIconAlignMode
//Align Top
dw1.Object.DataWindow.Tree.StateIconAlignMode = 1
402 PowerBuilder
Tree.Leaf.TreeNodeIconName
Description The file name of the tree node icon in the detail band.
dw_control.Object.DataWindow.Tree.Leaf.TreeNodeIconName
"DataWindow.Tree.Leaf.TreeNodeIconName { = value } “
value (exp) A string value for the file name of the tree node icon in the
detail band.
Usage In the painter Select the detail band by clicking the gray divider for the band.
Specify a file name and location in the Tree Node Icon File box on the General
tab in the Properties view. This property is disabled if Use Tree Node Icon is
not set on the General tab in the Properties view for the DataWindow.
Examples ls_LeafIcon = &
dw1.Object.DataWindow.Tree.Leaf.TreeNodeIconName
dw1.Object.DataWindow.Tree.Leaf.TreeNodeIconName = &
"c:\pictures\treenode.bmp"
Tree.Level.#.property
Description The file name of the icon for a TreeView node in a TreeView level band when
the icon is in either the expanded or collapsed state. You set the icon file name
separately for each TreeView level band.
Syntax Describe and Modify argument:
"DataWindow.Tree.Level.#.property { = value } “
# The number of the level for which you want to specify an icon.
The level number must exist.

property A property that indicates whether the icon specified is for the
expanded or collapsed state. Values are:
• CollapsedTreeNodeIconName
• ExpandedTreeNodeIconName
value (exp) A string value that is the file name of the tree node icon in
the selected TreeView level band.
Usage In the painter Select the level by clicking the gray divider for the band.
Specify a file name and location in the Collapsed Tree Node Icon File and
Expanded Tree Node Icon File boxes on the General tab in the Properties view
for the band. These properties are disabled if Use Tree Node Icon is not
selected on the General tab in the Properties view for the DataWindow.
You cannot get or set these properties using dot notation.
Examples The following example gets the name of the icon used when a level 1 node is
collapsed:
string ls_ico
ls_ico = dw_tview.Describe &
("DataWindow.Tree.Level.1.CollapsedTreeNodeIconName")
Type
Description The type of the control (for Describe) or the type of presentation style (for
SyntaxFromSql).
dw_control.Object.controlname.Type
Describe argument:
"controlname.Type"
404 PowerBuilder
controlname The name of the control for which you want the type. Valid
values are:
datawindow
bitmap (for Picture)
button
column
compute (for Computed Field)
graph
groupbox
line
ole
ellipse (for Oval)
rectangle
report
roundrectangle
tableblob
text
SyntaxFromSql:
Style ( Type = value )
value A keyword specifying the presentation style for the
DataWindow object. Keywords are:
(Default) Tabular
Grid
Form (for the Freeform style)
Crosstab
Graph
Group
Label
Nested
Ole
RichText

setting = dw1.Object.emp_name.Type
setting = dw1.Describe("emp_name.Type")
SQLCA.SyntaxFromSQL(sqlstring, &
'Style(... Type=grid ...)', errstring)

Units
Description The unit of measure used to specify measurements in the DataWindow object.
You set this in the DataWindow Style dialog box when you define the
DataWindow object.
dw_control.Object.DataWindow.Units
Describe argument:
"DataWindow.Units"
SyntaxFromSql:
DataWindow ( Units = value )
value The type of units for measurements in the DataWindow.
Values are:
0 – PowerBuilder units
1 – Display pixels
2 – 1/1000 of a logical inch
3 – 1/1000 of a logical centimeter
Usage PowerBuilder units and display pixels are adjusted for printing.
In the painter Select the DataWindow by deselecting all controls; then set
the value in the Properties view, General tab, Units option.
setting = dw1.Object.DataWindow.Units
setting = dw1.Describe("DataWindow.Units")
Update
Description Whether the specified column is updatable. Each updatable column is included
in the SQL statement that the Update method sends to the database. All
updatable columns should be in the same database table.
dw_control.Object.columnname.Update
406 PowerBuilder
"columnname.Update { = value }"

columnname The column for which you want to get or set the updatable
status
value Whether the column is updatable.
Values are:
Yes – Include the column in the SQL statement for updating
the database.
No – Do not include the column in the SQL statement.
Usage In the painter Set the value using Rows>Update Properties, Updateable
Columns option.
setting = dw1.Object.emp_name.Update
dw1.Object.emp_name.Update = "No"
setting = dw1.Describe("emp_name.Update")
dw1.Modify("emp_name.Update=No")
Validation
Description The validation expression for the specified column. Validation expressions are
expressions that evaluate to true or false. They provide checking of data that the
user enters in the DataWindow.
To set the validation expression, you can also use the SetValidate method. To
check the current validation expression, use the GetValidate method.
dw_control.Object.columnname.Validation
"columnname.Validation { = ' validationstring ’ }"
columnname The column for which you want to get or set the validation rule..
validationstring (exp) A string containing the rule that will be used to validate
data entered in the column. Validation rules are expressions that
evaluate to true or false. Validationstring is quoted and can be
a DataWindow expression.

Usage In the painter Set the value using the Column Specifications view,
Validation Expression option.
Use operators, functions, and columns to build an expression. Use Verify to test
it.
setting = dw1.Object.emp_status.Validation
setting = dw1.Describe("emp_status.Validation")
ValidationMsg
Description The message that PowerBuilder displays instead of the default message when
an ItemError event occurs in the column.
dw_control.Object.columnname.ValidationMsg
"columnname.ValidationMsg { = ' string ' }"
columnname The column for which you want to get or set the error message
displayed when validation fails.
string (exp) A string specifying the error message you want to set.
String is quoted and can be a DataWindow expression.
Usage In the painter Set the value using the Column Specifications view,
Validation Message option.
setting = dw1.Object.emp_salary.ValidationMsg
dw1.Object.emp_salary.ValidationMsg = &
"Salary must be between 10,000 and 100,000"
setting = dw1.Describe("emp_salary.ValidationMsg")
dw1.Modify("emp_salary.ValidationMsg = " &
"'Salary must be between 10,000 and 100,000'")
408 PowerBuilder
Values (for columns)

Description The values in the code table for the column.
dw_control.Object.columnname.Values
"columnname.Values { = ' string ' }"
columnname The column for which you want to specify the contents of the
code table.
string (exp) A string containing the code table values for the column.
In the string, separate the display values and the actual values
with a tab character, and separate multiple pairs of values with
a slash using this format:
"displayval~tactualval/displayval~tactualval/ ..."
For example:
"red~t1/white~t2"
String is quoted and can be a DataWindow expression.
tab.
When Style Type is DropDownListBox, fill in the Display Value and Data
Value columns for the code table.
When Style is Edit or EditMask, select the Use Code Table or Code Table
check box and fill in the Display Value and Data Value columns for the code
table.
Examples setting = dw1.Object.emp_status.Values
dw1.Object.emp_status.Values = &
"Active~tA/Part Time~tP/Terminated~tT"
setting = dw1.Describe("emp_status.Values")
dw1.Modify("emp_status.Values =
'Active~tA/Part Time~tP/Terminated~tT'")
Values (for graphs)


Vertical_Size
Description The height of the columns in the detail area of the DataWindow object.
Vertical_Size is meaningful only when Type is Form (meaning the Freeform
style). When a column reaches the specified height, PowerBuilder starts a new
column to the right of the current column. The space between columns is
specified in the Vertical_Spread property.
Style ( Vertical_Size = value )
value An integer specifying the height of the columns in the detail
area of the DataWindow object area in the units specified for the
DataWindow

'Style(... Vertical_Size=1225...)', errstring)
Vertical_Spread
Description The vertical space between columns in the detail area of the DataWindow
object. Vertical_Spread is meaningful only when Type is Form (meaning the
Freeform style). The Vertical_Size property determines when to start a new
column.
Style ( Vertical_Spread = value )
value An integer specifying the vertical space between columns in the
detail area of the DataWindow object area in the units specified
for the DataWindow

'Style(... Vertical_Spread=25...)', errstring)
410 PowerBuilder
VerticalScrollMaximum
Description The maximum height of the scroll box of the DataWindow’s vertical scroll bar.
This value is set by PowerBuilder based on the content of the DataWindow.
Use VerticalScrollMaximum with VerticalScrollPosition to synchronize
vertical scrolling in multiple DataWindow objects. The value is a long.
dw_control.Object.DataWindow.VerticalScrollMaximum
Describe argument:
"DataWindow.VerticalScrollMaximum"
setting = dw1.Object.DataWindow.VerticalScrollMaximum
setting =
dw1.Describe("DataWindow.VerticalScrollMaximum")
VerticalScrollPosition
Description The position of the scroll box in the vertical scroll bar. Use
VerticalScrollMaximum with VerticalScrollPosition to synchronize vertical
scrolling in multiple DataWindow objects.
dw_control.Object.DataWindow.VerticalScrollPosition
"DataWindow.VerticalScrollPosition { = scrollvalue }"
scrollvalue A long specifying the position of the scroll box in the
vertical scroll bar of the DataWindow
Examples string spos1

spos1 = dw1.Object.DataWindow.VerticalScrollPosition
string spos1, smax, sscroll, modstring
spos1 = &
dw1.Describe("DataWindow.VerticalScrollPosition")
smax = &
dw1.Describe("DataWindow.VerticalScrollMaximum")

sscroll = String(Long(smax)/2)
modstring = "DataWindow.VerticalScrollPosition=" + &
sscroll
dw1.Modify(modstring)
Visible
Description Whether the specified control in the DataWindow is visible.
dw_control.Object.controlname.Visible
"controlname.Visible { = ' value ' }"
Visible property.
value (exp) Whether the specified control is visible.
Values are:
0 – False; the control is not visible.
1 – True; the control is visible.
General tab. The Visible property is not supported for column controls in
DataWindow objects with the Label presentation style.
setting = dw1.Object.emp_status.Visible
dw1.Object.emp_status.Visible = 0
dw1.Object.emp_stat.Visible="0~tIf(emp_class=1,0,1)"
setting = dw1.Describe("emp_status.Visible")
dw1.Modify("emp_status.Visible=0")
dw1.Modify("emp_stat.Visible='0~tIf(emp_cls=1,0,1)'")
412 PowerBuilder
VTextAlign
Description The way text in a button is vertically aligned.
dw_control.Object.buttonname.VTextAlign
"buttonname.VTextAlign { = ' value ' }"
buttonname The name of the button for which you want to align text.
value An integer indicating how the button text is horizontally
aligned.
Values are:
0 – Center
1 – Top
2 – Bottom
3 – Multiline
General tab, Vertical Alignment option.
dw1.Object.b_name.VTextAlign = "0"
setting = dw1.Describe("b_name.VTextAlign")
dw1.Modify("b_name.VTextAlign ='0'")
Width
Description The width of the specified control.
dw_control.Object.controlname.Width
"controlname.Width { = ' value ' }"

width.
value (exp) The width of the controlname in the units specified for the
DataWindow. Value can be a quoted DataWindow expression.
Position tab.
setting = dw1.Object.emp_name.Width
dw1.Object.emp_name.Width = 250
setting = dw1.Describe("emp_name.Width")
dw1.Modify("emp_name.Width=250")
Width.Autosize
Description (RichText presentation style only) Whether the column or computed field input
field adjusts its width according to the data it contains.
The Width.Autosize and Multiline properties can be set together so that the
input field can display multiple lines.
dw_control.Object.controlname.Width.Autosize
"controlname.Width.Autosize { = ' value ' }"
controlname The name of the column or computed field for which you want
to get or set the Autosize setting.
value (exp) Whether the width of the input field adjusts according to
the data it contains. Values are:
• Yes – The width adjusts according to the data.
• No – The width is fixed and is set to the value of the Width
property.
414 PowerBuilder
Usage In the painter Select an input field so that it is flashing, then right-click and
select Properties from the pop-up menu. Set the value on the property sheet,
Input Field tab, Fixed Size option.
setting = dw1.Object.emp_name.Width.Autosize
dw1.Object.emp_name.Width.Autosize = "yes"
setting = dw1.Describe("emp_name.Width.Autosize")
dw1.Modify("emp_name.Width.Autosize=yes")
Width.Autosize
Description (Grid presentation style only) Whether a column adjusts its width according to
the data it contains.
Applies to Column controls in the Grid presentation style
dw_control.Object.controlname.Width.Autosize
"controlname.Width.Autosize { = ' value ' }"
controlname The name of the column for which you want to get or set the
Autosize setting.
value How the width of the column adjusts according to the data it
contains. Values are:
• 0 – None
• 1 – Widest shown
• 2 – Widest on page
• 3 – Widest retrieved from database
Usage In the painter Select a column control, then set the value in the Properties
view, Position tab, Autosize Width option.
X
Description The distance of the specified control from the left edge of the DataWindow
object.

dw_control.Object.controlname.X
"controlname.X { = ' value ' }"
controlname The name of the control for which you want to get or set the x
coordinate.
value (exp) An integer specifying the x coordinate of the control in the unit
of measure specified for the DataWindow object. Value can be a
Position tab.
setting = dw1.Object.emp_name.X
dw1.Object.emp_name.X = 10
setting = dw1.Describe("emp_name.X")
dw1.Modify("emp_name.X=10")
X1, X2
Description The distance of each end of the specified line from the left edge of the line’s
band.
Applies to Line controls
dw_control.Object.controlname.X1
dw_control.Object.controlname.X2
"controlname.X1 { = ' value ' }"
"controlname.X2 { = ' value ' }"
controlname The name of the line for which you want to get or set one of the x
coordinates.
416 PowerBuilder
value (exp) An integer specifying the x coordinate of the line in the unit of
measure specified for the DataWindow object. Value can be a
Position tab.
setting = dw1.Object.line_1.X1
dw1.Object.line_1.X1 = 10
dw1.Object.line_1.X2 = 1000
setting = dw1.Describe("line_1.X1")
dw1.Modify("line_1.X1=10")
dw1.Modify("line_1.X2=1000")
XHTMLGen.Browser
Description A string that identifies the browser in which XHTML generated within an
XSLT style sheet is displayed.
Obsolete property
XHTMLGen.browser is obsolete and should not be used, because the Web

dw_control.Object.DataWindow.XHTMLGen.Browser
"DataWindow.XHTMLGen.Browser { = ' value ' }"
value (exp) A string identifying the browser in which you want
to display the generated XHTML. The value should match
the browser identifier part of the text string that the
browser specifies in the HTTP header it sends to the server.
This property is usually set dynamically on the server
according to the HTTP header returned from the client.
Recognized strings are listed in the Usage section below.

Usage If the string specifies a browser that the DataWindow engine supports, the
DataWindow generates an XSLT style sheet and JavaScript for XHTML
transformation optimized for that browser. Browser-specific XSLT and
JavaScript are generated only for Microsoft Internet Explorer 5.0 and later and
Netscape 6.0 and later.
Browser identification strings are sent by the client to the server in the HTTP
header. The server component can assign the HTTP_USER_AGENT value
from the HTTP header to the Browser property.
The XML Web DataWindow generator recognizes these browsers:
Browser HTTP header string
Microsoft Internet Explorer Mozilla/4.0 (compatible; MSIE 5.0;
Mozilla/4.0 (compatible; MSIE 5.5;
Mozilla/4.0 (compatible; MSIE 6.x;
Netscape Mozilla/5.0(
In the painter On the Web Generation tab in the Properties view for the
select a browser from the list.
XMLGen.property
Description Settings that specify how XML is generated, whether client-side, postback, or
callback paging is used, the physical path to which XML is published, and the
URL referenced by the JavaScript that transforms the XML to XHTML.
Obsolete property
XMLGen.property is obsolete and should not be used, because the Web

dw_control.Object.DataWindow.XMLGen.property
"DataWindow.XMLGen.property { = value }"
418 PowerBuilder
• Inline
• PublishPath
• ResourceBase
value (exp) Inline – A boolean that specifies whether the XML
generated for the XML Web DataWindow is generated
inline to the XSLT transformation script. Values are:
true – The XML is generated within the XSLT
transformation script.
false – (default) The XML is published to a separate
document.
(exp) PublishPath – A string that specifies the physical
path of the Web site folder to which PowerBuilder
publishes the generated XML document that contains the
XML Web DataWindow content.
(exp) ResourceBase – A string that specifies the URL of
the generated XML document that contains the XML Web
DataWindow content.
Usage Inline The XML published on the Internet in your XML Web DataWindow
could contain sensitive data, and this data might be exposed to Internet users
when published to a separate document. For increased security, if the Inline
property to set to true, the XML is generated “inline” to the XSLT
transformation script in the page that renders the control. If only authenticated
users have access to this script, the security of the XML is ensured. Setting this
property should have no adverse side effects on the caching efficiency of the
control.
PublishPath and ResourceBase The PublishPath folder must correspond
to the URL specified in the ResourceBase property. At runtime, after
PowerBuilder generates XML content to the PublishPath folder, client-side
JavaScript in a generated page downloads it using a reference to the
ResourceBase property. The JavaScript transforms the XML content to
XHTML using the generated XSLT style sheet.
the options you require.
Examples These statements set the XMLGen.ResourceBase and XMLGen.PublishPath
properties:
dw1.Object.DataWindow.XMLGen.ResourceBase= &

dw1.Object.DataWindow.XMLGen.PublishPath= &
dw1.Modify("DataWindow.XMLGen.PublishPath=
'C:\Inetpub\wwwroot\MyWebApp\generatedfiles'")
dw1.Modify("DataWindow.XMLGen.ResourceBase=
'/MyWebApp/generatedfiles'")
This statement sets the XMLGen.Inline property so that XML is generated
inline:
dw1.Modify("DataWindow.XMLGen.Inline='1'")
XSLTGen.property
Description Settings that specify the physical path to which the generated XSLT style sheet
is published and the URL referenced by the JavaScript that transforms the
XML to XHTML.
Obsolete property
XSLTGen.property is obsolete and should not be used, because the Web

dw_control.Object.DataWindow.XSLTGen.property
"DataWindow.XSLTGen.property { = ' value ' }"
• PublishPath
• ResourceBase
value (exp) PublishPath – A string that specifies the physical
path of the Web site folder to which PowerBuilder
publishes the generated XSLT style sheet
(exp) ResourceBase – A string that specifies the URL of
the generated XSLT style sheet
420 PowerBuilder
ResourceBase property. At runtime, after PowerBuilder generates the XSLT
style sheet to the PublishPath folder, client-side JavaScript in a generated page
downloads it using a reference to the ResourceBase property. The JavaScript
transforms the XML content to XHTML using the generated XSLT style sheet.
DataWindow object, select XSLT from the Format to Configure list and specify
the ResourceBase and Publish Path locations.
Examples These statements set the XSLTGen.ResourceBase and XSLTGen.PublishPath
properties:
dw1.Object.DataWindow.XSLTGen.ResourceBase= &
dw1.Object.DataWindow.XSLTGen.PublishPath= &
Y
Description The distance of the specified control from the top of the control’s band.
dw_control.Object.controlname.Y
"controlname.Y { = ' value ' }"
controlname The name of the control for which you want to get or set the y
coordinate.
value (exp) An integer specifying the y coordinate of the control in the
unit of measure specified for the DataWindow object. Value can be
a quoted DataWindow expression.
Position tab.
setting = dw1.Object.emp_name.Y
dw1.Object.emp_name.Y = 100
setting = dw1.Describe("emp_name.Y")

dw1.Modify("emp_name.Y=100")
Y1, Y2
Description The distance of each end of the specified line from the top of the line’s band.
Applies to Line controls
dw_control.Object.controlname.Y1
dw_control.Object.controlname.Y2
"controlname.Y1 { = ' value ' }"
"controlname.Y2 { = ' value ' }"
controlname The name of the line for which you want to get or set one of the
y coordinates.
value (exp) An integer specifying the y coordinate of the line in the
unit of measure specified for the DataWindow object. Value can
be a quoted DataWindow expression.
Position tab.
setting = dw1.Object.line_1.Y1
dw1.Object.line_1.Y1 = 50
dw1.Object.line_1.Y2 = 50
setting = dw1.Describe("line_1.Y1")
dw1.Modify("line_1.Y1=50")
dw1.Modify("line_1.Y2=50")
Zoom
Description The scaling percentage of the DataWindow object.
dw_control.Object.DataWindow.Zoom
422 PowerBuilder

"DataWindow.Zoom { = value }"
value An integer specifying the scaling percentage of the
DataWindow object. The default is 100%.
Usage In the painter To see the effect of different zoom factors in Preview mode,
use Design>Zoom. The zoom factor you set in the painter is not used at
runtime.
Limitation
The zoom property is not supported for the Graph, RichText, and OLE
DataWindow styles.

setting = dw1.Object.DataWindow.Zoom
dw1.Object.DataWindow.Zoom = 50
setting = dw1.Describe("DataWindow.Zoom")
dw1.Modify("DataWindow.Zoom=50")

424 PowerBuilder
C H A P T E R 4 Accessing Data in Code
About this chapter This chapter explains the syntax for constructing expressions that access
data in a DataWindow object.
Contents Page
Topic
Accessing data and properties in DataWindow programming 425
environments
Techniques for accessing data 426
Syntaxes for DataWindow data expressions 434
Accessing data and properties in DataWindow

programming environments
In each programming environment, you can use methods and sometimes
expressions to access the data and properties of a DataWindow object.
Data Methods for single items of data These include GetItemString for data
and Describe and Modify for properties. These methods are available in all
environments.
DataWindow data expressions These let you access single items and
blocks of data. You can access data in a single column, data in selected
rows, and ranges of rows and columns.
Data expressions have a variety of syntaxes depending on the amount of
data you want to access.
You can get and set data values using the following syntax:
dwcontrol.Object.Data [ startrownum, startcolnum, endrownum,
endcolnum ]
For a list of syntaxes, see Syntaxes for DataWindow data expressions on
page 434.
Properties Methods for properties These are Describe and Modify. These methods
are available in all environments.

Techniques for accessing data
DataWindow property expressions These let you get and set the values of
properties of the DataWindow definition and of controls contained within the
definition, such as columns and text labels.
Property expressions take this form:
dwcontrol.Object.columnname.columnproperty = value
Where to find This chapter discusses techniques for accessing data with emphasis on data
information expressions.
For information on accessing properties using methods or property
expressions, see Chapter 5, Accessing DataWindow Object Properties in
Code.

Two techniques There are two ways to access data values in a DataWindow control:
• Methods SetItem and the group of GetItem methods access single values
in specific rows and columns. For example:
dw_1.SetItem(1, "empname", "Phillips")
ls_name = dw_1.GetItemString(1, "empname")
• Expressions DataWindow data expressions use dot notation and can
refer to single items, columns, blocks of data, selected data, or the whole
DataWindow control. For example:
dw_1.Object.empname[1] = "Phillips"
dw_1.Object.Data[1,1] = "Phillips"
Both methods allow you to access data in any buffer and to get original or
current values.
Which technique to The technique you use depends on how much data you are accessing and
use whether you know the names of the DataWindow columns when the script is
compiled:
426 PowerBuilder
CHAPTER 4 Accessing Data in Code
Table 4-1: Which technique to use when accessing data

If you want to access Use
A single item Either an expression or a method. Both are
equally efficient when referring to single
items.
Exception
If you want to use a column’s name rather
than its number, and the name is not known
until runtime, use a method; methods allow
you to name the column dynamically.
More than one item, such as: An expression. Specifying the data you want
• All the data in a column in a single statement is much more efficient
than calling the methods repeatedly in a
• A block of data specified by
program loop.
ranges of rows and columns
• Data in selected rows
• All the data in the DataWindow
What’s in this section The rest of this section describes how to construct expressions for accessing
DataWindow data. The section Syntaxes for DataWindow data expressions on
page 434 provides reference information on the syntaxes for data expressions.
For information on For information about using methods for accessing data, see SetItem,
methods GetItemDate, GetItemDateTime, GetItemDecimal, GetItemNumber,
GetItemString, and GetItemTime in Chapter 9, Methods for the DataWindow
Control.
About DataWindow data expressions

The Object property of the DataWindow control lets you specify expressions
that refer directly to the data of the DataWindow object in the control. This
direct data manipulation allows you to access small and large amounts of data
in a single statement, without calling methods.
There are several variations of data expression syntax, divided into three
groups. This section summarizes these syntaxes. The syntaxes are described in
detail later in this chapter.
Data in columns or One or all items (if rownum is absent, include either buffer or datasource)
computed fields when
you know the name dwcontrol.Object.columnname {.buffer } {.datasource } { [ rownum ] }

Returns a single value (for a specific row number) or an array of values (when
rownum is omitted) from the column.
See Syntax for one or all data items in a named column on page 435.
Selected items
dwcontrol.Object.columnname {.Primary }{.datasource }.Selected
Returns an array of values from the column with an array element for each
selected row.
See Syntax for selected data in a named column on page 437.
Range of items
dwcontrol.Object.columnname {.buffer } {.datasource } [ startrownum,
endrownum ]
Returns an array of values from the column with an array element for each row
in the range.
See Syntax for a range of data in a named column on page 439.
Data in numbered Single items
columns
dwcontrol.Object.Data {.buffer } {.datasource } [ rownum, colnum ]
Returns a single item whose datatype is the datatype of the column.
See Syntax for a single data item in a DataWindow on page 441.
Blocks of data involving a range of rows and columns
dwcontrol.Object.Data {.buffer } {.datasource } [ startrownum,
startcolnum, endrownum, endcolnum ]
Returns an array of structures or user objects. The structure elements match the
columns in the range. There is one array element for each row in the range.
See Syntax for data in a block of rows and columns on page 442.
Whole rows Single row or all rows
dwcontrol.Object.Data {.buffer } {.datasource } { [ rownum ] }
Returns one structure or user object (for a single row) or an array of them (for
all rows). The structure elements match the columns in the DataWindow
object.
See Syntax for data in a single row or all rows on page 444.
Selected rows
dwcontrol.Object.Data {.Primary } {.datasource } .Selected
428 PowerBuilder
Returns an array of structures or user objects. The structure elements match the
columns in the DataWindow object. There is one array element for each
selected row.
See Syntax for all data from selected rows on page 445.
Summary of syntaxes This diagram summarizes the variations in data expression syntax:
Figure 4-1: Variations in data expression syntax
For information about getting and setting values of DataWindow object

properties using a similar syntax, see Chapter 5, Accessing DataWindow
Object Properties in Code.
When a DataWindow data expression is evaluated

Expressions that refer to DataWindow data are not verified until execution of
your application.
No compiler checking When your script is compiled, PowerBuilder does not verify the parameters of
the expression that follow the Object property. Your application can select or
change the DataWindow object in a DataWindow control at runtime without
invalidating the compiled script.
Potential execution If the datatype of the expression is not compatible with how the expression is
errors used, or if the specified rows or columns do not exist, an error will occur at
runtime.
You can handle the error by surrounding the expression in a try-catch block and
catching any DWRuntimeErrors, or by writing a script for the DataWindow
control’s Error event.
Getting and storing the data from a DataWindow data expression

A DataWindow data expression can return a large amount of data.

Data structures for Single row and column When your data expression refers to a single row
data and column, you can assign the data to a variable whose data matches the
column’s datatype. When the expression refers to a single column but can refer
to multiple rows, you must specify an array of the appropriate datatype.
More than one column When the expression refers to more than one
column, you can get or set the data with a structure or user object. When you
create the definition, you must assign datatypes to the fields (in a structure) or
instance variables (in a user object) that match the datatypes of the columns.
When your expression refers to multiple rows, you get an array of the structure
or user object.
Likewise, if you want to set data in the DataWindow control, you will set up
the data in structures or user objects whose elements match the columns
referred to in the expression. An array of those structures or user objects will
provide data for multiple rows.
Datatypes For matching purposes, the datatypes should be appropriate to the
data—for example, any numeric datatype matches any other numeric type.
Examples of data The following table presents some examples of data specified by an expression
structures and the type of data structures you might define for storing the data:
Table 4-2: Types of storage for data specified by an expression
Type of selection Sample data storage
A single item A single variable of the appropriate datatype.
A column of values An array of the appropriate datatype.
A row A structure whose elements have datatypes that
match the DataWindow object’s columns.
A user object whose instance variables match the
DataWindow object’s columns.
Selected rows or all rows An array of the structure or user object defined for a
row.
A block of values An array of structures or user objects whose elements
or instance variables match the columns included in
the selected range.
Assigning data to When a data expression is assigned to an array, values are assigned beginning
arrays with array element 1 regardless of the starting row number. If the array is larger
than the number of rows accessed, elements beyond that number are
unchanged. If it is smaller, a variable-size array will grow to hold the new
values. However, a fixed-size array that is too small for the number of rows will
cause an execution error.
430 PowerBuilder
Two ways to instantiate user objects

A user object needs to be instantiated before it is used.
One way is to use the CREATE statement after you declare the user object. If
you declare an array of the user object, you must use CREATE for each array
element.
The second way is to select the Autoinstantiate box for the user object in the
User Object painter. When you declare the user object in a script, the user
object will be automatically instantiated, like a structure.
Any datatype and data The actual datatype of a DataWindow data expression is Any, which allows the
expressions compiler to process the expression even though the final datatype is unknown.
When data is accessed at runtime, you can assign the result to another Any
variable or to a variable, structure, or user object whose datatype matches the
real data.
Examples A single value This example gets a value from column 2, whose datatype is
string:
string ls_name
ls_name = dw_1.Object.Data[1,2]
A structure that matches DataWindow columns In this example, a
DataWindow object has four columns:
An ID (number)
A name (string)
A retired status (boolean)
A birth date (date)
A structure to hold these values has been defined in the Structure painter. It is
named str_empdata and has four elements whose datatypes are integer, string,
boolean, and date. To store the values of an expression that accesses some or
all the rows, you need an array of str_empdata structures to hold the data:
str_empdata lstr_currdata[]
lstr_currdata = dw_1.Object.Data
After this example executes, the upper bound of the array of structures, which
is variable-size, is equal to the number of rows in the DataWindow control.
A user object that matches DataWindow columns If the preceding
example involved a user object instead of a structure, then a user object defined
in the User Object painter, called uo_empdata, would have four instance
variables, defined in the same order as the DataWindow columns:

integer id
string name
boolean retired
date birthdate
Before accessing three rows, three array elements of the user object have been
created (you could use a FOR NEXT loop for this). The user object was not
defined with Autoinstantiate enabled:
uo_empdata luo_empdata[3]
luo_empdata[1] = CREATE uo_empdata
luo_empdata = dw_1.Object.Data[1,1,3,4]
Setting DataWindow data with a DataWindow data expression

When you set data in a DataWindow control, the datatypes of the source values
must match the datatypes of the columns being set.
Single value or an When your data expression refers to a single row and column, you can set the
array value in the DataWindow control with a value that matches the column’s
datatype. When you are setting values in a single column and specifying an
expression that can refer to multiple rows, the values you assign must be in an
array of the appropriate datatype.
Multiple columns and When the expression refers to more than one column, you can assign the data
whole rows with a structure or user object to the DataWindow data. When you create the
definition, the fields (in a structure) or instance variables (in a user object) must
match the columns. There must be the same number of fields or variables,
defined in the same order as the columns, with compatible datatypes.
When your expression can refer to multiple rows, you need an array of the
structure or user object.
Using arrays to set You do not have to know in advance how many rows are involved when you
values are setting data in the DataWindow control. PowerBuilder uses the number of
elements in the source array and the number of rows in the target expression to
determine how to make the assignment and whether it is necessary to insert
rows.
If the target expression is selected rows or a range of rows, then:
• When there are more array elements than target rows, the extra array
elements are ignored
432 PowerBuilder
• When there are fewer array elements than target rows, the column(s) in the
extra target rows are filled with default values
If the target expression is all rows but not all columns, then:
• When there are more array elements than target rows, the extra array
elements are ignored
• When there are fewer array elements than target rows, only the first rows
up to the number of array elements are affected
If the target expression is all rows and all columns, then the source data
replaces all the existing rows, resetting the DataWindow control to the new
data.
Inserting new rows When you are setting data and you specify a range, then
if rows do not exist in that range, rows are inserted to fill the range. For
example, if the DataWindow control has four rows and your expression says to
assign data to rows 8 through 12, then eight more rows are added to the
DataWindow control. The new rows use the initial default values set up for
each column. After the rows are inserted, the array of source data is applied to
the rows as described above.
Examples These examples refer to a DataWindow object that has three columns: emp_id,
emp_lname, and salary. The window declares these arrays as instance variables
and the window’s Open event assigns four elements to each array:
integer ii_id[]
string is_name[]
double id_salary[]
uo_empdata iuo_data[]
uo_empid_name iuo_id[]
The uo_empdata user object has three instance variables: id, name, and salary.
The uo_empid_name user object has two instance variables: id and name.
This example sets emp_lname in the selected rows to the values of is_name, an
array with four elements. If two rows are selected, only the first two values of
the array are used. If six rows are selected, the last two rows of the selection
are set to an empty string:
dw_1.Object.emp_lname.Selected = is_name
This example sets salary in rows 8 to 12 to the values in the array id_salary. The
id_salary array has only four elements, so the extra row in the range is set to 0
or a default value:
dw_1.Object.salary[8,12] = id_salary

Syntaxes for DataWindow data expressions
This statement resets the DataWindow control and inserts four rows to match
the array elements of iuo_data:
dw_1.Object.Data.Primary = iuo_data
This example sets columns 1 and 2 in rows 5 to 8 to the values in the array
iuo_id:
dw_1.Object.Data.Primary[5,1, 8,2] = iuo_id
This example sets emp_id in the first four rows to the values in the ii_id array.
Rows 5 through 12 are not affected:
dw_1.Object.emp_id.Primary = ii_id

This section describes in detail the syntaxes that were summarized in About
DataWindow data expressions on page 427.
You can think of the syntaxes as grouped in three categories:
• Expressions with a named column or computed field
• Syntax for one or all data items in a named column on page 435
• Syntax for selected data in a named column on page 437
• Syntax for a range of data in a named column on page 439
• Expressions with column numbers
• Syntax for a single data item in a DataWindow on page 441
• Syntax for data in a block of rows and columns on page 442
• Expressions that access whole rows
• Syntax for data in a single row or all rows on page 444
• Syntax for all data from selected rows on page 445
434 PowerBuilder
Syntax for one or all data items in a named column

Description A DataWindow data expression can access a single item in a column or
computed field when you specify the control name and a row number. It
accesses all the data in the column when you omit the row number.
Syntax dwcontrol.Object.columnname {.buffer } {.datasource } { [ rownum ] }
dwcontrol The name of the DataWindow control or child DataWindow in
which you want to get or set data.
columnname The name of a column or computed field in the DataWindow
object in dwcontrol. If the column or computed field does not
exist at runtime, an execution error occurs.
buffer The name of the buffer from which you want to get or set data.
(optional) Values are:
• Primary – (Default) The data in the primary buffer (the data
that has not been deleted or filtered out).
• Delete – The data in the delete buffer (data deleted from the
• Filter – The data in the filter buffer (data that was filtered
out).
datasource The source of the data. Values are:
(optional) • Current – (Default) The current values in the DataWindow
control.
• Original – The values that were initially retrieved from the
database. For a computed field, you must specify Original
because computed fields cannot be changed and do not have
current values.
rownum The row number of the desired item. The row number must be
(optional) enclosed in brackets.
To access all the data in the column, omit rownum.
When buffer or datasource is not optional

When rownum is omitted, you must specify at least one of the
other elements in the expression: either buffer or datasource.
Return value The expression has a datatype of Any. The expression returns a single value
(for a specific row number) or an array of values (when rownum is omitted).
Each value has a datatype of columnname.

Usage Is the expression a DWObject or data? When you want to access all the
data in the column, remember to specify at least one of the other optional
parameters. Otherwise, the expression you specify refers to the column control,
not its data. This expression refers to the DWObject empname, not the data in
the column:
dw_1.Object.empname
In contrast, these expressions all refer to data in the empname column:
dw_1.Object.empname.Primary // All rows
dw_1.Object.empname[5] // Row 5
Row numbers for computed fields When you refer to a control in a band
other than the detail band (usually a computed field) you still specify a row
number. For the header, footer, or summary, specify a row number of 1. For the
group header or trailer, specify the group number:
dw_1.Object.avg_cf[1]
If you specify nothing after the computed field name, you refer to the computed
field DWObject, not the data. For a computed field that occurs more than once,
you can get all values by specifying buffer or datasource instead of rownum,
just as for columns.
When the expression is an array When the expression returns an array
(because there is no row number), you must assign the result to an array, even
if you know there is only one row in the result.
This expression returns an array, even if there is only one row in the
DataWindow control:
dw_1.Object.empname.Primary
This expression returns a single value:
dw_1.Object.empname[22]
Examples Because the default setting is current values in the primary buffer, the
following expressions are equivalent—both get the value in row 1 for the
emp_name column:
dw_1.Object.emp_name[1]
dw_1.Object.emp_name.Primary.Current[1]
This statement sets the emp_name value in row 1 to Wilson:
dw_1.Object.emp_name[1] = "Wilson"
This statement gets values for all the emp_name values that have been
retrieved and assigns them to an array of strings:
436 PowerBuilder
string ls_namearray[]
ls_namearray = dw_1.Object.emp_name.Current
This statement gets current values of emp_name from all rows in the filter
buffer:
ls_namearray = dw_1.Object.emp_name.Filter
This statement gets original values of emp_name from all rows in the filter
buffer:
ls_namearray = dw_1.Object.emp_name.Filter.Original
This statement gets the current value of emp_name from row 14 in the delete
buffer:
string ls_name
ls_name = dw_1.Object.emp_name.Delete[14]
This statement gets the original value of emp_name from row 14 in the delete
buffer:
string ls_name
ls_name = dw_1.Object.emp_name.Delete.Original[14]
This statement gets all the values of the computed field review_date:
string ld_review[]
ld_review = dw_1.Object.review_date.Original
Syntax for selected data in a named column

Description A DataWindow data expression uses the Selected property to access values in
a named column or computed field for the currently selected rows. Selected
data is always in the primary buffer.
Syntax dwcontrol.Object.columnname {.Primary } {.datasource }.Selected
dwcontrol The name of the DataWindow control or child
DataWindow in which you want to get or set data.
columnname The name of a column or computed field in the
DataWindow object in dwcontrol. If the column or
computed field does not exist at runtime, an execution
error occurs.

(optional) • Current – (Default) The current values in the
DataWindow control.
• Original – The values that were initially retrieved from
the database. For a computed field, you must specify
Original (because computed fields cannot be changed
and do not have current values).
Return value The datatype of the expression is Any. The expression returns an array of
values with the datatype of columnname.
Usage When you specify selected values, the expression always returns an array and
you must assign the result to an array, even if you know there is only one row
selected.
For selected rows, the primary buffer is the only applicable buffer. For
consistency, you can include Primary in this syntax but it is not necessary.
Examples Because the primary buffer is the only applicable buffer for selected data and
current data is the default, these expressions are all equivalent. They access
values in the emp_name column for selected rows:
dw_1.Object.emp_name.Selected
dw_1.Object.emp_name.Primary.Selected
dw_1.Object.emp_name.Current.Selected
dw_1.Object.emp_name.Primary.Current.Selected
These expressions both access original values for selected rows:
dw_1.Object.emp_name.Original.Selected
dw_1.Object.emp_name.Primary.Original.Selected
This example sets the emp_name value in the first selected row to an empty
string. The rest of the selected rows are set to a default value, which can be an
empty string:
string ls_empty[]
ls_empty[1] = ""
dw_1.Object.emp_lname.Selected = ls_empty
This statement gets the original emp_name values in selected rows and assigns
them to an array of strings:
ls_namearray = dw_1.Object.emp_name.Original.Selected
438 PowerBuilder
Syntax for a range of data in a named column

Description A DataWindow data expression accesses values in a named column or
computed field for a range of rows when you specify the starting and ending
row numbers.
Syntax dwcontrol.Object.columnname {.buffer } {.datasource } [ startrownum,
endrownum ]
which you want to get or set data.
columnname The name of a column or computed field in the DataWindow
object in dwcontrol. If the column or computed field does not exist
at runtime, an execution error occurs.
buffer The name of the buffer from which you want to get or set data.
(optional) Values are:
• Primary – (Default) The data in the primary buffer (the data
that has not been deleted or filtered out).
• Delete – The data in the delete buffer (data deleted from the
• Filter – The data in the filter buffer (data that was filtered out).
(optional) • Current – (Default) The current values in the DataWindow
control.
• Original – The values that were initially retrieved from the
database. For a computed field, you must specify Original
(because computed fields cannot be changed and do not have
current values).
startrownum The number of the first row in the desired range of rows.
endrownum The number of the last row in the desired range of rows.
The row numbers must be enclosed in brackets and separated by
commas.
values with an array element for each row in the range. Each value’s datatype
is the datatype of columnname.
Usage When you specify a range, the expression always returns an array and you must
assign the result to an array, even if you know there is only one value in the
result. For example, this expression returns an array of one value:
dw_1.Object.empname[22,22]

Examples Because the primary buffer and current data are the default, these expressions
are all equivalent:
dw_1.Object.emp_name[11,20]
dw_1.Object.emp_name.Primary[11,20]
dw_1.Object.emp_name.Current[11,20]
dw_1.Object.emp_name.Primary.Current[11,20]
This example resets the emp_name value in rows 11 through 20 to an empty
string. Rows 12 to 20 are set to a default value, which may be an empty string:
string ls_empty[]
ls_empty[1] = ""
dw_1.Object.emp_name[11,20] = &
{"","","","","","","","","",""}
This statement gets the original emp_name values in rows 11 to 20 and assigns
them to elements 1 to 10 in an array of strings:
ls_namearray = dw_1.Object.emp_name.Original[11,20]
This statement gets current values of emp_name from rows 5 to 8 in the Filter
buffer and assigns them to elements 1 to 4 in an array of strings:
ls_namearray = dw_1.Object.emp_name.Filter[5,8]
This statement gets original values of emp_name instead of current values, as
shown in the previous example:
ls_namearray = &
dw_1.Object.emp_name.Filter.Original[5,8]
This statement gets current values of emp_name from rows 50 to 200 in the
delete buffer and assigns them to elements 1 to 151 in an array of strings:
ls_namearray = dw_1.Object.emp_name.Delete[50,200]
This statement gets original values of emp_name instead of current values, as
shown in the previous example:
ls_namearray = &
dw_1.Object.emp_name.Delete.Original[50,200]
440 PowerBuilder
Syntax for a single data item in a DataWindow

Description A DataWindow data expression accesses a single data item when you specify
its row and column number.
Syntax dwcontrol.Object.Data {.buffer } {.datasource } [ rownum, colnum ]
buffer The name of the buffer from which you want to get or set
(optional) data. Values are:
• Primary – (Default) The data in the primary buffer (the
data that has not been deleted or filtered out).
• Delete – The data in the delete buffer (data deleted from
the DataWindow control).
• Filter – The data in the filter buffer (data that was
filtered out).
DataWindow control.
the database.
rownum The row number of the desired item.
colnum The column number of the desired item.
The row and column numbers must be enclosed in brackets
and separated by commas.
Return value The datatype of the expression is Any. The expression returns a single item in
the DataWindow control. Its datatype is the datatype of the column.
Examples These expressions both refer to a single item in row 1, column 2. The
expressions access current data in the primary buffer:
dw_1.Object.Data[1,2]
dw_1.Object.Data.Primary.Current[1,2]
This statement changes the value of the original data to 0 for the item in row 1,
column 2 in the Filter buffer. Column 2 holds numeric data:
dw_1.Object.Data.Filter.Original[1,2] = 0

Syntax for data in a block of rows and columns

Description A DataWindow data expression accesses data in a range of rows and columns
when you specify the starting and ending row and column numbers.
Syntax dwcontrol.Object.Data {.buffer } {.datasource } [ startrownum,
startcolnum, endrownum, endcolnum ]
filtered out).
DataWindow control.
the database.
startrownum The number of the first row in the desired range of rows.
startcolnum The number for the first column in the range.
endrownum The number of the last row in the range.
endcolnum The number for the last column in the range.
The row and column numbers must be enclosed in
brackets and separated by commas.
structures or user objects. There is one structure element or user object instance
variable for each column in the designated range. The datatype of each element
matches the datatype of the corresponding column. There is one structure or
user object in the array for each row in the range of rows.
Usage When you specify a block, the expression always returns an array and you must
assign the result to an array, even if you know there is only one structure in the
result.
This expression returns an array of one structure from row 22:
dw_1.Object.data[22,1,22,4]
442 PowerBuilder
This expression returns an array of one value from row 22, column 1:
dw_1.Object.data[22,1,22,1]
Examples These statements both refer to data in the first ten rows and first four columns
of the DataWindow object in the control dw_1. The primary buffer and current
data are the default:
dw_1.Object.Data[1,1,10,4]
dw_1.Object.Data.Primary.Current[1,1,10,4]
This example gets employee IDs and last names for all the rows in the delete
buffer. The IDs and names are the first two columns. It saves the information
in a structure, called str_namelist, of two elements: an integer called id and a
string called lastname. The structure was defined previously in the Structure
painter. The list of IDs and names is then saved in the file DELETED.TXT:
integer li_fileNum
long ll_deletedrows
str_namelist lstr_namelist[]
ll_deletedrows = dw_1.DeletedCount()
lstr_namelist = &
dw_1.Object.Data.Delete[1,1, ll_deletedrows,2]
li_fileNum = FileOpen("C:\HR\DELETED.TXT", &

LineMode!, Write!)
FOR ll_count = 1 to UpperBound(lstr_namelist)
FileWrite(li_fileNum, &
String(lstr_namelist.id) + &
" " + &
lstr_namelist.lastname + &
"~r~n")
NEXT
FileClose(li_fileNum)
Using the structure from the previous example that holds IDs and last names,
this example sets all the IDs and last names in the DataWindow control to null:
long ll_n
str_namelist lstr_namelist[]
SetNull(lstr_namelist[1].id)
SetNull(lstr_namelist[1].lastname)
FOR ll_n = 2 to dw_1.RowCount()

lstr_namelist[ll_n] = lstr_namelist[1]
NEXT

dw_1.Object.Data[1,1, dw_1.RowCount(),2] = lstr_data
Syntax for data in a single row or all rows

Description A DataWindow data expression accesses a single row when you specify the
row number. It accesses all the data in the DataWindow control when you omit
the row number.
Syntax dwcontrol.Object.Data {.buffer } {.datasource } { [ rownum ] }
filtered out).
DataWindow control.
the database.
rownum The number of the row you want to access.
(optional) To access data for all rows, omit rownum.
The row number must be enclosed in brackets.
Return value The datatype of the expression is Any. The expression returns one structure or
user object (for a single row) or an array of them (for all rows). There is one
structure element or instance variable for each column in the DataWindow
object. The datatype of each element matches the datatype of the
corresponding column.
Usage When you omit the row number, the expression always returns an array, and
you must assign the result to an array, even if you know there is only one row
in the DataWindow control.
Examples These statements both access current data for row 5 in the primary buffer in the
DataWindow object contained in the DataWindow control dw_1:
444 PowerBuilder
dw_1.Object.Data[5]
dw_1.Object.Data.Primary.Current[5]
This example assigns all the data in dw_1 to the Any variable la_dwdata. The
value assigned to la_dwdata is an array of data structures whose members
match the column datatypes:
any la_dwdata
la_dwdata = dw_1.Object.Data
This example assigns all the data in the delete buffer for dw_1 to the Any
variable la_dwdata:
any la_dwdata
la_dwdata = dw_1.Object.Data.Delete
This example replaces all the data in the nested report in row 2 with data from
dw_2. The columns in the DataWindow object in dw_2 must match the
columns in the DataWindow object for the nested report:
dw_1.Object.NestRep[2].Object.Data = &
dw_2.Object.Data
Syntax for all data from selected rows

Description A DataWindow data expression accesses all the data in the currently selected
rows when you specify the Data and Selected properties. Selected rows are
always in the primary buffer.
Syntax dwcontrol.Object.Data {.Primary } {.datasource }.Selected
DataWindow control.
the database.
Return values The datatype of the expression is Any. The expression returns an array of
structures or user objects. There is one structure element or instance variable
for each column in the DataWindow object. The datatype of each element
matches the datatype of the corresponding column.

Usage When you specify selected rows, the expression always returns an array, and
you must assign the result to an array even if you know there is only one row
selected.
Examples Because the primary buffer is the only applicable buffer for selected data and
current data is the default, these expressions are all equivalent. They access
data in the selected rows:
dw_1.Object.Data.Selected
dw_1.Object.Data.Primary.Selected
dw_1.Object.Data.Current.Selected
dw_1.Object.Data.Primary.Current.Selected
Both these expressions access original values for selected rows:
dw_1.Object.Data.Original.Selected
dw_1.Object.Data.Primary.Original.Selected
This example takes the values in the selected rows in dw_2 and populates a
DropDownDataWindow in dw_1 with the values, replacing existing data in the
DropDownDataWindow. The column with the DropDownDataWindow is
called useroptions. The columns of the DataWindow object in dw_2 must
match the columns of the DataWindow object for the DropDownDataWindow:
dw_1.Object.useroptions.Object.Data = &
dw_2.Object.Data.Selected
446 PowerBuilder
C H A P T E R 5 Accessing DataWindow Object
Properties in Code
About this chapter This chapter explains the syntax for constructing expressions that access
properties of controls within a DataWindow.
Contents
Topic Page
About properties of the DataWindow object and its controls 447
PowerBuilder: Modify and Describe methods for properties 457
PowerBuilder: DataWindow property expressions 460
JavaScript: Modify and Describe methods for properties 475
About properties of the DataWindow object and its

controls
This section describes:
• 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
What you can do with DataWindow object properties

The DataWindow object defines the way data is displayed in a
DataWindow control. It contains controls that represent the columns, text
labels, computed fields, and images.

About properties of the DataWindow object and its controls
The properties of the DataWindow object and its controls store the information
that specifies the behavior of the DataWindow object. They are not properties
of the DataWindow control, but of the DataWindow object displayed in the
control.
Terminology
When you are programming for DataWindows, there are several types of
expressions involved.
A DataWindow expression is an expression assigned as a value to a
DataWindow property and is evaluated by the DataWindow engine. The
expression can refer to column data and can have a different value for each row
in the DataWindow.
A DataWindow property expression is an expression in your code that gets
or sets the value of a DataWindow property. Its effects are equivalent to what
the Describe and Modify methods do.
A DataWindow data expression is an expression in your code that gets or sets
data in the DataWindow. Its effects are similar to what the SetItem and several
GetItem methods do.
Types of values Property values can be constants or can be DataWindow expressions.

DataWindow expressions allow the property value to be based on other
conditions in the DataWindow, including data values. Conditional expressions
based on data can give the property a different value for each row.
Getting and setting You establish initial values for properties in the DataWindow painter. You can
values also get and set property values at runtime in code.
There are several techniques for accessing property values. A particular
property might be accessible by a subset of those techniques. For example,
some properties are read-only at runtime, some can be set only at execution,
and some accept only constants (not DataWindow expressions) as values.
For a complete list of properties and the ways you can access each one, see
Chapter 3, DataWindow Object Properties.
Examples: ways of This table lists the ways you can access a property, using the Border property
setting the Border as an example:
property
448 PowerBuilder
CHAPTER 5 Accessing DataWindow Object Properties in Code
Table 5-1: Ways to access and change DataWindow object properties

How to do it,
using the Border
What you can do property as an
with properties example What happens
Set the initial value Property sheet, The Border property takes on the
of the property in the General tab, Border value you set unconditionally. In the
workspace box Preview view and at runtime, the
control has the border you indicated
in the workspace unless you set the
Border property again in some way.
Specify the value of Property sheet, In Preview and at runtime, the border
the property at General tab, Border changes as specified in the
runtime based on an box, Expression expression, which overrides the
expression defined button setting on the property sheet.
for the control in the For example, an expression can give
workspace the Salary column value a
ShadowBox border when the salary
exceeds $70,000.
To see the effect in the Preview view,
you might need to close Preview and
reopen it.
Get the value of the Property expression Both the expression and the Describe
property at runtime for the Border method return the value of the Border
in code property or Describe property for the specified control.
method
Change the value of Property expression At runtime, the value of the property
the property at for the Border changes when the code executes. For
runtime in code property or Modify example, you could code Modify in
method the Clicked event and change the
border of the control the user clicked.
Set the initial value SyntaxFromSQL When SyntaxFromSQL executes, the
of the property at method border value of all columns is set in
runtime in code for a the generated syntax.
DataWindow being PowerBuilder SyntaxFromSQL is
created a method of the Transaction object
and is described in the PowerScript
Reference.
Specifying property values in the DataWindow painter

When you specify values in the Properties view of the DataWindow painter,

you are setting properties of the DataWindow object and its controls.
Properties for each Each control in the DataWindow (columns, text, drawing controls) has its own
control property sheets, because there are different sets of properties for each object.
To access individual property sheets, display the Properties view and then
select a control.
If several controls have the same property and you want them all to have the
same value, you can select all the controls so that the property sheet shows the
properties they have in common. When you change the property value, it is
applied to all selected controls.
DataWindow For many properties, you can specify a DataWindow expression in the
expressions for Properties view by clicking the Expression button beside the property. At
properties
runtime, the expression is evaluated for each row. When the expression
includes row-dependent information in the calculation (such as data), each row
can have a different value for the property. In the painter, you can see the results
in the Preview view. (You might need to close Preview and reopen it if you are
not seeing the settings you have made.)
For information about the components of expressions, see Using DataWindow
expression functions on page 17 and the Users Guide. For examples of
expressions, see Using DataWindow expressions as property values on page
451.
Accessing DataWindow object property values in code

Two techniques There are two ways to access property values in a DataWindow object:
• Methods The Describe and Modify methods use strings to specify the
property names. For example:
dw_1.Describe("empname.Border")
dw_1.Modify("empname.Border=1")
• Expressions DataWindow property expressions use the Object property
and dot notation. For example:
dw_1.Object.empname.Border = 1
li_border = Integer(dw_1.Object.empname.Border)
In JavaScript, only the Describe and Modify methods are available.
Which technique to The technique you use depends on the type of error checking you want to
use provide and on whether you know the names of the controls and properties you
want to access when the script is compiled.
450 PowerBuilder
Table 5-2: Error handling in DataWindow property expressions

If you want to Use
Use column and property names that are known when An expression
the script is compiled
Avoid extra nested tildes (and you know the column An expression
and property names you want to access)
Build a string at runtime that names controls and A method
properties
Use the DWRuntimeError to handle problems with An expression in a try-catch
incorrect control or property names block
Use the Error event to handle problems with incorrect An expression and a script
control or property names for the Error event
Avoid using the Error event (or DWRuntimeError) for A method and code that
handling problems with incorrect control or property evaluates its return value
names
Using DataWindow expressions as property values

When a DataWindow object property’s value can be an expression, you can
make the control’s appearance or other properties depend on other information
in the DataWindow.
A DataWindow expression can include:
• Operators
• The names of controls within the DataWindow, especially column and
computed field names
• DataWindow expression functions. Some functions, such as IsRowNew,
refer to characteristics of an individual row
• User-defined functions
Different formats for When you assign an expression in the painter, you specify just the expression:
the expression
DataWindowexpression
When you assign an expression in code, you specify a default value, a tab, and
the expression:
defaultvalue [tab] DataWindowexpression

Examples In the painter This expression for a column called emp_lname is applied to
the Background.Color property. It causes the name’s background to be light
gray (15790320) if the current row (person) uses the day care benefit. If not,
the background color is set to white:
If(bene_day_care = 'Y', 15790320, 1677215)
In code The expression assigned to the Background.Color property includes
a default value. Nested quotes complicate the syntax:
PowerBuilder
dw_1.Object.emp_lname.Background.Color = "16777215 ~t
If(bene_day_care = 'Y', 15790320, 16777215)"
JavaScript
dw_1.Modify("emp_lname.Background.Color = \"16777215 \t
If(bene_day_care = 'Y', 15790320, 16777215)\");
More examples in the DataWindow painter and in code

These examples illustrate the difference between the format for a DataWindow
expression specified in the DataWindow painter versus in code.
Border property The expression applied to the Border property of the
salary_plus_benefits column displays a border around salaries over $60,000:
If(salary_plus_benefits > 60000, 1, 0)
This statement changes the expression in code:
dw_1.Object.salary_plus_benefits.Border = &
"0 ~t If(salary_plus_benefits > 60000, 1, 0)"
Font.Weight property for a column To make out-of-state (not in
Massachusetts) names and numbers bold in a phone list, apply this expression
to the name and phone_number columns. The state column must be part of the
data source, but it does not have to be displayed:
If(state = 'MA', 400, 700)
dw_1.Object.name.Font.Weight = &
"700 ~t If(state = 'MA', 400, 700)"
dw_1.Object.phone_number.Font.Weight = &
"700 ~t If(state = 'MA', 400, 700)"
452 PowerBuilder
Brush.Color property for a rectangle This expression, applied to a

rectangle drawn around all the columns in a tabular report, causes alternate
rows to be shaded (a graybar effect). Make sure the columns and computed
fields have a transparent background. The expression Mod(GetRow( ), 2) =
1 distinguishes odd rows from even rows:
If(Mod(GetRow(), 2) = 1, 16777215, 15790320)

dw_1.Object.rectangle_1.Brush.Color = &
"0 ~t If(Mod(GetRow(), 2) = 1, 16777215, 15790320)"
Brush.Color and Brush.Hatch properties for a rectangle To highlight
employees whose review date is approaching, draw a rectangle behind the row.
This expression for the rectangle’s Brush.Color property makes the rectangle
light gray for employees for whom the month of the start date matches the
current month or the next month:
If(month(start_date) = month(today())
or month(start_date) = month(today()) + 1
or (month(today()) = 12 and month(start_date) = 1),
12632256, 16777215)
A similar expression for the Brush.Hatch property makes the fill pattern of the
rectangle Bdiagonal (1) for review dates that are approaching. Otherwise, the
rectangle is transparent (7) so that it does not show:
If(month(start_date) = month(today())
or month(start_date) = month(today()) + 1
or (month(today()) = 12 and month(start_date) = 1),
1, 7)
You can also set the Pen.Color and Pen.Style properties to affect the outline of
the rectangle.
If you wanted to change the Brush.Color property in code instead of setting it
in the painter, the code would look like this:
dw_1.Object.rectangle_1.Brush.Color = &
"'16777215 ~t " + &
"If(month(start_date) = month(today()) " + &
"or month(start_date) = month(today()) + 1 " + &
"or (month(today()) = 12 " + &
"and month(start_date) = 1), 12632256, 16777215)'"
Font.Height property for a rectangle This expression applied to the
Font.Height property of a text control makes the text control in the first row of
a DataWindow larger than it appears in other rows. Make sure the borders of
the text control are large enough to accommodate the increased size:

If(GetRow() = 1, 500, 200)

This statement changes the expression for the text control t_desc in code:
dw_1.Object.t_desc.Font.Height = &
"200 ~t If(GetRow() = 1, 500, 200)"
For more information For more information about DataWindow expressions, see Chapter 1,
DataWindow Operators and Expressions.
Nested strings and special characters for DataWindow object

properties
DataWindow property values often involve specifying strings within strings.
Embedded quotation marks need special treatment so that the strings are parsed
correctly. This treatment varies depending on the programming language you
are using.
Table 5-3: Specifying property values in different scripting languages
If you are using See
PowerScript Nested strings and special characters for DataWindow object
properties on page 454.
JavaScript Nested strings and special characters in JavaScript for
DataWindow object properties on page 456.
Nested strings and special characters for DataWindow object properties

Tilde (~) is the escape character that allows you to nest quoted strings within
other quoted strings and to specify special characters such as tabs and carriage
returns. For DataWindow object properties, several levels of nested strings can
create a complicated expression.
Techniques for Both double and single quotes are valid delimiters for strings. You can use this
quoting nested strings fact to simplify the specification of nested strings.
There are two ways to embed a string within another string. You can:
• Use the other type of quotation mark for the nested string. If the main
string uses double quotes, the nested string can use single quotes.
"If(state='MA',255,0)"
• Use the escape character to specify that a quote is part of the string instead
the closure of a previous quote.
"If(state=~"MA~",255,0)"
454 PowerBuilder
If the string includes a third level of nested strings, you need to add another
tilde which must be accompanied by its own escape character, a second tilde.
This is the reason that tildes are usually specified in odd numbers (1, 3, or 5
tildes).
This Modify expression (entered on a single line in code) shows three levels of
nested strings:
dw_1.Modify(
"DataWindow.Color = '255 ~t If(state=
~'MA~',255,0)'")
This version of the expression has more tildes because there are no single
quotes:
dw_1.Modify("DataWindow.Color = ~"255 ~t If(state=
~~~"MA~~~",255,0)~"")
Common special Strings can also include special characters, as shown in the previous example.
characters This table lists the special characters that are most often used in DataWindow
expressions.
Escape sequence Meaning
~t Tab
~r Carriage return
~n Newline or linefeed
~" Double quote
~’ Single quote
~~ Tilde
A line break is a carriage return plus a newline (\r\n).

Special use of tilde A special case of specifying tildes involves the EditMask.SpinRange property,
whose value is two numbers separated by a tilde (not an escape character,
simply a tilde). To specify this value in a script, you must use a nested string
with four tildes, which is interpreted as a single tilde when parsed:
dw_1.Modify("benefits.EditMask.SpinRange='0~~~~10'")
More information For more information about nested strings and special characters, see the

Nested strings and special characters in JavaScript for DataWindow object

properties
Different processing JavaScript uses different characters from those used within the DataWindow to
by language and delimit strings and identify special characters. For DataWindow object
DataWindow
properties, several levels of nested strings and two types of delimiter can create
a complicated expression.
In JavaScript, strings are delimited by double quotes and the escape character
in strings is the backslash (\). The escape character allows you to include
double quotes and special characters within a string. The DataWindow can use
either double or single quotes to delimit strings and uses tilde (~) as an escape
character.
Because some parts of the string are parsed by the language and some by the
DataWindow, strings passed to the DataWindow often use both types of escape
character. The one to use depends on whether the DataWindow or the external
language will evaluate the character. The external language deals with the outer
string and converts escape sequences to the corresponding special characters.
Nested strings are dealt with by the DataWindow parser.
Guidelines Observe these guidelines for each type of character:
• Special characters use the language escape character. Tabs, newlines, and
carriage returns are \t, \n, \r
• Nested double quotes require the language escape character (\) so they
won't be interpreted as the closure of the opening double quote. Depending
on the level of nesting, they may also require the DataWindow escape
character (~).
• Single quotes for nested strings do not need the language escape character,
but depending on the level of nesting they may need the DataWindow
escape character.
• Tildes are specified in odd-numbered groups. They do not interact with the
language escape character in counting the number of escape characters
used.
Examples Both of these JavaScript examples are valid ways of nesting a string:
dw_1.Modify("DataWindow.Crosstab.Values=\"empname\"");
dw_1.Modify("DataWindow.Crosstab.Values='empname'");
The following three JavaScript statements specify the same string. They show
a string with three levels of nesting using different combinations of escape
characters and quote types. In the first example, note the escaping of the inner
quote with a tilde for the DataWindow and a backslash for the language:
456 PowerBuilder
dw_1.Modify("emp_id.Color=\"16777215 \t If
(emp_status=~\"A~\",255,16777215)\"");
dw_1.Modify("emp_id.Color=\"16777215 \t If
(emp_status='A',255,16777215)\"");
dw_1.Modify("emp_id.Color='16777215 \t If
(emp_status=\"A\",255,16777215)'");
The corresponding example in PowerBuilder is:
dw_1.Modify("emp_id.Color = ~"16777215 ~t If
(emp_status=~~~"A~~~",255,16777215)~"")
Special use of tilde A special case of specifying tildes involves the EditMask.SpinRange property,
whose value is two numbers separated by a tilde (not an escape character,
simply a tilde). In code, the value is in a nested string and needs a tilde escape
character. The two tildes are interpreted as a single tilde when parsed by the
DataWindow:
dw_1.modify("benefits.EditMask.SpinRange='0~~10'");
PowerBuilder: Modify and Describe methods for

properties
The following sections provide information about using Modify and Describe
methods for DataWindow object properties:
• Advantage and drawbacks of Modify and Describe methods in
PowerBuilder
• Handling errors from Modify and Describe methods in PowerBuilder
Advantage and drawbacks of Modify and Describe methods in

PowerBuilder
In PowerBuilder, using the Describe and Modify methods to access
DataWindow object property values has an advantage and some drawbacks.
The examples here use Modify as illustrations, but similar considerations apply
to Describe.
Advantage Allows you to specify column and property names dynamically In your
script, you can build a string that specifies the column and property names.

PowerBuilder: Modify and Describe methods for properties
For example, the following code builds a string in which the default color value
and the two color values in the If function are determined in the script. Notice
how the single quotes around the expression are included in the first and last
pieces of the string:
red_amount = Integer(sle_1.Text)
modstring = "emp_id.Color='" + &
String(RGB(red_amount, 0, 0)) + &
"~tIf(emp_status=~~'A~~'," + &
String(RGB(255, 0, 0)) + &
"," + &
")'"
Modify(modstring)
The resulting string when red_amount is set to 128 is:
emp_id.Color='128~tIf(emp_status=~'A~',255,128)'
The following is a simpler example without the If function. You do not need
quotes around the value if you are not specifying an expression. Here the String
and RGB functions result in a constant value in the resulting modstring:
Modify(ls_columnname + ".Color=" + &
String(RGB(red_amount, 255, 255)))
Drawbacks Setting several properties at once is possible but hard to debug
Although you can set several properties in a single method call, it is harder to
understand and debug scripts that do so.
For example, assume the following is entered on a single line in the script
editor:
rtn = dw_1.Modify("emp_id.Font.Italic=0
oval_1.Background.Mode=0
oval_1.Background.Color=255")
Less efficient than an expression Using a DWObject variable in several
property expressions is a little more efficient than setting several properties in
a single call to Describe or Modify. However, if you want to be able to name
controls dynamically, you might still choose to use Describe or Modify.
For examples of using a DWObject variable, see Using the DWObject variable
in PowerBuilder on page 462.
Can require complex quoted strings When you specify an expression for a
property value, it is difficult to specify nested quotes correctly—the code is
hard to understand and prone to error. For Describe, this is less of a drawback—
strings do not become as complex because they do not include an expression.
458 PowerBuilder
For example, this string entered on a single line in a script assigns a

DataWindow expression to the Color property:
Modify("emp_id.Color=~"16777215 ~t
If(emp_status=~~~"A~~~",255,16777215)~"")
For more information about quoted strings, see Nested strings and special
characters for DataWindow object properties on page 454.
Handling errors from Modify and Describe methods in

PowerBuilder
In PowerBuilder, no runtime error occurs when Describe and Modify try to
access invalid controls or properties in the DataWindow object. The validity of
the argument string is evaluated before the controls are accessed.
Modify When the string that specifies the control and property to be accessed is invalid,
Modify returns an error string, instead of the expected value, such as:
Line 1 Column 12: incorrect syntax.
You can use the error message to figure out what part of the string is incorrect.
This is most useful when you are testing your scripts. The error message, which
names the line and column number after which the string was not recognized,
might not be helpful after your application is deployed.
Describe When the string for Describe has an unrecognized property, Describe’s return
value ends with an exclamation point (!). Describe returns as many values as it
recognizes up to the incorrect one.
When you specify a valid property but that property doesn’t have a value
(either because it hasn’t been set or because its value is an expression that can’t
be evaluated), Describe returns a question mark (?) for that property. The
property’s actual value is null.
Always check for errors

You should include error-checking code that checks for these return values.
Other errors can occur later if you depend on settings that failed to take effect.
For more information For more information on syntax and usage, see Describe and Modify in Chapter
9, Methods for the DataWindow Control.

PowerBuilder: DataWindow property expressions

In PowerBuilder, DataWindow property expressions use dot notation. These
sections explain how to use the expressions and what syntax to use to construct
them:
• Basic structure of DataWindows and property expressions in
PowerBuilder on page 460
• Datatypes of DataWindow property expressions in PowerBuilder on page
461
• Using the DWObject variable in PowerBuilder on page 462
• When a DataWindow property expression is evaluated in PowerBuilder
on page 465
• Handling errors from DataWindow property expressions in PowerBuilder
on page 466
• PowerBuilder syntax for DataWindow property expressions on page 468
Basic structure of DataWindows and property expressions in

PowerBuilder
Controls in a A DataWindow object is made up of many controls (such as Columns, Text,
DataWindow Pictures, and Reports). In PowerBuilder scripts, the datatype of these controls
is DWObject. Each DWObject has a set of properties according to its type. The
syntax of a property expression allows you to address any of these properties.
Object property A DataWindow property expression uses the Object property of the
DataWindow control to access the DataWindow object. Following the Object
property, you specify a control name and one or more properties.
The simple syntax is:
dwcontrol.Object.dwcontrolname.property
For example:
dw_1.Object.empname.Resizeable
For the full syntax, see PowerBuilder syntax for DataWindow property
460 PowerBuilder
About DataWindow data expressions

Expressions that access data in a DataWindow object using dot notation use the
Object and Data properties. These expressions are called data expressions (in
contrast to property expressions); because of the intricate syntax for data
expressions, they are described separately, in Chapter 4, Accessing Data in
Code.
Datatypes of DataWindow property expressions in PowerBuilder

DataWindow property The values of DataWindow object properties are strings. These strings can
values contain numeric or yes/no values, but the values you access are strings, not
integers or boolean values.
Although the property values are really strings, the PowerScript compiler
allows you to assign numbers and boolean values to properties whose strings
represent numeric values or contain yes/no strings. This does not mean the
datatype is integer or boolean. It is just a convenience when assigning a value
to the property.
For example, both of these statements are correct:
dw_1.Object.empname.Border = 1
dw_1.Object.empname.Border = '1'
DataWindow property In PowerBuilder, the datatype of a property expression is Any (not string), but
expressions the value of the data in the Any variable is a string. This may sound like an
unnecessary distinction, but it does matter when you use a property expression
as a method argument. If the method does not accept an Any variable as an
argument, you might need to use the String function to cast the data to the
correct datatype.
For example, because the MessageBox function accepts a string argument not
an Any datatype, the property expression is enclosed in a String conversion
function:
MessageBox("Border", &
String(dw_1.Object.empname.Border))

Using the DWObject variable in PowerBuilder

A PowerBuilder DWObject object is an object that exists within a
DataWindow object. Each column, computed field, text control, or drawing
control is a DWObject.
A DWObject reference allows you to refer directly to controls within a
DataWindow.
You can use a DWObject variable to simplify DataWindow property and data
expressions. A DWObject variable takes the place of several elements of the
control’s dot notation.
The following syntaxes and examples show how using a DWObject variable
affects property and data expressions.
Property expressions The simple syntax for a property expression is:
dwcontrol.Object.dwcontrolname.property
You can use a DWObject variable to refer to dwcontrolname.
If the code declares a DWObject variable and assigns the control within the
DataWindow to the variable, using syntax like this:
DWObject dwobjectvar
dwobjectvar = dwcontrol.Object.dwcontrolname
the syntax of the expression itself becomes:
dwobjectvar.property
For example, if the DataWindow had a column named empname, a text control
named t_emplabel, and a computed field named cf_average, you could make
the following assignments:
DWObject dwo_column, dwo_text, dwo_compute
dwo_column = dw_1.Object.empname
dwo_text = dw_1.Object.t_emplabel
dwo_compute = dw_1.Object.cf_average
Data expressions You can use a DWObject variable to refer to a column in a data expression. For
example, this syntax gets data for a single row and column:
dwcontrol.Object.columnname {.buffer } {.datasource } [ rownum ]
If the code declares a DWObject variable and assigns the control within the
DataWindow to the variable, using syntax like this:
DWObject dwobjectvar
dwobjectvar = dwcontrol.Object.columnname
462 PowerBuilder
The syntax of the expression itself becomes:

dwobjectvar. {.buffer } {.datasource } [ rownum ]
DWObject variables in PowerBuilder

In PowerBuilder, you can get better performance by using a DWObject
variable to resolve the object reference in a DataWindow property or data
expression. Evaluating the reference once and reusing the resolved reference is
more efficient than fully specifying the object reference again.
This technique yields the most benefit if your application uses compiled code
or if you are using a DataWindow expression in a loop.
For example, this code is not optimized for best performance, because the fully
specified data expression within the loop must be resolved during each pass:
integer li_data
FOR li_cnt = 1 to 100
li_data = dw_1.Object.emp_salary[li_cnt]
.. // Code to process data value
NEXT
This code has been optimized. The reference to the control within the
DataWindow (emp_salary) is resolved once before the loop begins. The
reference stored in the DWObject variable is reused repeatedly in the loop:
integer li_data
DWObject dwo_empsalary
dwo_empsalary = dw_1.Object.emp_salary
FOR li_cnt = 1 to 100

li_data = dwo_empsalary.Primary[li_cnt]
.. // Code to process data value
NEXT
PowerBuilder DWObject versus data

In a data expression for a column that refers to one item, the brackets for the
row index identify the expression as a data expression (for information, see
Syntax for one or all data items in a named column on page 435). However, if
you assign the column control to a DWObject variable, the brackets incorrectly
signify an array of objects. Therefore you must include a buffer name or data
source to specify that you want data:
dw_1.Object.emp_salary[1] //Single data item
DWObject dwo_empsalary

dwo_empsalary = dw_1.Object.emp_salary
dwo_empsalary[1] // Incorrect: array of DWObject
dwo_empsalary.Primary[1] // Single data item
DWObject arguments for DataWindow events in PowerBuilder

In PowerBuilder, several DataWindow events pass a DWObject argument
called dwo to the event script. The value is a resolved reference to a control
within the DataWindow having something to do with the user’s action that
triggered the event. Often it is the column the user is changing or the control
the user clicked.
What type of You can use DataWindow properties to find out more about the control stored
DWObject? in dwo. The first step is to find out the control’s type so that subsequent
statements will use properties that are appropriate for the control type. If an
expression uses a property that does not correspond to the control’s type, it will
trigger the Error event. This statement in an event script gets the type:
ls_type = dwo.Type
The possible values that can be assigned to ls_type are:
bitmap (for Picture)
button
column
compute (for Computed Field)
graph
groupbox
line
ole
ellipse (for Oval)
rectangle
roundrectangle
report
tableblob
text
datawindow (when the user doesn’t click a specific control)
You can write a CHOOSE CASE statement for the expected types.
After you have determined the type, you can get more details about the specific
control.
Examples If the control is a column, you can get the column name with this statement:
ls_name = dwo.Name
464 PowerBuilder
If the control is a column, you can get data from the whole column or from
specific rows. You must specify the buffer from which you want to retrieve
data. In this statement, row is another argument passed to the event so the value
in ls_data is the data in the row and column the user clicked. In this example,
if the column value is not a string, an error occurs (check ColType property to
get the column datatype):
ls_data = dwo.Primary[row]
This statement assigns a new value to the row and column the user clicked. The
assignment does not trigger the ItemChanged event and bypasses validation. If
the column is not numeric, an error occurs:
dwo.Primary[row] = 41
This statement gets all the data in the column the user clicked. The data is
stored as an array in the Any variable. An Any variable can hold all datatypes,
so no error occurs:
Any la_data
la_data = dwo
This statement gets data in the column from selected rows. The data is stored
as an array in the Any variable:
Any la_data
la_data = dwo.Selected
When a DataWindow property expression is evaluated in

PowerBuilder
In PowerBuilder, expressions that refer to DataWindow object properties and
data are not verified until your application runs.
No compiler checking When your script is compiled, PowerBuilder does not verify the parameters of
the expression that follow the Object property. Your application can select the
DataWindow object in a DataWindow control at runtime without invalidating
the compiled script.
Potential execution If the datatype of the expression is not compatible with how the expression is
errors used, or if the specified rows or columns do not exist, then an error will occur
at runtime.
You can handle the error by surrounding the expression in a try-catch block or
by writing a script for the DataWindow Error event.

Handling errors from DataWindow property expressions in

PowerBuilder
What causes errors In PowerBuilder, an invalid DataWindow property expression causes a runtime
error in your application. A runtime error causes the application to terminate
unless you catch the error in a runtime error handler or unless there is a script
for the Error event.
Table 5-4: Conditions that invalidate DataWindow property expressions
Conditions that cause errors Possible causes
Invalid names of controls within the Mistyping, which the compiler does not
DataWindow object catch because it does not evaluate the
expression.
A different DataWindow object has been
inserted in the control and it has different
columns and controls.
A property is not valid for the Mistyping.
specified control The control is a different type than expected.
You can prevent the application from terminating by handling the error in the
DataWindow control’s Error event or by catching the error in a try-catch block.
Responding to errors The Error event’s arguments give you several options for responding to the
in the Error event error. You choose a course of action and set the action argument to a value of
script
the ExceptionAction enumerated datatype.
ExceptionAction enumerated datatype

If you give the action argument a value other than ExceptionIgnore!, you will
prevent error-handling code in try-catch blocks from executing. For more
information on values for the ExceptionAction enumerated datatype, see the
Error event description in the PowerScript Reference.
If you are trying to find out a property value and you know the expression
might cause an error, you can include code that prepares for the error by storing
a default value in an instance variable. Then the Error event script can return
that value in place of the failed expression.
There are three elements to this technique: the declaration of an instance
variable, the script that sets the variable’s default value and then accesses a
DataWindow property, and the Error event script. These elements are shown in
Example 2 below.
466 PowerBuilder
Responding to errors You can prevent the application from terminating by handling the DataWindow
in a try-catch block runtime error (DWRuntimeError) in a try-catch block. If you are trying to find
out a property value and you know the expression might cause an error, you can
include code that automatically assigns a valid default value that can be
substituted for the failed expression, as in Example 2 below.
Examples Example 1 This code displays complete information about the error in a
multilineedit mle_1.
The error event script:
mle_1.text = &
"error#: " + string(errornumber) + "~r~n" + &
"text: " + errortext + "~r~n" + &
"parent: " + errorwindowmenu + "~r~n" + &
"object: " + errorobject + "~r~n" + &
"line: " + string(errorline) + "~r~n"
action = ExceptionIgnore!
The try-catch block:
Try
... //DataWindow property expression
Catch (DWRuntimeError myExc)
mle_1.text = &
"error#: " + string(myExc.number) + "~r~n" +&
"text: " + myExc.text + "~r~n" + &
"script: " + myExc.routinename + "~r~n" + &
"object: " + myExc.objectname + "~r~n" + &
"line: " + string(myExc.line) + "~r~n"
End Try
If the correct evaluation of the expression is not critical to the application, the
application continues without terminating.
Example 2 This example provides a return value that will become the
expression’s value if evaluation of the expression causes an error.
There are three elements to code in the error event script. The instance variable
is a string:
string is_dwvalue
This script for a button or other control stores a valid return value in an instance
variable and then accesses a DataWindow property:
is_dwvalue = "5"
ls_border = dw_1.Object.id.Border
The Error event script uses the instance variable to provide a valid return value:

action = ExceptionSubstituteReturnValue!
returnvalue = is_dwvalue
The try-catch block:
try
ls_border = dw_1.Object.id.Border
catch (DWRuntimeError myDWError)
ls_border = "5"
end try
At runtime, if the id column does not exist or some other error occurs, then the
expression returns a valid border value—here the string "5". If you are using
the Error event instead of a try-catch block, you must first store the value in an
instance variable.
PowerBuilder syntax for DataWindow property expressions

The following sections describe syntax for property expressions:
• Basic syntax for DataWindow property expressions in PowerBuilder on
page 468
• Syntax for nested objects in DataWindow property expressions in
PowerBuilder on page 471
Basic syntax for DataWindow property expressions in PowerBuilder

Description DataWindow property expressions in PowerBuilder use dot notation to specify
the controls and properties that you want to access.
Syntax dwcontrol.Object.dwcontrolname { .property } .property { = value }
which you want to get or set properties.
Object Object indicates that subsequent elements refer to the
DataWindow object within dwcontrol.
468 PowerBuilder
dwcontrolname a control within the DataWindow object. Possible values are
DataWindow (for properties that apply to the whole DataWindow)
or the name of a column, computed field, graph, line, oval,
picture, rectangle, roundrectangle, report, TableBlob, or text
control.
Nested DataWindow objects

If dwcontrolname is a column with the DropDownDataWindow
style, a report, or an OLE Object control, you can specify another
Object keyword and dwcontrolname to refer to properties of
controls within the nested DataWindow object. You can specify
Object.dwobjectname as many times as needed to refer to a deeply
nested report.
For nested syntax, see Syntax for nested objects in DataWindow
property expressions in PowerBuilder on page 471.
property A property that applies to dwcontrolname. If the property requires

additional qualifying properties, list the additional properties,
separating them with a dot.
For lists of applicable properties, see the Property tables at the
beginning of Chapter 3, DataWindow Object Properties.
value A string whose value is to be assigned to the property.
If the property value is a number, value can either be a string
whose value is a number or a numeric datatype. The value is
stored as a string.
If the property value is a yes or no value, value can be either a
string whose value is "yes" or "no" or a boolean value (true or
false). The value is stored as "yes" or "no" strings.
If the property value can be an expression, then value can be a
string that takes the form:
defaultvalue~t DataWindowexpression
where:
• Defaultvalue is any value that is allowed for property.
• DataWindowexpression is an expression that can include
names of controls in the DataWindow and DataWindow
expression functions.
• Defaultvalue and DataWindowexpression are separated by a
tab character (~t).
For examples of DataWindow expressions, see Using
DataWindow expressions as property values on page 451.
Datatype Any. The datatype of the expression is Any, but actual data is a string.

For more information about the expression’s datatype, see Datatypes of

DataWindow property expressions in PowerBuilder on page 461.
Examples Example 1 Boolean property values In this statement, the boolean value false
is stored as the string "no":
dw_1.Object.DataWindow.ReadOnly = false
This statement displays the value of the ReadOnly property (either "yes" or
"no") in the StaticText st_status:
st_status.Text = dw_1.Object.DataWindow.ReadOnly
When you test the value of a property in a relational expression, you must
compare your test value to the stored values. For ReadOnly, stored values are
yes or no, not boolean true or false:
IF dw_1.Object.DataWindow.Readonly = 'yes' THEN
This statement fails because the expression is not boolean:
IF dw_1.Object.DataWindow.Readonly THEN // Not valid
Example 2 Valid values for the Visible property are 0 and 1. You can set the
property to numbers, yes and no, or true and false. Therefore, these three
statements are equivalent:
dw_1.Object.street.Visible = false
dw_1.Object.street.Visible = "NO"
dw_1.Object.street.Visible = 0
Example 3 This example tests whether the X property contains a constant
(which can be converted to a number) or a DataWindow expression. The code
assigns a default value of 50 to the variable li_x, which remains the value if the
property contains an expression the script cannot convert:
integer li_x
IF IsNumber( dw_1.Object.id.X ) THEN
li_x = Integer( dw_1.Object.id.X )
ELSE
li_x = 50
END IF
Example 4 This script sets the X property to a DataWindow expression. The
expression causes IDs with values less than 10 to be indented:
string modstring, ls_x
ls_x = "50"
modstring = ls_x + "~t" + &
"If(id > 10, " + ls_x + "," + &
String(li_x + 20 ) + ")"
470 PowerBuilder
dw_1.Object.id.X = modstring
Example 5 This example makes three columns updatable and reports the
value of the Update property in the StaticText st_status. The reported value is
“yes,” not true:
dw_1.Object.id.Update = true
dw_1.Object.street.Update = true
dw_1.Object.last_name.Update = true
st_status.Text = &
"Updateable: id " + dw_1.Object.id.Update + &
", street " + dw_1.Object.street.Update + &
", last_name " + dw_1.Object.last_name.Update
Example 6 This example checks whether the id column is set up as a spin
control. If so, it sets the spin range to 0 through 10:
IF dw_1.Object.id.EditMask.Spin = "yes" THEN
dw_1.Object.id.EditMask.SpinRange = "0~~~~10"
END IF
Syntax for nested objects in DataWindow property expressions in PowerBuilder

Description In PowerBuilder, DataWindow property expressions use additional Object
keywords to refer to nested objects. Nested objects include composite or
related nested reports and child DataWindows associated with
DropDownDataWindow columns. Related nested and composite reports can
include their own nested objects. You can extend the dot notation to refer to any
level of nesting.
Syntax dwcontrol.Object.nestedcontrolname { [row ] } .Object.dwcontrolname.
property { .property } { = value }
DataWindow in which you want to get or set properties.
Object The Object keyword indicates that subsequent elements
refer to the DataWindow object within dwcontrol.

nestedcontrolname The name of a DropDownDataWindow column, nested
report, or OLE Object control within the DataWindow
object in dwcontrol.
About nested reports

A nested report can be one of a group of reports in the
Composite presentation style or a nested report included in
a base report, which is associated with a specific row.
row When nestedcontrolname is a nested report in a base

report, the number of the row the report is associated with
If the report is in a band other than the detail band, it is still
associated with a row (see Usage below).
dwcontrolname The name of a control within the nested DataWindow
object. Possible values are DataWindow (for properties
that apply to the whole DataWindow) or the name of a
Button, Column, Computed field, Graph, GroupBox, Line,
Oval, Picture, Rectangle, RoundRectangle, Report,
TableBlob, or Text control.
If dwcontrolname is a column with the
DropDownDataWindow style, a Report control, or an OLE
Object control, you can specify an additional Object
keyword and dwcontrolname to refer to properties of
controls within the nested DataWindow object. You can
specify Object.dwcontrolname as many times as needed to
refer to a control in a deeply nested DataWindow object.
property A property that applies to dwcontrolname. If the property
requires additional qualifying properties, list the additional
properties, separating them with a dot.
For lists of applicable properties, see the Property tables in
value A string whose value is to be assigned to the property
For more information, see Basic syntax for DataWindow
property expressions in PowerBuilder on page 468.
Datatype Any. The datatype of the expression is Any, but the actual data is a string.
For more information about the expression’s datatype, see Datatypes of
DataWindow property expressions in PowerBuilder on page 461.
472 PowerBuilder
Usage A nested report within a base report is usually in the detail band, and each
instance of the report is associated with a row. The property expression must
include a row number to identify which report to access. If the nested report is
in a band other than detail, there may be only one or a few instances of the
report, but it is still associated with a row. The expression must include a row
number that has an instance of the report.
The following table lists the band and the row that is associated with the report:
If the report is in this band This row is associated with the report
detail The specified row.
header The first row on the page. On screen, this is the
first row visible in the DataWindow body.
footer The last row on the page. On screen, this is the
last row visible in the DataWindow body.
header.n (group header) The first row of the group (where n is the group
number).
trailer.n (group trailer) The last row of the group (where n is the group
number).
summary The last row in the report.
Examples Example 1 Suppose that a DataWindow has the Composite presentation style
and includes a report called rpt_employee. The report includes a column
emp_id. This expression gets the validation expression for the column:
string ls_valid
ls_valid = dw_composite.Object.rpt_employee.&
Object.emp_id.Validation
Example 2 In a Composite DataWindow, one of the reports rpt_1 has a graph
gr_1. This example turns on grid lines for the category axis of that graph. The
example sets an instance variable to a default value of “not found.” If the
expression fails and triggers the Error event, the
ExceptionSubstituteReturnValue! action causes the text “not found” to be
returned so that the second assignment succeeds:
is_dwvalue = "not found"
dw_1.Object.rpt_1.Object.&
gr_1.Category.MajorGridline = 5
st_status.Text = dw_1.Object.rpt_1.Object.&
gr_1.Category.MajorGridline
The script for the Error event includes these lines:
action = ExceptionSubstituteReturnValue!
returnvalue = is_dwvalue

Example 3 Suppose that a DataWindow called dw_emp is a base report with

employee information. The detail band includes a nested report of salary
history called rpt_salary. This means there is a separate report with its own
properties in each row.
The script checks whether the employee belongs to management (the value in
the rank column in the base report is M). If so, the script assigns a DataWindow
expression to the Color property of the salary column in the rpt_salary nested
report. The expression highlights salaries that are over $60,000 in red.
Another statement sets the salary column’s Mode property so the color change
will be visible:
integer li_row
FOR li_row = 1 to RowCount( )

IF dw_emp.Object.rank.Primary[li_row] = "M" THEN
dw_emp.Object.rpt_salary[li_row].Object.&
salary.Background.Color = &
'255 ~t If(salary > 60000, 255, 0)'
dw_emp.Object.rpt_salary[li_row].Object.&
salary.Background.Mode = 0
END IF
NEXT
Example 4 In this example there is a graph in the summary band of a base
report called dw_emp. The graph is a nested report called rpt_graph_salaries.
Although the graph is not related to a particular row, you still need to provide
the row number associated with the summary band when you refer to its
properties. This statement turns on autoscaling for the values axis:
dw_emp.Object.rpt_graph_salaries.Object.&
gr_1.Values.AutoScale = 1
Example 5 If a column has a DropDownDataWindow edit style, there are
properties that affect the column’s appearance. Using nested object syntax, you
can also change properties of the child DataWindow for the column. In this
example, the DataWindow dw_gift allows a clerk at a nonprofit organization
to record donations. The clerk can pick a standard donation amount from a
drop-down DataWindow.
This example makes the drop-down DataWindow column called amount a
required value and changes the display format for the dollars column in the
child DataWindow:
474 PowerBuilder
dw_gift.Object.amount.dddw.Required = "Yes"
dw_gift.Object.amount.Object.dollars.Format = "$#,##0"
JavaScript: Modify and Describe methods for

properties
In JavaScript, you can get and set DataWindow properties with the Describe
and Modify methods. Property expressions and DWObject variables are not
supported.
These sections describe how to use Modify and Describe in JavaScript:
• Advantage and drawbacks of the Modify and Describe methods in
JavaScript on page 475
• Handling errors for Modify and Describe methods in JavaScript on page
476
Advantage and drawbacks of the Modify and Describe methods in

JavaScript
In JavaScript, using the Describe and Modify methods to access DataWindow
property values has advantages and drawbacks. The examples here use Modify
as illustrations, but similar considerations apply to Describe.
Advantage You can specify column and property names dynamically In your script,
you can build a string that specifies the column and property names.
For example, the following code builds a string in which the default color value
and the two color values in the If function are determined in the script. Notice
how the single quotes around the expression are included in the first and last
pieces of the string:
red_amount = parseInt(text_1.value);
if (red_amount >= 0 and red_amount < 256) {
modstring = "emp_id.Color='"
+ text_1.value
+ "\t If(emp_status=~'A~',"
+ 255
+ ","
+ text_1.value
+ ")'";

JavaScript: Modify and Describe methods for properties
dw_1.Modify(modstring)
The resulting string when red_amount is set to 128 is:
emp_id.Color='128\tIf(emp_status=~'A~',255,128)'
The following is a simpler example without the If function. The Color property
for the column specified in ls_columnname is set to a constant value. You do
not need quotes around the value if you are not specifying an expression:
dw_1.Modify(ls_columnname + ".Color=255");
Drawbacks Setting several properties at once is possible but hard to debug
Although you can set several properties in a single method call, it is harder to
understand and debug scripts that do so.
For example, the code for setting three properties is not too complex because
there are no nested strings:
oval_1.Background.Color=255");
Complex quoted strings are sometimes required When you specify an
expression for a property value, it is difficult to specify nested quotes
correctly—the code is hard to understand and prone to error. For Describe, this
is less of a drawback—strings will not become as complex because they do not
include an expression.
For example, this string entered on a single line in a script assigns a
DataWindow expression to the Color property:
Modify("emp_id.Color=\"16777215 \t
If(emp_status=~~\"A~~\",255,16777215)\"");
For more information about quoted strings, see the PowerScript Reference.
Handling errors for Modify and Describe methods in JavaScript

In all environments, including JavaScript, no runtime error occurs when
Describe and Modify try to access invalid controls or properties in the
DataWindow object. The validity of the argument string is evaluated before the
controls are accessed.
Modify When the string that specifies the control and property to be accessed is invalid,
Modify returns an error string, instead of the expected value, such as:
Line 1 Column 12: incorrect syntax.
476 PowerBuilder
You can use the error message to figure out what part of the string is incorrect.
This is most useful when you are testing your scripts. The error message, which
names the line and column number after which the string was not recognized,
may not be helpful after your application is deployed.
Describe When the string for Describe has an unrecognized property, Describe’s return
value ends with an exclamation point (!). It will return as many values as it
recognizes up to the incorrect one.
When you specify a valid property but that property doesn’t have a value
(either because it hasn’t been set or because its value is an expression that can’t
be evaluated), Describe returns a question mark (?) for that property. The
property’s actual value is null.
Always check for errors

You should include error-checking code that checks for these return values.
Other errors can occur later if you depend on settings that failed to take effect.
For more information For more information on syntax and usage, see Describe and Modify in Chapter
9, Methods for the DataWindow Control.

JavaScript: Modify and Describe methods for properties
478 PowerBuilder
C H A P T E R 6 DataWindow Constants
About this chapter This chapter lists the PowerBuilder enumerated datatypes that provide
constants for setting DataWindow property values.
Contents
Topic Page
About DataWindow constants 479
Alphabetical list of DataWindow constants 480
About DataWindow constants

About constants This section lists the constants that are defined in the DataWindow control
for values of properties and arguments for methods. Constants have both
a name and a numeric value.
What values to use PowerBuilder In PowerBuilder, constants are defined as sets of values
associated with enumerated datatypes. Values for enumerated datatypes
always end with an exclamation point. When an enumerated datatype is
specified as the datatype, you must use the enumerated value. You cannot
use the numeric equivalent.
dw1.BorderStyle = StyleRaised!
JavaScript In JavaScript, you must use the numeric value. The named
values are not available.
DataWindow object properties When setting DataWindow properties
in PowerBuilder, you use the numeric value in quoted strings.
How this section is This section lists the values according to the PowerBuilder enumerated
organized datatypes, so you can see which values are available for setting a
particular type of data. If you know a value’s name but not the enumerated
datatype it belongs to, you can find the value in the index of this book.

Alphabetical list of DataWindow constants
Alphabetical list of DataWindow constants

This section groups DataWindow constants according to enumerated datatype.
Enumerated datatype Page
AccessibleRole 480
Alignment 483
Band 483
Border 483
BorderStyle 484
CharSet 485
DWBuffer 485
DWConflictResolution 486
DWItemStatus 486
FillPattern 487
grColorType 488
grDataType 488
grObjectType 489
grObjectType 490
LineStyle 490
MetaDataType 491
RichTextToolbarActivation 491
RowFocusInd 492
SaveAsType 492
SQLPreviewFunction 494
SaveMetaData 494
SQLPreviewType 495
WebPagingMethod 495
AccessibleRole
Description Values for specifying the AccessibleRole property for DataWindows and
controls in DataWindows.
Values Use the numeric values with the AccessibleRole DataWindow object property
PowerBuilder enumerated value Numeric value
DefaultRole! 0
480 PowerBuilder
CHAPTER 6 DataWindow Constants

HelpBalloonRole!
TitleBarRole! 31 1
CharacterRole!
MenuBarRole! 32 2
ListRole!
ScrollBarRole! 33 3
ListItemRole!
GripRole! 34 4
OutlineRole!
SoundRole! 35 5
OutlineItemRole!
CursorRole! 36 6
PageTabRole!
CaretRole! 37 7
AlertRole! 8
WindowRole! 9
ClientRole! 10
MenuPopupRole! 11
MenuItemRole! 12
ToolTipRole! 13
ApplicationRole! 14
DocumentRole! 15
PaneRole! 16
ChartRole! 17
DialogRole! 18
BorderRole! 19
GroupingRole! 20
SeparatorRole! 21
ToolBarRole! 22
StatusBarRole! 23
TableRole! 24
ColumnHeaderRole! 25
RowHeaderRole! 26
ColumnRole! 27
RowRole! 28
CellRole! 29
LinkRole! 30

AccessibleRole

HelpBalloonRole! 31
CharacterRole! 32
ListRole! 33
ListItemRole! 34
OutlineRole! 35
OutlineItemRole! 36
PageTabRole! 37
482 PowerBuilder
Alignment
Description Values for specifying the alignment of text in DataWindow columns or text
controls.
Values Use the numeric values with the Alignment DataWindow object property.
PowerBuilder
enumerated Numeric
value value Meaning
Left! 0 Text is left aligned.
Right! 1 Text is right aligned.
Center! 2 Text is centered.
Justify! 3 Wrapped text is justified. The last line of text is not
stretched to fill the area. So for a single line of text,
justified alignment will appear to have no effect.
See also Alignment on page 185
Band
Description Values identifying the band containing the insertion point in a DataWindow
control.
In PowerBuilder, band values are returned by the Position method for a
RichTextEdit DataWindow.
Values
PowerBuilder Numeric
enumerated value value Meaning
Detail! 0 The detail band
Header! 1 The header band
Footer! 2 The footer band
Border
Description Values identifying the border style for a column in a DataWindow.

BorderStyle
Used in the GetBorderStyle and SetBorderStyle methods and the Border

property for DataWindow columns.
Values
PowerBuilder
enumerated Numeric
value value Meaning
NoBorder! 0 No border.
ShadowBox! 1 Each data value is in a box that has a drop shadow
Box! 2 Each data value is surrounded by a rectangular
border with no shading
ResizeBorder! 3 The column is resizable; the user can grab the border
around any data value and drag it
Underline! 4 Each data value in the column is underlined
Lowered! 5 Each data value has a 3D border with shading to
make it look lowered
Raised! 6 Each data value has a 3D border with shading to
make it look raised
See also Border on page 203

GetBorderStyle
SetBorderStyle
BorderStyle
Description Values for specifying the border style of the DataWindow control.
PowerBuilder only. Used for the Border property of the DataWindow control.
Values
PowerBuilder
enumerated Numeric
value value Meaning
StyleBox! 2 The DataWindow control is surrounded by a
rectangular box without any shading
StyleLowered! 5 The control has a 3D border with shading to make
it look lowered
StyleRaised! 6 The control has a 3D border with shading to make
it look raised
StyleShadowBox! 1 The control has a rectangular border with a drop
shadow
484 PowerBuilder
See also Border on page 203
CharSet
Description Values for specifying the character set used in the DataWindow.
Generally, the value for CharSet is derived from the font selected for controls
within the DataWindow.
Values are used with the Font.CharSet DataWindow object property. Use the
numeric values, not the enumerated values, for DataWindow object properties.
Values
— 1 The default character set for the specified font
CharSetAnsi! 0 Standard ANSI
CharSetUnicode! Unicode
CharSetAnsiHebrew! Right-to-left Hebrew
CharSetAnsiArabic! Right-to-left Arabic
CharSetDBCS- Double-byte Japanese
Japanese!
— 2 Symbol
— 128 Shift-JIS
— 255 OEM
See also Font.property
DWBuffer
Description Values for specifying the DataWindow buffer containing the rows you want to
access.
Used in many DataWindow methods that access data.

DWConflictResolution
Values
PowerBuilder
enumerated Numeric
value value Meaning
Primary! 0 The data in the primary buffer, meaning
data that has not been deleted or filtered
out. (Default value when argument is
optional.)
Delete! 1 Data in the delete buffer, meaning data
that has been deleted from the
DataWindow but has not been committed
to the database.
Filter! 2 Data in the filter buffer, meaning data that
has been removed from view.
See also GetItemStatus

SetItem
DWConflictResolution
Description Values for specifying how to handle potential conflicts when synchronizing
DataWindows in a distributed application.
Values
FailOnAnyConflict! 0 Prevents changes from being synchronized if
data in the source DataWindow has changed
since its state was captured. (Default value
when argument is optional.)
AllowPartialChanges! 1 Allows changes that are not in conflict to be
applied.
See also SetChanges on page 804 explains how to test whether conflicts exist.
DWItemStatus
Description Values for specifying how DataWindow data will be updated in the database.
486 PowerBuilder
Values
PowerBuilder
enumerated Numeric
value value Meaning
NotModified! 0 The information in the row or column is
unchanged from what was retrieved.
DataModified! 1 The information in the column or one of
the columns in the row has changed since
it was retrieved.
New! 2 The row is new but no values have been
specified for its columns. (Applies to rows
only, not to individual columns.)
NewModified! 3 The row is new, and values have been
assigned to its columns. In addition to
changes caused by user entry or the
SetItem method, a new row gets the status
NewModified when one of its columns has
a default value. (Apples to rows only, not
to individual columns.)
See also SetItemStatus on page 827 describes how to change individual item statuses
and how the status affects the SQL statements that update the database.
FillPattern
Description Values for the fill pattern of shapes (for example, bars or pie slices) in a graph
control.
Used in Get/SetSeriesStyle and Get/SetDataStyle methods for graph controls in
a DataWindow or PowerBuilder graph controls.
Values
PowerBuilder
enumerated Numeric
value value Meaning
Solid! 0 A solid color
Horizontal! 1 Horizontal lines
Vertical! 2 Vertical lines
FDiagonal! 3 Lines from upper left to lower right
BDiagonal! 4 Lines from lower left to upper right

grColorType
PowerBuilder
enumerated Numeric
value value Meaning
Square! 5 A pattern of squares
Diamond! 6 A pattern of diamonds
See also GetDataStyle

GetSeriesStyle
SetDataStyle
SetSeriesStyle
grColorType
Description Values for specifying the purpose of a color in a graph, for example,
background or foreground.
a DataWindow or for PowerBuilder graph controls.
Values
PowerBuilder
enumerated Numeric
value value Meaning
Foreground! 0 Text (fill color)
Background! 1 The background color
Shade! 2 The shaded area of three-dimensional graphics
LineColor! 3 The color of the line

GetSeriesStyle
SetDataStyle
SetSeriesStyle
grDataType
Description Values for specifying X or Y value when getting information about a scatter
graph.
488 PowerBuilder
Used in the GetData method for graph controls in a DataWindow or for

PowerBuilder graph controls.
Values
PowerBuilder
enumerated Numeric
value value Meaning
yValue! 1 (Default) The y value of the data point
xValue! 0 The x value of the data point
See also GetData
grObjectType
Description Values that identify parts of a graph.
Used as the return value of the ObjectAtPointer method for graph controls in a
DataWindow or for PowerBuilder graph controls.
Values
TypeGraph! 0 Any place within the graph control that isn’t
another grObjectType
TypeTitle! 4 The title of the graph
TypeLegend! 8 Within the legend box, but not on a series
label
TypeData! 2 A data point or other data marker
TypeCategory! 3 A label for a category
TypeCategoryAxis! 10 The category axis or between the category
labels
TypeCategoryLabel! 6 The label of the category axis
TypeSeries! 1 The line that connects the data points of a
series when the graph’s type is line or on the
series label in the legend box
TypeSeriesAxis! 9 The series axis of a 3D graph
TypeSeriesLabel! 5 The label of the series axis of a 3D graph
TypeValueAxis! 11 The value axis, including on the value labels
TypeValueLabel! 7 The user clicked the label of the value axis
See also ObjectAtPointer

grSymbolType
grSymbolType
Description Values for the symbols associated with data points in a graph.
Values
NoSymbol! 0 None
SymbolHollowBox! 1 A hollow box
SymbolX! 2 An X
SymbolStar! 3 A star
SymbolHollowUpArrow! 4 An outlined up arrow
SymbolHollowDownArrow! 5 An outlined down arrow
SymbolHollowCircle! 6 An outlined circle
SymbolHollowDiamond! 7 An outlined diamond
SymbolSolidBox! 8 A filled box
SymbolSolidDownArrow! 9 A filled down arrow
SymbolSolidUpArrow! 10 A filled up arrow
SymbolSolidDiamond! 11 A filled diamond
SymbolSolidCircle! 12 A filled circle
SymbolPlus! 13 A plus sign

GetSeriesStyle
SetDataStyle
SetSeriesStyle
LineStyle
Description Values for the pattern of lines in a graph.
490 PowerBuilder
Values
PowerBuilder
enumerated Numeric
value value Meaning
Continuous! 0 The line style is a solid line
Dash! 1 The line style is ----
DashDot! 2 The line style is -.-.-.
DashDotDot! 3 The line style is -..-..-..
Dot! 4 The line style is .....
Transparent! 5 The line allows the background shapes to show
through

GetSeriesStyle
SetDataStyle
SetSeriesStyle
MetaDataType
Description Values that specify whether metadata is saved when XML is exported from a
DataWindow object.
Values
XMLNone! 0 Metadata (XML Schema or DTD) is not
generated when XML is exported
XMLSchema! 1 XML Schema is generated when XML is
exported
XMLDTD! 2 DTD is generated when XML is exported
See also SaveMetaData
RichTextToolbarActivation
Description Values for specifying when a font toolbar appears for a DataWindow.

RowFocusInd
Values
RichTextToolbarActivation 0 Never displays a rich text toolbar.
Never!
RichTextToolbarActivation 1 Displays a rich text toolbar whenever a
OnEdit! column with the rich text edit style has
focus. This is the default setting.
RichTextToolbarActivation 2 Displays a rich text toolbar at all times
Always! when the DataWindow is visible.
RowFocusInd
Description Values for specifying the indicator for the current row in a DataWindow.
Used in the SetRowFocusIndicator method for DataWindow controls.
Values
PowerBuilder
enumerated Numeric
value value Meaning
Off! 0 There is no indicator for the current row
FocusRect! 1 The row with focus has a dotted rectangle around it
Hand! 2 A pointing hand appears in the left margin of the
DataWindow beside the row with focus
See also SetRowFocusIndicator
SaveAsType
Description Values for specifying a format for data you want to save.
Used in the SaveAs method for saving the data of a DataWindow, a graph
control in a DataWindow, or a PowerBuilder graph control.
Values
Excel! 0 Microsoft Excel format.
492 PowerBuilder
Text! 1 (Default) Tab-separated columns with a
return at the end of each row
CSV! 2 Comma-separated values
SYLK! 3 Microsoft Multiplan format
WKS! 4 Lotus 1-2-3 format
WK1! 5 Lotus 1-2-3 format
DIF! 6 Data Interchange Format
dBASE2! 7 dBASE-II format
dBASE3! 8 dBASE-III format
SQLInsert! 9 SQL syntax
Clipboard! 10 Save an image of the graph to the
clipboard
PSReport! 11 Powersoft Report (PSR) format
WMF! 12 Windows Metafile format
HTMLTable! 13 HTML TABLE, TR, and TD elements
Excel5! 14 Microsoft Excel Version 5 format
XML! 15 Extensible Markup Language (XML)
XSLFO! 16 Extensible Stylesheet Language
Formatting Objects (XSL-FO)
PDF! 17 Portable Document Format (PDF)
Excel8! 18 Microsoft Excel Version 8 and higher
format
EMF! 19 Enhanced Metafile Format
XLSX! 24 Microsoft Excel 2007 format for XML
data (requires .NET Framework 3.0 or
later)
XLSB! 25 Microsoft Excel 2007 format for binary
data (requires .NET Framework 3.0 or
later)
Obsolete values
The following SaveAsType values are considered to be obsolete and will be
removed in a future release: Excel!, WK1!, WKS!, SYLK!, dBase2!, WMF!.
Use Excel8!, XLSB!, or XLSX! for current versions of Microsoft Excel!, and
EMF! in place of WMF!.

SQLPreviewFunction
Formats supported on UNIX The following formats are supported in

PowerBuilder components deployed to the UNIX platform: Text!, CSV!,
SQLInsert!, HTMLTable!, XML!, XSLFO!, and PDF!.
The following formats are not supported on UNIX: PSReport!, Excel!,
Excel5!, Excel8!, SYLK!, WKS!, WK1!, DIF!, dBase2!, dBase3!, Clipboard!,
WMF!, EMF!, XLSB!,and XLSX!.
PSR format changed The format of PSR files created in PowerBuilder has
changed in order to improve data integrity for the SaveAsAscii function. As a
result, PSR files created in newer builds of PowerBuilder cannot be opened in
builds that predate this change. This change was made in PowerBuilder 8.0
build 7063 and PowerBuilder 7.0.3 build 10102.
See also SaveAs
SQLPreviewFunction
Description Values passed to the SQLPreview DataWindow event to indicate what method
triggered the event.
Values
PowerBuilder
enumerated Numeric
value value Meaning
PreviewFunction 1 The program called the DataWindow Retrieve
Retrieve! method
PreviewFunction 2 The program called the DataWindow
ReselectRow! ReselectRow method
PreviewFunction 3 The program called the Datawindow Update
Update! method
See also SQLPreview
SaveMetaData
Description Values that specify how metadata is saved when it is generated with the XML
exported from a DataWindow object.
494 PowerBuilder
Values
MetaDataInternal! 0 Metadata is saved into the generated XML
document or string. To save data using the
.Data.XML expression syntax, you must
use this value.
MetaDataExternal! 1 Metadata is saved as an external .xsd or
.dtd file (SaveAs method only).
See also MetaDataType
SQLPreviewType
Description Values passed to the SQLPreview DataWindow event to indicate what SQL
statement is being sent to the DBMS.
Values
PowerBuilder
enumerated Numeric
value value Meaning
PreviewSelect! 1 A SELECT statement
PreviewInsert! 2 An INSERT statement
PreviewDelete! 3 A DELETE statement
PreviewUpdate! 4 An UPDATE statement
See also SQLPreview
WebPagingMethod
Description Values that specify how the Web DataWindow handles paging requests.
Obsolete constant
WebPagingMethod is obsolete and should not be used, because the Web

WebPagingMethod
Values
Postback! 0 Post back to server to perform paging
operations
Callback! 1 Use script callbacks to retrieve the next
page of XML data
XMLClientside! 2 Retrieve entire result set and use XSLT
transformation of cached stylesheet to
perform paging operations on the client
496 PowerBuilder
C H A P T E R 7 Properties of the DataWindow
Control and DataStore
About this chapter The chapter lists the properties of the DataWindow control and DataStore.
These properties can be set in code to control the appearance and behavior
of the container for the DataWindow object.
Properties for PowerBuilder DataWindow

These properties are also documented in the PowerBuilder book Objects
and Controls.
Properties for DataStore objects

You can set properties of a DataStore object in code using dot notation.
Table 7-1: Setting DataStore properties using dot notation
DataStore property Datatype Description
DataObject String Specifies the name of the DataWindow or Report object associated
with the control.
ClassDefinition PowerObject An object of type PowerObject containing information about the
class definition of the object or control.
Object DWObject Used for the direct manipulation of controls within a DataWindow
object from a script. These controls could be, for example, columns
or text controls.
For information, see Chapter 4, Accessing Data in Code and
Chapter 5, Accessing DataWindow Object Properties in Code.

Properties for DataWindow controls

You can set properties of a DataWindow control in the window or user object
painter or in code.
Table 7-2: Properties of DataWindow controls
DataWindow
property Datatype Description
Border Boolean Specifies whether the control has a border. Values are:
• True – Control has a border.
• False – Control does not have a border.
BorderStyle BorderStyle Specifies the border style of the control. Values are:
(enumerated) StyleBox!
StyleLowered!
StyleRaised!
StyleShadowBox!
BringToTop Boolean Specifies whether PowerBuilder moves the control to the top of the
front-to-back order.
ClassDefinition PowerObject An object of type PowerObject containing information about the
class definition of the object or control.
ControlMenu Boolean Specifies whether the Control Menu box displays in the control
title bar. Values are:
• True – Control Menu box displays in the control title bar.
• False – Control Menu box does not display in the control title
bar.
DataObject String Specifies the name of the DataWindow object or Report object
associated with the control.
DragAuto Boolean Specifies whether PowerBuilder puts the control automatically into
Drag Mode. DragAuto has these boolean values:
• True – When the control is clicked, the control is automatically
in Drag Mode.
• False – When the control is clicked, the control is not
automatically in Drag Mode. You have to manually put the
control into Drag Mode by using the Drag function.
DragIcon String Specifies the name of the stock icon or the file containing the icon
you want to display when the user drags the control (the ICO file).
The default icon is a box the size of the control.
When the user drags the control, the icon displays when the control
is over an area in which the control can be dropped (a valid drop
area). When the control is over an area that is not a valid drop area,
the No-Drop icon displays.
498 PowerBuilder
CHAPTER 7 Properties of the DataWindow Control and DataStore
DataWindow
Enabled Boolean Specifies whether the control is enabled (can be selected). Values
are:
• True – Control is enabled.
• False – Control is not enabled.
Height Integer Specifies the height of the DataWindow control, in PowerBuilder
units.
HScrollBar Boolean Specifies whether a horizontal scroll bar displays in the control
when all the data cannot be displayed at one time. Values are:
• True – Horizontal scroll bar is displayed.
• False – Horizontal scroll bar is not displayed.
HSplitScroll Boolean Specifies whether the split bar displays in the control. Values are:
• True – Split bar is displayed.
• False – Split bar is not displayed.
Icon String Specifies the name of the ICO file that contains the icon that
displays when the DataWindow control is minimized.
LiveScroll Boolean Scrolls the rows in the DataWindow control while the user is
moving the scroll box.
MaxBox Boolean Specifies whether a Maximize Box displays in the DataWindow
control title bar. Values are:
• True – Maximize Box displays.
• False – Maximize Box does not display.
MinBox Boolean Specifies whether a Minimize Box displays in the DataWindow
control title bar. Values are:
• True – Minimize Box displays.
• False – Minimize Box does not display.
Object DWObject Used for the direct manipulation of controls within a DataWindow
object from a script. These controls could be, for example, columns
or text controls.
For information, see Chapter 4, Accessing Data in Code and
Chapter 5, Accessing DataWindow Object Properties in Code.
Resizable Boolean Specifies whether the DataWindow control is resizeable. Values
are:
• True – DataWindow is resizeable.
• False – DataWindow is not resizeable.

DataWindow
RightToLeft Boolean Specifies that characters should be displayed in right-to-left order.
The application must be running on a Hebrew or Arabic version of
PowerBuilder under an operating system that supports right-to-left
display. Values are:
• True – Characters display in right-to-left order.
• False – Characters display in left-to-right order.
TabOrder Integer Specifies the tab value of the DataWindow control within the
window or user object. (0 means the user cannot tab to the control.)
Tag String Specifies the tag value assigned to the DataWindow control.
Title String Specifies the text that displays in the DataWindow control title bar.
TitleBar Boolean Specifies whether a title bar displays in the DataWindow control.
The user can move the DataWindow control only if it has a title bar.
Values are:
• True – Title bar is displayed in control.
• False – No title bar is displayed in control.
Visible Boolean Specifies whether the DataWindow control is visible. Values are:
• True – Control is visible.
• False – Control is not visible.
VScrollBar Boolean Specifies whether a vertical scroll bar displays in the control when
not all the data can be displayed at one time. Values are:
• True – Vertical scroll bar is displayed.
• False – Vertical scroll bar is not displayed.
Width Integer Specifies the width of the DataWindow control, in PowerBuilder
units.
X Integer Specifies the X position (the distance from the left edge of the
window), in PowerBuilder units.
Y Integer Specifies the Y position (the distance from the top edge of the
window), in PowerBuilder units.
500 PowerBuilder
C H A P T E R 8 DataWindow Events
About this chapter This chapter describes what DataWindow objects are and the ways you
can use them in various programming environments.
Contents
Topic Page
About return values for DataWindow events 501
Categories of DataWindow events 502
DataWindow event cross-reference 503
Alphabetical list of DataWindow events 503
About return values for DataWindow events

The way to specify a return code in a DataWindow event is different in
each of the DataWindow environments.
PowerBuilder Use a RETURN statement as the last statement in the event script. The
datatype of the value is long.
For example, in the ItemChanged event, set the return code to 2 to reject
an empty string as a data value:
IF data = "" THEN
RETURN 2
Java Use the setReturnCode method of the event object passed to the event. The
datatype of the value is int. The setReturnCode method is inherited from
the parent EventData class.
For example, in the retrieveStart event, prevent the DataWindow from
being reset, so that the newly retrieved rows as appended to the rows
already retrieved:
event.setReturnCode(2);

Categories of DataWindow events
Categories of DataWindow events

The reference entries are listed in alphabetical order. To help you find the event
you need, the events are organized here by the type of actions that trigger them.
Changing data EditChanged
ItemChanged
ItemError
DropDown for drop-down lists
Database access DBError
RetrieveStart
RetrieveRow
RetrieveEnd
SQLPreview
UpdateStart
UpdateEnd
Error handling DBError
Error
ItemError
WSError
Focus GetFocus
LoseFocus
ItemFocusChanged
RowFocusChanging
RowFocusChanged
Key presses KeyDown
ProcessEnter
TabOut
BackTabOut
TabDownOut
TabUpOut
Mouse actions ButtonClicked
ButtonClicking
Clicked
DoubleClicked
DragDrop
DragEnter
DragLeave
DragWithin
MouseMove
MouseUp
502 PowerBuilder
CHAPTER 8 DataWindow Events
RButtonDown
Printing PrintStart
PrintPage
PrintMarginChange
Printend
Rich Text RichTextCurrentStyleChanged
RichTextLoseFocus
RichTextLimitError
Scrolling ScrollHorizontal
ScrollVertical
TreeView actions Collapsed
Collapsing
Expanded
Expanding
TreeNodeSelected
TreeNodeSelecting
Miscellaneous Constructor
Destructor
Resize
GraphCreate for Graph controls and presentation styles
HTMLContextApplied (obsolete)
MessageText for crosstab DataWindows
DataWindow event cross-reference

Event names conform to the conventions of each environment. Events for
PowerBuilder DataWindow objects and DataStores are listed in Objects and
Controls. (In online Help, look up DataWindow control or DataStore object,
and click the Events button to view these lists.)
Alphabetical list of DataWindow events

The list of DataWindow events follows in alphabetical order.

BackTabOut
BackTabOut
Description Occurs when the user presses Shift+Tab or, in some edit styles, the left arrow,
to move focus to the prior control in the Window or user object.
PowerBuilder event information
Event ID: pbm_dwnbacktabout
BackTabOut is not a standard PowerBuilder DataWindow event. To write a
script for this event, you must first define a user-defined event for the event ID
pbm_dwnbacktabout.
Return codes There are no special outcomes for this event. The only code is:
0 Continue processing
ButtonClicked
Description Occurs when the user clicks a button inside a DataWindow object.
Event ID: pbm_dwnbuttonclicked
row Long by value. The number of the row the user clicked.
actionreturncode Long by value. The value returned by the action performed
by the button.
For information about return values, see the Action
DataWindow object property.
dwo DWObject by value. A reference to the control within the
DataWindow under the pointer when the user clicked.
Usage The ButtonClicked event executes code after the action assigned to the button
has occurred.
This event is fired only if you have not selected Suppress Event Processing for
the button.
If Suppress Event Processing is on, only the Clicked event and the action
assigned to the button are executed when the button is clicked.
504 PowerBuilder
If Suppress Event Processing is off, the Clicked event and the ButtonClicked
event are fired. If the return code of the ButtonClicking event is 0, the action
assigned to the button is executed and the ButtonClicked event is fired. If the
return code of the ButtonClicking event is 1, neither the action nor the
ButtonClicked event are executed.
Do not use a message box in the Cnlicked event

If you call the MessageBox function in the Clicked event, the action assigned
to the button is executed, but the ButtonClicking and ButtonClicked events are
not executed.
Returning the row number

When you place a button in the DataWindow and use the window’s
ButtonClicked event to return the row number, you will get different results
depending on where you place the button. If the button is in the Detail band, it
returns the number of the row. If the button is in the Header band, it returns the
number of the first row displayed in the DataWindow control. If the button is
in the Summary band, it returns the number of the final row in the list. If the
button is in the Footer band, it returns the number of the last row displayed in
the DataWindow control.
Examples This statement in the ButtonClicked event displays the value returned by the
button’s action:
MessageBox(" ", actionreturncode)
This statement in the ButtonClicked event displays the value returned by the
button’s action:
String ls_Object
String ls_Win
ls_Object = String(dwo.name)
If ls_Object = "cb_close" Then
Close(Parent)
ElseIf ls_Object = "cb_help" Then

ls_win = parent.ClassName()
f_open_help(ls_win)
End If
See also ButtonClicking

ButtonClicking
ButtonClicking
Description Occurs when the user clicks a button. This event occurs before the
ButtonClicked event.
Event ID: pbm_dwnbuttonclicking
Return codes Set the return code to affect the outcome of the event:
0 Execute the action assigned to the button, then trigger the
ButtonClicked event
1 Prevent the action assigned to button from executing and the
ButtonClicked event from firing
For information on setting the return code in a particular environment, see
About return values for DataWindow events on page 501.
Usage Use the ButtonClicking event to execute code before the action assigned to the
button occurs. If the return code is 0, the action assigned to the button is then
executed and the ButtonClicked event is fired. If the return code is 1, the action
and the ButtonClicked event are inhibited.
This event is fired only if you have not selected Suppress Event Processing for
the button.
The Clicked event is fired before the ButtonClicking event.
Do not use a message box in the Clicked event

If you call the MessageBox function in the Clicked event, the action assigned
to the button is executed, but the ButtonClicking and ButtonClicked events are
not executed.
506 PowerBuilder
Returning the row number

When you place a button in the DataWindow and use the window’s
ButtonClicking event to return the row number, you will get different results
depending on where you place the button. If the button is in the Detail band, it
returns the number of the row. If the button is in the Header band, it returns the
number of the first row displayed in the DataWindow control. If the button is
in the Summary band, it returns the number of the final row in the list. If the
button is in the Footer band, it returns the number of the last row displayed in
Examples This statement in the ButtonClicking event displays a message box before
proceeding with the action assigned to the button:
MessageBox(" ", "Are you sure you want to proceed?")
See also ButtonClicked
Clicked
Description Occurs when the user clicks anywhere in a DataWindow control.
Event ID: pbm_dwnlbuttonclk
xpos Integer by value. The distance of the pointer from the left
side of the DataWindow workspace. The distance is given
in pixels.
ypos Integer by value. The distance of the pointer from the top
of the DataWindow workspace. The distance is given in
pixels.
If the user does not click on a row, the value of the row
argument is 0. For example, row is 0 when the user clicks
outside the data area, or in the header, summary, or footer
area.

Clicked
1 Prevent the focus from changing
Usage The DataWindow Clicked event occurs when the mouse button is pressed
down.
The dwo, Name, or object argument provides easy access to the control the user
clicks within the DataWindow. You do not need to know the coordinates of
elements within the DataWindow to program control-specific responses to the
user’s clicks. For example, you can prevent editing of a column and use the
Clicked script to set data or properties for the column and row the user clicks.
A click can also trigger RowFocusChanged and ItemFocusChanged events. A
double-click triggers a Clicked event, then a DoubleClicked event.
For graphs in DataWindow controls, the ObjectAtPointer method provides
similar information about objects within the graph control.
PowerBuilder programming note The xpos and ypos arguments provide the
same values the functions PointerX and PointerY return when you call them for
Examples This code highlights the row the user clicked.
This.SelectRow(row, true)
If the user clicks on a column heading, this code changes the color of the label
and sorts the associated column. The column name is assumed to be the name
of the heading text control without _t as a suffix.
string ls_name
IF dwo.Type = "text" THEN

dwo.Color = RGB(255,0,0)
ls_name = dwo.Name
ls_name = Left(ls_name, Len(ls_name) - 2)
This.SetSort(ls_name + ", A")

This.Sort()
END IF
See also ButtonClicked
ButtonClicking
DoubleClicked
ItemFocusChanged
508 PowerBuilder
RButtonDown
RowFocusChanged
RowFocusChanging
Collapsed
Description Occurs when a node in a TreeView DataWindow has collapsed.
Event ID: pbm_dwncollapsed
row Long by value. The number of the first row in the group to be
collapsed.
grouplevel Long by value. The TreeView level of the group to be collapsed.
Return codes There are no return codes.

Usage A TreeView node collapses when the user clicks the State icon (-) in the
TreeView DataWindow or uses any of the Collapse methods.
The Collapsing event occurs before the Collapsed event.
Examples The following statements in the Collapsed event save the current row and level
to instance variables:
ii_level = grouplevel
ii_row = row
See also Collapsing
Expanded
Collapsing
Description Occurs before a node in a TreeView DataWindow collapses.
Event ID: pbm_dwncollapsing

Constructor
collapsed.
grouplevel Long by value. The TreeView level of the group to be collapsed.
Return codes Set the return code to affect the outcome of the event. Return 0 to continue
processing (collapse the selected node) or return any other value to cancel the
collapse.
Usage A TreeView node collapses when the user clicks the State icon (-) in the
The Collapsing event occurs before the Collapsed event.
Examples The following statements in the Collapsing event script display a message box
that allows the user to cancel the operation. The message box does not display
if the Collapsing event was triggered by the CollapseAll or CollapseLevel
methods:
Integer li_ret
if row <>-1 then

li_ret = MessageBox("Collapsing node", &
"Are you sure you want to collapse this node?", &
Exclamation!, OKCancel!)
IF li_ret = 1 then
return 0
ELSE
RETURN 1
END IF
END IF
See also Collapsed
Expanding
Constructor
Description Occurs when the DataWindow control or DataStore object is created, just
before the Open event for the window that contains the control.
Event ID: pbm_constructor
510 PowerBuilder
Usage You can write code for the Constructor event to affect DataWindow properties
before it is displayed.
Examples This example retrieves data for the DataWindow dw_1 before its window is
displayed:
dw_1.SetTransObject(SQLCA)
dw_1.Retrieve( )
See also Destructor
DBError
Description Occurs when a database error occurs in the DataWindow or DataStore.
Event ID: pbm_dwndberror
sqldbcode Long by value. A database-specific error code.
See your DBMS documentation for information on the
meaning of the code.
When there is no error code from the DBMS, sqldbcode
contains one of these values:
-1 – Cannot connect to the database because of missing
values in the transaction object.
-2 – Cannot connect to the database.
-3 – The key specified in an Update or Retrieve no
longer matches an existing row. This can happen when
another user has changed the row after you retrieved it.
-4 – Writing a blob to the database failed.
sqlerrtext String by value. A database-specific error message.
sqlsyntax String by value. The full text of the SQL statement being
sent to the DBMS when the error occurred.
buffer DWBuffer by value. The buffer containing the row
involved in the database activity that caused the error.
For a list of valid values, see DWBuffer on page 485.

DBError
row Long by value.
The number of the row involved in the database activity
that caused the error (the row being updated, selected,
inserted, or deleted).
0 Display the error message and trigger the Transaction object’s DBError
event if it is defined.
1 Do not display the error message, and trigger the Transaction object’s
DBError event if it is defined.
2 Display the error message and ignore the Transaction object’s DBError
event whether it is defined or not.
3 Do not display the error message and ignore the Transaction object’s
DBError event whether it is defined or not.
Usage By default, when the DBError event occurs in a DataWindow control, it
displays a system error message. You can display your own message and
suppress the system message by specifying a return code of 1 in the DBError
event.
Since DataStores are nonvisual, a system message does not display when the
DBError event occurs in a DataStore. You must add code to the DBError event
to handle the error.
If the row that caused the error is in the Filter buffer, you must unfilter it if you
want the user to correct the problem.
Reported row number

The row number stored in row is the number of the row in the buffer, not the
number the row had when it was retrieved into the DataWindow object.
Obsolete methods in PowerBuilder Information formerly provided by the

DBErrorCode and DBErrorMessage methods is available in the arguments
sqldbcode and sqlerrtext.
Examples This example illustrates how to display custom error messages for particular
database error codes:
CHOOSE CASE sqldbcode
512 PowerBuilder
CASE -195 // Required value is NULL.

MessageBox("Database Problem", &
"Error inserting row " + string(row) &
+ ". Please specify a value for Employee ID.")
CASE ...
// Code to handle other errors
END CHOOSE
RETURN 1 // Do not display system error message

See also Error
ItemError
WSError
Destructor
Description Occurs when the DataWindow control or DataStore object is destroyed,
immediately after the Close event of a window or form.
Event ID: pbm_destructor
Usage The Destructor event destroys the DataWindow control or DataStore object
and removes it from memory. After it has been destroyed, you can no longer
refer to it in other event code. (If you do, a runtime error occurs.)
Restriction on methods
Calling a DataStore method that accesses the underlying DataStore internals
within this event is not a valid coding practice and can fail silently. Such
methods include RowCount, DBCancel, and Modify.
When you issue a DESTROY on a DataStore, the Destructor event is triggered
and a Windows WM_DESTROY message is added to the object’s message
queue. WM_DESTROY invalidates the memory for the DataStore. If the
WM_DESTROY message is handled before the method calls in the Destructor
event, methods that attempt to access the destroyed memory fail silently.

DoubleClicked
See also Constructor
DoubleClicked
Description Occurs when the user double-clicks in a DataWindow control.
Event ID: pbm_dwnlbuttondblclk
xpos Integer by value. The distance of the pointer from the
left side of the DataWindow’s workspace. The distance
is given in pixels.
ypos Integer by value. The distance of the pointer from the
top of the DataWindow’s workspace. The distance is
given in pixels.
row Long by value. The number of the row the user double-
clicked.
If the user did not double-click on a row, the value of the
row argument is 0. For example, row is 0 when the user
double-clicks outside the data area, in text or spaces
between rows, or in the header, summary, or footer area.
dwo DWObject by value. A reference to the control within
the DataWindow the user double-clicked.
Usage The dwo, Name, or DWObject argument provides easy access to the control the
user clicks. You do not need to know the coordinates of elements within the
DataWindow to program control-specific responses to the user’s clicks. For
example, you can prevent editing of a column and use the Clicked event to set
data or properties for the column and row the user clicks.
PowerBuilder programming note The xpos and ypos arguments provide
the same values the functions PointerX and PointerY return when you call them
for the DataWindow control.
Examples This example displays a message box reporting the row and column clicked
and the position of the pointer relative to the upper-left corner of the
DataWindow control:
string ls_columnname
514 PowerBuilder
IF dwo.Type = "column" THEN

ls_columnname = dwo.Name
END IF
MessageBox("DoubleClicked Event", &

"Row number: " + row &
+ "~rColumn name: " + ls_columnname &
+ "~rDistance from top of dw: " + ypos &
+ "~rDistance from left side of dw: " + xpos)
See also Clicked
ItemFocusChanged
RButtonDown
RowFocusChanged
RowFocusChanging
DragDrop
Description PowerBuilder only Occurs when the user drags an object onto the control
and releases the mouse button to drop the object.
Event ID: pbm_dwndragdrop
source DragObject by value. A reference to the control being
dragged.
row Long by value. The number of the row the pointer was over
when the user dropped the object.
If the pointer was not over a row, the value of the row
argument is 0. For example, row is 0 when the pointer is
outside the data area, in text or spaces between rows, or in
the header, summary, or footer area.
dwo DWObject by value. A reference to the control under the
pointer within the DataWindow when the user dropped the
object.

DragEnter
Usage Obsolete methods in PowerBuilder You no longer need to call the

DraggedObject method in a drag event. Use the source argument instead.
Examples This example for the DragDrop event for a DataWindow checks whether the
source object is a DataWindow control. If so, it finds out the current row in the
source and moves it to the target:
DataWindow ldw_Source
IF source.TypeOf() = DataWindow! THEN

ldw_Source = source
IF row > 0 THEN
ldw_Source.RowsMove(row, row, Primary!, &
This, 1, Primary!)
END IF
END IF
See also DragEnter
DragLeave
DragWithin
DragEnter
Description PowerBuilder only Occurs when the user is dragging an object and enters
the control.
Event ID: pbm_dwndragenter
dragged.
See also DragDrop
DragLeave
DragWithin
516 PowerBuilder
DragLeave
Description PowerBuilder only Occurs when the user is dragging an object and leaves
the control.
Event ID: pbm_dwndragleave
dragged.
Examples This example checks the name of the control being dragged and if it is dw_1,
it cancels the drag operation:
IF ClassName(source) = "dw_1" THEN
dw_1.Drag(Cancel!)
END If
See also DragDrop
DragEnter
DragWithin
DragWithin
Description PowerBuilder only Occurs when the user is dragging an object within the
control.
Event ID: pbm_dwndragleave
dragged.

DropDown
row Long by value. The number of the row the pointer is over.
If the pointer is not over a row, the value of the row
argument is 0. For example, row is 0 when the pointer is
outside the data area, in text or spaces between rows, or in
the header, summary, or footer area.
dwo DWObject by value. A reference to the control under the
pointer within the DataWindow.
Usage The DragWithin event occurs repeatedly as the mouse moves within the
control.
Obsolete methods in PowerBuilder You no longer need to call the
See also DragDrop
DragEnter
DragLeave
DropDown
Description Occurs just before the list provided by a DropDownDataWindow is displayed.
Use this event to retrieve new data for the child DataWindow.
A DropDownDataWindow is a drop-down choice list whose data is provided
by retrieving data for another DataWindow. To create a
DropDownDataWindow, you assign the DropDownDataWindow edit style to
a column and associate it with another DataWindow that retrieves the data for
the choice list.
Event ID: pbm_dwndropdown
DropDown is not a standard PowerBuilder DataWindow event. To write a
pbm_dwndropdown.
518 PowerBuilder
EditChanged
Description Occurs for each keystroke the user types in an edit control in the DataWindow.
Event ID: pbm_dwnchanging
row Long by value. The number of the row containing the item
whose value is being changed.
dwo DWObject by value. A reference to the column containing
the item whose value is being changed. Dwo is a reference
to the column control, not the name of the column.
data String by value. The current contents of the DataWindow
edit control.
Examples This example displays the row and column that the user is editing in a
StaticText control:
st_1.Text = "Row " + String(row) &
+ " in column " + dwo.Name
See also ItemChanged
Error
Description PowerBuilder Occurs when an error is found in a data or property expression
for an external object or a DataWindow object. Also occurs when a
communications error is found in a distributed application.
Event ID: None
errornumber Unsigned integer by value (PowerBuilder’s error number).
errortext String, read-only (PowerBuilder’s error message).
errorwindowmenu String, read-only. The name of the window or menu that is the
parent of the object whose script caused the error.
errorobject String, read-only. The name of the object whose script caused
the error.

Error
errorscript String, read-only. The full text of the script in which the error
occurred.
errorline Unsigned integer by value. The line in the script where the
error occurred.
action ExceptionAction by reference.
A value you specify to control the application’s course of
action as a result of the error. Values are:
• ExceptionFail! – Fail as if this script were not
implemented. This is the default action. The error
condition triggers the SystemError event if you do not
handle the error in a Try-Catch block.
• ExceptionIgnore! – Ignore this error and return as if no
error occurred. Use this option with caution because the
conditions that caused the error can cause another error.
• ExceptionRetry! – Execute the function or evaluate the
expression again in case the OLE server was not ready.
This option is not valid for DataWindows.
• ExceptionSubstituteReturnValue! – Use the value
specified in the returnvalue argument instead of the value
returned by the OLE server or DataWindow and cancel the
error condition.
returnvalue Any by reference. A value whose datatype matches the
expected value that the OLE server or DataWindow would
have returned.
This value is used when the value of action is
ExceptionSubstituteReturnValue!.
Return codes None. (Do not use a RETURN statement.)

Usage DataWindow and OLE objects are dynamic. Expressions that use dot notation
to refer to data and properties of these objects might be valid under some
runtime conditions but not others. The Error event allows you to respond to this
dynamic situation with error recovery logic.
The Error event also allows you to respond to communications errors in the
client component of a distributed application. In the Error event for a custom
connection object, you can tell PowerBuilder what action to take when an error
occurs during communications between the client and the server.
520 PowerBuilder
The Error event gives you an opportunity to substitute a default value when the
error is not critical to your application. Its arguments also provide information
that is helpful in debugging. For example, the arguments can help you debug
DataWindow data expressions that cannot be checked by the compiler—such
expressions can only be evaluated at runtime.
When to substitute a return value

The ExceptionSubstituteReturnValue! action allows you to substitute a return
value when the last element of an expression causes an error. Do not use
ExceptionSubstituteReturnValue! to substitute a return value when an element
in the middle of an expression causes an error. The substituted return value will
not match the datatype of the unresolved object reference and will cause a
system error.
The ExceptionSubstituteReturnValue! action is most useful for handling errors
in data expressions.
For DataWindows, if an error occurs while evaluating a data or property

expression, error processing occurs like this:
1 The Error event occurs.
If you use a Try-Catch block, it is best not to script the Error event.
2 If the Error event has no script or its action argument is not changed from
the default action (ExceptionFail!), either a catch statement is executed or
the SystemError event occurs.
3 If you do not handle the error in a Try-Catch block and the SystemError
event has no script, an application error occurs and the application is
terminated.
The chapter on “Using DataWindow Objects” in the DataWindow
Programmers Guide contains a table of correspondences between Error event
arguments and DWRuntimeError properties. You can use the
DWRuntimeError properties in a Try-Catch block to obtain the same
information about an error condition that you would otherwise obtain from
Error event arguments.
The error processing in the client component of a distributed application is the
same as for DataWindows. For information about handling communications
errors in a distributed application, see the discussion of distributed applications
in Application Techniques.

Expanded
For information about error processing in OLE controls, see the

ExternalException event description in the PowerScript Reference.
For information about using data and property expressions for DataWindow
objects, see Chapter 4, Accessing Data in Code and Chapter 5, Accessing
DataWindow Object Properties in Code.
Examples This example displays information about the error that occurred and allows the
script to continue:
MessageBox("Error Number " + string(errornumber)&
+ " Occurred", "Errortext: " + String(errortext))
action = ExceptionIgnore!
See also DBError
Expanded
Description Occurs when a node in a TreeView DataWindow has expanded.
Event ID: pbm_dwnexpanded
row Long by value. The number of the first row in the group that has been
expanded.
grouplevel Long by value. The TreeView level of the group that has been
expanded.

Usage A TreeView node expands when the user clicks the State icon (+) in the
TreeView DataWindow or uses any of the Expand methods.
The Expanding event occurs before the Expanded event.
Examples The following statement writes the TreeView level and row to a single-line edit
box when a node is expanded:
sle_1.text = "TreeView level: " + string(grouplevel)
sle_1.text += " Row: " + string(row)
See also Collapsed
Expanding
522 PowerBuilder
Expanding
Description Occurs before a node in a TreeView DataWindow expands.
Event ID: pbm_dwnexpanding
expanded.
grouplevel Long by value. The TreeView level of the group to be expanded.
Return codes Set the return code to affect the outcome of the event. Return 0 to continue
processing (expand the selected node) or return any other value to cancel the
expansion.
Usage A TreeView node expands when the user clicks the State icon (+) in the
TreeView DataWindow or uses any of the Expand methods.
The Expanding event occurs before the Expanded event.
Examples The following statements in the Expanding event script display a message box
that allows the user to cancel the operation:
Integer li_ret
li_ret = MessageBox("Expanding node", &

"Are you sure you want to expand this node?", &
Exclamation!, OKCancel!)
IF li_ret = 1 then
return 0
ELSE
RETURN 1
END IF
See also Collapsing
Expanded
GetFocus
Description Occurs just before the control receives focus (before it is selected and becomes
active).

GraphCreate

Event ID: pbm_dwnsetfocus
See also Clicked
LoseFocus
GraphCreate
Description Occurs after the DataWindow control creates a graph and populates it with
data, but before it has displayed the graph. In this event, you can change the
appearance of the data about to be displayed.
Event ID: pbm_dwngraphcreate
GraphCreate is not a standard PowerBuilder DataWindow event. To write a
pbm_dwngraphcreate.
Examples The following statement sets to black the foreground (fill) color of the Q1
series in the graph gr_quarter, which is in the DataWindow control dw_report.
The statement is in the user event GraphCreate, which is associated with the
event ID pbm_dwngraphcreate:
dw_report.SetSeriesStyle("gr_quarter", "Q1", &
foreground!, 0)
See also GetFocus
HTMLContextApplied
Description Occurs when the SetHTMLAction method has been called to apply an action
to a DataWindow control or DataStore. The event occurs after the context has
been set but before the action is applied.
524 PowerBuilder
Obsolete method
HTMLContextApplied is obsolete and should not be used, because the Web

Event ID: pbm_dwnhtmlcontextapplied
action String. A descriptor of the action about to be applied to the
DataStore. Action strings include:
AppendRow
DeleteRow
InsertRow
PageFirst
PageLast
PageNext
PagePrior
Retrieve
Sort
Update
The list is subject to change and additional actions may be
added in the future. Case is not relevant for action values.
0 Continue processing (execute the action)
1 Prevent the action from being applied
Usage Actions include navigating from page to page, inserting and deleting rows,
retrieving and updating data. Typically the HTMLContextApplied event is
used to call server-side methods for validating data that is about to be updated.
The SetHTMLAction method triggers the HTMLContextApplied event. If the
HTMLContextApplied event returns 1, then the SetHTMLAction method
returns -4 to indicate that the action was canceled.
See also SetHTMLAction method

ItemChanged
ItemChanged
Description Occurs when a field in a DataWindow control has been modified and loses
focus (for example, the user presses Enter, the Tab key, or an arrow key or
clicks the mouse on another field within the DataWindow). It occurs before the
change is applied to the item. ItemChanged can also occur when the AcceptText
or Update method is called for a DataWindow control or DataStore object.
Event ID: pbm_dwnitemchange
whose value is being changed.
the item whose value has been changed. Dwo is a reference
to the column control, not the name of the column.
data String by value. The new data the user has specified for the
item.
0 (Default) Accept the data value
1 Reject the data value and do not allow focus to change
2 Reject the data value but allow the focus to change
Usage The ItemChanged event does not occur when the DataWindow control itself
loses focus. If the user clicks on an Update or Close button, you will need to
write a script that calls AcceptText to see if a changed value should be accepted
before the button’s action occurs. For information on the right way to do this,
see AcceptText on page 556.
Obsolete techniques in PowerBuilder

Information formerly provided by the GetText method is available in the data
argument.
Instead of calling SetActionCode, use a RETURN statement with a return code.
Examples This example uses the ItemChanged event to provide additional validation; if
the column is emp_name, it checks that only letters were entered in the column:
IF Dwo.name = "Emp_name" THEN
IF NOT Match(Data, "^[A-za-z]$") THEN
526 PowerBuilder
RETURN 2
END IF
END IF
See also ItemError
ItemError
Description Occurs when a field has been modified, the field loses focus (for example, the
user presses Enter, Tab, or an arrow key or clicks the mouse on another field in
the DataWindow), and the data in the field does not pass the validation rules
for its column. ItemError can also occur when a value imported into a
DataWindow control or DataStore does not pass the validation rules for its
column.
Event ID: pbm_dwnitemvalidationerror
whose new value has failed validation.
the item. Dwo is a reference to the column control, not the
name of the column.
data String by value. The new data the user specified for the
item.
0 (Default) Reject the data value and show an error message box
1 Reject the data value with no message box
2 Accept the data value
3 Reject the data value but allow focus to change
Usage If the return code is 0 or 1 (rejecting the data), the field with the incorrect data
regains the focus.
The ItemError event occurs instead of the ItemChanged event when the new
data value fails a validation rule. You can force the ItemError event to occur by
rejecting the value in the ItemChanged event.

ItemError
Obsolete techniques in PowerBuilder

Information provided by the GetText and GetRow methods is now available in
the data and row arguments.
Instead of calling GetColumnName, use the dwo argument and a reference to its
Name property.
Instead of calling SetActionCode, use a RETURN statement with the return
codes listed above.
Examples The following excerpt from an ItemError event script of a DataWindow control
allows the user to blank out a column and move to the next column. For
columns with datatypes other than string, the user cannot leave the value empty
(the empty string does not match the datatype). If the user tried to leave the
value blank, this code sets the value of the column to a null value of the
appropriate datatype.
string ls_colname, ls_datatype
ls_colname = dwo.Name
ls_datatype = dwo.ColType
// Reject the value if non-blank
IF Trim(data) <> "" THEN
RETURN 0
END IF
// Set value to null if blank

CHOOSE CASE ls_datatype
CASE "long"
integer null_num
SetNull(null_num)
This.SetItem(row, ls_colname, null_num)
RETURN 3
CASE "date"
date null_date
SetNull(null_date)
This.SetItem(row, ls_colname, null_date)
RETURN 3
// Additional cases for other datatypes

END CHOOSE
See also ItemChanged
528 PowerBuilder
ItemFocusChanged
Description Occurs when the current item in the control changes.
Event ID: pbm_dwnitemchangefocus
row Long by value. The number of the row containing the item that just
gained focus.
dwo DWObject by value. A reference to the column containing the item.
Usage ItemFocusChanged occurs when focus is set to another column in the
DataWindow, including when the DataWindow is first displayed.
The row and column together uniquely identify an item in the DataWindow.
PowerBuilder programming note In the ItemFocusChanged event, dwo is
always a column control. Therefore, you can get more information about it by
examining any properties that are appropriate for columns such as dwo.id and
dwo.Name.
Examples This example reports the row and column that just gained focus and that just
lost focus. (The first time the event occurs, there is no item that just lost focus;
the script saves the row number and column name in two instance variables
called ii_row and is_colname so that the old item is known the next time the
event occurs.)
IF ii_row > 0 THEN
sle_olditem.Text = "Old row: " + String(ii_row) &
+ " Old column: " + is_colname
END IF
sle_newitem.Text = "New row: " + String(row) &

+ " New column: " + dwo.Name
// Replace values of instance variables

// with info for next change in focus
ii_row = row
is_colname = dwo.Name
See also RowFocusChanged
RowFocusChanging

KeyDown
KeyDown
Description Occurs for each keystroke when the user is editing in the DataWindow edit
control.
Event ID: pbm_dwnkey
KeyDown is not a standard PowerBuilder DataWindow event. To write a script
for this event, you must first define a user-defined event for the event ID
pbm_dwnkey.
key Integer by value.
keyflags UnsignedLong by value. The modifier keys that are pressed. The
keyflags value is the sum of the values for all the pressed keys.
Key values are:
• 1 Shift key
• 2 Ctrl key
• 3 Shift + Ctrl keys
LoseFocus
Description Occurs just before a control loses focus (after it becomes inactive).
Event ID: pbm_dwnkillfocus
Usage Write code for a control’s LoseFocus event if you want some processing to
occur when the user changes focus to another control.
PowerBuilder programming note Because the MessageBox function grabs
focus, you should not use it when focus is changing, such as in a LoseFocus
event. Instead, you might display a message in the window’s title or a
MultiLineEdit.
530 PowerBuilder
When to call AcceptText You should not call AcceptText in the LoseFocus
event or from a user event posted from LoseFocus, unless the DataWindow
control no longer has focus. For information about the right way to call
AcceptText when the DataWindow control loses focus, see the AcceptText
method.
See also GetFocus
AcceptText method
MessageText
Description Occurs when a crosstab DataWindow generates a message. Typical messages
are Retrieving data and Building crosstab.
Event ID: pbm_dwnmessageText
MessageText is not a standard PowerBuilder DataWindow event. To write a
pbm_dwnmessagetext.
text String by value. The message text.
Examples The following line in the user event for pbm_dwnmessagetext displays
informational messages as MicroHelp in an MDI application (w_crosstab is an
MDI frame window). The informational messages are displayed in the MDI
application’s MicroHelp as the crosstab is rebuilt:
w_crosstab.SetMicroHelp(text)
See also GetFocus
MouseMove
Description Occurs when the user moves the mouse pointer in a DataWindow control.

MouseUp

Event ID: pbm_dwnmousemove
MouseMove is not a standard PowerBuilder DataWindow event. To write a
script for this event, you must first define a user event for the event ID
pbm_dwnmousemove.
xpos Integer by value. The distance of the pointer from the left side
of the DataWindow’s workspace. The distance is given in
pixels.
ypos Integer by value. The distance of the pointer from the top of the
DataWindow’s workspace. The distance is given in pixels.
row Long by value. The number of the row under the pointer.
If the pointer is not over a row, the value of the row argument is
0. For example, row is 0 when the user double-clicks outside the
data area, in text or spaces between rows, or in the header,
summary, or footer area.
DataWindow that is under the pointer.
See also Clicked
DoubleClicked
MouseUp
RButtonDown
MouseUp
Description Occurs when the user releases a mouse button in a DataWindow control.
532 PowerBuilder

Event ID: pbm_dwnlbuttonup
MouseUp is not a standard PowerBuilder DataWindow event. To write a script
for this event, you must first define a user event for the event ID
pbm_dwnlbuttonup.
xpos Integer by value. The distance of the pointer from the left side of
the DataWindow’s workspace. The distance is given in pixels.
DataWindow’s workspace. The distance is given in pixels.
row Long by value. The number of the row under the pointer.
If the pointer is not over a row, the value of the row argument is
0. For example, row is 0 when the user double-clicks outside the
data area, in text or spaces between rows, or in the header,
summary, or footer area.
DataWindow that is under the pointer.
See also Clicked
DoubleClicked
MouseMove
OnSubmit
Description This event is triggered just before the Web DataWindow causes a submit.

Printend
Obsolete event
OnSubmit is obsolete and should not be used, because the Web DataWindow
Web DataWindow client control event information

Event name: OnSubmit
Return codes Returning 1 from this event will prevent the submit from occurring.
Usage Use to host multiple DataWindows.
Examples The following client side script transfers the context and action from one
DataWindow to the DataWindow being submitted.
<SCRIPT>
function dw_first_OnSubmit()
{
dw_first.submitForm.dw_second_context.value =
dw_second.GetFullContext();
dw_first.submitForm.dw_second_action.value = "";
}
function dw_second_OnSubmit()
{
dw_second.submitForm.dw_first_context.value =
dw_first.GetFullContext();
dw_second.submitForm.dw_first_action.value = "";
}
</SCRIPT>
To enable the second DataWindow to create the required fields on the submit
form, each of the DataWindows must have two arguments defined in the
SelfLinkArgs property:
• dw_first must have dw_second_context and dw_second_action defined
• dw_second must have dw_first_context and dw_first_action defined
Printend
Description Occurs when the printing of a DataWindow or DataStore ends.
534 PowerBuilder

Event ID: pbm_dwnprintend
pagesprinted Long by value. The total number of pages that were
printed.
Examples This statement displays the number of pages that were printed after the Print
method was called to print the contents of the DataWindow control:
st_1.Text = String(pagesprinted) &
+ " page(s) have been printed."
See also PrintMarginChange
PrintPage
PrintStart
PrintMarginChange
Description Occurs when the print margins of the DataWindow change.
Event ID: pbm_dwnprintmarginchange
PrintMarginChange is not a standard PowerBuilder DataWindow event. To
write a script for this event, you must first define a user-defined event for the
event ID pbm_dwnprintmarginchange.
See also Printend
PrintPage
PrintStart

PrintPage
PrintPage
Description Occurs before each page of the DataWindow or DataStore is formatted for
printing.
Event ID: pbm_dwnprintpage
pagenumber Long by value. The number of the page about to be printed.
copy Long by value. The number of the copy being printed.
0 Do not skip the page
1 Skip the page
Usage The PrintPage event for a DataWindow control recalculates DataWindow
pages before each page of a DataWindow object is formatted for printing.
However, you cannot use this event to modify the page number of the current
page or the remaining pages in the DataWindow.
Examples After a script prints a DataWindow control, you can limit the number of pages
to be printed by suppressing every page after page 50.
This statement in a CommandButton’s Clicked event script prints the contents
of the DataWindow control:
dw_1.Print()
This code in the PrintPage event of dw_1 cancels printing after reaching page
50:
IF pagenumber > 50 THEN This.PrintCancel()
If you know every fifth page of the DataWindow contains the summary
information you want, you can suppress the other pages with some arithmetic
and a RETURN statement:
IF Mod(pagenumber / 5) = 0 THEN
RETURN 0
ELSE
RETURN 1
END IF
See also Printend
PrintMarginChange
536 PowerBuilder
PrintStart
PrintStart
Description Occurs when the printing of the DataWindow or DataStore starts.
Event ID: pbm_dwnprintstart
pagesmax Long by value. The total number of pages that will be
printed, unless pages are skipped.
Usage To skip printing some of the pages in the DataWindow or DataStore, write code
for the PrintPage event.
See also Printend
PrintMarginChange
PrintPage
ProcessEnter
Description Occurs when the user presses the Enter key when focus is in the DataWindow
or the DataWindow’s edit control.
Event ID: pbm_dwnprocessenter
ProcessEnter is not a standard PowerBuilder DataWindow event. To write a
pbm_dwnprocessenter.

RButtonDown
RButtonDown
Description Occurs when the right mouse button is pressed on the DataWindow control.
Event ID: pbm_dwnrbuttondown
flags UnsignedLong by value. The modifier keys and mouse buttons
that are pressed. The flags value is the sum of the values for all
the pressed keys and buttons.
Key and button values are:
• 1 – Left mouse button
• 2 – Right mouse button
• 4 – Shift key
• 8 – Ctrl key
• 16 – Middle mouse button
In the RButtonDown event, the right mouse button is always
pressed, so 2 is always summed in the value of flags.
For information on evaluating the flags value, see Syntax 2 of
MouseMove in the PowerScript Reference.
xpos Integer by value. The distance of the pointer from the left edge
of the window’s workspace in pixels.
window’s workspace in pixels.
See also Clicked
Resize
Description Occurs when the user or a script opens or resizes the client area of a
DataWindow control.
Event ID: pbm_dwnresize
538 PowerBuilder
sizetype UnsignedLong by value.
• 0 – (SIZE_RESTORED) The DataWindow has been
resized, but it was not minimized or maximized. The
user may have dragged the borders or a script may have
called the Resize method.
• 1 – (SIZE_MINIMIZED) The DataWindow has been
minimized.
• 2 – (SIZE_MAXIMIZED) The DataWindow has been
maximized.
newwidth Integer by value. The width of the client area of the
DataWindow control in pixels.
newheight Integer by value. The height of the client area of the
DataWindow control in pixels.
RetrieveEnd
Description Occurs when the retrieval for the DataWindow or DataStore is complete.
Event ID: pbm_dwnretrieveend
rowcount Long by value. The number of rows that were retrieved.
Usage The number of rows retrieved in the rowcount argument is an unfiltered value.
Examples This message box displayed in the RetrieveEnd event script tells the user the
number of rows just retrieved:
MessageBox("Total rows retrieved", String(rowcount))
See also RetrieveRow
RetrieveStart
SQLPreview

RetrieveRow
UpdateStart
RetrieveRow
Description Occurs after a row has been retrieved.
Event ID: pbm_dwnretrieverow
row Long by value. The number of the row that was just
retrieved
1 Stop the retrieval
Usage If you want to guard against potentially large queries, you can have code in the
RetrieveRow event check the row argument and decide whether the user has
reached a maximum limit. When row exceeds the limit, you can return 1 to
abort the retrieval (in which case the retrieval cannot be resumed).
A script in the RetrieveRow event (even a comment) can significantly increase
the time it takes to complete a query.
Obsolete methods in PowerBuilder Instead of calling SetActionCode, use
the RETURN statement with a return code instead.
Examples This code for the RetrieveRow event aborts the retrieval after 250 rows have
been retrieved.
IF ll_row > 250 THEN
MessageBox("Retrieval Halted", &
"You have retrieved 250 rows, the allowed &
maximum.")
RETURN 1
ELSE
RETURN 0
END IF
See also RetrieveEnd
RetrieveStart
540 PowerBuilder
SQLPreview
UpdateStart
RetrieveStart
Description Occurs when the retrieval for the DataWindow or DataStore is about to begin.
Event ID: pbm_dwnretrievestart
1 Do not perform the retrieval
2 Do not reset the rows and buffers before retrieving data
Usage A return code of 2 prevents previously retrieved data from being cleared,
allowing the current retrieval process to append new rows to the old data.
Obsolete methods in PowerBuilder Instead of calling SetActionCode, use
the RETURN statement with a return code instead.
Examples This statement in the RetrieveStart event prevents a reset from taking place
(rows will be added to the end of the previously retrieved rows):
RETURN 2
This statement in the RetrieveStart event aborts the retrieval:
RETURN 1
This code allows rows to be retrieved only when a user has an ID between 101
and 200 inclusive (the ID was stored in the instance variable il_id_number
when the user started the application); all other IDs cannot retrieve rows:
CHOOSE CASE il_id_number
CASE IS < 100
RETURN 1
CASE 101 to 200

RETURN 0
CASE IS > 200

RETURN 1

RichTextCurrentStyleChanged
END CHOOSE
See also RetrieveEnd
RetrieveRow
SQLPreview
UpdateStart
RichTextCurrentStyleChanged
Description Occurs when a column with the RichText edit style has focus and the current
style of the selection or cursor position has changed.
Event ID: pbm_dwnrichtextcurrentstlechanged
RichTextLoseFocus
Description Occurs when a column with the RichText edit style loses focus.
Event ID: pbm_dwnrichtextlosefocus
542 PowerBuilder
RichTextLimitError
Description Occurs when data in a column with the RichText edit style exceeds column
size.
Event ID: pbm_dwnrichtextlimiterror
text String by value. Plain text of column the user edited.
RowFocusChanged
Description Occurs when the current row changes in the DataWindow.
Event ID: pbm_dwnrowchange
currentrow Long by value. The number of the row that has just become
current.
Usage The SetRow method, as well as user actions, can trigger the RowFocusChanged
and ItemFocusChanged events.
In a read-only DataWindow, when you click on any column that is not in the
current row, the RowFocusChanging and RowFocusChanged events fire, but
the current column is not changed—the current column remains at 0, since no
column can have focus. DataWindows are read-only if updates are not allowed,
all tab orders are set to 0, or all tab columns are protected.

RowFocusChanging
If, however, focus is on an editable column in an updatable DataWindow (a

DataWindow that has one or more editable columns), the row focus events do
not fire when you click on a protected column or on a column whose tab order
is 0. The focus remains on the current, editable column.
If focus moves off an editable column in an updatable DataWindow, the
DataWindow switches to read-only mode. This can happen when the last row
in the DataWindow does not have an editable column. In this case, tabbing off
the last editable column causes the row focus to move to the row following the
row with the last editable column. The DataWindow then remains in read-only
mode until focus is given to an editable column.
When you use the ScrollToRow method to change focus, the
RowFocusChanging event is triggered before the scroll occurs, and the
RowFocusChanged event is triggered after the scroll occurs.
Examples This example displays the current row number and the total number of rows in
a SingleLineEdit:
sle_1.Text = "Row " + String(currentrow) &
+ " of " + String(This.RowCount())
See also ItemFocusChanged
RowFocusChanging
RowFocusChanging
Description Occurs when the current row is about to change in the DataWindow. (The
current row of the DataWindow is not necessarily the same as the current row
in the database.)
The RowFocusChanging event occurs just before the RowFocusChanged
event.
Event ID: pbm_dwnrowchanging
currentrow Long by value. The number of the row that is current
(before the row is deleted or its number changes). If the
DataWindow object is empty, currentrow is 0 to indicate
there is no current row.
544 PowerBuilder
newrow Long by value. The number of the row that is about to
become current. If the new row is going to be an inserted
row, newrow is 0 to indicate that it does not yet exist.
0 Continue processing (setting the current row)
1 Prevent the current row from changing
Usage Typically the RowFocusChanging event is coded to respond to a mouse click
or keyboard action that would change the current row in the DataWindow
object. The following methods can also trigger the RowFocusChanging event,
as well as the RowFocusChanged and ItemFocusChanged events, when the
action changes the current row:
SetRow
Retrieve
RowsCopy
RowsMove
DeleteRow
RowsDiscard
In these cases, the RowFocusChanging event script can prevent the changing
of the DataWindow object’s current row only. The script cannot prevent the
data from being changed (for example, the rows still get moved).
When you use the ScrollToRow method to change focus, the
RowFocusChanging event is triggered before the scroll occurs, and the
RowFocusChanged event is triggered after the scroll occurs.
In a tabular DataWindow, if the user clicks to change rows, the row focus does
not change, and the row and DataWindow do not scroll. You can still scroll
programmatically or by using the scroll bar.
In a read-only DataWindow, when you click on any column that is not in the
current row, the RowFocusChanging and RowFocusChanged events fire, but
the current column is not changed—the current column remains at 0, since no
column can have focus. DataWindows are read-only if updates are not allowed,
all tab orders are set to 0, or all tab columns are protected.

ScrollHorizontal
However, if focus is on an editable column in an updatable DataWindow (a

DataWindow that has one or more editable columns), the row focus events do
not fire when you click on a protected column or on a column whose tab order
is 0. The focus remains on the current, editable column.
If focus moves off an editable column in an updatable DataWindow, the
DataWindow switches to read-only mode. This can happen when the last row
in the DataWindow does not have an editable column. In this case, tabbing off
the last editable column causes the row focus to move to the row following the
row with the last editable column. The DataWindow then remains in read-only
mode until focus is given to an editable column.
Examples This example displays a message alerting you that changes have been made in
the window dw_detail which will be lost if the row focus is changed to the
window dw_master.
IF dw_detail.DeletedCount() > 0 OR &
dw_detail.ModifiedCount() > 0 THEN
MessageBox("dw_master", "Changes will be lost &
in Detail")
ELSE
RETURN 0
END IF
See also ItemFocusChanged
RowFocusChanged
ScrollHorizontal
Description Occurs when user scrolls left or right in the DataWindow with the TAB or arrow
keys or the scroll bar.
Event ID: pbm_dwnhscroll
scrollpos Long by value. The distance in PowerBuilder units of the scroll box
from the left end of the scroll bar (if the DataWindow is split, in the
pane being scrolled).
546 PowerBuilder
pane Integer by value. The number of the pane being scrolled. (When the
DataWindow is split with two scroll bars, there are two panes.)
Values are:
• 1 – The left pane (if the scroll bar is not split, the only pane).
• 2 – The right pane.
Examples This example displays the customer ID of the current row (the cust_id column)
in a SingleLineEdit control when the pane being scrolled is pane 1 and the
position is greater than 100:
string ls_id
ls_id = ""
IF pane = 1 THEN
IF scrollpos > 100 THEN
ls_id = String(dw_1.Object.Id[dw_1.GetRow()])
END If
END IF
sle_message.Text = ls_id
RETURN 0
See also ScrollVertical
ScrollVertical
Description Occurs when user scrolls up or down in the DataWindow with the Tab or arrow
keys or the scroll bar.
Event ID: pbm_dwnvscroll
scrollpos Long by value. The distance in PowerBuilder units of the
scroll box from the top of the scroll bar.

SQLPreview
Examples As the user scrolls vertically, this script displays the range of rows currently
being displayed in the DataWindow:
long ll_numrows
string ls_firstrow, ls_lastrow
ll_numrows = dw_1.RowCount()
ls_firstrow = dw_1.Object.Datawindow.FirstRowOnPage
ls_lastrow = dw_1.Object.Datawindow.LastRowOnPage
sle_message.Text = "Rows " + ls_firstrow &

+ " through " + ls_lastrow + " of " &
+ String(ll_numrows)
RETURN 0
See also ScrollHorizontal
SQLPreview
Description Occurs immediately before a SQL statement is submitted to the DBMS.
Methods that trigger DBMS activity are Retrieve, Update, and ReselectRow.
Event ID: pbm_dwnsql
request SQLPreviewFunction by value. The function that initiated the
database activity.
For a list of valid values, see SQLPreviewFunction on page 494.
sqltype SQLPreviewType by value. The type of SQL statement being sent
to the DBMS.
For a list of valid values, see SQLPreviewType on page 495.
sqlsyntax String by value. The full text of the SQL statement.
buffer DWBuffer by value. The buffer containing the row involved in the
database activity.
row Long by value. The number of the row involved in the database
activity, that is, the row being updated, selected, inserted, or
deleted.
548 PowerBuilder
1 Stop processing
2 Skip this request and execute the next request
Usage Some uses for the sqlsyntax argument are:
• Changing the SQL to be executed (you can get the value of sqlsyntax,
modify it, and call SetSQLPreview)
• Keeping a record (you can write the SQL statement to a log file)
Reported row number

The row number stored in row is the number of the row in the buffer, not the
number the row had when it was retrieved into the DataWindow object.
If the row that caused the error is in the Filter buffer, you must unfilter it if you
want the user to correct the problem.
GetSQLPreview and binding

When binding is enabled for your database, the SQL returned in the
GetSQLPreview method may not be complete—the input arguments are not
replaced with the actual values. For example, when binding is enabled,
GetSQLPreview might return the following SQL statement:
INSERT INTO "cust_order" ( "ordnum", "custnum",
"duedate", "balance" ) VALUES ( ?, ?, ?, ? )
When binding is disabled, it returns:
INSERT INTO "cust_order" ( "ordnum", "balance",
"duedate", "custnum" ) VALUES ( '12345', 900,
'3/1/94', '111' )
If you require the complete SQL statement for logging purposes, you should
disable binding in your DBMS.
For more information about binding, see Connecting to Your Database.
Obsolete methods in PowerBuilder Information formerly provided by

GetSQLPreview and GetUpdateStatus is available in the arguments sqlsyntax,
row, and buffer.

TabDownOut
Examples This statement in the SQLPreview event sets the current SQL string for the
DataWindow dw_1:
dw_1.SetSQLPreview( &
"INSERT INTO billings VALUES(100, " + &
String(Current_balance) + ")")
See also RetrieveStart
UpdateEnd
UpdateStart
TabDownOut
Description Occurs when the user presses Enter or the down arrow to change focus to the
next control in a window or user object.
Event ID: pbm_dwntabdownout
TabDownOut is not a standard PowerBuilder DataWindow event. To write a
pbm_dwntabdownout.
TabOut
Description Occurs when the user presses Tab or, in some edit styles, the right arrow, to
move to the next control in a window or user object.
Event ID: pbm_dwntabout
TabOut is not a standard PowerBuilder DataWindow event. To write a script
pbm_dwntabout.
550 PowerBuilder
TabUpOut
Description Occurs when the user presses Shift+Enter or the up arrow to move to the
previous control in a window or user object.
Event ID: pbm_dwntabupout
TabUpOut is not a standard PowerBuilder DataWindow event. To write a script
pbm_dwntabupout.
TreeNodeSelected
Description Occurs after a node in a TreeView DataWindow is selected.
Event ID: pbm_dwntreenodeselected
row Long by value. The number of the first row in the group that has been
selected.
grouplevel Long by value. The level of the group that has been selected.

Usage A TreeView node is selected when the user clicks the State icon (-) in the
The TreeNodeSelected event occurs after the selecting operation when the user
selects a tree node using the SelectTreeNode method.
Examples The following statements in the TreeNodeSelected event refresh the text box
value with the new node:
sle_row.text = string(row)
sle_level.text = string(grouplevel)
return 0
See also TreeNodeSelecting

TreeNodeSelecting
TreeNodeSelecting
Description Occurs before a node in a TreeView DataWindow is selected.
Event ID: pbm_dwntreenodeselecting
selected.
grouplevel Long by value. The TreeView level of the group to be selected.
Return codes Set the return code to affect the outcome of the event. Return 0 to continue the
selecting operation or return any other value to cancel the selecting operation.
Usage The TreeNodeSelecting event occurs before the user selects a TreeNode or uses
the SelectTreeNode method.
Examples The following statements in the TreeNodeSelecting event refresh the text box
value with the new node:
sle_row.text = string(row)
sle_level.text = string(grouplevel)
return 0
See also TreeNodeSelected
UpdateEnd
Description Occurs when all the updates to the database from the DataWindow (or
DataStore) are complete.
Event ID: pbm_dwnupdateend
rowsinserted Long by value. The number of rows inserted.
rowsupdated Long by value. The number of rows updated.
rowsdeleted Long by value. The number of rows deleted.
552 PowerBuilder
SQLPreview
UpdateStart
UpdateStart
Description Occurs after a script calls the Update method and just before changes in the
DataWindow or DataStore are sent to the database.
Event ID: pbm_dwnupdatestart
1 Do not perform the update
SQLPreview
UpdateEnd
WSError
Description Occurs when an error is returned for a DataWindow using a Web service data
source. The error can occur during any of the following operations: connect,
retrieve, delete, insert, update, or disconnect.
Event ID: pbm_dwnwserror
operation String for the type of operation (Retrieve, Update, Insert,
Delete, Connect, or Disconnect)
rownum Long for the row number or 0 if not applicable, such as
when an error occurs during connection to the Web service
buffername String for the name of the buffer being accessed while the
error occurred (Primary, Filter, or Delete)

WSError
wsinfo String for the WSDL file, the URL that defines the Web
service, or the assembly that is used access the Web
service
method String for the name of the Web service method invoked
errormessage String for the exception message returned from the method
0 Display the error message
1 Do not display the error message
Usage Because you cannot use the DBError event with a Web Service DataWindow,
you must use the WSError event to obtain any error information.
Examples The following code in a WSError event script causes information about an
error to display in a message box:
MessageBox("Error event", "Error in row " &
+ string(rownum) + ", Occurred during " + method &
+ "; the cause of the error is: "+ errormessage)
See also DBError
554 PowerBuilder
C H A P T E R 9 Methods for the DataWindow
Control
About this chapter This chapter documents the methods of the DataWindow control in the
PowerBuilder and Web environments. You will find syntax, notes, and
examples for all environments.
Methods for graphs are in Chapter 10, Methods for Graphs in the
DataWindow Control.
Contents The methods in this chapter are listed alphabetically.
Before you begin For methods (or functions) in the PowerBuilder environment that apply to
controls other than DataWindows and DataStores, see the PowerScript
Reference.
AboutBox
Description Displays a dialog identifying the DataWindow, including copyright and
version information.
Obsolete method
AboutBox is obsolete and should not be used, because the DataWindow
Web Control for ActiveX technology is obsolete.
Applies to
DataWindow type Method applies to
Web ActiveX DataWindow control
Syntax Web ActiveX

void dwcontrol.AboutBox ( )
Return value None

AcceptText
AcceptText
Description Applies the contents of the DataWindow’s edit control to the current item
in the buffer of a DataWindow control or DataStore. The data in the edit
control must pass the validation rule for the column before it can be stored
in the item.
Applies to
PowerBuilder DataWindow control, DataWindowChild object,
DataStore object
Syntax PowerBuilder
integer dwcontrol.AcceptText ( )
dwcontrol A reference to a DataWindow control, DataStore, or
child DataWindow
Return value Returns 1 if it succeeds and –1 if it fails (for example, the data did not pass
validation).
If there is no DataWindow object assigned to the DataWindow control or
DataStore, this method returns 1.
Usage When a user moves from item to item in a DataWindow control, the
control validates and accepts data the user has edited.
How to call AcceptText When a user modifies a DataWindow item then
immediately changes focus to another control in the window, the
DataWindow control does not accept the modified data—the data remains
in the edit control. Use the AcceptText method in this situation to ensure
that the DataWindow object contains the data the user edited.
However, you must not call AcceptText in the LoseFocus event or in a user
event posted from LoseFocus if the DataWindow control still has focus. If
you do, an infinite loop can occur.
The problem Normally, new data is validated and accepted when the
user moves to a new cell in the DataWindow. If the new data causes an
error, a message box displays, which causes the DataWindow to lose
focus. If you have also coded the LoseFocus event or an event posted from
LoseFocus to call AcceptText to validate data when the control loses focus,
this AcceptText runs because of the message box and triggers an infinite
loop of validation errors.
556 PowerBuilder
CHAPTER 9 Methods for the DataWindow Control
The solution It is desirable to validate the last changed data when the
control loses focus. You can accomplish this by making sure AcceptText
gets called only when the DataWindow control really has lost focus. The
third PowerBuilder example illustrates how to use an instance variable to
keep track of whether the DataWindow control has focus. The posted
event calls AcceptText only when the DataWindow control does not have
focus.
This is a change from previous versions of PowerBuilder. Previously, the
posted user event would run while the message box for the validation error
was displayed. Now, it runs after the message box is dismissed, causing
another validation error to occur and another message box to be displayed,
resulting in an infinite loop.
Events AcceptText can trigger an ItemChanged or an ItemError event.
AcceptText in the ItemChanged event

Calling AcceptText in the ItemChanged event has no effect.
Examples In this example, the user is expected to enter a key value (such as an
employee number) in a column of the DataWindow object, then click the
OK button. This script for the Clicked event for the button calls AcceptText
to validate the entry and place it in the DataWindow control. Then the
script uses the item in the Retrieve method to retrieve the row for that key:
IF dw_emp.AcceptText() = 1 THEN
dw_emp.Retrieve(dw_emp.GetItemNumber &
(dw_emp.GetRow(), dw_emp.GetColumn()))
END IF
This script for the Clicked event for a CommandButton accepts the text in
the DataWindow dw_Emp and counts the rows in which the column
named balance is greater than 0:
integer i, Count
dw_employee.AcceptText()
FOR i = 1 to dw_employee.RowCount()
IF dw_employee.GetItemNumber(i,'balance') &
> 0 THEN
Count = Count + 1
END IF
NEXT

CanUndo
This example illustrates how to validate newly entered data when the
DataWindow control loses focus. An instance variable keeps track of
whether the DataWindow control has focus. It is set in the GetFocus and
LoseFocus events. The LoseFocus event posts the ue_acceptText event,
which calls the AcceptText method only if the DataWindow control does
not have focus.
The instance variable:
boolean dw_has_focus
The GetFocus event:
dw_has_focus = true
The LoseFocus event:
dw_has_focus = false
dw_1.event post ue_acceptText( )
The ue_acceptText event:

IF dw_has_focus = false THEN
dw_1.accepttext( )
END IF
See also Update
CanUndo
Description Tests whether Undo can reverse the most recent edit in the editable control
over the current row and column.
Applies to
PowerBuilder DataWindow control
Syntax PowerBuilder
boolean dwcontrol.CanUndo ( )
dwcontrol A reference to a DataWindow control
Return value Returns true if the last edit can be reversed (undone) using the Undo
method and false if the last edit cannot be reversed.
558 PowerBuilder
If dwcontrol is null, the method returns null.

Usage PowerBuilder environment
For use with other PowerBuilder controls, see CanUndo in the
Examples These statements check to see if the last edit in the edit control of
dw_contact can be reversed; if yes the statements reverse it, and if no they
display a message:
IF dw_contact.CanUndo() THEN
dw_contact.Undo()
ELSE
MessageBox(Parent.Title, "Nothing to Undo")
END IF
See also Undo
ClassName
Description Provides the class (or name) of the specified object.
Applies to
Syntax PowerBuilder
string dwcontrol.ClassName ( )
Return value Returns the class of dwcontrol, the name assigned to the control. Returns
Usage Method inherited from PowerObject. For use with variables in the
PowerBuilder environment, see ClassName in PowerScript Reference.

Clear
Clear
Description Deletes selected text in the edit control over the current row and column,
but does not store it in the clipboard.
Applies to
Syntax PowerBuilder
long dwcontrol.Clear ( )
Return value Returns the number of characters that Clear removed from dwcontrol. If no
text is selected, no characters are removed and Clear returns 0. If an error
occurs, Clear returns –1.
Usage To select text for deleting, the user can use the mouse or keyboard. You
can also call the SelectText method in a script.
To delete selected text and store it in the clipboard, use the Cut method.
PowerBuilder environment
For use with other PowerBuilder controls, see Clear in the PowerScript
Reference.
Examples If the user is editing the emp_name column in dw_emp and selects the text
Wilson, this statement clears Wilson from the edit control and returns 6:
long chars_returned
chars_returned = dw_emp.Clear( )
If the text in the edit control in dw_emp is Wilson, the first statement
selects the W and the second clears W from the edit control. The return
value would be 1:
dw_emp.SelectText(1,1)
dw_emp.Clear( )
See also Clear in the PowerScript Reference
Cut
Paste
ReplaceText
SelectText
560 PowerBuilder
ClearValues
Description Deletes all the items from a value list or code table associated with a
DataWindow column. (A value list is called a code table when it has both
display and data values.) ClearValues does not affect the data stored in the
column.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.ClearValues ( string column )
integer dwcontrol.ClearValues ( integer column )
dwcontrol A reference to a DataWindow control or DataStore.
column The column whose value list you want to delete. Column
can be a column number (integer) or a column name
(string).
Return value Returns 1 if it succeeds and –1 if an error occurs. The return value is
usually not used.
Usage The edit style of the column can be DropDownListBox, Edit, or
RadioButton. ClearValues has no effect when column has the EditMask or
DropDownDataWindow edit style.
Examples This statement clears all values from the drop-down list of
dw_Employee’s status column:
dw_Employee.ClearValues("status")
See also GetValue
SetValue
Collapse
Description Collapses a group in a TreeView DataWindow that has the specified
TreeView level and includes the specified row.

CollapseAll
Applies to
Syntax PowerBuilder
Integer dw_control.Collapse(long row, long groupLevel)
dw_control A reference to a TreeView-style DataWindow control
row The number of the row that belongs to the TreeView level of the
group to be collapsed
groupLevel The TreeView level of the group to be collapsed
Return value Returns 1 if the collapse operation succeeds and one of the following
negative values if it fails:
-1 DataWindow is null
-5 One or more of the parameters are invalid
-16 DataWindow is not a TreeView DataWindow
Usage A TreeView DataWindow has several TreeView level bands (groups) that
can be expanded and collapsed. You can use the Collapse method to
collapse a group in a TreeView DataWindow that includes a particular row
in a particular TreeView level.
The Collapse method triggers the Collapsing and Collapsed events.
Examples The following example collapses the group at TreeView level 2 that
includes row 3:
integer li_ret
li_ret = dw_treeview.Collapse(3,2)
See also CollapseAll
CollapseAllChildren
CollapseLevel
Expand
CollapseAll
Description Collapses all groups in a TreeView DataWindow.
562 PowerBuilder
Applies to
Syntax PowerBuilder
Integer dw_control.CollapseAll( )
Return value Returns 1 if the CollapseAll operation succeeds and one of the following
can be expanded and collapsed. You can use the CollapseAll method to
collapse all groups in a TreeView DataWindow.
The CollapseAll method triggers the Collapsing and Collapsed events with
row and level arguments of –1.
Examples The following example collapses all groups:
integer li_ret
li_ret = dw_treeview.CollapseAll()
See also Collapse
CollapseAllChildren
CollapseLevel
ExpandAll
CollapseAllChildren
Description Collapses a group in a TreeView DataWindow that has the specified
TreeView level and includes the specified row; also collapses all the
group’s children.
Applies to
Syntax PowerBuilder

CollapseLevel
Integer dw_control.ExpandAllChildren(long row, long groupLevel)

row The number of the row that belongs to the group to be collapsed
Return value Returns 1 if the expand operation succeeds and one of the following
can be expanded and collapsed. You can use the CollapseAllChildren
method to collapse a group with a specified TreeView level in a TreeView
DataWindow and all of its children.
The CollapseAllChildren method triggers the Collapsing and Collapsed
events.
Examples The following example collapses the group in a TreeView DataWindow
that has TreeView level 2 and includes row 3 and all the group’s children:
integer li_ret
li_ret = dw_treeview.CollapseAllChildren(3,2)
See also Collapse
CollapseAll
CollapseLevel
ExpandAllChildren
CollapseLevel
Description Collapses all the groups in a TreeView DataWindow that have the
specified TreeView level.
Applies to
Syntax PowerBuilder
564 PowerBuilder
Integer dw_control.CollapseLevel (long groupLevel)

Return value Returns 1 if the CollapseLevel operation succeeds and one of the
following negative values if it fails:
can be expanded and collapsed. You can use the CollapseLevel method to
collapse all the groups in a TreeView DataWindow that have a particular
TreeView level.
The CollapseLevel method triggers the Collapsing and Collapsed events
with a row argument of –1.
Examples The following example collapses TreeView level 2:
integer li_ret
li_ret = dw_treeview.CollapseLevel(2)
See also Collapse
CollapseAll
CollapseAllChildren
ExpandLevel
Copy
Description Puts selected text from the current row and column of an edit control onto
the clipboard. Copy does not change the source text.
Applies to
PowerBuilder DataWindow control, OLE DWObject
Syntax PowerBuilder
integer objectref.Copy ( )

Copy
objectref A reference to a DataWindow control
or
The fully qualified name of a OLE DWObject within a
DataWindow control that contains the object you want to
copy to the clipboard.
The fully qualified name for a DWObject has this syntax:
dwcontrol.Object.dwobjectname
Return value Returns the number of characters that were copied to the clipboard. If no
text is selected in objectref, no characters are copied and Copy returns 0. If
an error occurs, Copy returns –1.
For OLE DWObjects, Copy returns 0 if it succeeds and one of the
following negative values if an error occurs:
–1 Container is empty
–2 Copy Failed
–9 Other error
If objectref is null, the method returns null.
Usage To select text for copying, the user can use the mouse or keyboard. You
can also call the SelectText method in a script. For the RichTextEdit
presentation style in PowerBuilder, there are several additional methods
for selecting text: SelectTextAll, SelectTextLine, and SelectTextWord.
To insert the contents of the clipboard into a control, use the Paste method.
Copy does not delete the selected text or OLE object. To delete the data,
use the Clear or Cut method.
For use with other PowerBuilder controls, see Copy in the PowerScript
Reference.
Examples Assuming the selected text in the edit control of dw_emp is Temporary
Address, these statements copy Temporary Address to the clipboard and
store 17 in copy_amt:
integer copy_amt
copy_amt = dw_emp.Copy()
See also Clear
Clipboard in the PowerScript Reference
566 PowerBuilder
Cut
Paste
ReplaceText
SelectedText
CopyRTF
Description Returns the selected text, pictures, and input fields in a RichText
DataWindow as a string with rich text formatting. Bitmaps and input fields
are included in the string.
Applies to
PowerBuilder DataWindow control, DataStore object
Syntax PowerBuilder
string dwcontrol.CopyRTF ( { boolean selected {, Band band } } )
dwcontrol A reference to a DataWindow control or DataStore object. The
DataWindow object in the DataWindow control or DataStore
must be a RichText DataWindow.
selected A value indicating whether to copy selected text only. Values
(optional) are:
• true – (Default) Copy selected text only.
• false – Copy the entire contents of the band.
band A value specifying the band from which to copy text. Values
(optional) for this enumerated datatype are listed in Chapter 6,
DataWindow Constants.
The default is the band that contains the insertion point.
Return value Returns the selected text as a string.

CopyRTF returns an empty string (“”) if:
• There is no selection and selected is true

• An error occurs
Usage CopyRTF does not involve the clipboard. The copied information is stored
in a string. If you use the standard clipboard methods (Copy and Cut) the
clipboard will contain the text without any formatting.

CopyRTF
To incorporate the text with RTF formatting into another RichTextEdit

control, use PasteRTF.
For use with RichTextEdit controls, see CopyRTF in the PowerScript
Reference. For information about rich text format, see the chapter about
implementing rich text in Application Techniques.
Examples This statement returns the text that is selected in the RichText
DataWindow dw_letter and stores it in the string ls_richtext:
string ls_richtext
ls_richtext = dw_letter.CopyRTF()
This example copies the text in dw_1, saving it in ls_richtext, and pastes
it into dw_2. The user clicks the RadioButton rb_true to copy selected text
and rb_false to copy all the text. The number of characters pasted is saved
in ll_numchars reported in the StaticText st_status:
string ls_richtext
boolean lb_selected
long ll_numchars
IF rb_true.Checked = true THEN

lb_selected = true
ELSE
lb_selected = false
END IF
ls_richtext = dw_1.CopyRTF(lb_selected)
ll_numchars = dw_2.PasteRTF(ls_richtext)
st_status.Text = String(ll_numchars)
See also Copy
CopyRTF in the PowerScript Reference
Cut
PasteRTF
568 PowerBuilder
Create
Description Creates a DataWindow object using DataWindow source code and puts
that object in the specified DataWindow control or DataStore object. This
dynamic DataWindow object does not become a permanent part of the
application source library.
Applies to
Syntax PowerBuilder
integer dwcontrol.Create ( string syntax {, string errorbuffer } )
dwcontrol A reference to the DataWindow control or DataStore in which
PowerBuilder will create the new DataWindow object.
syntax A string whose value is the DataWindow source code that will
be used to create the DataWindow object.
errorbuffer The name of a string that will hold any error messages that are
(optional) generated. If you do not specify an error buffer, a message box
will display the error messages.
Return value In PowerBuilder, returns 1 if it succeeds and -1 if an error occurs.

If any argument’s value is null, the method returns null.
Usage The Create method creates a DataWindow object using the source code in
syntax. It substitutes the new DataWindow object for the DataWindow
object currently associated with dwcontrol.
DataWindow source code syntax is complex and is best produced by
copying existing DataWindows. In a PowerBuilder application, you can
use the Describe and LibraryExport methods to obtain the source code of
existing DataWindows to use as models. In the PowerBuilder
development environment, you can export the syntax of a DataWindow
object in the Library painter.
Another source of DataWindow code is the SyntaxFromSQL method,
which creates DataWindow source code based on a SQL statement. Many
values in the source code syntax correspond to properties of the
DataWindow object, which are documented in Chapter 3, DataWindow
Object Properties.

Create
When you examine syntax for existing DataWindow objects, you will see
that the order of the syntax can vary. Release must be the first statement,
and DataWindow should be the next statement. If you change the order,
use care; the order can affect the results.
Calling SyntaxFromSQL as the syntax argument

You can call SyntaxFromSQL directly as the value for syntax. However,
this does not give you the chance to check whether errors have been
reported in its error argument. Before you use SyntaxFromSQL in Create,
make sure the SQL syntax is valid.
Comments To designate text in your DataWindow syntax as a comment,

use either of the standard PowerBuilder methods:
• Use double slashes (//) to indicate that the text after the slashes and on
the same line is a comment.
When you use this method, the comment can be all or part of a line
but cannot cover multiple lines; the compiler ignores everything
following the double slashes on the line.
• Begin a comment with slash asterisk (/*) and end it with asterisk slash
(*/) to indicate that all the text between the delimiters is a comment.
When you use this method, the comment can be all or part of a line or
occupy multiple lines; the compiler ignores everything between /*
and */.
For DataWindows in group boxes If a DataWindow object is in a
group box, it is not automatically moved to the top when you call Create,
even if the BringToTop property is set to true in the DataWindow painter.
You must explicitly set the BringToTop property to true after you call
Create. For example:
dw_1.Create(ls_syntax, ls_errors)
dw_1.BringToTop=true
Examples These statements create a new DataWindow in the control dw_new from
the DataWindow source code returned by the SyntaxFromSQL method.
Errors from SyntaxFromSQL and Create are displayed in the
MultiLineEdits mle_sfs and mle_create. After creating the DataWindow,
you must call SetTransObject for the new DataWindow object before you
can retrieve data:
string error_syntaxfromSQL, error_create
string new_sql, new_syntax
570 PowerBuilder
new_sql = 'SELECT emp_data.emp_id, ' &

+ 'emp_data.emp_name ' &
+ 'from emp_data ' &
+ 'WHERE emp_data.emp_salary>45000'
new_syntax = SQLCA.SyntaxFromSQL(new_sql, &

'Style(Type=Form)', error_syntaxfromSQL)
IF Len(error_syntaxfromSQL) > 0 THEN

// Display errors
mle_sfs.Text = error_syntaxfromSQL
ELSE
// Generate new DataWindow
dw_new.Create(new_syntax, error_create)
IF Len(error_create) > 0 THEN
mle_create.Text = error_create
END IF
END IF
dw_new.SetTransObject(SQLCA)
dw_new.Retrieve()
See also SyntaxFromSQL in PowerScript Reference
SetTrans
SetTransObject
CreateError
Description Returns the error messages that were generated during a previous call to
Create.
Obsolete method
CreateError is obsolete and should not be used, because the DataWindow
Web Control for ActiveX technology is obsolete.
Applies to
Syntax Web ActiveX

CreateFrom
string dwcontrol.CreateError ( )
dwcontrol A reference to the DataWindow control for which you just
called the Create method
Return value Returns a string whose value is the error message text that was generated
when attempting to create a DataWindow from source code. If no errors
occur, returns an empty string.
Usage Call CreateError immediately after the Create method to get error
messages generated by Create.
See also Create
CreateFrom
Description Creates a DataStore object from the passed ResultSet object.
Applies to
PowerBuilder DataStore object
Syntax PowerBuilder
integer dsobject.CreateFrom ( ResultSet rssource )
dsobject The name of the DataStore object into which you want to
place the data in the passed result set
rssource A ResultSet or ADOResultSet object that contains meta
data from which the DataStore object is created
Return value Integer. Returns 1 if it succeeds or a negative number if an error occurs. If

any argument is null, in PowerBuilder the method returns null.
Usage Use CreateFrom to create a DataStore from a passed result set. Typically,
a PowerBuilder client calls methods on a component running in a
transaction server and converts results sets returned from those methods to
DataStore objects using CreateFrom.
572 PowerBuilder
CreateFrom creates an external DataWindow definition with no visual

component—it has no controls and the height of all bands is zero. Since
the data source for the DataStore object is external, Update methods on the
DataStore object have no effect. The Print method will print a blank page.
Client applications can use the DataStore object directly or display the data
in a DataWindow control using the ShareData method.
For more information about result sets and methods for exchanging data
between components and clients, see Usage for GenerateResultSet.
Examples This example creates an instance of the SVUBookstore component, calls
the GetMajors method, and creates a DataStore object using the data
definition in the returned ResultSet object:
SVUBookstore lcst_mybookstore
resultset lrs_resultset
datastore ds_local
integer li_rc
li_rc = myconnect.CreateInstance(lcst_mybookstore)
IF li_rc <> 0 THEN
MessageBox("Create Instance", string(li_rc) )
myconnect.DisConnectServer()
RETURN
END IF
lrs_resultset = lcst_mybookstore.GetMajors()
ds_local = CREATE DataStore

ds_local.CreateFrom(lrs_resultset)
This example creates a DataStore object from an ADO Recordset returned
from a method on an MTS component.
OLEObject loo_mycomponent
OLEObject loo_ADOrecordset
ADOresultset lrs_ADOresultset
datastore ds_local
integer li_rc
loo_mycomponent = CREATE OLEObject

li_rc =
loo_mycomponent.ConnectToNewObject("PB.Test")
IF li_rc <> 0 THEN
MessageBox("Connect Failed", string(li_rc) )
RETURN
END IF

CrosstabDialog
// Use an OLEObject to hold ADO Recordset

// returned from method on MTS component
loo_ADOrecordset = loo_mycomponent.GetTestResult()
// Create an ADOResultSet and get its data

// from OLEObject holding passed ADO Recordset
lrs_ADOresultset = CREATE ADOResultSet
lrs_ADOresultset.SetRecordSet(loo_ADOrecordset)
// Use CreateFrom to populate DataStore

// from ADOResultSet object
ds_local = CREATE DataStore
ds_local.CreateFrom(lrs_ADOresultset)
See also GenerateResultSet
SetRecordSet in the PowerScript Reference
SetResultSet in the PowerScript Reference
CrosstabDialog
Description Displays the Crosstab Definition dialog box so the user can modify the
definition of a crosstab DataWindow at runtime. The dialog box is the one
you use in the DataWindow painter to define the crosstab.
Applies to
Syntax PowerBuilder
integer dwcontrol.CrossTabDialog ( )
Return value Returns 1 if it succeeds and –1 if an error occurs.

Usage If the style of the DataWindow object in the DataWindow control is not
crosstab, CrosstabDialog has no effect. You must connect to a database and
set the DataWindow control’s transaction object before you call
CrossTabDialog.
574 PowerBuilder
Examples This statement in the script for the CommandButton cb_define displays
the Crosstab Definition dialog so the user can modify the definition of the
crosstab DataWindow object in dw_1:
dw_1.CrosstabDialog()
Cut
Description Deletes selected text in the current row and column of an edit control and
stores it on the clipboard, replacing the clipboard contents with the deleted
text.
Applies to
Syntax PowerBuilder
long dwcontrol.Cut ( )
dwcontrol A reference to a DataWindow control. The text is cut from the
edit control over the current row and column.
Return value Returns the number of characters that were cut from dwcontrol and stored
in the clipboard. If no text is selected, no characters are cut and Cut returns
0. If an error occurs, Cut returns –1.
Usage To select text for deleting, the user can use the mouse or keyboard. You
can also call the SelectText method in a script. For the RichTextEdit
presentation style in PowerBuilder, there are several additional methods
for selecting text: SelectTextAll, SelectTextLine, and SelectTextWord.
To insert the contents of the clipboard into a control, use the Paste method.
To delete selected text but not store it in the clipboard, use the Clear
method.
For use with other PowerBuilder controls, see Cut in the PowerScript
Reference.

DBCancel
Examples Assuming the selected text in the edit control of dw_emp is Temporary,
this statement deletes Temporary from the edit control, stores it in the
clipboard, and returns 9:
dw_emp.Cut()
See also Copy
Clear
Clipboard in the PowerScript Reference
Paste
DBCancel
Description Cancels the retrieval in process in a DataWindow.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.DBCancel ( )
dwcontrol A reference to the DataWindow control, DataStore, or
child DataWindows

If dwcontrol is null, in PowerBuilder and JavaScript the method returns
null.
Usage To cancel a database retrieval, you need two pieces of code:
• Code that calls DBCancel. To let the user cancel the retrieval, you
could call DBCancel (or call a user function or member method that
calls it) in code for a button or an item on a menu. This code would
generally set an instance variable or data member to indicate that the
user requested cancellation.
In PowerBuilder, this code might be:
ib_cancel = true
dw_1.DBCancel()
576 PowerBuilder
• Code for the RetrieveRow event that sets an action/return code of 1 to

stop the retrieval.
In PowerBuilder, this code might be:
IF ib_cancel = true THEN
RETURN 1
END IF
Coding something in the RetrieveRow event’s script (even just a
comment) enables the operating system to process events while the
DataWindow is being populated with rows from the database. If the
RetrieveRow event’s script is empty, menus and command buttons can’t
even be clicked until the retrieval is completely finished. This can be
frustrating if the user inadvertently starts a retrieval that is going to take a
long time.
If the Async DBParm parameter is set to 1 (for asynchronous operation),
a user or a script can cancel a query either before the first row is returned
or during the data retrieval process. If Async is set to 0 (for synchronous
operation), the user cannot select the menu or CommandButton until the
first row is retrieved. The asynchronous setting is useful when a query
might take a long time to retrieve its first row.
For a list of the DBMSs that support the Async DBParm parameter, see the
Connection Reference.
Examples In this example, the menu bar for an MDI application has menu items for
starting and canceling a retrieval. When the user cancels the retrieval, a
user function calls DBCancel and sets a boolean instance variable to
Get/SetSeriesStyle and Get/SetDataStyle. The RetrieveStart and
RetrieveRow events check this variable and return the appropriate value.
In this hypothetical application, the user starts a retrieval by selecting
Retrieve from a menu. The script for the Retrieve menu item calls a user
function for the window:
w_async1.wf_retrieve()
The wf_retrieve function sets the Async DBParm for asynchronous
processing and starts the retrieval. Because Async is set to 1, the user can
select the Cancel menu item at any time, even before the first row is
retrieved. (In your own application, you would include error handling to
make sure Retrieve returned successfully.)
long rc
ib_cancel = false
SQLCA.DBParm = 'Async = 1'

DBErrorCode
rc = dw_1.Retrieve()
The user can stop the retrieval by selecting Cancel from the menu. The
script for the Cancel menu item reads:
w_async1.wf_cancel()
The user function wf_cancel for the window w_async1 calls DBCancel
and sets a flag indicating that the retrieval is canceled. Other events for the
DataWindow will check this flag and abort the retrieval too. The variable
ib_cancel is an instance variable for the window:
ib_cancel = true
dw_1.DBCancel()
Scripts for the RetrieveStart and RetrieveRow events both check the
ib_cancel instance variable and, if it is true, stop the retrieval by returning
a value of 1. In order to cancel the retrieval, some code or comment in the
script for the RetrieveRow event is required:
IF ib_cancel = true THEN
RETURN 1
END IF
See also Retrieve
DBErrorCode
Description Reports the database-specific error code that triggered the DBError event.
Obsolete method
DBErrorCode is obsolete and will be discontinued in the future. You should
replace all use of DBErrorCode as soon as possible. The database error
code is available as an argument in the DBError event.
Applies to
PowerBuilder DataWindow control, DataWindowChild object
Syntax PowerBuilder
long dwcontrol.DBErrorCode ( )
578 PowerBuilder
dwcontrol A reference to a DataWindow control or child DataWindow
Return value Returns an error code when a database error occurs in dwcontrol. Error
codes –1 through –4 are PowerBuilder codes. Other codes are database-
specific. Returns 0 if there is no error.
PowerBuilder error codes are:
• –1 Can’t connect to the database because of missing values in the
transaction object.
• –2 Can’t connect to the database.
• –3 The key specified in an Update or Retrieve no longer matches an
existing row. (This can happen when another user has changed the
row after you retrieved it.)
• –4 Writing a blob to the database failed.
Usage When a database error occurs while a DataWindow control is interacting
with the database, PowerBuilder triggers the DBError event. Since
DBErrorCode is meaningful only if a database error has occurred, you
should call this method only in the DBError event.
Examples This statement returns the error code for dw_employee:
dw_employee.DBErrorCode()
Since this method is meaningful only in a DataWindow DBError event,
you can use the pronoun This instead of the DataWindow’s name:
This.DBErrorCode()
These statements check the error code for dw_employee and if it is -4,
perform some processing:
long ll_Error_Nbr
ll_Error_Nbr = This.DBErrorCode()
IF ll_Error_Nbr = - 4 THEN ...
When an error occurs in dw_Emp, the following statements in the
DBError event’s script will display the error number and message. A
return code of 1 suppresses the default error message:
long ll_Error_Nbr
ll_Error_Nbr = This.DBErrorCode()

DBErrorMessage
IF ll_Error_Nbr <> 0 THEN

MessageBox("Database Error", "Number " &
+ string(ll_Error_Nbr) + " " &
+ This.DBErrorMessage(), StopSign!)
// Stop PowerBuilder from displaying the
error
RETURN 1
END IF
See also DBErrorMessage
DBErrorMessage
Description Reports the database-specific error message that triggered the DBError
event.
Obsolete method
DBErrorMessage is obsolete and will be discontinued in a future release.
You should replace all use of DBErrorMessage as soon as possible. The
database error message is available as an argument in the DBError event.
Applies to
Syntax PowerBuilder
string dwcontrol.DBErrorMessage ( )
dwcontrol A reference to a DataWindow control or child
DataWindow
Return value Returns a string whose value is a database-specific error message

generated by a database error in dwcontrol. Returns the empty string (“”)
if there is no error.
580 PowerBuilder
Usage When a database error occurs while a DataWindow control is interacting

with the database, PowerBuilder triggers the DBError event. Since
DBErrorMessage is meaningful only if a database error has occurred, you
should call this method only in the DBError event.
Examples This statement returns the error message generated by a database error in
dw_employee:
dw_employee.DBErrorMessage()
Since this method is meaningful only in a DataWindow, you can use the
pronoun This instead of the DataWindow’s name:
This.DBErrorMessage()
If data processing fails in dw_Emp and these statements are coded in the
script for the DBError event, a message box containing the error number
and the message displays:
string err_msg
err_msg = This.DBErrorMessage()
IF err_msg <> "" THEN

MessageBox("DBError", "Number" + &
String(This.DBErrorCode())+ " " + &
err_msg, StopSign!)
// Stop PowerBuilder from displaying the
error
RETURN 1
END IF
See also DBErrorCode
DeletedCount
Description Reports the number of rows that have been marked for deletion in the
database.
Applies to
DataStore object
Syntax PowerBuilder

DeletedCount
long dwcontrol.DeletedCount ( )
dwcontrol A reference to a DataWindow control, DataStore, or child
DataWindow
Return value Returns the number of rows that have been deleted from dwcontrol but not
updated in the associated database table.
Returns 0 if no rows have been deleted or if all the deleted rows have been
updated in the database table. DeletedCount returns –1 if it fails.
If any argument’s value is null, in PowerBuilder and JavaScript the
method returns null.
Usage An updatable DataWindow control or DataStore has several buffers. The
primary buffer stores the rows currently being displayed. The delete buffer
stores rows that the application has marked for deletion by calling the
DeleteRow method. These rows are saved until the database is updated.
You can use DeletedCount to find out if there are any rows in the delete
buffer.
If a DataWindow is not updatable, rows that are deleted are discarded—
they are not stored in the delete buffer. Therefore, DeletedCount returns 0
for a nonupdatable DataWindow unless a method, such as RowsCopy or
RowsMove, has been used to populate the delete buffer.
Examples Assuming two rows in dw_employee have been deleted but have not been
updated in the associated database table, these statements set ll_Del to 2:
Long ll_Del
ll_Del = dw_employee.DeletedCount( )
This example tests whether there are rows in the delete buffer, and if so,
updates the database table associated with dw_employee:
Long ll_Del
ll_Del = dw_employee.DeletedCount()
IF ll_Del <> 0 THEN dw_employee.Update()
See also DeleteRow
FilteredCount
ModifiedCount
RowCount
582 PowerBuilder
DeleteRow
Description Deletes a row from a DataWindow control, DataStore object, or child
DataWindow.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.DeleteRow ( long row )
DataWindow.
row A value identifying the row you want to delete. To delete the
current row, specify 0 for row.
Return value Returns 1 if the row is successfully deleted and –1 if an error occurs.
method returns null. If there is no DataWindow object assigned to the
DataWindow control or DataStore, this method returns –1.
Usage DeleteRow deletes the row from the DataWindow’s primary buffer.
If the DataWindow is not updatable, all storage associated with the row is
cleared. If the DataWindow is updatable, DeleteRow moves the row to the
DataWindow’s delete buffer; PowerBuilder uses the values in the delete
buffer to build the SQL DELETE statement.
The row is not deleted from the database table until the application calls
the Update method. After the Update method has updated the database and
the update flags are reset, the storage associated with the row is cleared.
Apply GetChanges after deleting rows in a distributed application

If a DataWindow or data store is populated using SetChanges or
SetFullState, and an Update is done that includes deleted rows, the deleted
rows remain in the delete buffer until a subsequent GetChanges is applied
to the DataWindow or data store.
Examples This statement deletes the current row from dw_employee:

dw_employee.DeleteRow(0)

Describe
These statements delete row 5 from dw_employee and then update the
database with the change:
dw_employee.DeleteRow(5)
dw_employee.Update()
See also DeletedCount
InsertRow
Describe
Description Reports the values of properties of a DataWindow object and controls
within the DataWindow object. Each column and graphic control in the
DataWindow has a set of properties (listed in Chapter 3, DataWindow
Object Properties). You specify one or more properties as a string, and
Describe returns the values of the properties.
Describe can also evaluate expressions involving values of a particular row

and column. When you include Describe’s Evaluate function in the
property list, the value of the evaluated expression is included in the
reported information.
Applies to
DataStore object
Syntax PowerBuilder
string dwcontrol.Describe ( string propertylist )
DataWindow.
propertylist A string whose value is a blank-separated list of properties or
Evaluate functions.
For a list of valid properties, see Chapter 3, DataWindow
Object Properties.
Return value Returns a string that includes a value for each property or Evaluate
function. A newline character (~n or \n) separates the value of each item
in propertylist.
584 PowerBuilder
If the property list contains an invalid item, Describe returns an

exclamation point (!) for that item and ignores the rest of the property list.
Describe returns a question mark (?) if there is no value for a property.
When the value of a property contains an exclamation point or a question

mark, the value is returned in quotes so that you can distinguish between
the returned value and an invalid item or a property with no value.
Usage Use Describe to understand the structure of a DataWindow. For example,
you can find out which bands the DataWindow uses and what the
datatypes of the columns are. You can also use Describe to find out the
current value of a property and use that value to make further
modifications.
Describe is often used to obtain the DataWindow’s SELECT statement in
order to modify it (for example, by adding a WHERE clause).
When you can obtain the DataWindow’s SQL statement

When you use the Select painter to graphically create a SELECT statement,
PowerBuilder saves its own SELECT statement (called a PBSELECT
statement), and not a SQL SELECT statement, with the DataWindow
definition.
When you call Describe with the property Table.Select, it returns a SQL
SELECT statement only if you are connected to the database. If you are not
connected to the database, Describe returns a PBSELECT statement.
Property syntax The syntax for a property in the property list is:
controlname.property
For the types of controls in a DataWindow and their properties with
examples, see Chapter 3, DataWindow Object Properties.
Properties whose value is a list When a property returns a list, the tab
character separates the values in the list. For example, the Bands property
reports all the bands in use in the DataWindow as a list.
header[tab]detail[tab]summary[tab]footer[tab]header.1[tab]trailer.1
If the first character in a property’s returned value list is a quotation mark,
it means the whole list is quoted and any quotation marks within the list
are single quotation marks.

Describe
For example, the following is a single property value.

" Student[tab]'Andrew'or'[newline]Andy' "
Specifying special characters There are different ways of specifying
special characters in a string in each environment:
Table 9-1: Specifying special characters in different environments
Character PowerBuilder JavaScript
tab ~t \t
newline ~n \n
single quote ~’ \’
double quote ~" \"
Quoted property values Describe returns a property’s value enclosed in

quotes when the text would otherwise be ambiguous. For example, if the
property’s value includes a question mark, then the text is returned in
quotes. A question mark without quotes means that the property has no
value.
Column name or number When the control is a column, you can specify
the column name or a pound sign (#) followed by the column number. For
example, if salary is column 5, then "salary.coltype" is equivalent to
"#5.coltype".
Control names The DataWindow painter automatically gives names to
all controls. (In previous versions of PowerBuilder, the painter only named
columns and column labels.)
Evaluating an expression Describe’s Evaluate function allows you to
evaluate DataWindow painter expressions within a script using data in the
DataWindow. Evaluate has the following syntax, which you specify for
propertylist.
Evaluate ( 'expression', rownumber )
Expression is the expression you want to evaluate and rownumber is the
number of the row for which you want to evaluate the expression. The
expression usually includes DataWindow painter functions. For example,
in the following statement, Describe reports either 255 or 0 depending on
the value of the salary column in row 3:
ls_ret = dw_1.Describe( &
"Evaluate('If(salary > 100000, 255, 0)', 3)")
586 PowerBuilder
You can call DataWindow control functions in a script to get data from the
DataWindow, but some painter functions (such as LookUpDisplay) cannot
be called in a script. Using Evaluate is the only way to call them. (See the
example Evaluating the display value of a DropDownDataWindow on
page 588.)
Sample property values To illustrate the types of values that Describe
reports, consider a DataWindow called dw_emp with one group level. Its
columns are named emp and empname, and its headers are named emp_h
and empname_h. The following table shows several properties and the
returned value. In the first example below, a sample command shows how
you might specify these properties for Describe and what it reports.
Table 9-2: Examples of return values for Describe method
Property Reported value
datawindow.Bands header[tab]detail[tab]summary[tab]footer[tab]header.1
[tab]trailer.1
datawindow.Objects emp[tab]empname[tab]emp_h[tab]empname_h
emp.Type column
empname.Type column
empname_h.Type text
emp.Coltype char(20)
state.Type ! (! indicates an invalid item—there is no column
named state)
empname_h.Visible ?
Examples PowerBuilder examples
This example calls Describe with some of the properties shown in the
previous table. The reported values (formatted with tabs and newlines)
follow. Note that because state is not a column in the DataWindow,
state.type returns an exclamation point (!):
string ls_request, ls_report
ls_request = "DataWindow.Bands DataWindow.Objects "&

+ "empname_h.Text " &
+ "empname_h.Type emp.Type emp.Coltype " &
+ "state.Type empname.Type empname_h.Visible"
ls_report = dw_1.Describe(ls_request)
Describe sets the value of ls_report to the following string:
header~tdetail~tsummary~tfooter~theader.1~ttrailer.

Describe
1~N emp~tempname~temp_h~tempname_h~N
"Employee~R~NName"~N text~N column~Nchar(20)~N!
These statements check the datatype of the column named salary before
using GetItemNumber to obtain the salary value:
string ls_data_type
integer li_rate
ls_data_type = dw_1.Describe("salary.ColType")
IF ls_data_type = "number" THEN
li_rate = dw_1.GetItemNumber(5, "salary")
ELSE
. . . // Some processing
END IF
Column name or number This statement finds out the column type of
the current column, using the column name:
s = This.Describe(This.GetColumnName()+ ".ColType")
For comparison, this statement finds out the same thing, using the current
column’s number:
s = This.Describe("#" + String(This.GetColumn()) &
+ ".ColType")
Scrolling and the current row This example, as part of the
DataWindow control’s ScrollVertical event, makes the first visible row the
current row as the user scrolls through the DataWindow:
s = This.Describe("DataWindow.FirstRowOnPage")
IF IsNumber(s) THEN This.SetRow(Integer(s))
Evaluating the display value of a DropDownDataWindow This
example uses Describe’s Evaluate function to find the display value in a
DropDownDataWindow column called state_code. You must execute the
code after the ItemChanged event, so that the value the user selected has
become the item value in the buffer. This code is the script of a custom user
event called getdisplayvalue:
string rownumber, displayvalue
rownumber = String(dw_1.GetRow())
displayvalue = dw_1.Describe( &
"Evaluate('LookUpDisplay(state_code) ', " &
+ rownumber + ")")
This code, as part of the ItemChanged event’s script, posts the
getdisplayvalue event:
588 PowerBuilder
dw_1.PostEvent("getdisplayvalue")
Assigning null values based on the column’s datatype The
following excerpt from the ItemError event script of a DataWindow
control allows the user to blank out a column and move to the next column.
For columns with datatypes other than string, the user cannot leave the
value empty (which is an empty string and does not match the datatype)
without the return code. Data and row are arguments of the ItemError
event:
string s
s = This.Describe(This.GetColumnName() &
+ ".Coltype")
CHOOSE CASE s
CASE "number"
IF Trim(data) = "" THEN
integer null_num
SetNull(null_num)
This.SetItem(row, &
This.GetColumn(), null_num)
RETURN 3
END IF
CASE "date"
IF Trim(data) = "" THEN
date null_date
SetNull(null_date)
This.SetItem(row, &
This.GetColumn(), null_date)
RETURN 3
END IF
. . . // Additional cases for other datatypes
END CHOOSE
See also Create
Modify
Drag
Description Starts or ends the dragging of a control.

Expand
Applies to
Syntax PowerBuilder
integer dwcontrol.Drag ( DragMode dragvalue )
dwcontrol A reference to a DataWindow control or child DataWindow.
dragvalue A value indicating the action you want to take on a control:
• Begin! – Put dwcontrol in drag mode.
• Cancel! – Stop dragging dwcontrol but do not cause a
DragDrop event.
• End! – Stop dragging dwcontrol and if dwcontrol is over a
target object, cause a DragDrop event.
Usage Inherited from DragObject. For information, see Drag in the PowerScript
Reference.
Expand
Description Expands a group in a TreeView DataWindow that has the specified
TreeView level and includes the specified row.
Applies to
Syntax PowerBuilder
Integer dw_control.Expand(long row, long groupLevel)
row The number of the row that belongs to the TreeView level of the
group to be expanded
groupLevel The TreeView level of the group to be expanded
590 PowerBuilder

can be expanded and collapsed. You can use the Expand method to expand
a group in a TreeView DataWindow that includes a particular row in a
particular TreeView level.
The Expand method triggers the Expanding and Expanded events.
Examples The following example expands the group at TreeView level 2 that
includes row 3:
integer li_ret
li_ret = dw_treeview.Expand(3,2)
See also Collapse
ExpandAll
ExpandAllChildren
ExpandLevel
IsExpanded
ExpandAll
Description Expands all groups in a TreeView DataWindow.
Applies to
Syntax PowerBuilder
Integer dw_control.ExpandAll( )
Return value Returns 1 if the ExpandAll operation succeeds and one of the following

ExpandAllChildren
can be expanded and collapsed. You can use the ExpandAll method to
expand all groups in a TreeView DataWindow.
The ExpandAll method triggers the Expanding and Expanded events with
row and level arguments of –1.
Examples The following example expands all groups:
integer li_ret
li_ret = dw_treeview.ExpandAll()
See also Collapse
Expand
ExpandAllChildren
ExpandLevel
IsExpanded
ExpandAllChildren
Description Expands a group in a TreeView DataWindow that has the specified
TreeView level and includes the specified row; also expands all the
group’s children.
Applies to
Syntax PowerBuilder
Integer dw_control.ExpandAllChildren(long row, long groupLevel)
row The number of the row that belongs to the group to be expanded
592 PowerBuilder
can be expanded and collapsed. You can use the ExpandAllChildren method
to expand a group with a specified TreeView level in a TreeView
DataWindow and all of its children.
The ExpandAllChildren method triggers the Expanding and Expanded
events.
Examples The following example expands the group in a TreeView DataWindow
that has TreeView level 2 and includes row 3; it also expands all the
group’s children:
integer li_ret
li_ret = dw_treeview.ExpandAllChildren(3,2)
See also CollapseAllChildren
Expand
ExpandAll
ExpandLevel
IsExpanded
ExpandLevel
Description Expands all the groups in a TreeView DataWindow that have the specified
TreeView level.
Applies to
Syntax PowerBuilder
Integer dw_control.ExpandLevel (long groupLevel)
Return value Returns 1 if the ExpandLevel operation succeeds and one of the following

Filter

can be expanded and collapsed. You can use the ExpandLevel method to
expand all the groups in a TreeView DataWindow that have a particular
TreeView level.
The ExpandLevel method triggers the Expanding and Expanded events
with a row argument of –1.
Examples The following example expands all the groups at TreeView level 2:
integer li_ret
li_ret = dw_treeview.ExpandLevel(2)
See also CollapseLevel
Expand
ExpandAll
ExpandAllChildren
IsExpanded
Filter
Description Displays rows in a DataWindow that pass the current filter criteria. Rows
that do not meet the filter criteria are moved to the filter buffer.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.Filter ( )
DataWindow
Return value Returns 1 if it succeeds and -1 if an error occurs. The return value is
usually not used.
null.
594 PowerBuilder
Usage Filter causes all rows to be retrieved and then it applies the filter. Even
when the Retrieve As Needed option is set, the Filter method retrieves all
rows before applying the filter.
Filter uses the current filter criteria for the DataWindow. To change the
filter criteria, use the SetFilter method. The SetFilter method is equivalent
to using the Filter command on the Rows menu of the DataWindow
painter. If you do not call SetFilter to assign or change criteria before
calling the Filter method, the DataWindow will default to use the criteria
in the object definition.
When the Retrieve method retrieves data for the DataWindow,
PowerBuilder applies the filter that was defined for the DataWindow
object, if any. You only need to call Filter after you change the filter criteria
with SetFilter or if the data has changed because of processing or user
input.
Filter has no effect on the DataWindows in a composite report.
Filtering and groups

When you filter a DataWindow with groups, you might need to call
GroupCalc after you call Filter.
For information on removing the filter or letting the user specify a filter
expression, see SetFilter.
Examples This statement displays rows in dw_Employee based on its current filter
criteria:
dw_Employee.SetRedraw(false)
dw_Employee.Filter()
dw_Employee.SetRedraw(true)
See also FilteredCount
RowCount
SetFilter
FilteredCount
Description Reports the number of rows that are not displayed in the DataWindow
because of the current filter criteria.

FilteredCount
Applies to
DataStore object
Syntax PowerBuilder
long dwcontrol.FilteredCount ( )
DataWindow
Return value Returns the number of rows in dwcontrol that are not displayed because
they do not meet the current filter criteria. Returns 0 if all rows are
displayed and -1 if an error occurs.
null.
Usage A DataWindow object can have a filter as part of its definition. After the
DataWindow retrieves data, the filter is applied and rows that do not meet
the filter criteria are moved to the filter buffer. You can change the filter
criteria by calling the SetFilter method, and you can apply the new criteria
with the Filter method.
Examples These statements retrieve data in dw_Employee, display employees with
area code 617, and then test to see if any other data was retrieved. If the
filter criteria specifying the area code was part of the DataWindow
definition, it would be applied automatically after calling Retrieve and you
would not need to call SetFilter and Filter:
dw_Employee.Retrieve()
dw_Employee.SetFilter("AreaCode=617")
// Did any rows get filtered out

IF dw_Employee.FilteredCount() > 0 THEN
... // Process rows not in area code 617
END IF
These statements retrieve data in dw_Employee and display the number of
employees whose names do not begin with B:
dw_Employee.Retrieve()
596 PowerBuilder
dw_Employee.SetFilter("Left(emp_lname, 1)=~"B~"")
IF dw_Employee.FilteredCount() > 0 THEN

MessageBox("Employee Count", &
String(dw_Employee.FilteredCount()) + &
"Employee names do not begin with B.")
END IF
See also Filter
ModifiedCount
RowCount
SetFilter
Find
Description Finds the next row in a DataWindow or DataStore in which data meets a
specified condition.
Applies to
DataStore object
Syntax PowerBuilder
long dwcontrol.Find ( string expression, long start, long end )
dwcontrol A reference to the DataWindow control, DataStore, or child
DataWindow in which you want to search the detail band.
expression A string whose value is a boolean expression that you want to
use as the search criterion. The expression includes column
names.
start A value identifying the row location at which to begin the
search. Start can be greater than the number of rows.
end A value identifying the row location at which to end the search.
End can be greater than the number of rows. To search
backward, make end less than start.

Find
Return value Returns the number of the first row that meets the search criteria within the
search range. Returns 0 if no rows are found and one of these negative
numbers if an error occurs:
–1 General error
–5 Bad argument
For use with a RichTextEdit control or presentation style, see Find in the
The search is case-sensitive. When you compare text to a value in a

column, the case must match.
When the Find expression includes quotes If the text you want to
find includes quotes, you must treat the nested quote as doubly nested,
because the DataWindow parses the string twice before the Find method
uses it. Therefore, you cannot simply alternate double and single quotes,
as you can in most strings.
For example, to find the name O’Connor, the Find expression can be:
"O~~~’Connor" (3 tildes and single quote) or
"O~~~~~"Connor" (5 tildes and double quote)
but not:
"O’Connor" or "O~"OConnor"
When the last row satisfies the search criteria If you use Find in a
loop that searches through all rows, you may end up with an endless loop
if the last row satisfies the search criteria. When the start value becomes
greater than end, the search reverses direction and Find would always
succeed, resulting in an endless loop.
To solve this problem, you could make the end value 1 greater than the
number of rows (see the examples). Another approach, shown below,
would be to test within the loop whether the current row is greater than the
row count and, if so, exit. This PowerBuilder code illustrates how:
long ll_find = 1, ll_end
ll_end = dw_main.RowCount()
ll_find = dw_main.Find(searchstr, ll_find, ll_end)
DO WHILE ll_find > 0
... // Collect found row
598 PowerBuilder
ll_find++
// Prevent endless loop
IF ll_find > ll_end THEN EXIT
ll_find = dw_main.Find(searchstr, ll_find,
ll_end)
LOOP
Examples This statement searches for the first row in dw_status in which the value
of the emp_salary column is greater than 100,000. The search begins in
row 3 and continues until it reaches the last row in dw_status:
long ll_found
ll_found = dw_status.Find("emp_salary > 100000", &
3, dw_status.RowCount())
To test values in more than one column, use boolean operators to join
conditional expressions. The following statement searches for the
employee named Smith whose salary exceeds 100,000:
long ll_found
ll_found = dw_status.Find( &
"emp_lname = 'Smith' and emp_salary >
100000", &
1, dw_status.RowCount())
These statements search for the first row in dw_emp that matches the value
that a user entered in the SingleLineEdit called Name (note the single
quotes embedded in the search expression around the name):
string ls_lname_emp
long ll_nbr, ll_foundrow
ll_nbr = dw_emp.RowCount()
// Remove leading and trailing blanks.

ls_lname_emp = Trim(sle_Name.Text)
ll_foundrow = dw_emp.Find( &

"emp_lname = '" + ls_lname_emp + "'", 1,
ll_nbr)
This script excerpt finds the first row that has a null value in emp_id. If no
null is found, the script updates the DataWindow object. If a null is found,
it displays a message:
IF dw_status.AcceptText() = 1 THEN
IF dw_status.Find("IsNull(emp_id)", &
1, dw_status.RowCount()) > 0 THEN
MessageBox("Caution", "Cannot Update")

Find
ELSE
dw_status.Update()
END IF
END IF
The following script attached to a Find Next command button searches for
the next row that meets the specified criteria and scrolls to that row. Each
time the button is clicked, the number of the found row is stored in the
instance variable il_found. The next time the user clicks Find Next, the
search continues from the following row. When the search reaches the end,
a message tells the user that no row was found. The next search begins
again at the first row.
Note that although the search criteria are hard-coded here, a more realistic
scenario would include a Find button that prompts the user for search
criteria. You could store the criteria in an instance variable, which Find
Next could use:
long ll_row
// Get the row num. for the beginning of the search

// from the instance variable, il_found
ll_row = il_found
// Search using predefined criteria

ll_row = dw_main.Find( &
"item_id = 3 or item_desc = 'Nails'", &
ll_row, dw_main.RowCount())
IF ll_row > 0 THEN
// Row found, scroll to it and make it current
dw_main.ScrollToRow(ll_row)
ELSE
// No row was found
MessageBox("Not Found", "No row found.")
END IF
// Save the number of the next row for the start

// of the next search. If no row was found,
// ll_row is 0, making il_found 1, so that
// the next search begins again at the beginning
il_found = ll_row + 1
This example searches all the rows in dw_main and builds a list of the
names that include a lowercase a. Note that the end value of the search is
one greater than the row count, avoiding an infinite loop if the name in the
last row satisfies the search:
600 PowerBuilder
long ll_find, ll_end

string ll_list
// The end value is one greater than the row count

ll_end = dw_main.RowCount() + 1
ll_find = 1
ll_find = dw_main.Find("Pos(last_name,'a') > 0", &

ll_find, ll_end)
DO WHILE ll_find > 0
//collect names
ll_list = ll_list + '~r' &
+
dw_main.GetItemString(ll_find,'last_name')
// Search again
ll_find++
ll_find = dw_main.Find("Pos(last_name,'a') &
> 0", ll_find, ll_end )
LOOP
See also FindGroupChange
FindRequired
FindGroupChange
Description Searches for the next break for the specified group. A group break occurs
when the value in the column for the group changes. FindGroupChange
reports the row that begins the next section.
Applies to
Syntax PowerBuilder
long dwcontrol.FindGroupChange ( long row, integer level )
dwcontrol A reference to a DataWindow control or the DataStore.
row A value identifying the row at which you want to begin
searching for the group break.

FindGroupChange
level The number of the group for which you are searching. Groups
are numbered in the order in which you defined them.
Return value Returns the number of the row whose group column has a new value,
meaning that it begins a new group. Returns 0 if the value in the group
column did not change and a negative number if an error occurs.
The return value observes these rules based on the value of row. If the
starting row is:
• The first row in a group, then FindGroupChange returns the starting
row number
• A row within a group, other than the last group, then
FindGroupChange returns the row number of the first row of the next
group
• A row in the last group, other than the first row of the last group, then
FindGroupChange returns 0
Usage If the starting row begins a new section at the specified level, then that row
is the one returned. To continue searching for subsequent breaks,
increment the starting row so that the search resumes with the second row
in the group.
Examples This statement searches for the first break in group 2 in dw_regions. The
search begins in row 5:
dw_regions.FindGroupChange(5, 2)
This code finds the number of the row at which a break occurs in group 1.
It then checks whether the department number is 121. The search begins
at row 0:
boolean lb_found
long ll_breakrow
lb_found = false
ll_breakrow = 0
DO WHILE NOT (lb_found)

ll_breakrow = dw_1.FindGroupChange(ll_breakrow,
1)
602 PowerBuilder
// If no breaks are found, exit.

IF ll_breakrow <= 0 THEN EXIT
// Have we found the section for Dept 121?

IF dw_1.GetItemNumber(ll_breakrow, &
"dept_id") = 121 THEN
lb_found = true
END IF
// Increment starting row to find next break

ll_breakrow = ll_breakrow + 1
LOOP
IF lb_found = false THEN

MessageBox( &
"Not Found", &
"The Department was not found.")
ELSE
... // Processing for Dept 121
END IF
See also Find
FindRequired
FindNext
Description Finds the next occurrence of text in a RichTextEdit DataWindow control
and highlights it, using criteria set up in a previous call of the Find method.
Applies to
Syntax PowerBuilder
integer dwcontrol.FindNext ( )
dwcontrol A reference to a DataWindow control containing a
DataWindow with the RichTextEdit presentation style
Return value Returns the number of characters found. FindNext returns 0 if no matching
text is found and -1 if the DataWindow’s presentation style is not
RichTextEdit or an error occurs.

FindRequired

For use with PowerBuilder RichTextEdit controls, see FindNext in the
Examples This example searches the DataWindow control dw_1 for text the user
specifies in the SingleLineEdit sle_search. The search proceeds forward
from the cursor position, is case-insensitive, and is not limited to whole
words:
integer li_charsfound
li_charsfound = dw_1.Find(sle_search.Text, &
true, true, false, true)
A second button labeled Find Next would have a script like this:
dw_1.FindNext()
See also Find
FindRequired
Description Reports the next row and column that is required and contains a null value.
The method arguments that specify where to start searching also store the
results of the search. You can speed up the search by specifying that
FindRequired check only inserted and modified rows.
Applies to
Syntax PowerBuilder
integer dwcontrol.FindRequired ( DWBuffer dwbuffer, long row,
integer colnbr, string colname, boolean updateonly )
dwcontrol A reference to the DataWindow control or DataStore in which
you want to find required columns that have null values.
dwbuffer A value indicating the DataWindow buffer you want to search
for required columns. Valid buffers are:
• Primary!
• Filter!
604 PowerBuilder
row A value identifying the first row to be searched. Row also
stores the number of the found row. FindRequired increments
the row number automatically after it validates each row’s
columns. When it finds a row with a required column that
contains a null value, the row number is stored in row. After
FindRequired validates the last column in the last row, it sets
row to 0.
PowerBuilder The row argument must be a variable so it
can return a value for the found row.
colnbr A value identifying the first column to be searched. Colnbr
also stores the number of the found column. After validating
the last column, FindRequired sets colnbr to 1 and
increments row. When it finds a required column that contains
a null value, the column number is stored in colnbr.
PowerBuilder The colnbr argument must be a variable so it
can return a value for the found column.
colname A string in which you want to store the name of the required
column that contains a null value (the name of colnbr).
PowerBuilder The colname argument must be a variable so
it can hold a value for the name of the found column.
updateonly A value indicating whether you want to validate all rows and
columns or only rows that have been inserted or modified:
• true – Validate only those rows that have changed. Setting
updateonly to true enhances performance in large
DataWindows.
• false – Validate all rows and columns.
Return value Returns 1 if FindRequired successfully checked the rows and –1 if an error
occurs.
Usage For FindRequired to report an empty required column, the column’s value
must actually be null, not an empty string.
To make a column required, set the Required property to true in a script or
check the Required check box for the column in the DataWindow painter.
New rows have null values in their columns, unless the columns have
default values. If updateonly is false, FindRequired reports empty required
columns in new rows. If updateonly is true, FindRequired does not check
new rows because new, empty rows are not updated in the database.

FindRequired
When the user modifies a row and leaves a column empty, the new value
is an empty string, unless the column’s edit style has the Empty String Is
null check box checked. FindRequired does not report empty required
columns in modified rows unless this property is set.
Examples The following code makes a list of all the row numbers and column names
in dw_1 in which required columns are missing values. The list is
displayed in the MultiLineEdit mle_required:
long ll_row = 1
integer colnbr = 0
string colname
mle_required.Text = ""
DO WHILE ll_row <> 0
colnbr++ // Continue searching at next column
// If there's an error, exit
IF dw_1.FindRequired(Primary!, &
ll_row, colnbr, &
colname, false) < 0 THEN EXIT
// If a row was found, save the row and column

IF ll_row <> 0 THEN
mle_required.Text = mle_required.Text &
+ String(ll_row) + "~t" &
+ colname + "~r~n"
END IF
// When FindRequired returns 0 (meaning

// no more rows found), drop out of loop
LOOP
This example is a function that ensures that no required column in a
DataWindow control is empty (contains null). It takes one argument—the
DataWindow control, which is declared in the function declaration like
this:
DataWindow adw_control
The function returns –2 if the user’s last entry cannot be accepted or if
FindRequired returns an error. It returns –1 if an empty required column is
found. It returns 1 if all required columns have data:
integer li_colnbr = 1
long ll_row = 1
string ls_colname, ls_textname
// Make sure the last entry is accepted
606 PowerBuilder
IF adw_control.AcceptText() = -1 THEN
adw_control.SetFocus()
RETURN -2
END IF
// Find the first empty row and column, if any

IF adw_control.FindRequired(Primary!, ll_row, &
li_colnbr, ls_colname, true) < 1 THEN
//If search fails due to error, then return
RETURN -2
END IF
// Was any row found?

IF ll_row <> 0 THEN
// Get the text of that column's label.
ls_textname = ls_colname + "_t.Text"
ls_colname =
adw_control.Describe(ls_textname)
// Tell the user which column to fill in

MessageBox("Required Value Missing", &
"Please enter a value for '" &
+ ls_colname + "', row " &
+ String(ll_row) + ".", &
StopSign! )
// Make the problem column current.

adw_control.SetColumn(li_colnbr)
adw_control.ScrollToRow(ll_row)
adw_control.SetFocus()
RETURN -1
END IF
// Return success code if all required

// rows and columns have data
RETURN 1
See also Find
FindGroupChange
FindRequiredColumn
FindRequiredColumnName
FindRequiredRow
ScrollToRow
SetColumn
SetTransObject

FindRequiredColumn
FindRequiredColumn
Description Returns the column number that the FindRequired method found. The
column is being reported because it is a required column but contains a
null value. You must call FindRequired first to search for the required but
missing information.
Obsolete method
FindRequiredColumn is obsolete and should not be used, because the
DataWindow Web Control for ActiveX technology is obsolete.
Applies to
Syntax Web ActiveX

number dwcontrol.FindRequiredColumn ( )
called FindRequired
Return value Returns the number of a column in the DataWindow.

Usage FindRequiredColumn, FindRequiredColumnName, and FindRequiredRow
can all be called after FindRequired to identify rows and columns with
missing data. For details, see FindRequired on page 604.
See also FindRequired
FindRequiredRow
Description Returns the column name that the FindRequired method found. The
column is being reported because it is a required column but contains a
null value. You must call FindRequired first to search for the required but
missing information.
608 PowerBuilder
Obsolete method
FindRequiredColumnName is obsolete and should not be used, because the
Applies to
Syntax Web ActiveX

string dwcontrol.FindRequiredColumnName ( )
called FindRequired
Return value Returns the name of a column in the DataWindow.

FindRequiredColumn
FindRequiredRow
FindRequiredRow
Description Returns the row number that the FindRequired method found. The row is
being reported because it contains a required column that has a null value.
You must call FindRequired first to search for the required but missing
information.
Obsolete method
FindRequiredRow is obsolete and should not be used, because the
Applies to

Generate
Syntax Web ActiveX

number dwcontrol.FindRequiredRow ( )
called FindRequired
Return value Returns the number of a row in the DataWindow.

FindRequiredColumn
Generate
Description Creates HTML syntax for the Web DataWindow.
Obsolete method
Generate is obsolete and should not be used, because the Web
Applies to
Web Server component
Syntax Web DataWindow server component

string dwcontrol.Generate ( )
Return value Returns an HTML rendering of the current page of the DataWindow if the
method succeeds and an empty string if an error occurs.
Usage Call this method to create HTML syntax from the DataWindow defined
for the server component. The Generate method is usually called by a
server-side script running on a page server. The page server creates the
complete Web page by combining the return value with other appropriate
HTML elements.
610 PowerBuilder
The contents of the page of data can be affected by user actions in the
client control. The page server calls the SetAction method before calling
Generate to apply the user’s actions.
The Generate method causes DataWindow columns to be rendered as

HTML INPUT elements with the following exceptions:
• A column to which you assign a hyperlink. The hyperlink is valid only
if the column tab order is set to 0, its Protect property is set to 1, or if
it has an Edit.DisplayOnly property that is set to “yes”. A column with
a valid hyperlink is rendered in an <A HREF> tag.
• A column for which the ValueIsHTML property is set to true. The
column value can be plain text or some combination of HTML tags
and plain text. The column value is included unchanged within the
generated HTML page.
• A column with a DropDownListBox or DropDownDW edit style.
Columns with these edit styles are always be rendered in <SELECT>
tags.
• Computed fields that are not dynamically calculated on the client.
Computed fields are rendered as HTML INPUT elements only if the
ClientComputedFields property for the DataWindow is set to “yes”.
Otherwise they are rendered as text.
If the column has a validation rule, it is translated to JavaScript if possible.
Parts of the DataWindow object included in the generated HTML are:
• Columns, computed fields, text controls
• Pictures (picture format should be GIF or JPEG)
• Buttons
• Page headers and footers
• Group headers and trailers
• Summary bands
• Display formats, validation rules, edit styles (EditMasks are
converted to display formats)
DataWindow features that will not be rendered into HTML include:
• Graph, OLE, and RichText presentation styles and controls
• Drawing controls (lines, circles, rectangles)

GenerateHTMLForm
• Client-side expressions that include aggregate functions. Such

expressions will be computed on the server
• Resizable and movable controls
• Sliding of controls to fill empty space
• Autosizing of height or width
Examples The following example generates a DataWindow object in HTML:
dwGen.Generate();
See also GenerateXHTML
GenerateXMLWeb
SetAction
SetBrowser
SetColumnLink
SetDWObject
SetHTMLObjectName
SetPageSize
SetSelfLink
SetServerSideState
SetTrans
SetWeight
GenerateHTMLForm
Description Creates an HTML Form element containing columns for one or more rows
in a DataWindow control or DataStore. This method also returns an
HTML Style element containing style sheet information.
Obsolete method
GenerateHTMLForm is obsolete and should not be used, because the Web
Applies to
DataStore object
Syntax PowerBuilder
612 PowerBuilder
integer dwcontrol.GenerateHTMLForm ( string syntax, string style,

string action { , long startrow, long endrow, integer startcolumn,
integer endcolumn {, DWBuffer buffer } } )
Return value Returns 1 if the method succeeds and –1 if an error occurs.
If any argument is null, the method returns null.
GenerateResultSet
Description Generates a result set from data in a DataStore or DataWindow control.
In PowerBuilder, when the result set is generated in a component on a
transaction server, the format of the result set is ADO Recordset on MTS.
Applies to
PowerBuilder DataStore object
Syntax PowerBuilder
integer dsobject.GenerateResultSet (REF ResultSet rsdest {
,dwBuffer dwbuffer } )
dsobject The name of the DataStore object that contains the data to be
returned in the result set.
rsdest The ResultSet object into which the data in the DataStore is
written. This value is passed by reference.
dwbuffer A value of the dwBuffer enumerated datatype identifying the
(optional) DataWindow buffer containing the data for the result set. The
default is the primary buffer.
Return value Returns 1 if it succeeds and –1 if it fails. If any argument is null, it returns
null.
Usage How to use it Result sets are intended for exchanging data between a
DataStore and some data-aware application that does not use DataWindow
technology. With result sets, the receiving end does not support updating
of the data.

GenerateResultSet
The GenerateResultSet method is typically used in a PowerBuilder custom

class user object that has been packaged as a component on an MTS server.
A function in the user object generates a result set from information that
has been retrieved into a DataStore. The function then returns the result set
or passes it to another method.
For example, a function for PowerBuilder custom class user object
running in a transaction server can retrieve data into a DataStore object,
create a result set object, and return the result set. A client application calls
the function to get the data. The client application must be able to handle
result sets, but it does not need to have support for DataWindow
technology.
Likewise, a client application can generate a result set from a DataStore
and pass the result set to the server.
The CreateFrom method can convert a result set back to a DataStore.
Result set format The result set is returned to a client in a format that is
standard for the server. In MTS, returning a result set created by
GenerateResultSet causes an ADO Recordset to be marshaled to the client.
The GenerateResultSet method can also be called in a client application.

Since the format of the result set depends on the server on which it is used,
the format is fixed when that result set is passed to a server. For MTS, the
format is an ADO Recordset.
Destroying or modifying the DataStore

The generated ResultSet object maintains a reference to the DataStore
from which it was generated, so changes made to the DataStore object
after the result set is generated will be reflected in the generated ResultSet
object. If you destroy the DataStore object before returning the result set,
the result set becomes invalid. You can rely on garbage collection to
destroy the DataStore object or destroy it explicitly in the component’s
deactivate event.
Examples In this example, a DataStore object is created and data is retrieved into it,
and then the GenerateResultSet method is used to create a result set that
can be returned to a client.
datastore ds_datastore
resultset lrs_resultset
integer li_rc
ds_datastore = CREATE DataStore
614 PowerBuilder
ds_datastore.SetTransObject (SQLCA)
IF ds_datastore.Retrieve() = -1 THEN
... // report error and return
END IF
li_rc =
ds_datastore.GenerateResultSet(lrs_resultset)
IF li_rc <> 1 THEN
... // report error and return
END IF
return lrs_resultset
See also CreateFrom
SetRecordSet in PowerScript Reference
GenerateXHTML
Description Generates the inline content of the Web DataWindow in XHTML.
Obsolete method
GenerateXHTML is obsolete and should not be used, because the Web
Applies to

string dwcontrol.GenerateXHTML ({page[ ] variables})
dwcontrol The name of the server-side DataWindow control you want to
generate in XHTML.
page An array for passing page variables. The page variables must
be defined as String datatypes.
Return value Integer. 1 indicates success, and –1 indicates failure.

GenerateXHTML
Usage At runtime, GenerateXHTML performs the tasks required to generate the

dynamic XHTML, including retrieving the action context and generating
the XHTML inline. Connection errors, including database error messages,
are also generated inline.
For information about the advantages and limitations of each rendering
format, see the DataWindow Programmers Guide.
The GenerateXHTML method delivers the DataWindow in XHTML to the
client browser and it generates a CSS style sheet and JS files that are
cached on the client side and referenced in the XHTML source.
Examples The following JSP example specifies subdirectories of the current
application directory to publish the CSS and JS components of the Web
DataWindow and generates the DataWindow in XHTML:
String resourceBase = request.getScheme() + "://" +
request.getServerName() + ":" +
request.getServerPort() +
request.getContextPath();
String publishPath = application.getRealPath("/");
dwGen.Modify("DataWindow.CSSGen.ResourceBase = '" +
resourceBase + "/css'");
dwGen.Modify("DataWindow.CSSGen.PublishPath = '" +
publishPath + "css'");
dwGen.Modify("DataWindow.JSGen.ResourceBase = '" +
resourceBase + "/js'");
dwGen.Modify("DataWindow.JSGen.PublishPath = '" +
publishPath + "js'");
String dwXHTML = dwGen.GenerateXHTML();

out.print (dwXHTML);
See also Generate
GenerateXMLWeb
616 PowerBuilder
GenerateXMLWeb
Description Generates the XML content and the XSLT and CSS style sheets for a Web
DataWindow, which is transformed to XHTML on the client side.
Obsolete method
GenerateXMLWeb is obsolete and should not be used, because the Web
Applies to

string dwcontrol.GenerateXMLWeb ({page[ ] variables})
dwcontrol The name of the server-side DataWindow control
page An array for passing page variables. The page variables must
be defined as String datatypes.
Return value Integer. 1 indicates success, and –1 indicates failure.

Usage The GenerateXMLWeb function uses the resource base and publish paths
for a DataWindow object to determine where it generates XML, XSLT,
CSS, and JS files. If a resource base or a publish path is not specified for
a DataWindow object, the GenerateXMLWeb function creates a TEMP
directory on the server where the XML, XSLT, CSS, and JS files are
stored.
At design time, you can override the resource base and publish paths by
making Modify calls on the DataWindow object in the Source view before
you call GenerateXMLWeb. The following example creates separate
subdirectories for XML, XSLT, CSS, and JS files:
String resourceBase = request.getScheme() + "://" +
request.getServerName() + ":" +
request.getServerPort() +
request.getContextPath();
String publishPath = application.getRealPath("/");
dwGen.Modify("DataWindow.XMLGen.ResourceBase = '" +
resourceBase + "/xml'");

GenerateXMLWeb
dwGen.Modify("DataWindow.XMLGen.PublishPath = '" +
publishPath + "xml'");
dwGen.Modify("DataWindow.XSLTGen.ResourceBase = '"
+
resourceBase + "/xsl'");
dwGen.Modify("DataWindow.XSLTGen.PublishPath = '" +
publishPath + "xsl'");
dwGen.Modify("DataWindow.CSSGen.ResourceBase = '" +
resourceBase + "/css'");
dwGen.Modify("DataWindow.CSSGen.PublishPath = '" +
publishPath + "css'");
dwGen.Modify("DataWindow.JSGen.ResourceBase = '" +
resourceBase + "/js'");
dwGen.Modify("DataWindow.JSGen.PublishPath = '" +
publishPath + "js'");
At runtime, the client browser displays an XHTML page that it transforms
from XML using XSLT applied with CSS and JS files that it gets initially
from the server. However, in most cases, after the initial loading of the
page, the client does not need to go back to the server to obtain layout
(XSLT) or styling (CSS) information, as these remain in the browser’s
cache. This provides greater efficiency and scalability for your Web
applications.
Examples In the following example, the Web DataWindow component generates the
XML document, XSLT and CSS style sheets, and JS files for the content,
structure, styling, and client-side functionality of the Web DataWindow:
dwGen.GenerateXMLWeb();
See also Generate
GenerateXHTML
618 PowerBuilder
GetBandAtPointer
Description Reports the band in which the pointer is currently located, as well as the
row number associated with the band. The bands are the headers, trailers,
and detail areas of the DataWindow and correspond to the horizontal areas
of the DataWindow painter.
Applies to
Syntax PowerBuilder
string dwcontrol.GetBandAtPointer ( )
dwcontrol A reference to a DataWindow control.
Return value Returns a string that names the band in which the pointer is located,
followed by a tab character and the number of the row associated with the
band (see the table in Usage). Returns the empty string (“ ”) if an error
occurs.
Usage The following table lists the band names, where the pointer is when a
given band is reported, and the row that is associated with the band.
Band Location of pointer Associated row
detail In the body of the The row at the pointer. If rows do not fill
DataWindow object the body of the DataWindow object
because of a group with a page break,
then the first row of the next group. If
the body is not filled because there are
no more rows, then the last row.
header In the header of the The first row visible in the DataWindow
DataWindow object body.
header.n In the header of group The first row of the group.
level n
trailer.n In the trailer of group The last row of the group.
level n
footer In the footer of the The last row visible in the DataWindow
DataWindow object body.
summary In the summary of the The last row before the summary.
DataWindow object

GetBorderStyle
You can parse the return value by searching for the tab character (ASCII
09). In PowerBuilder, search for ~t. For an example that parses a string that
includes a tab, see GetValue.
Examples These statements set the string named band to the location of the pointer
in DataWindow dw_rpt:
String band
band = dw_rpt.GetBandAtPointer()
Some possible return values are:
Table 9-3: Example return values for the GetBandAtPointer method
Return value Meaning
detail[tab]8 In row 8 of the detail band of dw_rpt
header[tab]10 In the header of dw_rpt; row 10 is the first visible row
header.2[tab]1 In the header of group level 2 for row 1
trailer.1[tab]5 In the trailer of group level 1 for row 5
footer[tab]111 In the footer of dw_rpt; the last visible row is 111
summary[tab]23 In the summary of dw_rpt; the last row is 23
See also GetObjectAtPointer
GetBorderStyle
Description Reports the border style of a column in a DataWindow control or
DataStore object.
Applies to
DataStore object
Syntax PowerBuilder
border dwcontrol.GetBorderStyle ( integer column )
border dwcontrol.GetBorderStyle ( string column )
DataWindow.
column The column for which you want to obtain the border style.
Column can be a column number or a column name.
620 PowerBuilder
Return value Returns the border style of column in dwcontrol as a value of the Border
enumerated datatype. For a list of possible values, see Border on page 483.
Returns null if it fails. If any argument is null, the method returns null.
Examples This code gets the border style for the current column:
border B2
B2 = dw_emp.GetBorderStyle(dw_emp.GetColumn())
This code tests the border of column 2 in dw_emp and, if there is no
border, displays a shadow box border:
border B2
B2 = dw_emp.GetBorderStyle(2)
IF B2 = NoBorder! THEN
dw_emp.SetBorderStyle(2, ShadowBox!)
END IF
See also SetBorderStyle
GetChanges
Description Retrieves changes made to a DataWindow or DataStore as a blob. This
method is used primarily in distributed applications.
Applies to
Syntax PowerBuilder
long dwcontrol.GetChanges ( REF blob changeblob {, blob cookie }
)
changeblob A variable into which the returned DataWindow changes will
be placed.
cookie A read-only blob created by GetStateStatus that is compared
(obsolete) with the changeblob to determine the likely success of a
subsequent call to SetChanges.
This argument is obsolete and will be disabled in a future
release.

GetChanges
Return value Returns the number of rows in the DataWindow change blob if it succeeds
and one of the following values if it fails:
• –1 An internal error occurred.
• –2 There is a conflict between the state of the DataWindow change
blob and the state of the DataWindow from which the cookie was
created; an attempt to use this blob in a SetChanges call against the
DataWindow will fail.
• –3 There is a conflict between the state of the DataWindow change
blob and the state of the DataWindow from which the cookie was
created; but partial changes from the change blob can be applied.
If any argument is null, the method returns null.
Usage GetChanges is used in conjunction with SetChanges to synchronize two or
more DataWindows or DataStores. GetChanges retrieves data buffers and
status flags for changed rows in a DataWindow or DataStore and places
this information in a blob. SetChanges then applies the contents of this
blob to another DataWindow or DataStore.
Reapplying changes from one DataWindow (or DataStore) to another

If you call GetChanges on a DataWindow and apply the data passed in the
changeblob argument to another DataWindow using SetChanges, you
must call GetChanges on the second DataWindow before you reapply
changes to it from the first DataWindow. The GetChanges call on the
second DataWindow updates the original timestamp on that DataWindow
so that it matches the current timestamp. (You cannot use the Reset,
ResetUpdate, or AcceptText calls to update the original timestamp.) If you
try to reapply changes without first calling GetChanges on the second
DataWindow, you will get an error due to the conflict between the state of
the DataWindow changeblob and the state of the second DataWindow.
The change blob created by GetChanges includes only those rows that
have a status of New!, NewModified!, or DataModified!.
For information about status values, see DWItemStatus on page 486.
Examples These statements use GetChanges to capture changes to a DataWindow
control on a client. If GetChanges succeeds, the client calls a remote object
function that applies the changes to a DataStore on the server and updates
the database:
blob lblb_changes
long ll_rv
622 PowerBuilder
ll_rv = dw_employee.GetChanges(lblb_changes)
IF ll_rv = -1 THEN
MessageBox("Error", "GetChanges call
failed!")
ELSE
iuo_employee.UpdateData(lblb_changes)
END IF
See also GetFullState
GetStateStatus
SetChanges
SetFullState
GetChangesBlob
Description Returns changes made to a DataWindow or DataStore. You must call
GetChanges first to set up the change information. This method is used
primarily in distributed applications.
Obsolete method
GetChangesBlob is obsolete and should not be used, because the
Applies to
Syntax Web ActiveX

string dwcontrol.GetChangesBlob ( )
called GetChanges
Return value Returns a string whose value is the DataWindow change blob set up by
GetChanges.

GetChild
Usage GetChanges and GetChangesBlob are used in conjunction with

SetChanges to synchronize two or more DataWindows or DataStores. For
details, see GetChanges.
the database:
blob lblb_changes
long ll_rv
IF ll_rv = -1 THEN
failed!")
ELSE
END IF
GetStateStatus
SetChanges
SetFullState
GetChild
Description Provides a reference to a child DataWindow or to a report in a composite
DataWindow, which you can use in DataWindow functions to manipulate
that DataWindow or report.
Applies to
Syntax PowerBuilder
integer dwcontrol.GetChild (string name, REF DataWindowChild
dwchildvariable )
dwcontrol A reference to the DataWindow control or DataStore that
contains the child DataWindow or report.
624 PowerBuilder
name A string that names the column containing the child
DataWindow or that names the report in the composite
DataWindow.
dwchildvariable A variable in which you want to store the reference to the
child DataWindow or report.
Return value Returns 1 if it succeeds and –1 if an error occurs—for example, if the child
object does not exist.
If any argument is null, in PowerBuilder and JavaScript the method returns
null.
Usage A child DataWindow is a DropDownDataWindow in a DataWindow
object.
A report is a DataWindow that is part of a composite DataWindow. A
report is read-only. When you define the composite DataWindow in the
DataWindow painter, each report is given a name. You can see the name
in the Name option of the Properties view. You must use the report name
(not the name of the DataWindow object in which the report has been
placed) when calling GetChild.
Use GetChild when you need to explicitly retrieve data for a child
DataWindow or report. Although PowerBuilder automatically retrieves
data for the child or report when the main DataWindow is displayed, you
need to explicitly retrieve data when there are retrieval arguments or when
conditions change and you want to retrieve new rows.
When you insert a row or retrieve data in the main DataWindow,
PowerBuilder automatically retrieves data for the child DataWindow. If
the child DataWindow has retrieval arguments, PowerBuilder displays a
dialog box asking the user for values for those arguments. To suppress the
dialog box, you can explicitly retrieve data for the child before changing
the main DataWindow (see the example).
Nested reports
You cannot use GetChild to get a reference to a report in a composite
DataWindow when the report itself is a composite or nested DataWindow.
Changing property values with the Modify method can cause the reference
returned by GetChild to become invalid. After setting such a property, call
GetChild again. If a property causes this behavior, this is noted in its
description in Chapter 3, DataWindow Object Properties.

GetChild
Examples This example retrieves data for the child DataWindow associated with the
column emp_state before retrieving data in the main DataWindow. The
child DataWindow expects a region value as a retrieval argument. Because
you populate the child DataWindow first, specifying a value for its
retrieval argument, there is no need for PowerBuilder to display the
retrieval argument dialog box:
DataWindowChild state_child
integer rtncode
rtncode = dw_1.GetChild('emp_state', state_child)

IF rtncode = -1 THEN MessageBox( &
"Error", "Not a DataWindowChild")
// Establish the connection

CONNECT USING SQLCA;
// Set the transaction object for the child

state_child.SetTransObject(SQLCA)
// Populate with values for eastern states

state_child.Retrieve("East")
// Set transaction object for main DW and retrieve

dw_1.SetTransObject(SQLCA)
dw_1.Retrieve()
In a composite DataWindow there are two reports: orders and current
inventory. The orders report has a retrieval argument for selecting the
order status. This report displays open orders. The composite
DataWindow is displayed in a DataWindow control called dw_news and
the reports are named open_orders and current_inv. The following code in
the Open event of the window that contains dw_news provides a retrieval
argument for open_orders:
DataWindowChild dwc_orders
dw_news.GetChild("open_orders", dwc_orders)
dwc_orders.SetTransObject(SQLCA)
dwc_orders.Retrieve("open")
See also GetChildObject
SetTransObject
626 PowerBuilder
GetChildObject
Description Gets the reference to a child object for a Web ActiveX DataWindow.
Obsolete method
GetChildObject is obsolete and should not be used, because the
Applies to
Syntax Web ActiveX

OleObject dwcontrol.GetChildObject ( )
dwcontrol A reference to the DataWindow control or DataStore that
contains the child DataWindow or report
Return value Returns an object that is the DataWindowChild or report. If no object is

found, a null object reference is returned.
Usage You must call GetChild before you call GetChildObject.
Examples The following example displays the reference to the child object in a
message box:
var ls ;
var ldwc;
window.dw_1.GetChild ("dept_id");
ldwc = window.dw_1.GetChildObject();
ls = ldwc.Describe ("Datawindow.Table.Select");
window.alert(ls);
See also GetChild
GetClickedColumn
Description Obtains the number of the column the user clicked or double-clicked in a
DataWindow control or DataStore object.

GetClickedRow
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.GetClickedColumn ( )
dwcontrol A reference to a DataWindow control, DataStore object, or child
DataWindow
Return value Returns the number of the column that the user clicked or double-clicked
in dwcontrol. Returns 0 if the user did not click or double-click a column
(for example, the user double-clicked outside the data area, in text or
spaces between columns, or in the header, summary, or footer area).
null.
Usage Call GetClickedColumn in the Clicked or DoubleClicked event for a
DataWindow control.
When the user clicks on the column, that column becomes the current
column after the Clicked or DoubleClicked event is finished. During those
events, GetColumn and GetClickedColumn can return different values.
If the user arrived at a column by another means, such as tabbing,
GetClickedColumn cannot identify that column. Use GetColumn instead to
identify the current column.
Examples These statements return the number of the column the user clicked or
double-clicked in dw_employee:
integer li_ColNbr
li_ColNbr = dw_employee.GetClickedColumn()
See also GetClickedRow
GetColumn
GetClickedRow
Description Obtains the number of the row the user clicked or double-clicked in a
628 PowerBuilder
Applies to
Syntax PowerBuilder
long dwcontrol.GetClickedRow ( )
dwcontrol A reference to a DataWindow control or DataStore object
Return value Returns the number of the row that the user clicked or double-clicked in
dwcontrol. Returns 0 if the user did not click or double-click a row (for
example, the user double-clicked outside the data area, in text or spaces
between rows, or in the header, summary, or footer area).
null.
Usage Call GetClickedRow in the Clicked or DoubleClicked event for a
DataWindow control.
When the user clicks on the row, that row becomes the current row after
the Clicked or DoubleClicked event is finished. During those events,
GetRow and GetClickedRow can return different values.
If the user arrived at a row by another means, such as tabbing,

GetClickedRow cannot identify that row. Use GetRow instead to identify
the current row.
Not on child DataWindows

The GetClickedRow method does not work on child DataWindows.
Examples These statements return the number of the row the user clicked or
double-clicked in dw_Employee:
long li_RowNbr
li_RowNbr = dw_employee.GetClickedRow()
See also GetClickedColumn
GetRow

GetColumn
GetColumn
Description Obtains the number of the current column. The current column is the
column that has focus.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.GetColumn ( )
dwcontrol A reference to a DataWindow control DataStore, or child
DataWindow
Return value Returns the number of the current column in dwcontrol. Returns 0 if no
column is current (because all the columns have a tab value of 0, making
all of them uneditable), and –1 if an error occurs.
null.
Usage GetColumn and GetClickedColumn, when called in the Clicked or
DoubleClicked event, can return different values. The column the user
clicked does not become current until after the event.
Use GetColumnName (instead of GetColumn) when you need the column’s
name. Use SetColumn to change the current column.
For use with PowerBuilder ListView controls, see GetColumn in the
The current column

A column becomes the current column after the user tabs to it or clicks it
or if a script calls the SetColumn method. A column cannot be current if it
cannot be edited (if it has a tab value of 0).
A DataWindow always has a current column, even when the control is not
active, as long as there is at least one editable column.
630 PowerBuilder
Examples These statements return the number of the current column in

dw_Employee:
integer li_ColNum
li_ColNum = dw_employee.GetColumn()
See also GetClickedColumn
GetColumnName
GetRow
SetColumn
SetRow
GetColumnName
Description Obtains the name of the current column. The current column is the column
that has the focus.
Applies to
DataStore object
Syntax PowerBuilder
string dwcontrol.GetColumnName ( )
dwcontrol A reference to a DataWindow control DataStore, or child
DataWindow
Return value Returns the name of the current column in dwcontrol. Returns the empty
string (“”) if no column is current or if an error occurs.
null.
Usage For information on the current column, see GetColumn on page 630.
Examples These statements return the name of the current column in dw_Employee:
string ls_ColName
ls_ColName = dw_employee.GetColumnName()
See also GetColumn
GetRow
SetColumn

GetContextService
SetRow
GetContextService
Description Returns a reference to a context-specific instance of the specified service.
Applies to
DataStore object
Syntax PowerBuilder
integer objectname.GetContextService ( string servicename,
PowerObject servicereference )
objectname A reference to an object or control for which you want a
service.
servicename String specifying the service object. Valid values include:
• ContextInformation – Context information service
• Internet – Internet service
• ContextKeyword – Context keyword service
servicereference PowerObject into which the method places a reference to
the service object specified by servicename. This argument
is passed by reference.
Return value Returns 1 if the method succeeds and –1 if an error occurs.

Usage Inherited from PowerObject. For information, see GetContextService in
the PowerScript Reference.
GetFormat
Description Obtains the display format assigned to a column in a DataWindow control
or DataStore object.
632 PowerBuilder
Applies to
DataStore object
Syntax PowerBuilder
string dwcontrol.GetFormat ( string column )
string dwcontrol.GetFormat ( integer column )
DataWindow.
column The column for which you want the display format. Column can
be a column number (integer) or a column name (string).
Return value Returns the display format specification for column in dwcontrol. If an
error occurs, GetFormat returns the empty string (“ ”).
If any argument value is null, in PowerBuilder and JavaScript the method
returns null.
Usage If you want to change the display format of a column temporarily, you can
use GetFormat to save the current format.
Examples These statements save the format of column salary of dw_employee before
changing it to a new format:
string OldFormat, NewFormat = "$##,###.00"
OldFormat = dw_employee.GetFormat("salary")
dw_employee.SetFormat("salary", NewFormat)
See also SetFormat
GetFullContext
Description This method returns a string representing the context of the client-side
control to be passed on a form submit.
Obsolete method
GetFullContext is obsolete and should not be used, because the Web

GetFullContext
Applies to
Web Client control
Syntax Web DataWindow client control

string dwcontrol.GetFullContext ( )
Return value String

Usage Use to host multiple DataWindows.
Examples The following client side script transfers the context and action from one
DataWindow to the DataWindow being submitted.
<SCRIPT>
function dw_first_OnSubmit()
{
dw_first.submitForm.dw_second_context.value
=
dw_second.GetFullContext();
dw_first.submitForm.dw_second_action.value =
"";
}
function dw_second_OnSubmit()
{
dw_second.submitForm.dw_first_context.value
=
dw_first.GetFullContext();
dw_second.submitForm.dw_first_action.value =
"";
}
</SCRIPT>
To enable the second DataWindow to create the required fields on the
submit form, each of the DataWindows must have two arguments defined
in the SelfLinkArgs property:
dw_first must have dw_second_context and dw_second_action
defined
dw_second must have dw_first_context and dw_first_action defined
634 PowerBuilder
GetFullState
Description Retrieves the complete state of a DataWindow or DataStore as a blob.
This method is used primarily in distributed applications.
Applies to
Syntax PowerBuilder
long dwcontrol.GetFullState ( blob dwasblob )
dwasblob A variable into which the returned DataWindow will be placed.
Return value Returns the number of rows in the DataWindow blob if it succeeds and –
1 if an error occurs. GetFullState will return –1 if the DataWindow control
or DataStore does not have a DataWindow object associated with it.
returns null.
Usage GetFullState retrieves the entire state of a DataWindow or DataStore,
including the DataWindow object specification, the data buffers, and the
status flags. When you call SetFullState to apply the blob created by
GetFullState to another DataWindow, the target DataWindow has enough
information to recreate the source DataWindow.
Because the blob created by GetFullState contains the DataWindow object
specification, a subsequent call to SetFullState will overwrite the
DataWindow object for the target DataWindow control or DataStore. If the
target of SetFullState does not have a DataWindow object associated with
it, the blob will assign one. In this case, SetFullState has the effect of
setting the DataObject property for the target.
When you use GetFullState and SetFullState to synchronize a DataWindow
control on a client with a DataStore on a server, you need to make sure that
the DataWindow object for the DataStore contains the presentation style
you want to display on the client.
Examples These statements retrieve data into a DataStore and use GetFullState to
retrieve the complete state of the DataStore into a blob:
// Instance variables:
// datastore ids_datastore

GetFullStateBlob
// blob blb_data
long ll_rv
ids_datastore = create datastore

ids_datastore.dataobject = "d_emplist"
ids_datastore.SetTransObject (SQLCA)
ids_datastore.Retrieve()
ll_rv = ids_datastore.GetFullState(blb_data)
See also GetChanges
GetFullStateBlob
GetStateStatus
SetChanges
SetFullState
GetFullStateBlob
Description Returns the state of a DataWindow or DataStore. You must call
GetFullState first to set up the state information. This method is used
primarily in distributed applications.
Obsolete method
GetFullStateBlob is obsolete and should not be used, because the
Applies to
Syntax Web ActiveX

string dwcontrol.GetFullStateBlob ( )
called GetFullState
Return value Returns a string whose value is the DataWindow state blob set up by
GetFullState.
636 PowerBuilder
Usage GetFullState and GetFullStateBlob are used in conjunction with SetFullState

to synchronize two or more DataWindows or DataStores. For details, see
GetFullState on page 635.
the database:
blob lblb_changes
long ll_rv
IF ll_rv = -1 THEN
failed!")
ELSE
END IF
GetStateStatus
SetChanges
SetFullState
GetItem
Description Gets the value of an item for the specified row and column in a Web
DataWindow client control. Use one of the datatype-specific methods
such as GetItemString for other types of DataWindow control. GetItem
returns the value available in the data available to the client. This is
equivalent to the primary buffer in other environments.
Obsolete method
GetItem is obsolete and should not be used, because the Web DataWindow
Applies to
Web Client control

GetItemDate

returnvalue dwcontrol.GetItem (number row, number column )
returnvalue dwcontrol.GetItem (number row, string column )
row A value identifying the row location of the data.
column The column location of the data. Column can be a column
number or a column name. The column number is the number
of the column as it is listed in the Column Specification view
of the DataWindow painter—not necessarily the number of the
column in the Design view.
To get the contents of a computed field, specify the name of the
computed field for column. Computed fields do not have
numbers.
Return value Returns the value in the specified row and column. The datatype of the
returned data corresponds to the datatype of the column. Returns null if the
column value is null. Returns the empty string (“”) if an error occurs.
If any argument value is null, the method returns null.
Usage Use GetItem to get data that has been accepted by the DataWindow. In a
script for the ItemChanged or ItemError event, you can use the newValue
argument to find out what the user entered before the data is accepted.
Examples This statement sets LName to the value for row 3 of the emp_name column
in the DataWindow dw_employee:
var LName = dw_employee.GetItem(3, "emp_name");
See also SetItem
GetItemDate
Description Gets data whose type is Date from the specified buffer of a DataWindow
control or DataStore object. You can obtain the data that was originally
retrieved and stored in the database from the original buffer, as well as the
current value in the primary, delete, or filter buffers.
638 PowerBuilder
Applies to
DataStore object
Syntax PowerBuilder
date dwcontrol.GetItemDate ( long row, string column
{, DWBuffer dwbuffer , boolean originalvalue } )
date dwcontrol.GetItemDate ( long row, integer column
{, DWBuffer dwbuffer, boolean originalvalue } )
DataWindow.
column The column location of the data. The datatype of the column
must be date. Column can be a column number or a column
name. The column number is the number of the column as it is
listed in the Column Specification view of the DataWindow
painter—not necessarily the number of the column in the
Design view.
To get the contents of a computed field, specify the name of
the computed field for column. Computed fields do not have
numbers.
dwbuffer A value identifying the DataWindow buffer from which you
(optional) want to get the data.
originalvalue A boolean indicating whether you want the original or current
(optional) values for row and column:
• True – Returns the original values (the values initially
retrieved from the database).
• False – (Default) Returns the current values.
If you specify dwbuffer, you must also specify originalvalue.
Return value Returns the date value in the specified row and column. Returns null if the
column value is null or if there is no DataWindow object assigned to the
DataWindow control or DataStore. Returns 1900-01-01 if any other error
occurs.
returns null.

GetItemDate
Usage Use GetItemDate when you want to get information from the
DataWindow’s buffers. To find out what the user entered in the current
column before that data is accepted, use GetText. In the ItemChanged or
ItemError events, use the data argument.
To access a row in the original buffer, specify the buffer that the row
currently occupies (primary, delete, or filter) and the number of the row in
that buffer. When you specify true for originalvalue, the method gets the
original data for that row from the original buffer.
An execution error occurs when the datatype of the DataWindow column
does not match the datatype of the method; in this case, date.
Datatypes of columns and computed fields

There is a difference in datatypes between columns and computed
columns retrieved from the database and computed fields defined in the
DataWindow painter. Computed columns from the database can have a
datatype of date, but a date computed field always has a datatype of
DateTime, not date. In PowerBuilder, use the GetItemDateTime method
instead.
PowerBuilder only: using GetItemDate in a String function

When you call GetItemDate as an argument for the String function and do
not specify a display format, the value is formatted as a DateTime value.
This statement returns a string like "2/26/96 00:00:00":
String(dw_1.GetItemDate(1, "start_date"))
To get a simple date string, you can specify a display format:
String(dw_1.GetItemDate(1,"start_date"), "m/d/yy")
or you can assign the date to a date variable before calling the String
function:
date ld_date
string ls_date
ld_date = dw_1.GetItemDate(1, "start_date")
ls_date = String(ld_date)
Examples These statements set hiredate to the current Date data in the third row of
the primary buffer in the column named first_day of dw_employee:
Date hiredate
hiredate = dw_employee.GetItemDate(3, "first_day")
640 PowerBuilder
These statements set hiredate to the current Date data in the third row of
the filter buffer in the column named first_day of dw_employee:
Date hiredate
hiredate = dw_employee.GetItemDate(3, &
"first_day", Filter!, false)
These statements set hiredate to original Date data in the third row of the
primary buffer in the column named hdate of dw_employee:
Date hiredate
hiredate = dw_employee.GetItemDate(3, &
"hdate", Primary!, true)
See also GetItemDateTime
GetItemDecimal
GetItemNumber
GetItemString
GetItemTime
GetText
SetItem
SetText
GetItemDateTime
Description Gets data whose type is DateTime from the specified buffer of a
DataWindow control or DataStore object. You can obtain the data that was
originally retrieved and stored in the database from the original buffer, as
well as the current value in the primary, delete, or filter buffers.
Applies to
DataStore object
Syntax PowerBuilder
DateTime dwcontrol.GetItemDateTime ( long row, string column
DateTime dwcontrol.GetItemDateTime ( long row, integer column

GetItemDateTime
DataWindow in which you want to obtain the DateTime data
contained in a specific row and column.
must be DateTime. Column can be a column number or a
column name. The column number is the number of the column
as it is listed in the Column Specification view of the
DataWindow painter—not necessarily the number of the
numbers.
(optional) want to get the data.
• True – Returns the original values, that is, the values initially
retrieved from the database.
If you specific dwbuffer, you must also specify originalvalue.
Return value Returns the DateTime or Timestamp value in the specified row and
column. Returns null if the column value is null or if there is no
DataWindow object assigned to the DataWindow control or DataStore.
Returns 1900-01-01 00:00:00.000000 if any other error occurs.
If any argument value is null, in PowerBuilder the method returns null.
Usage Use GetItemDateTime when you want to get information from the
642 PowerBuilder
Datatype mismatch
does not match the datatype of the method—in this case, DateTime.
Computed fields displaying date or time values have a datatype of

DateTime, not date or time. Always use GetItemDateTime to get their
value, not GetItemDate or GetItemTime.
Examples These statements set as_of to the current DateTime data in the primary
buffer for row 3 of the column named start_dt in the DataWindow
dw_emp:
DateTime as_of
as_of = dw_emp.GetItemDateTime(3, "start_dt")
These statements set as_of to the current DateTime data in the delete
buffer for row 3 of the end_dt column of dw_emp:
DateTime as_of
as_of = dw_emp.GetItemDateTime(3, "end_dt", &
Delete!, false)
These statements set AsOf to the original DateTime data in the primary
buffer for row 3 of the end_dt column of dw_emp:
DateTime as_of
as_of = dw_emp.GetItemDateTime(3, "end_dt", &
Primary!, true)
See also GetItemDate
GetItemDecimal
GetItemNumber
GetItemString
GetItemTime
SetItem
GetItemDecimal
Description Gets data whose type is decimal from the specified buffer of a
DataWindow control or DataStore object. You can obtain the data that was
originally retrieved and stored in the database from the original buffer, as
well as the current value in the primary, delete, or filter buffers.

GetItemDecimal
Applies to
DataStore object
Syntax PowerBuilder
decimal dwcontrol.GetItemDecimal ( long row, integer column
decimal dwcontrol.GetItemDecimal ( long row, string column
row A value identifying the row location of the decimal data.
must be one of type decimal. Column can be a column number
or a column name. The column number is the number of the
column as it is listed in the Column Specification view of the
DataWindow painter—not necessarily the number of the
numbers.
(optional) DataWindow buffer from which you want to get the data. For
a list of valid values, see DWBuffer on page 485.
• True – Returns the original values, that is, the values
initially retrieved from the database.
Return value Returns the decimal value in the specified row and column. Returns null if
the column value is null or if there is no DataWindow object assigned to
the DataWindow control or DataStore. Triggers the SystemError event and
returns –1 if any other error occurs (see Handling errors on page 645).
Usage Use GetItemDecimal when you want to get information from the
644 PowerBuilder
Handling errors The return value is a valid value from the database
unless the SystemError event is triggered. When the value cannot be
converted because the column’s datatype does not match the method’s
datatype, an execution error occurs, which triggers the SystemError event.
The default error processing halts the application.
If you write a script for the SystemError event, it should also halt the
application. Therefore, the error return value is seldom used.
Examples These statements set salary_amt to the current decimal data in the primary
buffer for row 4 of the column named emp_salary of dw_employee:
decimal salary_amt
salary_amt = &
dw_employee.GetItemDecimal(4, "emp_salary")
These statements set salary_amt to the current decimal data in the filter
decimal salary_amt
salary_amt = dw_employee.GetItemDecimal(4, &
"emp_salary", Filter!, false)
These statements set salary_amt to the original decimal data in the primary
decimal salary_amt
salary_amt = dw_employee.GetItemDecimal(4, &
"emp_salary", Primary!, true)
GetItemDateTime
GetItemNumber
GetItemString
GetItemTime
SetItem

GetItemFormattedString
Description Gets and formats data whose type is String from the specified buffer of a
Applies to
DataStore object
Syntax PowerBuilder
string dwcontrol.GetItemFormattedString ( long row, integer
column
string dwcontrol.GetItemFormattedString ( long row, string column
DataWindow.
row A value identifying the row location of the string data.
must be String. Column can be a column number or a column
Design view.
numbers.
(optional) DataWindow buffer from which you want to get the data. For a
list of valid values, see DWBuffer on page 485.
Usage Use GetItemFormattedString in place of GetItemString when you want to

return the value from a column in its current display format. This is
especially useful if the column in question is not a computed column.
646 PowerBuilder
Examples These statements set LName to the current string in the primary buffer for
row 3 of in the column named emp_name in the DataWindow
dw_employee. The retrieved value is formatted with the display format of
the column:
String LName
LName = dw_employee.GetItemFormattedString(3,
"emp_name")
See also GetItemString
GetItemUnformattedString
GetItemNumber
Description Gets numeric data from the specified buffer of a DataWindow control or
DataStore object. You can obtain the data that was originally retrieved and
stored in the database from the original buffer, as well as the current value
in the primary, delete, or filter buffers.
Applies to
DataStore object
Syntax PowerBuilder
numeric dwcontrol.GetItemNumber ( long row, string column
numeric dwcontrol.GetItemNumber ( long row, integer column
DataWindow.
row A value identifying the row location of the numeric data.
column The column location of the numeric data. The datatype of
the column must be one of a numeric datatype. Column can
be a column number or a column name. The column number
is the number of the column as it is listed in the Column
Specification view of the DataWindow painter—not
necessarily the number of the column in the Design view.
To get the contents of a computed field, specify the name of
the computed field for column. Computed fields do not have
numbers.

GetItemNumber
(optional) want to get the data. For a list of valid values, see DWBuffer
on page 485.
originalvalue A boolean indicating whether you want the original or
(optional) current values for row and column:
• True – Return the original values (the values initially
• False – (Default) Return the current values.
If you specify dwbuffer, you must also specify
originalvalue.
Return value Returns the numeric value in the specified row and column (decimal,
double, integer, long, or real). Returns null if the column value is null or if
there is no DataWindow object assigned to the DataWindow control or
DataStore. Triggers the SystemError event and returns –1 if any other error
occurs (see Handling errors on page 648).
returns null.
Usage Use GetItemNumber to get information from the DataWindow’s buffers.
To find out what the user entered in the current column before that data is
accepted, use GetText. In the ItemChanged or ItemError events, use the
data argument.
Handling errors The return value is a valid value from the database
unless the SystemError event is triggered. When the value cannot be
converted because the column’s datatype does not match the method’s
datatype, an execution error occurs, which triggers the SystemError event.
The default error processing halts the application. If you write a script for
the SystemError event, it should also halt the application. Therefore, the
error return value is seldom used.
Examples These statements set EmpNbr to the current numeric data in the primary
buffer for row 4 of the column named emp_nbr in dw_employee:
integer EmpNbr
EmpNbr = dw_employee.GetItemNumber(4, "emp_nbr")
648 PowerBuilder
These statements set EmpNbr to the current numeric data in the filter
buffer for row 4 of the column named salary of dw_employee:
integer EmpNbr
EmpNbr = dw_employee.GetItemNumber(4, &
"salary", Filter!, false)
These statements set EmpNbr to the original numeric data in the primary
buffer for row 4 of the column named salary of dw_Employee:
integer EmpNbr
EmpNbr = dw_Employee.GetItemNumber(4, &
"salary", Primary!, true)
GetItemDateTime
GetItemDecimal
GetItemString
GetItemTime
SetItem
GetItemStatus
Description Reports the modification status of a row or a column within a row. The
modification status determines the type of SQL statement the Update
method will generate for the row or column.
Applies to
DataStore object
Syntax PowerBuilder
DWItemStatus dwcontrol.GetItemStatus ( long row, integer column,
DWBuffer dwbuffer )
DWItemStatus dwcontrol.GetItemStatus ( long row, string column,
DWBuffer dwbuffer )
DataWindow.
row A value identifying the row for which you want the status.

GetItemStatus
column The column for which you want the status. Column can be a
column number or a column name. The column number is the
number of the column as it is listed in the Column Specification
view of the DataWindow painter—not necessarily the number
of the column in the Design view.
Specify 0 to get the status of the whole row.
dwbuffer A value identifying the DataWindow buffer containing the row
for which you want status. For a list of valid values, see
DWBuffer on page 485.
Return value A value of the dwItemStatus enumerated datatype. The return value
identifies the status of the item at row, column of dwcontrol in dwbuffer.
For a list of status values, see DWItemStatus on page 486.
If column is 0, GetItemStatus returns the status of row. If there is no
DataWindow object assigned to the DataWindow control or DataStore,
GetItemStatus returns null.

returns null.
Usage Use GetItemStatus to understand what SQL statements will be generated
for new and changed information when you update the database.
For rows in the primary and filter buffers, Update generates an INSERT
statement for rows with NewModified! status. It generates an UPDATE
statement for rows with DataModified! status and references the columns
that have been affected.
For rows in the delete buffer, Update does not generate a DELETE
statement for rows whose status was New! or NewModified! before being
moved to the delete buffer.
Examples These statements store in the variable l_status the status of the column
named emp_status in row 5 in the filter buffer of dw_1:
dwItemStatus l_status
l_status = dw_1.GetItemStatus(5, "emp_status", &
Filter!)
These statements store in the variable l_status the status of the column
named Salary in the current row in the primary buffer of dw_emp:
l_status = dw_emp.GetItemStatus( &
dw_emp.GetRow(), "Salary", Primary!)
650 PowerBuilder
See also SetItemStatus
GetItemString
Description Gets data whose type is String from the specified buffer of a DataWindow
Applies to
DataStore object
Syntax PowerBuilder
string dwcontrol.GetItemString ( long row, integer column
string dwcontrol.GetItemString ( long row, string column
DataWindow.
must be String. Column can be a column number or a column
Design view.
numbers.
(optional) DataWindow buffer from which you want to get the data. For a

GetItemString
Return value Returns the string value in the specified row and column. Returns the
empty string (“ ”) if there is no DataWindow object assigned to the
DataWindow control or DataStore or if any other error occurs.
Usage Use GetItemString to get information from the DataWindow’s buffers. To
find out what the user entered in the current column before that data is
data argument.
GetItemString returns a formatted value in the case of a computed column,
and an unformatted value in the case of a noncomputed column. For
PowerBuilder DataWindows, you can use the GetItemFormattedString
method to return a formatted value, or the GetItemUnformattedString
method to return an unformatted value, for any type of column.
Mismatched datatypes
does not match the datatype of the method—in this case, String.
row 3 of the column named emp_name in the DataWindow dw_employee:
String LName
LName = dw_employee.GetItemString(3, "emp_name")
These statements set LName to the current string in the delete buffer for
row 3 of the column named emp_name of dw_employee:
String LName
LName = dw_employee.GetItemString(3, &
652 PowerBuilder
"emp_name", Delete!, false)

The following statements set LName to the original string in the delete
buffer for row 3 of the column named emp_name of dw_employee:
String LName
LName = dw_employee.GetItemString(3, &
"emp_name", Delete!, true)
GetItemDateTime
GetItemDecimal
GetItemNumber
GetItemTime
GetText
SetItem
SetText
GetItemTime
Description Gets data whose type is Time from the specified buffer of a DataWindow
Applies to
DataStore object
Syntax PowerBuilder
time dwcontrol.GetItemTime ( long row, string column
time dwcontrol.GetItemTime ( long row, integer column

GetItemTime
DataWindow.
must be time. Column can be a column number or a column
Design view.
numbers.
(optional) DataWindow buffer from which you want to get the data. For
a list of valid values, see DWBuffer on page 485.
• True – Return the original values (the values initially
• False – (Default) Return the current values.
Return value Returns the time value in the specified row and column. Returns null if the
column value is null or if there is no DataWindow object assigned to the
DataWindow control or DataStore. Returns 00:00:00.000000 if an error
occurs.
Usage Use GetItemTime to get information from the DataWindow’s buffers. To
find out what the user entered in the current column before that data is
data argument.
654 PowerBuilder
Datatypes of columns and computed fields

does not match the datatype of the method—in this case, time.
There is a difference in datatypes between computed columns retrieved
from the database and computed fields defined in the DataWindow painter.
Computed columns from the database can have a datatype of time, but a
time computed field always has a datatype of DateTime, not time. Use the
GetItemDateTime method instead.
PowerBuilder only: using GetItemTime in a String function

When you call GetItemTime as an argument for the String function and do
not specify a display format, the value is formatted as a DateTime value.
This statement returns a string like "2/26/06 00:00:00":
String(dw_1.GetItemTime(1, "start_date"))
To get a simple time string, you can specify a display format for the String
function or you can assign the value to a time variable before calling the
String function (see GetItemDate for examples).
Examples These statements set Start to the current Time data in the primary buffer
for row 3 of the column named title in dw_employee:
Time Start
Start = dw_employee.GetItemTime(3, "title")
These statements set Start to the current Time data in the filter buffer for
row 3 of the column named start_time of dw_employee:
Time Start
Start = dw_employee.GetItemTime(3, &
"start_time", Filter!, false)
These statements set Start to the original Time data in the primary buffer
for row 3 of the column named start_time of dw_employee:
Time Start
Start = dw_employee.GetItemTime(3, &
"start_time", Primary!, true)
GetItemDateTime
GetItemDecimal
GetItemNumber

GetItemString
GetText
SetItem
SetText
Description Gets raw (unformatted) data whose type is String from the specified buffer
of a DataWindow control or DataStore object.
Applies to
DataStore object
Syntax PowerBuilder
string dwcontrol.GetItemUnformattedString ( long row,
integer column {, DWBuffer dwbuffer, boolean originalvalue } )
string dwcontrol.GetItemUnformattedString ( long row, string
column
dwcontrol A reference to a DataWindow control, DataStore, or
child DataWindow.
column The column location of the data. The datatype of the
column must be String. Column can be a column number
or a column name. The column number is the number of
the column as it is listed in the Column Specification
view of the DataWindow painter—not necessarily the
number of the column in the Design view.
To get the contents of a computed field, specify the name
of the computed field for column. Computed fields do
not have numbers.
dwbuffer (optional) A value of the dwBuffer enumerated datatype
identifying the DataWindow buffer from which you
want to get the data. For a list of valid values, see
DWBuffer on page 485.
656 PowerBuilder
originalvalue A boolean indicating whether you want the original or
(optional) current values for row and column:
If you specify dwbuffer, you must also specify
originalvalue.
Usage Use GetItemUnformattedString in place of GetItemString when you want to

return the value from a column without its display format. This is
especially useful if the column in question is a computed column.
row 3 of in the column named emp_name in the DataWindow
dw_employee. The retrieved value is unformatted:
String LName
LName = dw_employee.GetItemUnformattedString(3,
"emp_name")
See also GetItemFormattedString
GetItemString
GetLastError
Description Returns the error code of the last database error that occurred in the Web
DataWindow server component.
Obsolete method
GetLastError is obsolete and should not be used, because the Web
Applies to

long dwcontrol.GetLastError ( )

GetLastErrorString
dwcontrol A reference to the DataWindow server component
Return value Returns a numeric error code for the last database error that occurred.
Usage Call GetLastError and GetLastErrorString to get information about database
errors that caused SetAction, Update, Retrieve, and RetrieveEx to return –1.
Examples This code in a page server script calls Retrieve for the Web DataWindow
server component called dwComponent and gets information about the
database error if Retrieve fails:
retVal = dwComponent.Retrieve( );
if (retVal < 0) {
Response.Write("Retrieval error: "
+ dwComponent.GetLastError( )
+ "<BR>"
+ dwComponent.GetLastErrorString( )
+ "<BR>");
}
See also GetLastErrorString
Retrieve
Update
GetLastErrorString
Description Returns the text of the error message for the last database error that
occurred in the Web DataWindow server component.
Obsolete method
GetLastErrorString is obsolete and should not be used, because the Web
Applies to
658 PowerBuilder

string dwcontrol.GetLastErrorString ( )
dwcontrol A reference to the DataWindow server component
Return value Returns a string containing an error message for the last database error that
occurred.
Usage Call GetLastError and GetLastErrorString to get information about database
errors that caused SetAction, Update, Retrieve, and RetrieveEx to return –1.
Examples This code in a page server script calls Retrieve for the Web DataWindow
server component called dwComponent and gets information about the
database error if Retrieve fails:
retVal = dwComponent.Retrieve( );
if (retVal < 0) {
Response.Write("Retrieval error: "
+ dwComponent.GetLastError( )
+ "<BR>"
+ dwComponent.GetLastErrorString( )
+ "<BR>");
}
See also GetLastError
Retrieve
Update
GetMessageText
Description Obtains the message text generated by a crosstab DataWindow object in a
DataWindow control. Only crosstab DataWindows generate messages.
Obsolete method
GetMessageText is obsolete and will be discontinued in a future release.
You should replace all use of GetMessageText as soon as possible. The
message text is available as an argument in a user event defined for
pbm_dwnmessagetext in a DataWindow control.

GetNextModified
Applies to
Syntax PowerBuilder
string dwcontrol.GetMessageText ( )
dwcontrol A reference to the DataWindow control for which you want the
message text
Return value Returns the text of the message generated by dwcontrol. If there is no text
or an error occurs, GetMessageText returns the empty string (“”).
Usage To use GetMessageText, you must first define a user-defined event for the
event ID pbm_dwnmessagetext; then you call this method in the script for
that event.
Typical messages are Retrieving data and Building crosstab.
Examples This statement is part of a script for a user-defined event with the ID
pbm_dwmessagetext. The style of the DataWindow object in the
DataWindow control is crosstab. The statement sets the MicroHelp of the
MDI frame window w_crosstab:
w_crosstab.SetMicroHelp(This.GetMessageText())
GetNextModified
Description Reports the next row that has been modified in the specified buffer.
Applies to
DataStore object
Syntax PowerBuilder
long dwcontrol.GetNextModified (long row, DWBuffer dwbuffer )
dwcontrol A name of the DataWindow control, DataStore, or child
DataWindow in which you want to locate the modified row.
660 PowerBuilder
row A value identifying the row location after which you want to
locate the modified row. To search from the beginning, specify
0.
DataWindow buffer in which you want to locate the modified
row. For a list of valid values, see DWBuffer on page 485.
Return value Returns the number of the first row that was modified after row in
dwbuffer in dwcontrol. Returns 0 if there are no modified rows after the
specified row.
returns null.
Usage PowerBuilder stores the update status of rows and columns in the
DataWindow. The status settings indicate whether a row or column is new
or has been modified. GetNextModified reports rows with the status
NewModified! and DataModified!.
For more information on the status of rows and columns, see GetItemStatus
and SetItemStatus.
Using GetNextModified on the delete buffer will return rows that have been
modified and then deleted. The DeletedCount method will report the total
number of deleted rows.
GetNextModified begins searching in the row after the value you specify in
row. This is different from the behavior of Find, FindGroupChange, and
FindRequired, which begin searching in the row you specify.
Total number of modified rows

You can use the ModifiedCount method to find out the total number of
modified rows in the primary and filter buffers.
Examples These statements count the number or rows that were modified in the
primary buffer for dw_status and then display a message reporting the
number modified:
integer rc
long NbrRows, ll_row = 0, count = 0
dw_status.AcceptText()
NbrRows = dw_status.RowCount()
DO WHILE ll_row <= NbrRows

GetObjectAtPointer
ll_row = dw_status.GetNextModified(ll_row,
Primary!)
IF ll_row > 0 THEN
count = count + 1
ELSE
ll_row = NbrRows + 1
END IF
LOOP
MessageBox("Modified Count", &
String(count) &
+ " rows were modified.")
See also DeletedCount
FindRequired
GetNextModified
ModifiedCount
SetItemStatus
GetObjectAtPointer
Description Reports the control within the DataWindow object and row number under
the pointer. Controls include columns, labels, and other graphic controls,
such as lines and pictures.
Applies to
Syntax PowerBuilder
string dwcontrol.GetObjectAtPointer ( )
Return value Returns the string whose value is the name of the control under the pointer,
followed by a tab character and the row number. Returns the empty string
null.
662 PowerBuilder
Usage If the object doesn’t have a name, neither a name nor a row is reported.
Since PowerBuilder 7, the painter gives names to all controls. In earlier
versions, only columns and column labels got default names in the
DataWindow painter and you could name other controls yourself.
09). In PowerBuilder, search for ~t. For an example that parses a string that
includes a tab, see GetValue.
For information on the rows associated with bands and therefore with
controls in those bands, see GetBandAtPointer.
Examples These statements obtain the name of the control under the pointer in the
DataWindow dw_emp:
String dwobjectname
dwobjectname = dw_emp.GetObjectAtPointer()
Some possible return values are:
Table 9-4: Example return values for the GetObjectAtPointer
method
Return value Meaning
salary~t23 The control named salary in row 23.
salary_h~t15 The control named salary_h, which is in the header. Row
15 is the first visible row below the header.
See also GetBandAtPointer
GetParent
Description Obtains the parent of the specified object.
Applies to
DataStore object
Syntax PowerBuilder
PowerObject objectname.GetParent ( )
objectname A control in a window or user object or an item on a menu for
which you want the parent object

GetRichTextAlign
Return value Returns a reference to the parent of objectname.

Usage Inherited from PowerObject. For information, see GetParent in the
GetRichTextAlign
Description Gets the current alignment setting for editing columns with the RichText
edit style.
Syntax Integer dwcontrol.GetRichTextAlign ( REF alignment align )
dwcontrol A reference to the DataWindow control
align Current alignment setting of the selected text
Return value Returns an integer to indicate whether the column that you selected has the
RichText edit style and whether the content has one or more alignment
types applied.
0 Success
-1 No RichText column is being edited
-2 The selected text is a mix of alignment types
Usage You can call this method from a button in a custom toolbar that you use to
obtain current font settings for columns with the RichText edit style.
Examples This example obtains the current alignment setting to be used for editing
columns with the RichText edit style:
Integer li_integer
Alignment l_align
li_integer = dw_1.GetRichTextAlign(l_align)
See also GetRichTextColor
GetRichTextFaceName
GetRichTextSize
GetRichTextStyle
SetRichTextAlign
664 PowerBuilder
GetRichTextColor
Description Gets the current color setting for editing columns with the RichText edit
style.
Syntax Integer dwcontrol.GetRichTextColor ( REF long color )
color A long used to define the color
RichText edit style and whether the content has one or more colors
applied.
0 Success
-2 The selected text is a mix of colors
Usage If the color for columns with the RichText edit style is white, background
transparency and gradient and text transparency will not work properly.
You can call this method from a button in a custom toolbar that you use to
Examples This example obtains the current color setting of the font to be used for
editing columns with a RichText edit style:
Integer li_integer
Long l_long
li_integer = dw_1.GetRichTextColor(l_long)
See also GetRichTextAlign
GetRichTextFaceName
GetRichTextSize
GetRichTextStyle
SetRichTextColor
GetRichTextFaceName
Description Gets the current typeface setting for editing columns with the RichText
edit style.

GetRichTextSize

Syntax Integer dwcontrol.GetRichTextFaceName ( REF string typeface )
typeface A string used to define the type
RichText edit style and whether the content has one or more fonts applied.
0 Success
-2 The selected text is a mix of fonts
Examples This example obtains the typeface of the font to be used for editing
columns with a RichText edit style:
Integer li_integer
String ls_string
li_integer = dw_1.GetRichTextFaceName(ls_string)
If Tahoma font is selected when the above script is called, ls_string is
Tahoma and the method returns 0. If a mix of fonts is selected, ls_string is
blank and the method returns –2.
GetRichTextColor
GetRichTextSize
GetRichTextStyle
SetRichTextFaceName
GetRichTextSize
Description Gets the current font size setting for editing columns with the RichText
edit style.
Syntax Integer dwcontrol.GetRichTextSize ( REF integer size )
666 PowerBuilder
size Value indicating the point size of the font; if the selected
text is a mix of sizes, the value is 0
RichText edit style and whether the content has one or more sizes applied.
0 Success
-2 The selected text is a mix of sizes
Examples This example obtains the current size setting of the font to be used for
editing columns with a RichText edit style:
Integer li_integer
Integer li_textsize
li_integer = dw_1.GetRichTextSize(li_textsize)
If 10 point text is selected when the above script is called, li_textsize is 10
and the method returns 0. If a mix of sizes is selected, li_textsize is 0 and
the method returns –2.
GetRichTextColor
GetRichTextFaceName
GetRichTextStyle
SetRichTextSize
GetRichTextStyle
Description Determines whether selected text or text at the cursor in a RichText
column has a specified formatting.
Syntax Integer dwcontrol.GetRichTextStyle ( TextStyle style, REF boolean state
)

GetRow
style Value for specifying a text style. Allowable values are:
bold!
italic!
strikeout!
subscript!
superscript!
underlined!
state Indicates whether the selected text or text at the cursor
position has a style applied to it
RichText edit style and whether the content has one or more styles applied.
0 Success
-2 The selected text is a mix of styles
obtain the current font settings for columns with the RichText edit style.
Examples This example determines whether a bold font is the current style setting for
editing columns with a RichText edit style.
Integer li_style
Boolean lb_state
li_style = dw_1.GetRichTextStyle(bold!, lb_state)
If bold text is selected when the above script is called, the lb_state
argument is true, and the method returns 0. If mixed text is selected, such
as bold and italic, lb_state is true, and the method returns –2.
GetRichTextColor
GetRichTextFaceName
GetRichTextSize
SetRichTextStyle
GetRow
Description Reports the number of the current row in a DataWindow control or
DataStore object.
668 PowerBuilder
Applies to
DataStore object
Syntax PowerBuilder
long dwcontrol.GetRow ( )
dwcontrol A reference to a DataWindow control, DataStore, or the child
DataWindow
Return value Returns the number of the current row in dwcontrol. Returns 0 if no row is
current and -1 if an error occurs.
null.
Current row not always displayed

The current row is not always a row displayed on the screen. For example,
if the cursor is on row 7 column 2 and the user uses the scroll bar to scroll
to row 50, the current row remains row 7 unless the user clicks row 50.
Examples This statement returns the number of the current row in dw_Employee:
dw_employee.GetRow()
See also GetColumn
SetColumn
SetRow
GetRowFromRowId
Description Gets the row number of a row in a DataWindow control or DataStore
object from the unique row identifier associated with that row.
Applies to
DataStore object
Syntax PowerBuilder

GetRowFromRowId
long dwcontrol.GetRowFromRowId (long rowid {, DWBuffer buffer }

)
DataWindow.
rowid A number specifying the row identifier for which you want the
associated row number.
buffer A value of the dwBuffer enumerated datatype identifying the
(optional) DataWindow buffer that contains the row.
Return value Returns the row number in buffer. Returns 0 if the row number is not in the
current buffer and –1 if an error occurs.
returns null.
Usage This method allows you to use a unique row identifier to retrieve the
associated DataWindow or DataStore row number. The row identifier is
not affected by operations (such as Insert, Delete, or Filter) that might
change the original order (and consequently the row numbers) of the rows
in the DataWindow or DataStore.
Row identifiers
The row identifier is relative to the DataWindow that currently owns the
row.
Examples This example uses the row identifier previously obtained using the
GetRowIdFromRow method to retrieve the row’s number after the original
order of the rows in the DataWindow has changed.
long ll_rowid
long ll_rownumber
ll_rowid = dw_1.GetRowIdFromRow(dw_1.GetRow())
// suppose original order of rows changes...
ll_rownumber = dw_1.GetRowFromRowId(ll_rowid)
See also GetRow
GetRowIdFromRow
670 PowerBuilder
GetRowIdFromRow
Description Gets the unique row identifier of a row in a DataWindow control or
DataStore object from the row number associated with that row.
Applies to
DataStore object
Syntax PowerBuilder
long dwcontrol.GetRowIdFromRow (long rownumber {, DWBuffer
buffer } )
dwcontrol A reference to a DataWindow control, DataStore, or the child
DataWindow.
rownumber A number specifying the row number for which you want the
associated row identifier.
buffer A value of the dwBuffer enumerated datatype identifying the
(optional) DataWindow buffer that contains the row. For a list of valid
values, see DWBuffer on page 485.
Return value Returns the row identifier in buffer. Returns 0 if the row identifier is not in
the current buffer and –1 if an error occurs.
returns null.
Usage The row identifier value is not the same as the row number value used in
many DataWindow and DataStore function calls and should not be used
for the row number value. Instead you should first convert the unique row
identifier into a row number by calling GetRowFromRowId.
Row identifiers
The row identifier is relative to the DataWindow that currently owns the
row.
Examples This example retrieves the current row’s unique identifier:

long ll_rowid
ll_rowid = dw_emp.GetRowIDFromRow(dw_emp.GetRow())
See also GetRow
GetRowFromRowId

GetSelectedRow
GetSelectedRow
Description Reports the number of the next highlighted row after a specified row in a
Applies to
DataStore object
Syntax PowerBuilder
long dwcontrol.GetSelectedRow ( long row )
DataWindow.
row A value identifying the location of the row after which you want
to search for the next selected row. Specify 0 to begin searching
at the first row.
Return value Returns the number of the first row that is selected after row in dwcontrol.
Returns 0 if no row is selected after the specified row.
returns null.
Usage Rows are not automatically selected—that is, highlighted—when they
become current. You can select a row by calling the SelectRow method.
GetSelectedRow begins its search after the specified row. It does not
matter whether row itself is selected.
Examples This statement returns the number of the first row that is selected in
dw_Employee:
dw_employee.GetSelectedRow(0)
This statement returns the number of the first row that is selected
beginning with row 25 in dw_Employee:
dw_employee.GetSelectedRow(25)
See also SelectRow
672 PowerBuilder
GetSQLPreview
Description Reports the SQL statement that the DataWindow control is currently
submitting to the database.
Obsolete method
GetSQLPreview is obsolete and will be discontinued in a future release.
You should replace all references to GetSQLPreview as soon as possible.
The SQL syntax is available as an argument in the DBError and
SQLPreview events.
Applies to
DataStore object
Syntax PowerBuilder
string dwcontrol.GetSQLPreview ( )
Return value Returns the current SQL statement for dwcontrol. Returns the empty string
See also SetSQLPreview
GetSQLSelect
Description Reports the SQL SELECT statement associated with a DataWindow if its
data source is one that accesses a SQL database (such as SQL Select,
Quick Select, or Query).
Applies to
DataStore object
Syntax PowerBuilder

GetSQLSelect
string dwcontrol.GetSQLSelect ( )
DataWindow
Return value Returns the current SQL SELECT statement for dwcontrol. GetSQLSelect
returns the empty string (“”) if it cannot return the statement.
Usage When you want to change the SQL SELECT statement for a DataWindow
or DataStore at runtime, you can use GetSQLSelect to save the current
SELECT statement before making the change.
When you define a DataWindow, PowerBuilder stores a PowerBuilder

SELECT statement (PBSELECT) with the DataWindow. If a database is
connected and SetTransObject has been called for the DataWindow, then
GetSQLSelect returns the SQL SELECT statement. Otherwise,
GetSQLSelect returns the PBSELECT statement.
You can also use Describe to obtain the SQL SELECT statement. The
DataWindow object’s Table.Select property holds the information.
Examples The code saves the SELECT statement for dw_emp in the variable
old_select. Then it adds a WHERE clause. The example assumes the old
SELECT statement did not have one already:
string old_select, new_select, where_clause
// Get old SELECT statement
old_select = dw_emp.GetSQLSelect()
// Specify new WHERE clause

where_clause = "WHERE ..."
// Add the new where clause to old_select
new_select = old_select + where_clause
// Set the SELECT statement for the DW

dw_emp.SetSQLSelect(new_select)
See also SetSQLSelect
674 PowerBuilder
GetStateStatus
Description Retrieves the current status of the internal state flags for a DataWindow
and places this information in a blob.
Obsolete method
GetStateStatus is obsolete and will be discontinued in a future release. You
should remove all use of GetStateStatus as soon as possible. This method
was originally added to PowerScript to allow you to synchronize a source
DataWindow with multiple target DataWindows. This technique is no
longer supported.
Applies to
Syntax PowerBuilder
long dwcontrol.GetStateStatus ( blob cookie )
dwcontrol A reference to the DataWindow control or DataStore for which
you want to get state status
cookie A variable in which you want to store a cookie that contains state
information for the DataWindow
Return value Returns 1 if it succeeds and –1 if it fails.

returns null.
Usage In situations where a single DataStore on a server acts as the source for
multiple target DataWindows (or DataStores) on different clients, you can
use GetChanges in conjunction with GetStateStatus to determine the likely
success of SetChanges. This allows you to avoid shipping a change blob
across the wire when SetChanges will fail anyway (because changes in the
blob conflict with changes made previously by another client).
To determine the likely success of SetChanges, you need to:

GetStateStatus
1 Call the GetStateStatus method on the DataStore on which you want

to do a SetChanges. GetStateStatus checks the state of the DataStore
and makes the state information available in a reference argument
called a cookie. The cookie is generally much smaller than a
DataWindow change blob.
2 Send the cookie back to the client.
3 Call the GetChanges method on the DataWindow that contains the
changes you want to apply, passing the cookie retrieved from
GetStateStatus as a parameter. The return value from GetChanges
indicates whether there are currently any potential conflicts between
the state of the DataWindow blob and the state of the DataStore on
which you want to execute SetChanges.
If the return value from GetChanges indicates that there are potential
conflicts, you can then be certain that a subsequent call to SetChanges will
fail if the FailOnAnyConflict! argument is specified. On the other hand, if
the return value from GetChanges indicates no conflicts, the call to
SetChanges may still fail, because the state of the Datastore may have
changed since you called GetStateStatus and GetChanges.
For example, if another client session has called SetChanges or some other
processing has been executed that altered the state of the DataStore since
you retrieved the cookie, then SetChanges will fail.
Examples The following example is a script for a remote object function. The script
uses GetStateStatus to capture the state of a DataStore on the server into a
cookie. Once the cookie has been created, it is returned to the client:
blob lblb_cookie
long ll_rv
ll_rv = ids_datastore.GetStateStatus(lblb_cookie)
return lblb_cookie
See also GetChanges
GetFullState
SetChanges
SetFullState
676 PowerBuilder
GetText
Description Obtains the value in the edit control over the current row and column.
When the user changes a value in a DataWindow, it is available in the edit
control before it is accepted into the column.
Applies to
DataStore object
Syntax PowerBuilder
string dwcontrol.GetText ( )
DataWindow
Return value Returns the value in the edit control over the current row and column in
dwcontrol. The value might or might not have been accepted into the row
and column. Returns the empty string (“ ”) if no column is currently
selected in dwcontrol.
null.
Usage The values in the rows and columns of a DataWindow are items in the
DataWindow’s buffer. When a user edits a value in a row and column, the
item value is transferred as text to an edit control in which the user can
change the value. When the user leaves the column or when a script calls
AcceptText, the text in the edit control is accepted into the column and
becomes the value of the item in the buffer.
You do not need to call GetText in the script for the ItemChanged or
ItemError event. To check the value entered in the edit control over the
current row and column before allowing it to be accepted into the column,
use the data argument.
To obtain the value stored in the DataWindow’s buffer for the row and
column, use the GetItem method that corresponds with the datatype of the
column.

GetTrans
Examples This statement returns the text held in the edit control for the currently
selected cell in dwEmp to the string variable selectedCell. The text might
be a name or address for a column with the Edit edit style, Y or N for a
column with the CheckBox edit style, or M or F for a column with the
RadioButtons edit style that represents gender:
string selectedCell
selectedCell = dwEmp.GetText()
See also SetText
GetTrans
Description Gets the values for the DataWindow control or DataStore object’s internal
transaction object and stores these values in the programmer-specified
transaction object.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.GetTrans ( transaction transaction )
DataWindow
transaction The name of the transaction object into which you want to put the
values
usually not used.
Usage The SetTrans method (not the SetTransObject method) sets the internal
transaction object. If you have not called SetTrans, GetTrans will fail.
Use GetTrans when you want to get the values for the transaction object in
order to modify them, as shown in the last example.
678 PowerBuilder
If you are using SetTransObject, which specifies transaction information

using a programmer-specified transaction object, GetTrans will not report
information about the programmer-specified transaction object currently
in effect. (SetTransObject is the recommended connection method because
it gives better application performance. See SetTrans and SetTransObject
for more information.)
Examples This example puts the values in the internal transaction object for
dw_employee into the programmer-specified transaction object named
object1:
transaction object1
object1 = CREATE transaction
dw_employee.GetTrans(object1)
The following statement puts the values in the internal transaction object
for dw_employee into the default transaction object (SQLCA):
dw_employee.GetTrans(SQLCA)
The following statements change the database type and password of
dw_employee. The first two statements create the transaction object
emp_TransObj. The next two statements use the SetTrans method to set
the values of SQLCA, and then use the GetTrans method to store the
values of the current transaction object for dw_employee in
emp_TransObj. The last two statements change the database type and
password, and then the SetTrans method puts the revised values in the
transaction object for dw_employee:
// Name the transaction object.
transaction emp_TransObj
// Create the transaction object.

emp_TransObj = CREATE transaction
// Set the internal transaction object.

dw_employee.SetTrans(SQLCA)
// Fill the new transaction object with original

// values from SQLCA.
dw_employee.GetTrans(emp_TransObj)
// Put revised values into the new transaction

// object.
// Change the database type.
emp_TransObj.DBMS = "Sybase"

GetUpdateStatus
// Change the password.

emp_TransObj.LogPass = "cam2"
// Associate the new transaction object with

// dw_employee, replacing SQLCA.
dw_employee.SetTrans(emp_TransObj)
See also SetTrans
GetUpdateStatus
Description Reports the row number and buffer of the row that is currently being
updated in the database. When called because of an error, GetUpdateStatus
reports the row that caused the error.
Obsolete method
GetUpdateStatus is obsolete and will be discontinued in a future release.
You should replace all references to GetUpdateStatus as soon as possible.
The update status is available as an argument in the DBError and
SQLPreview events.
Applies to
Syntax PowerBuilder
integer dwcontrol.GetUpdateStatus (long row, DWBuffer dwbuffer )
row A variable that will store the number of the row that will be
updated or for which an update was attempted.
DataWindow buffer that contains the row being updated. For a
Return value Returns 1 if it succeeds and –1 if an error occurs. The number and buffer
of the row currently being updated are stored in row and dwbuffer.
680 PowerBuilder
Examples These statements in the script for the DBError event for a DataWindow
control obtain the text of the error message, display a message box with
the number of the row in which the error occurred and the error message,
and then make the row with the error the current row.
Additional code in the IF statement considers the case of the bad row being
in the filter or delete buffer. If the row is in the filter buffer, the script
changes the filter so that the user can edit the row in the primary buffer. If
the row is in the delete buffer, the message box displays a slightly different
title:
long row_number, row_key
dwBuffer buffer_type
string message_text, message_title, old_filter
// Get the error message text and set the title

message_text = DBErrorMessage()
message_title = "Database Error Updating Row"
// Get the row in which the error occurred

This.GetUpdateStatus(row_number, buffer_type)
IF buffer_type = Filter! THEN

old_filter =
This.Describe("DataWindow.Filter")
row_key = This.GetItemNumber(row_number, &
"emp_id", Filter!, false)
This.SetFilter("(" + old_filter + ")" + &

"OR emp_id = " + String(row_key))
This.Filter()
// Error row is now last row in primary buffer

row_number = This.RowCount()
ELSEIF buffer_type = Delete! THEN

message_title = "Database Error Deleting Row"
END IF
// Display the location of the error and the error
// message.
MessageBox(message_title + &
String(row_number), message_text)
IF buffer_type <> Delete! THEN

// Make the row with the error the current

GetValidate
row.
This.ScrollToRow(row_number)
END IF
// Return 1 from the DBError event
// (do not display error message) because we've
// already displayed a message
RETURN 1
GetValidate
Description Obtains the validation rule for a column in a DataWindow.
Applies to
DataStore object
Syntax PowerBuilder
string dwcontrol.GetValidate ( string column )
string dwcontrol.GetValidate ( integer column )
DataWindow.
column The column for which you want the validation rule. Column can
be a column number or a column name. The column number is the
number of the column as it is listed in the Column Specification
view of the DataWindow painter—not necessarily the number of
the column in the Design view.
Return value Returns the validation rule for column in dwcontrol. Returns the empty
string (“”) if no validation criteria are defined for the column.
returns null.
Usage You can use GetValidate to save the current validation rule before calling
SetValidate to change the rule temporarily.
Examples These statements change the validation rule for column 7 in the
DataWindow control dw_Employee to Rule2:
682 PowerBuilder
string Rule1, Rule2 = "Long(GetText()) > 15000"

Rule1 = dw_Employee.GetValidate(7)
dw_Employee.SetValidate(7, Rule2)
See also SetValidate
GetValue
Description Obtains the value of an item in a value list or code table associated with a
column in a DataWindow.
Applies to
DataStore object
Syntax PowerBuilder
string dwcontrol.GetValue ( string column, integer index )
string dwcontrol.GetValue ( integer column, integer index )
DataWindow.
column The column for which you want the item. Column can be a
column number (integer) or a column name (string).
index The number of the item in the value list or the code table for the
edit style.
Return value Returns the item identified by index in the value list or the code table
associated with column of dwcontrol. If the item has a display value that
is not the actual value, GetValue returns a tab-separated string consisting
of:
displayvalue[tab]codevalue
Returns the empty string (“ ”) if the index is not valid or the column does
not have a value list or code table.
returns null.

GroupCalc
Usage You can use GetValue to find out the values associated with the following
edit styles: CheckBox, RadioButton, DropDownListBox, Edit Mask, and
Edit. If the edit style has a code table in which each value in the list has a
display value and a data value, GetValue reports both values.
GetValue does not get values from a DropDownDataWindow code table.
09). In PowerBuilder, search for ~t.
Examples If the value list for column 7 of dw_employee contains Full Time, Part
Time, Retired, and Terminated, these statements return the value of item 3
(Retired):
string Status
Status = dw_employee.GetValue(7,3)
If the value list for the column named product of dw_employee is
Widget[tab]1, Gadget[tab]2, the following code returns Gadget[tab]2 and
saves the display value in a string variable:
string ls_prodinfo, ls_prodname, ls_prodnum
integer li_tab
ls_prodinfo = dw_employee.GetValue("product", 2)
li_tab = Pos(ls_prodinfo, "~t", 1)

ls_prodname = Left(ls_prodinfo, li_tab - 1)
ls_prodnum = Mid(ls_prodinfo, li_tab + 1)
See also ClearValues
SetValue
GroupCalc
Description Recalculates the breaks in the grouping levels in a DataWindow.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.GroupCalc ( )
684 PowerBuilder
DataWindow

null.
Usage Use GroupCalc to force the DataWindow object to recalculate the breaks
in the grouping levels after you have added or modified rows in a
DataWindow.
GroupCalc does not sort the data before it recalculates the breaks.
Therefore, unless you populated the DataWindow in a sorted order, call the
Sort method to sort the data before you call GroupCalc.
Examples This code imports new rows from a file into the DataWindow dw_emp and
then recalculates the group breaks for dw_emp:
dw_emp.ImportFile("d:\employee.txt")
dw_emp.SetRedraw(false)
dw_emp.SetSort("1A")
dw_emp.Sort()
dw_emp.GroupCalc()
dw_emp.SetRedraw(true)
See also Sort
Hide
Description Makes an object or control invisible. Users cannot interact with an
invisible object. It does not respond to any events, so the object is also, in
effect, disabled.
Applies to
Syntax PowerBuilder
Integer objectname.Hide ( )
objectname The name of the object or control you want to make invisible

ImportClipboard
Return value Returns 1 if it succeeds and –1 if an error occurs. If objectname is null,

Hide returns null.
Usage Inherited from GraphicObject. For information, see Hide in the
ImportClipboard
Description Inserts data into a DataWindow control or DataStore object from tab-
separated, comma-separated, or XML data on the clipboard.
Applies to
DataStore object
Syntax PowerBuilder
long dwcontrol.ImportClipboard ( {saveastype importtype}, { long
startrow {, long endrow {, long startcolumn {, long endcolumn {, long
dwstartcolumn } } } } } )
DataWindow.
importtype An enumerated value of the SaveAsType DataWindow
(optional for constant or a number representing that value (see
PowerBuilder) SaveAsType on page 492). Valid import type arguments for
ImportClipboard are:
Text!
CSV!
XML!
If you want to generate an XML trace file, the XML!
argument is required.
startrow The number of the first detail row in the clipboard that you
(optional for want to copy. The default is 1.
PowerBuilder) For default XML import, if startrow is supplied, the first N
(startrow -1) elements are skipped, where N is the
DataWindow row size.
For template XML import, if startrow is supplied, the first
(startrow -1) occurrences of the repetitive row mapping
defined in the template are skipped.
686 PowerBuilder
endrow The number of the last detail row in the clipboard that you
(optional for want to copy. The default is the rest of the rows.
PowerBuilder) For default XML import, if endrow is supplied, import stops
when N * endrow elements have been imported, where N is
the DataWindow row size.
For template XML import, if endrow is supplied, import
stops after endrow occurrences of the repetitive row
mapping defined in the template have been imported.
startcolumn The number of the first column in the clipboard that you
PowerBuilder) For default XML import, if startcolumn is supplied, import
skips the first (startcolumn - 1) elements in each row.
This argument has no effect on template XML import.
endcolumn The number of the last column in the clipboard that you
(optional for want to copy. The default is the rest of the columns.
PowerBuilder) For default XML import, if endcolumn is supplied and is
smaller than N, where N is the DataWindow row size,
import skips the last (N - endcolumn) elements in each row.
dwstartcolumn The number of the first column in the DataWindow control
(optional for or DataStore that should receive data. The default is 1. This
PowerBuilder) argument is supported for default and template XML
import.
Return value Returns the number of rows that were imported if it succeeds and one of
the following negative integers if an error occurs:
-1 No rows or startrow value supplied is greater than the number of rows
in the string
-3 Invalid argument
-4 Invalid input
-11 XML Parsing Error; XML parser libraries not found or XML not
well formed
-12 XML Template does not exist or does not match the DataWindow
-13 Unsupported DataWindow style for import
-14 Error resolving DataWindow nesting

ImportClipboard
Usage The clipboard data must be formatted in tab-separated or comma-

separated columns or in XML. The datatypes and order of the
DataWindow object’s columns must match the data on the clipboard.
If an XML or CSV column contains a leading double quote, it is assumed
to be part of the column value. A leading double quote has to be closed to
mark the end of an item.
All the arguments of this function are optional. You do not need to specify
the importtype argument. The startcolumn and endcolumn arguments
control the number of imported columns and the number of columns in the
DataWindow that are affected. The dwstartcolumn argument specifies the
first DataWindow column to be affected. The following formula calculates
the last column to be affected.
dwstartcolumn + (endcolumn - startcolumn)
ImportClipboard does not support Crosstab DataWindow objects.
Examples This statement copies all data in the clipboard to the DataWindow
dw_employee starting at the first column:
dw_employee.ImportClipboard()
This statement copies all data in the clipboard to the DataWindow
dw_employee starting at the first column and specifies that the data is in
XML format:
dw_employee.ImportClipboard(XML!)
This statement imports rows 1 to 200 of the XML data on the clipboard,
ignoring any template mappings before column 5:
dw_employee.ImportClipboard(XML!, 1, 200, 0, 0, 5)
This statement inserts data from the clipboard into the DataWindow
dw_employee. It copies rows 2 through 30 and columns 3 through 8 on the
clipboard to the DataWindow beginning in column 5. It adds 29 rows to
the DataWindow with data in columns 5 through 10:
dw_employee.ImportClipboard(2,30,3,8,5)
See also ImportFile
ImportString
688 PowerBuilder
ImportFile
Description Inserts data into a DataWindow control or DataStore from a file. The data
can be tab-separated text, comma-separated text, XML, or dBase format 2
or 3.
Applies to
DataStore object
Syntax PowerBuilder
long dwcontrol.ImportFile ( {saveastype importtype}, string filename
{, long startrow {, long endrow {, long startcolumn {, long endcolumn
{, long dwstartcolumn } } } } } )
dwcontrol A reference to a DataWindow control or DataStore
(optional for constant or a number representing that value (see
PowerBuilder) SaveAsType on page 492). If this argument is specified, the
filename argument can be specified without an extension.
Valid type arguments for ImportFile are:
Text!
CSV!
XML!
DBase2!
DBase3!
filename A string whose value is the name of the file from which you
want to copy data. The file must be an ASCII, tab-separated
file (TXT) or a comma-separated file (CSV), Extensible
Markup Language file (XML), or dBase format 2 or 3 file
(DBF). Specify the file’s full name. If the optional
importtype is not specified, the name must end in the
appropriate extension.
If filename is an empty string, or if it is null, ImportFile
displays the File Open dialog box and allows the user to
select a file. The remaining arguments are ignored.

ImportFile
startrow The number of the first detail row in the file that you want
(optional for to copy. The default is 1.
endrow The number of the last detail row in the file that you want to
(optional for copy. The default is the rest of the rows.
PowerBuilder) For default XML import, if endrow is supplied, import stops
when N * endrow elements have been imported, where N is
the DataWindow row size.
startcolumn The number of the first column in the file that you want to
(optional for copy. The default is 1.
endcolumn The number of the last column in the file that you want to
(optional for copy. The default is the rest of the columns.
smaller than N, where N is the DataWindow row size, import
skips the last (N - endcolumn) elements in each row.
import.
Events ImportFile may trigger an ItemError event.

Return value Long. Returns the number of rows that were imported if it succeeds and
one of the following negative integers if an error occurs:
in the file
-2 Empty file
-3 Invalid argument
690 PowerBuilder
-4 Invalid input
-5 Could not open the file
-6 Could not close the file
-7 Error reading the text
-8 Unsupported file name suffix (must be *.txt, *.csv, *.dbf or *.xml)
-10 Unsupported dBase file format (not version 2 or 3)
well formed
-15 File size exceeds limit
Usage The format of the file can be indicated by specifying the optional
importtype parameter, or by including the appropriate file extension.
The file should consist of rows of data. If the file includes column
headings or row labels, set the startrow and startcolumn arguments to skip
them. The datatypes and order of the DataWindow object’s columns must
match the columns of data in the file.
The startcolumn and endcolumn arguments control the number of columns
imported from the file and the number of columns in the DataWindow that
are affected. The dwstartcolumn argument specifies the first DataWindow
column to be affected. The following formula calculates the last
DataWindow to be affected.
dwstartcolumn + (endcolumn - startcolumn)
To let users select the file to import, specify a null string for filename.
PowerBuilder displays the Select Import File dialog box. A drop-down list
lets the user select the type of file to import.
Specifying a null string for filename

If you specify a null string for filename, the remaining arguments are
ignored. All the rows and columns in the file are imported.

ImportFile
Double quotes The location and number of double quote marks in a

field in a tab-separated file affect how they are handled when the file is
imported. If a string is enclosed in one pair of double quotes, the quotes
are discarded. If it is enclosed in three pairs of double quotes, one pair is
retained when the string is imported. If the string is enclosed in two pairs
of double quotes, the first pair is considered to enclose a null string, and
the rest of the string is discarded.
When there is a double quote at the beginning of a string, any characters
after the second double quote are discarded. If there is no second double
quote, the tab or comma character delimiting the fields is not recognized
as a field separator and all characters up to the next occurrence of a double
quote, including a carriage return, are considered to be part of the string.
A validation error is generated if the combined strings exceed the length
of the first string.
Double quotes after the first character in the string are rendered literally.
Here are some examples of how tab-separated strings are imported into a
two-column DataWindow:
Table 9-5: Examples of strings imported into a two-column
DataWindow
Text in file Result
"Joe" TAB "Donaldson" Joe Donaldson
Bernice TAB """Ramakrishnan""" Bernice "Ramakrishnan"
""Mary"" TAB ""Li"" Empty cells
"Mich"ael TAB """Mariam""" Mich "Mariam"
"Amy TAB Doherty" Amy<TAB>Doherty in first cell, second
cell empty
3""" TAB 4" 3""" 4"

ImportFile does not support Crosstab DataWindow objects.
Examples This statement inserts all the data in the file D:\TMP\EMPLOYEE.CSV
into dw_employee starting at the first column:
dw_employee.ImportFile("D:\TMP\EMPLOYEE.CSV")
This statement inserts all the data in the file D:\TMP\EMPLOYEE.XML
into dw_employee starting at the first column:
dw_employee.ImportFile(XML!,"D:\TMP\EMPLOYEE")
692 PowerBuilder
The following statements are equivalent. Both import the contents of the
XML file named myxmldata:
dw_control.ImportFile("myxmldata.xml")
dw_control.ImportFile(XML!, "myxmldata")
This statement imports rows 1 to 200 of employee.xml, ignoring any
template mappings before column 5:
dw_employee.ImportFile(XML!,"D:\TMP\EMPLOYEE.XML",
1, 200, 0, 0, 5)
This statement inserts the data from the file D:\TMP\EMPLOYEE.TXT
into the DataWindow dw_employee. It copies rows 2 through 30 and
columns 3 through 8 in the file to the DataWindow beginning in column
5. The result is 29 rows added to the DataWindow with data in columns 5
through 10:
dw_employee.ImportFile("D:\TMP\EMPLOYEE.TXT", &
2, 30, 3, 8, 5)
See also ImportClipboard
ImportString
ImportString
Description Inserts data into a DataWindow control or DataStore from tab-separated,
comma-separated, or XML data in a string.
Applies to
DataStore object
Syntax PowerBuilder
long dwcontrol.ImportString ( {saveastype importtype}, string string
{, long startrow {, long endrow {,long startcolumn {, long endcolumn
{, long dwstartcolumn } } } } } )

ImportString
(optional for constant or a string or number representing that value (see
PowerBuilder) SaveAsType on page 492). Valid type arguments are:
Text!
CSV!
XML!
If you want to generate an XML trace file, the XML!
argument is required.
string A string from which you want to copy the data. The string
should contain tab-separated or comma-separated columns
or XML with one row per line (see Usage).
startrow The number of the first detail row in the string that you
endrow The number of the last detail row in the string that you want
(optional for to copy. The default is the rest of the rows.
PowerBuilder) For default XML import, if endrow is supplied, import
stops when N * endrow elements have been imported,
where N is the DataWindow row size.
startcolumn The number of the first column in the string that you want
(optional for to copy. The default is 1.
endcolumn The number of the last column in the string that you want
(optional for to copy. The default is the rest of the columns.
smaller than N, where N is the DataWindow row size,
import skips the last (N - endcolumn) elements in each row.
694 PowerBuilder
import.
Events ImportString may trigger an ItemError event.

Return value Returns the number of rows that were imported if it succeeds and one of
the following negative integers if an error occurs:
in the string
-3 Invalid argument
-4 Invalid input
well formed
Usage All the arguments of this function except string are optional. You do not
need to specify the importtype argument.
The string must be formatted in tab-separated or comma-separated
columns or in XML. For TXT and CSV files, the format of the string is the
same as if the data came from an ASCII file, and each line must end with
a carriage return and a newline character (~r~n). If the string has four tab-
separated columns, one line might look like for a tab-separated string:
col1_data~t col2_data~t col3_data~t col4_data~r~n
For a DataWindow control or DataStore, the string should consist of rows
of data. If the data includes column headings or row labels, set the startrow
and startcolumn arguments to skip them. The datatypes and order of the
DataWindow object’s columns must match the columns of data in the
string.
The startcolumn and endcolumn arguments control the number of columns
imported from the string and the number of columns in the DataWindow
that are affected. The dwstartcolumn argument specifies the first
DataWindow column to be affected. The following formula calculates the
last DataWindow to be affected.

ImportString
dwstartcolumn + ( endcolumn - startcolumn )

If string data to be assigned to a single row and column has multiple lines
(indicated by line-ending characters in the import string), you must quote
the string data using ~". Do not use single quotes.
This example of a valid tab-separated import string assigns multiline
values to each row in column 2:
ls_s = &
"1~t~"Mickey~r~nMinnie~r~nGoofy~" ~r~n" + &
"2~t~"Susan~r~nMary~r~nMarie~" ~r~n" + &
"3~t~"Chris~r~nBen~r~nMike~" ~r~n" + &
"4~t~"Mott~r~nBarber~r~nPicard~" "
ImportString does not support Crosstab DataWindow objects.
Examples These statements copy all data in the string ls_Emp_Data to the
DataWindow control dw_employee starting at the first column:
string ls_Emp_Data
ls_Emp_Data = . . .
dw_employee.ImportString(ls_Emp_Data)
This statement stores data in the string ls_Text and imports it into the
DataWindow dw_employee. The DataWindow is a report of department
100 and start and end dates of personnel. The string includes the
department number and other information, which is not imported.
ImportString imports rows 2 through 10 and columns 2 through 5 in the
string to the DataWindow beginning in column 2. The result is 9 rows
added to the DataWindow with data in columns 5 through 8:
string ls_text
ls_text = "Dept~tLName~tFName~tStart" &

+ "~tEnd~tAmount~tOutcome ~r~n"
ls_text = ls_text + &
"100~tJones~tMary~tApr88~tJul94~t40~tG~r~n"
"100~tMarsh~tMarsha~tApr89~tJan92~t35~tG~r~n"
"100~tJames~tHarry~tAug88~tMar93~t22~tM~r~n"
...
696 PowerBuilder
"100~tWorth~tFrank~tSep87~tJun94~t55~tE~r~n"
dw_employee.ImportString(ls_text, 2, 10, 2, 5, 5)
This statement imports rows 1 to 200 of the data in the XML string ls_emp,
ignoring any template mappings before column 5:
dw_employee.ImportString(ls_emp, 1, 200, 0, 0, 5)
See also ImportClipboard
ImportFile
InsertDocument
Description Inserts a rich text format or plain text file into a DataWindow control or
DataStore object.
The new content is added in one of two ways:
• The new content can be inserted at the insertion point.
• The new content can replace all existing content.
Applies to
Syntax PowerBuilder
integer dwcontrol.InsertDocument ( string filename, boolean
clearflag, FileType filetype)
dwcontrol A reference to a DataWindow control or DataStore object. The
DataWindow object in the DataWindow control or DataStore
must be a RichTextEdit DataWindow.
filename A string whose value is the name of the file you want to display
in the RichTextEdit control. Filename can include the file’s
path.
clearflag A boolean value specifying whether the new file will replace
the current contents of the control. Values are:
• True – Replace the current contents with the file.
• false – Insert the file into the existing contents at the
insertion point.

InsertDocument
filetype A value of the FileType enumerated datatype specifying the
type of file being opened. Values are:
• FileTypeRichText! – (Default) The file being opened is in
rich text format (RTF).
• FileTypeText! – The file being opened is plain ASCII text
(TXT).
• FileTypeHTML! – The file being opened is in HTML
format (HTM or HTML)
• FileTypeDoc! – The file being opened is in Microsoft Word
format (DOC)
Return value Returns 1 if it succeeds and –1 if an error occurs. If any argument’s value
is null, InsertDocument returns null.
Usage When the control supports headers and footer (the HeaderFooter property
is set to true), inserting a document can replace, but not add to, existing
header and footer text. You must set clearflag to true to replace the existing
header and footer text with header and footer text from the inserted
document.
Not all RTF formatting is supported. PowerBuilder supports version 1.6 of
the RTF standard, except for the following:
• No support for formatted tables
• No drawing controls
Any unsupported formatting is ignored.
For use with other PowerBuilder RichTextEdit controls, see
InsertDocument in the PowerScript Reference.
Examples This example inserts a document into a RichTextEdit DataWindow:

integer rtn
rtn = dw_1.InsertDocument("c:\pb\test.rtf", &
false, FileTypeRichText!)
See also DataSource in the PowerScript Reference
InputFieldInsert in the PowerScript Reference
InsertPicture in the PowerScript Reference
698 PowerBuilder
InsertRow
Description Inserts a row in a DataWindow or DataStore. If any columns have default
values, the row is initialized with these values before it is displayed.
Applies to
DataStore object
Syntax PowerBuilder
long dwcontrol.InsertRow ( long row )
DataWindow.
row A value identifying the row before which you want to insert a
row. To insert a row at the end, specify 0.
Return value Returns the number of the row that was added if it succeeds and –1 if an
error occurs.
method returns null. If there is no DataWindow object assigned to the
DataWindow control or DataStore, this method returns –1.
Usage InsertRow simply inserts the row without changing the display or the
current row. To scroll to the row and make it the current row, call
ScrollToRow. To simply make it the current row, call SetRow.
A newly inserted row (with a status flag of New!) is not included in the
modified count until data is entered in the row (its status flag becomes
NewModified!).
Examples This statement inserts an initialized row before row 7 in dw_Employee:
dw_Employee.InsertRow(7)
This example inserts an initialized row after the last row in dw_employee,
then scrolls to the row, which makes it current:
long ll_newrow
ll_newrow = dw_employee.InsertRow(0)
dw_employee.ScrollToRow(ll_newrow)
See also DeleteRow
Update

IsExpanded
IsExpanded
Description Performs a test to see whether a group in a TreeView DataWindow with
the specified TreeView level is expanded, and whether the group includes
the specified row.
Applies to
Syntax PowerBuilder
Boolean dw_control.IsExpanded(long row, long groupLevel)
row The number of the row that belongs to the group
groupLevel The TreeView level of the group
Return value Returns true if the group is expanded and false if the group is not expanded.
IsExpanded also returns false if the DataWindow is not a TreeView
DataWindow or the row or groupLevel is invalid.
can be expanded and collapsed. You can use the IsExpanded method to test
whether or not a group in a TreeView DataWindow is expanded.
Examples The following example performs a test to determine whether the group
that contains row 3 at TreeView level 2 is expanded:
boolean lb_expanded
lb_expanded = dw_treeview.IsExpanded(3,2)
See also Expand
ExpandAll
ExpandAllChildren
ExpandLevel
IsRowSelected
Description Determines whether a row is selected in a DataWindow. A selected row is
highlighted using reverse video.
700 PowerBuilder
Obsolete method
IsRowSelected is obsolete and should not be used, because the Web
Applies to
Web Client control

boolean dwcontrol.IsSelected ( number row )
DataWindow
row A value identifying the row you want to test to see if it is selected
Return value Returns true if row in dwcontrol is selected and false if it is not selected. If
row is greater than the number of rows in dwcontrol or is 0 or negative,
IsRowSelected also returns false.
Usage You can call IsRowSelected in a script for the Clicked event to determine
whether the row the user clicked was selected. With IsRowSelected and
SelectRow, you can highlight a row on the client without causing a
postback.
Examples This code calls IsRowSelected to test whether the clicked row is selected.
If the row is selected, SelectRow deselects it; if it is not selected, SelectRow
selects it:
if (rowNumber > 0)
{
if (dw_1.IsRowSelected(rowNumber))
dw_1.SelectRow(rowNumber, false);
else
dw_1.SelectRow(rowNumber, true);
}
See also SelectRow

IsSelected
IsSelected
Description Determines whether a row is selected in a DataWindow or DataStore. A
selected row is highlighted using reverse video.
Applies to
DataStore object
Syntax PowerBuilder
boolean dwcontrol.IsSelected ( long row )
DataWindow
row A value identifying the row you want to test to see if it is selected
Return value Returns true if row in dwcontrol is selected and false if it is not selected. If
row is greater than the number of rows in dwcontrol or is 0 or negative,
IsSelected also returns false.

Usage You can call IsSelected in a script for the Clicked event to determine
whether the row the user clicked was selected.
Examples This code calls IsSelected to test whether the current row in dw_employee
is selected. If the row is selected, SelectRow deselects it; if it is not
selected, SelectRow selects it:
long CurRow
boolean result
CurRow = dw_employee.GetRow()
result = dw_employee.IsSelected(CurRow)
IF result THEN
dw_employee.SelectRow(CurRow, false)
ELSE
dw_employee.SelectRow(CurRow, true)
END IF
This code uses the NOT operator on the return value of IsSelected to
accomplish the same result as the IF/THEN/ELSE statement above:
integer CurRow
702 PowerBuilder
boolean result
CurRow = dw_employee.GetRow()
dw_employee.SelectRow(CurRow, &
NOT dw_employee.IsSelected(CurRow))
See also SelectRow
LineCount
Description Determines the number of lines in an edit control that allows multiple
lines.
Applies to
Syntax PowerBuilder
long dwcontrol.LineCount ( )
Return value Returns the number of lines in dwcontrol if it succeeds and –1 if an error
occurs. If dwcontrol is null, LineCount returns null.
Usage LineCount counts each visible line, whether it was the result of wrapping
or carriage returns.
When you call LineCount for a DataWindow, it reports the number of lines
in the edit control over the current row and column. A user can enter
multiple lines in a DataWindow column only if it has a text datatype and
its box is large enough to display those lines.
The size of the column’s box determines the number of lines allowed in
the column. When the user is typing, lines do not wrap automatically; the
user must press Enter to type additional lines.
For use with other PowerBuilder controls, see LineCount in the

ModifiedCount
Examples If the MultiLineEdit mle_Instructions has 9 lines, this example sets

li_Count to 9:
integer li_Count
li_Count = mle_Instructions.LineCount()
These statements display a MessageBox if fewer than two lines have been
entered in the MultiLineEdit mle_Address:
integer li_Lines
li_Lines = mle_Address.LineCount()
IF li_Lines < 2 THEN
MessageBox("Warning", "2 lines are
required.")
END IF
ModifiedCount
Description Reports the number of rows that have been modified but not updated in a
DataWindow or DataStore.
Applies to
DataStore object
Syntax PowerBuilder
long dwcontrol.ModifiedCount ( )
DataWindow
Return value Returns the number of rows that have been modified in the primary buffer.
Returns 0 if no rows have been modified or if all modified rows have been
updated in the database table. Returns –1 if an error occurs.
null.
Usage ModifiedCount reports the number of rows that are scheduled to be added
or updated in the database table associated with a DataWindow or
DataStore. This includes rows in the primary and filter buffers.
704 PowerBuilder
A newly inserted row (with a status flag of New!) is not included in the
modified count until data is entered in the row (its status flag becomes
NewModified!).
The DeletedCount method counts the number of rows in the deleted buffer.
The RowCount method counts the total number of rows in the primary
buffer.
Examples If five rows in dw_Employee have been modified but not updated in the
associated database table or filtered out of the primary buffer, the
following code sets ll_Rows equal to 5:
long ll_Rows
ll_Rows = dw_Employee.ModifiedCount()
If any rows in dw_Employee have been modified but not updated in the
associated database table, this statement updates the database table
associated with the dw_employee DataWindow control:
IF dw_employee.ModifiedCount() > 0 THEN &
See also DeleteRow
DeletedCount
FilteredCount
Retrieve
RowCount
Update
Modify
Description Modifies a DataWindow object by applying specifications, given as a list
of instructions, that change the DataWindow object’s definition.
You can change appearance, behavior, and database information for the
DataWindow object by changing the values of properties. You can add and
remove controls from the DataWindow object by providing specifications
for the controls.
Applies to
DataStore object

Modify
Syntax PowerBuilder
string dwcontrol.Modify ( string modstring )
DataWindow.
modstring A string whose value is the specifications for the modification.
See Usage for appropriate formats.
Return value Returns the empty string (“”) if it succeeds and an error message if an error
occurs. The error message takes the form "Line n Column n incorrect
syntax". The character columns are counted from the beginning of the
compiled text of modstring.
Usage Modify lets you make many of the same settings in a script that you would
make in the DataWindow painter. Typical uses for Modify are:
• Changing colors, text settings, and other appearance settings of
controls
• Changing the update status of different tables in the DataWindow so
that you can update more than one table
• Modifying the WHERE clause of the DataWindow object’s SQL
SELECT statement
• Turning on Query mode or Prompt For Criteria so users can specify

the data they want
• Changing the status of Retrieve Only As Needed
• Changing the data source of the DataWindow object
• Controlling the Print Preview display
• Deleting and adding controls (such as lines or bitmaps) in the
DataWindow object
Each of these uses is illustrated in the Examples for this method.
You can use three types of statements in modstring to modify a
DataWindow object.
706 PowerBuilder
Statement type What it does

CREATE control (settings) Adds control to the DataWindow object (such
as text, computed fields, and bitmaps). Settings
is a list of properties and values using the
format you see in exported DataWindow
syntax. To create a control, you must supply
enough information to define it.
Control cannot be an OLE Object control. You
cannot add an OLE object to a DataWindow
using the Modify method.
DESTROY [COLUMN] Removes control from the DataWindow object.
control When control is a column, specify the keyword
COLUMN to remove both the column and the
column’s data from the buffer.
controlname.property=value Changes the value of property to value.
Properties control the location, color, size, font,
and other settings for controlname. When
controlname is DataWindow, you can also set
properties for database access.
Depending on the specific property, value can
be:
• A constant.
• A quoted constant.
• An expression that consists of a default
value followed by a valid DataWindow
expression that returns the appropriate
datatype for the property. Expressions are
described below.
Object names The DataWindow painter automatically gives names to

all controls. In previous versions, it named only columns and column
labels, and to describe and modify properties of other controls easily, you
had to name them.
Expressions for Modify When you specify an expression for a
DataWindow property, the expression has the format:
defaultvalue~tDataWindowpainterexpression
Defaultvalue is a value that can be converted to the appropriate datatype
for the property. It is followed by a tab (~t).

Modify
DataWindowpainterexpression is an expression that can use any

DataWindow painter function. The expression must also evaluate to the
appropriate datatype for the property. When you are setting a column’s
property, the expression is evaluated for each row in the DataWindow,
which allows you to vary the display based on the data.
A typical expression uses the If function:
'16777215 ~t If(emp_status=~~'A~~',255,16777215)'
To use that expression in a modstring, specify the following (entered as a
single line):
modstring = "emp_id.Color='16777215 ~t
If(emp_status=~~'A~~',255,16777215)'"
Not all properties accept expressions. For details on each property, see
Quotes and tildes Because Modify’s argument is a string, which can
include other strings, you need to use special syntax to specify quotation
marks. To specify that a quotation mark be used within the string rather
than match and end a previously opened quote, you can either specify the
other style of quote (single quotes nested with double quotes) or precede
the quotation mark with a tilde (~).
For another level of nesting, the string itself must specify ~", so you must
include ~~ (which specifies a tilde) followed by ~" (which specifies a
quote). For example, another way to type the modstring shown above
(entered as a single line) is:
modstring = "emp_id.Color=~"16777215 ~t
If(emp_status=~~~"A~~~",255,16777215)~""
For more information about quotes and tildes, see the section on standard
datatypes in the PowerScript Reference.
Building a modstring with variables To use variable data in modstring,
you can build the string using variables in your program. As you
concatenate sections of modstring, make sure quotes are included in the
string where necessary. For example, the following code builds a
modstring similar to the one above, but the default color value and the two
color values in the If function are calculated in the script. Notice how the
single quotes around the expression are included in the first and last pieces
of the string:
red_amount = Integer(sle_1.Text)
modstring = "emp_id.Color='" + &
708 PowerBuilder
"~tIf(emp_status=~~'A~~'," + &
String(RGB(255, 0, 0)) + &
"," + &
")'"
The following is a simpler example without the If function. You do not
need quotes around the value if you are not specifying an expression. Here
the String and RGB functions produce in a constant value in the resulting
modstring:
modstring = "emp_id.Color=" + &
String(RGB(red_amount, 255, 255))
You can set several properties with a single call to Modify by including
each property setting in modstring separated by spaces. For example,
assume the following is entered on a single line in the script editor:
oval_1.Background.Color=255")
However, it is easier to understand and debug a script in which each call
to Modify sets one property.
Debugging tip
If you build your modstring and store it in a variable that is the argument
for Modify, you can look at the value of the variable in Debug mode. When
Modify’s error message reports a column number, you can count the
characters as you look at the compiled modstring.
Modifying a WHERE clause

For efficiency, use Modify instead of SetSQLSelect to modify a WHERE
clause. Modify is faster because it does not verify the syntax and does not
change the update status of the DataWindow object. However, Modify is
more susceptible to user error. SetSQLSelect modifies the syntax twice
(when the syntax is modified and when the retrieve executes) and affects
the update status of the DataWindow object.
PowerBuilder already includes many functions for modifying a

DataWindow. Before using Modify, check the list of DataWindow
functions in Objects and Controls to see if a function exists for making the
change. Many of these functions are listed in the See also section.

Modify
Modify is for modifying the properties of a DataWindow object and its

internal controls. You can set properties of the DataWindow control that
contains the object using standard dot notation. For example, to put a
border on the control, specify:
dw_1.Border = true
Examples These examples illustrate the typical uses listed in the Usage section. The
examples use PowerScript. For a discussion of Modify and nested quotation
marks in JavaScript, see Chapter 5, Accessing DataWindow Object
Properties in Code.
Changing colors The effect of setting the Color property depends on
the control you are modifying. To set the background color of the whole
DataWindow object, use the following syntax:
dwcontrolname.Modify ( "DataWindow.Color='long'" )
To set the text color of a column or a text control, use similar syntax:
dwcontrolname.Modify ( "controlname.Color='long'" )
To set the background color of a column or other control, use the following
syntax to set the mode and color. Make sure the mode is opaque:
dwcontrolname.Modify ( "controlname.Background.Mode= &
'<0 - Opaque, 1 - Transparent>'")
dwcontrolname.Modify ( "controlname.Background.Color='long'" )
The following examples use the syntaxes shown above to set the colors of
various parts of the DataWindow object.
This statement changes the background color of the DataWindow dw_cust
to red:
dw_cust.Modify("DataWindow.Color = 255")
This statement causes the DataWindow dw_cust to display the text of
values in the salary column in red if they exceed 90,000 and in green if
they do not:
dw_cust.Modify( &
"salary.Color='0~tIf(salary>90000,255,65280)'")
This statement nests one If function within another to provide three
possible colors. The setting causes the DataWindow dw_cust to display
the department ID in green if the ID is 200, in red if it is 100, and in black
if it is neither:
dw_cust.Modify("dept_id.Color='0~t " &
710 PowerBuilder
+
"If(dept_id=200,65380,If(dept_id=100,255,0))'")
The following example uses a complex expression with nested If functions
to set the background color of the salary column according to the salary
values. Each portion of the concatenated string is shown on a separate line.
See the pseudocode in the comments for an explanation of what the nested
If functions do. The example also sets the background mode to opaque so
that the color settings are visible.
The example includes error checking, which displays Modify’s error
message, if any:
string mod_string, err
long color1, color2, color3, default_color
err = dw_emp.Modify("salary.Background.Mode=0")
IF err <> "" THEN
MessageBox("Status", &
"Change to Background Mode Failed " + err)
RETURN
END IF
/* Pseudocode for mod_string:

If salary less than 10000, set the background to red.
If salary greater than or equal to 10000 but less
than 20000, set the background to blue.
If salary greater than or equal to 20000 but less
than 30000, set the background color to green.
Otherwise, set the background color to white, which
is also the default. */
color1 = 255 //red
color2 = 16711680 //blue
color3 = 65280 //green
default_color = 16777215//white
mod_string = &
"salary.Background.Color = '" &
+ String(default_color) &
+ "~tIf(salary < 10000," &
+ String(color1) &
+ ",If(salary < 20000," &
+ String(color2) &
+ ",If(salary < 30000," &
+ String(color3) &
+ "," &

Modify
+ ")))'"
err = dw_emp.Modify(mod_string)
IF err <> "" THEN
"Change to Background Color Failed " +
err)
RETURN
END IF
This example sets the text color of a RadioButton column to the value of
color1 (red) if the column’s value is Y; otherwise, the text is set to black.
As above, each portion of the concatenated string is shown on a separate
line:
integer color1, default_color
string mod_string, err
color1 = 255 //red

default_color = 0 //black
mod_string = "yes_or_no.Color ='" &

+ "~tif(yes_or_no=~~'Y~~'," &
+ String(color1) &
+ "," &
+ ")'"
err = dw_emp.Modify(mod_string)
IF err <> "" THEN
"Modify to Text Color " &
+ "of yes_or_no Failed " + err)
RETURN
END IF
Changing displayed text To set the text of a text control, the next two
examples use this syntax:
dwcontrolname.Modify ( "textcontrolname.Text='string'" )
This statement changes the text in the text control Dept_t in the
DataWindow dw_cust to Dept:
dw_cust.Modify("Dept_t.Text='Dept'")
This statement sets the displayed text of dept_t in the DataWindow
dw_cust to Marketing if the department ID is greater than 201; otherwise
it sets the text to Finance:
712 PowerBuilder
dw_cust.Modify("dept_t.Text='none~t " + &

"If(dept_id >
201,~'Marketing~',~'Finance~')'")
Updating more than one table An important use of Modify is to make it
possible to update more than one table from one DataWindow object. The
following script updates the table that was specified as updatable in the
DataWindow painter; then it uses Modify to make the other joined table
updatable and to specify the key column and which columns to update.
This technique eliminates the need to create multiple DataWindow objects
or to use embedded SQL statements to update more than one table.
In this example, the DataWindow object joins two tables: department and
employee. First department is updated, with status flags not reset. Then
employee is made updatable and is updated. If all succeeds, the Update
command resets the flags and COMMIT commits the changes. Note that to
make the script repeatable in the user’s session, you must add code to
make department the updatable table again:
integer rc
string err
/* The SELECT statement for the DataWindow is:

SELECT department.dept_id, department.dept_name,
employee.emp_id, employee.emp_fname,
employee.emp_lname FROM department, employee ;
*/
// Update department, as set up in the DW painter

rc = dw_1.Update(true, false)
IF rc = 1 THEN
//Turn off update for department columns.
dw_1.Modify("department_dept_name.Update =
No")
dw_1.Modify("department_dept_id.Update =
No")
dw_1.Modify("department_dept_id.Key = No")
// Make employee table updatable.

dw_1.Modify( &
"DataWindow.Table.UpdateTable =
~"employee~"")
//Turn on update for desired employee

columns.
dw_1.Modify("employee_emp_id.Update = Yes")

Modify
dw_1.Modify("employee_emp_fname.Update =
Yes")
dw_1.Modify("employee_emp_lname.Update =
Yes")
dw_1.Modify("employee_emp_id.Key = Yes")
//Then update the employee table.

rc = dw_1.Update()
IF rc = 1 THEN
COMMIT USING SQLCA;
ELSE
ROLLBACK USING SQLCA;
+ "Update of employee table failed. " &
+ "Rolling back all changes.")
END IF
ELSE
+ "Update of department table failed. " &
+ "Rolling back changes to department.")
END IF
Adding a WHERE clause The following scripts dynamically add a
WHERE clause to a DataWindow object that was created with a SELECT
statement that did not include a WHERE clause. (Since this example
appends a WHERE clause to the original SELECT statement, additional
code would be needed to remove a where clause from the original SELECT
statement if it had one.) This technique is useful when the arguments in the
WHERE clause might change at execution time.
The original SELECT statement might be:

SELECT employee.emp_id, employee.l_name
FROM employee
Presumably, the application builds a WHERE clause based on the user’s
choices. The WHERE clause might be:
WHERE emp_id > 40000
The script for the window’s Open event stores the original SELECT
statement in original_select, an instance variable:
dw_emp.SetTransObject(SQLCA)
original_select = &
dw_emp.Describe("DataWindow.Table.Select")
714 PowerBuilder
The script for a CommandButton’s Clicked event attaches a WHERE

clause stored in the instance variable where_clause to original_select and
assigns it to the DataWindow’s Table.Select property:
string rc, mod_string
mod_string = "DataWindow.Table.Select='" &

+ original_select + where_clause + "'"
rc = dw_emp.Modify(mod_string)
IF rc = "" THEN
dw_emp.Retrieve( )
ELSE
MessageBox("Status", "Modify Failed" + rc)
END IF
Quotes inserted in the DataWindow painter

For SQL Anywhere and Oracle, the DataWindow painter puts double
quotes around the table and column name (for example, SELECT
"EMPLOYEE"."EMP_LNAME"). Unless you have removed the quotes, the
sample WHERE clause must also use these quotes. For example:
where_clause = &
" where ~~~"EMPLOYEE~~~".~~~"SALARY~~~" >
40000"
Query mode Query mode provides an alternate view of a DataWindow

in which the user specifies conditions for selecting data. PowerBuilder
builds the WHERE clause based on the specifications. When the user exits
query mode, you can retrieve data based on the modified SELECT
statement.
In this example, a window that displays a DataWindow control has a menu
that includes a selection called Select Data. When the user chooses it, its
script displays the DataWindow control in query mode and checks the
menu item. When the user chooses it again, the script turns query mode off
and retrieves data based on the new WHERE clause specified by the user
through query mode. The script also makes a CheckBox labeled Sort data
visible, which turns query sort mode on and off.
The script for the Select Data menu item is:
string rtn
IF m_selectdata.Checked = false THEN

// Turn on query mode so user can specify data

Modify
rtn =
dw_1.Modify("DataWindow.QueryMode=YES")
IF rtn = "" THEN

// If Modify succeeds, check menu to show
// Query mode is on and display sort
CheckBox
This.Check()
ParentWindow.cbx_sort.Show()
ELSE
MessageBox("Error", &
"Can't access query mode to select
data.")
END IF
ELSE
// Turn off Query mode and retrieve data
// based on user's choices
rtn = dw_1.Modify("DataWindow.QueryMode=NO")
IF rtn = "" THEN

// If Modify succeeds, uncheck menu to
show
// Query mode is off, hide the sort
// CheckBox, and retrieve data
This.UnCheck()
ParentWindow.cbx_sort.Hide()
dw_1.AcceptText()
dw_1.Retrieve()
ELSE
MessageBox("Error", &
"Failure exiting query mode.")
END IF
END IF
A simple version of the script for Clicked event of the Sort data CheckBox
follows. You could add code as shown in the Menu script above to check
whether Modify succeeded:
IF This.Checked = true THEN
dw_1.Modify("DataWindow.QuerySort=YES")
ELSE
dw_1.Modify("DataWindow.QuerySort=NO")
END IF
For details on how you or the user specifies information in query mode,
see the PowerBuilder Users Guide.
716 PowerBuilder

You cannot use QueryMode and QuerySort with DataWindow objects that
use any of the following presentation styles: N-Up, Label, Crosstab,
RichText, and Graph.
Prompt for criteria is another way of letting the user specify retrieval
criteria. You set it on a column-by-column basis. When a script retrieves
data, PowerBuilder displays the Specify Retrieval Criteria window, which
gives the user a chance to specify criteria for all columns that have been
set.
In a script that is run before you retrieve data, for example, in the Open
event of the window that displays the DataWindow control, the following
settings would make the columns emp_name, emp_salary, and dept_id
available in the Specify Retrieval Criteria dialog when the Retrieve
method is called:
dw_1.Modify("emp_name.Criteria.Dialog=YES")
dw_1.Modify("emp_salary.Criteria.Dialog=YES")
dw_1.Modify("dept_id.Criteria.Dialog=YES")
There are other Criteria properties that affect both query mode and prompt
for criteria. For details, see the Criteria DataWindow object property in
Retrieve as needed In this example, the DataWindow object has been
set up with Retrieve Only As Needed selected. When this is on,
PowerBuilder retrieves enough rows to fill the DataWindow, displays
them quickly, then waits for the user to try to display additional rows
before retrieving more rows. If you want the fast initial display but do not
want to leave the cursor open on the server, you can turn off Retrieve Only
As Needed with Modify.
After you have determined that enough rows have been retrieved, the
following code in the RetrieveRow event script changes the
Retrieve.AsNeeded property, which forces the rest of the rows to be
retrieved:
dw_1.Modify("DataWindow.Retrieve.AsNeeded=NO")
Changing the data source This example changes the data source of a
DataWindow object from a SQL SELECT statement to a stored procedure.
This technique works only if the result set does not change (that is, the
number, type, and order of columns is the same for both sources).

Modify
When you define the DataWindow object, you must define all possible
DataWindow retrieval arguments. In this example, the SELECT statement
defined in the painter has three arguments, one of type string, one of type
number, and one of type date. The stored procedure has two arguments,
both of type string. So, in the painter, you need to define four DataWindow
arguments, two of type string, one of type number, and one of type date.
(Note that you do not have to use all the arguments you define.)
string rc, mod_string, name_str = "Watson"
integer dept_num = 100
// Remove the DataWindow's SELECT statement

Dw_1.Modify("DataWindow.Table.Select = ''")
// Set the Procedure property to your procedure

mod_string = "DataWindow.Table.Procedure = &
'1 execute dbo.emp_arg2;1 @dept_id_arg &
= :num_arg1, @lname_arg = :str_arg1'"
rc = dw_1.Modify(mod_string)
// If change is accepted, retrieve data

IF rc = "" THEN
dw_1.Retrieve(dept_num, name_str)
ELSE
"Change to DW Source Failed " + rc)
END IF
Replacing a DropDownDataWindow object

Suppose you use Modify to replace one DropDownDataWindow object
with another; for example:
dw_parent.Modify(dept_id.dddw.name= &
d_dddw_empsal_by_dept )
PowerBuilder compares the two DataWindow objects and reuses the
original result set if the number of columns and their datatypes match. The
display and data value column names must exist in the data object SQL
statements for both objects. If there are any differences, PowerBuilder will
re-retrieve the data.
Deleting and adding controls in the DataWindow object This

statement deletes a bitmap control called logo from the DataWindow
dw_cust:
718 PowerBuilder
dw_cust.Modify("destroy logo")
This statement deletes the column named salary from the DataWindow
dw_cust. Note that this example includes the keyword column, so the
column in the DataWindow and the data are both deleted:
dw_cust.Modify("destroy column salary")
This example adds a rectangle named rect1 to the header area of the
DataWindow dw_cust (with the value of modstring entered as a single
line):
string modstring
modstring = 'create rectangle(Band=background

X="206" Y="6" height="69" width="1363"
brush.hatch="6" brush.color="12632256"
pen.style="0" pen.width="14" pen.color="268435584"
background.mode="2" background.color="-1879048064"
name=rect1 )'
dw_cust.Modify(modstring)
These statements add a bitmap named logo to the header area for grouping
level 1 in the DataWindow dw_cust (with the value of modstring entered
as a single line):
string modstring
modstring = 'create bitmap(band=footer x="37" y="12"

height="101" width="1509"
filename="C:\PB\BEACH.BMP" border="0" name=bmp1 )'
dw_cust.Modify(modstring)
Syntax for creating controls

To create a control, you must provide DataWindow syntax. The easiest
way to get correct syntax for all the necessary properties is to paint the
control in the DataWindow painter and export the syntax to a file. Then
you make any desired changes and put the syntax in your script, as shown
above. This is the only way to get accurate syntax for complex controls
like graphs.
See also Describe

Reset
SetBorderStyle
SetDataStyle

Move
SetFilter
SetFormat
SetPosition
SetRowFocusIndicator
SetSeriesStyle
SetSQLPreview
SetSQLSelect
SetTabOrder
SetValidate
Move
Description Moves a control or object to another position relative to its parent window,
or for some window objects, relative to the screen.
Applies to
Syntax PowerBuilder
integerobjectname.Move ( integer x, integer y )
objectname A reference to an object or control you want to move
x The x coordinate of the new location in PowerBuilder units
y The y coordinate of the new location in PowerBuilder units
Return value Returns 1 if it succeeds and –1 if an error occurs or if objectname is a

maximized window.
If any argument’s value is null, Move returns null.
Usage Inherited from system window object. For information, see Move in the
720 PowerBuilder
OLEActivate
Description Activates Object Linking and Embedding (OLE) for the specified object
and sends the specified command verb to the OLE server application.
Applies to
Syntax PowerBuilder
integer dwcontrol.OLEActivate ( long row, integer column, integer
verb )
integer dwcontrol.OLEActivate ( long row, string column, integer
verb )
row A long identifying the row location of the Database Blob control
in the DataWindow object.
column The column location of the Database Blob. Column can be a
column number (integer) or a column name (string).
verb Usually 0, but the verb is dependent on the OLE server.
is null, OLEActivate returns null.
Usage The user can activate OLE by double-clicking an OLE blob column in a
DataWindow. Use OLEActivate when you want to activate OLE in
response to some other event or action—for example, when the user clicks
a button.
The verb you specify determines what action occurs when the OLE server
application is invoked. The default verb (0) generally means you want to
edit the document. Each OLE application has its own particular set of
supported verbs. To find out what verbs the application supports, consult
the documentation for the application, or look for the application name in
the HKEY_LOCAL_MACHINE\SOFTWARE\Classes section of the
Windows registry and find its Protocol\ StdFileEditing\Verb key. For
example, the AVIFile class has three verbs, 0, 1, and 2, for Play, Edit, and
Open.

OneTrip
Data for an OLE application is stored in the database as a Binary/Text

Large Object (blob). In SQL Anywhere®, the datatype of the database
column is long binary. To make the blob accessible to users, use the
DataWindow painter to set up the blob column. In the painter, you add an
OLE Database Blob object (called TableBlob in the DataWindow object
properties) to the DataWindow object and specify the OLE server
application in the Database Binary/Text Large Object window.
For setup details, see Application Techniques.
Examples This statement activates OLE for the Database Blob control in row 5 of the
salary column in DataWindow dw_emp_data. The verb is 0:
dw_emp_data.OLEActivate(5, "salary", 0)
See also Activate in the PowerScript Reference
OneTrip
Description Generates HTML syntax for the Web DataWindow after setting values that
refresh the state of the server component so that it is in sync with user
actions.
Obsolete method
OneTrip is obsolete and should not be used, because the Web DataWindow
Applies to

string dwcomponent.OneTrip ( string htmlobjectname, string
browser,
string selflink, string selflinkargs, string action, string context )
string dwcomponent.OneTripEx ( string htmlobjectname,
string retrievalargs, string browser, string selflink,
string selflinkargs, string action, string context )
dwcomponent A reference to a Web DataWindow server component
722 PowerBuilder
htmlobjectname A string specifying a name used in generated code for the
Web DataWindow client control, page parameters, and
client side events. You must specify a unique object name
when there is more than one Web DataWindow on a Web
page.
retrievalargs A string that contains the values of the retrieval arguments
expected by the DataWindow object associated with the
server component (see Usage note).
browser A string identifying the browser and version. The value
should match the browser information passed to the Web
server in the HTTP header. The corresponding server
variable is HTTP_USER_AGENT.
Sets the value of the HTMLGen.Browser property for the
DataWindow object associated with the server component.
For information on recognized browsers, see
HTMLGen.property.
selflink The URL for the current page. It cannot include parameters.
Parameters from selflinkargs may be added when HTML is
generated.
The server component uses SelfLink to generate URLs for
navigation buttons that obtain additional rows from the
result set.
Sets the value of the HTMLGen.SelfLink property for the
selflinkargs A string in the form:
Argname is an argument passed to the server.
Exp is a DataWindow expression whose value is a string.
The DataWindow in the server component evaluates it,
converts it using URL encoding, and includes in the
selflinkargs string.
Sets the value of the HTMLGen.SelfLinkArgs property for
the DataWindow object associated with the server
component.
action A string describing an action associated with a button click
or method call in a Web DataWindow client control on a
Web page. The value of action is stored in a page parameter
called htmlobjectname_action.

OneTrip
context A string describing the context of action in the Web
DataWindow client control. The string is generated by a
Web DataWindow script and the value is stored in a page
parameter called htmlobjectname_context.
The format is not documented and subject to change.
Return value Returns the generated HTML if it succeeds and an error message if any of
the requested settings fails.
Usage OneTrip and OneTripEx perform the tasks of SetSelfLink, SetBrowser,
Retrieve, SetAction, and Generate in a single method. They are meant to be
used with a server component that has been previously configured with a
DataWindow definition and transaction information. Using OneTrip
produces maximum performance for the Web DataWindow client while
allowing the server component to remain stateless.
Use OneTripEx instead of OneTrip if you need to specify retrieval
arguments. The retrievalargs string in the OneTripEx syntax has the format:
value1 \n value2 \n value3... \n value16
The values of the retrieval arguments must be separated by newline
characters (\n) and individual values cannot contain newline characters as
part of the value. The Web DataWindow supports up to 16 retrieval
arguments.
You can specify an array for the value of a retrieval argument by separating
the array values with a tab character (\t). For example, if the DataWindow
expected an array for the second retrieval argument, the syntax would be:
value1 \n value2a\t value2b \t value2c \n value3...
If the script gets the values for the retrieval arguments from page
parameters, you must also specify the retrieval arguments as selflinkargs
expressions, so that the values will be available as page parameters when
the page is reloaded.
The evaluated selflinkargs expressions are included in the generated
HTML as hidden fields and are available to server-side scripts as page
parameters. You can use the arguments to supply information that the
server component needs to render additional pages of the result set, such
as retrieval arguments. Selflinkargs can also be used to keep login
information or other data available that was passed in the original call to
the page.
724 PowerBuilder
For information on quotation marks and other formatting for the

expression, see the SetSelfLink method.
Examples This Web Target server-side script uses OneTripEx to get generated
HTML. The DataWindow object expects two retrieval arguments, an
employee ID and a salary:
function GetParam( envparam ) {
if( exists(document.value[envparam] ) ) {
return document.value[envparam];
}
return "";
};
// Create component on server

dwMine =
java.CreateComponent("DataWindow/MyVersion",
"iiop://testMachine:9000", "jagadmin", "",
"DataWindow/HTMLGenerator110");
// Get information about user’s latest button click

var action = psDocument.GetParam("dwMine_action");
var context =
psDocument.GetParam("dwMine_context");
// Get browser and hyperlinking information

var browser = psDocument.GetEnv("HTTP_USER_AGENT");
var selfLink = psDocument.GetEnv("SCRIPT_NAME");
// Get retrieval arguments from page parameters

var args = "" + psDocument.GetParam("arg_empid") +
"\n" + psDocument.GetParam("arg_salary");
// Set up page parameters for reloaded page

linkargs = "arg_empid =’\"" +
psDocument.GetParam("arg_empid") + "\"’"
+ "|arg_salary= ’\"" +
psDocument.GetParam("arg_salary") +
"\"’";
// Include the generated HTML in the Web page

psDocument.Write(dwMine.OneTripEx("dwMine", args,
browser, selfLink, linkargs, action, context)
);
See also Generate
Retrieve

Paste
SetAction
SetBrowser
SetSelfLink
Paste
Description Inserts (pastes) the contents of the clipboard into the specified control. If
no text is selected in the control, the text on the clipboard is pasted at the
insertion point. If text is selected, Paste replaces the selected text with the
text on the clipboard.
Applies to
Syntax PowerBuilder
long dwcontrol.Paste ( )
dwcontrol A reference to a DataWindow control. Text is pasted into the
edit control over the current row and column.
Return value Returns the number of characters that were pasted into the edit control for
dwcontrol. If nothing has been cut or copied (the clipboard is empty),
Paste does not change the contents of the edit control and returns 0. If the
clipboard contains nontext data (for example, a bitmap or OLE object) and
the control cannot accept that data, Paste does not change the contents and
returns 0.
null.
Usage The text is pasted into the edit control over the current row and column. If
the clipboard contains more text that is allowed for that column, the text is
truncated. If the clipboard text does not match the column’s datatype, all
the text is truncated, so that any selected text is replaced with an empty
string.
To insert a specific string in dwcontrol or to replace selected text with a
specific string, use the ReplaceText method.
726 PowerBuilder
For use with other PowerBuilder controls, see Paste in the PowerScript
Reference.
Examples If the clipboard contains “Proposal good for 90 days” and no text is
selected in the edit control of dw_rpt, this statement pastes “Proposal good
for 90 days” at the insertion point in the edit control and returns 25:
dw_rpt.Paste()
If the clipboard contains the string “Final Edition”, the edit control in
dw_rpt contains “This is a Preliminary Draft”, and the text in edit control
is selected, this statement deletes “This is a Preliminary Draft”, replaces it
with “Final Edition”, and returns 13:
dw_rpt.Paste()
See also Copy
Cut
ReplaceText
PasteRTF
Description Pastes rich text data from a string into a DataWindow control or DataStore
object.
Applies to
Syntax PowerBuilder
long rtename.PasteRTF ( string richtextstring, { Band band } )
rtename A reference to a DataWindow control or DataStore object.
The DataWindow object in the DataWindow control or
DataStore must be a RichTextEdit DataWindow.
richtextstring A string whose value is data with rich text formatting.

PointerX
band A value specifying the band into which the rich text data is
(optional) pasted. Valid values for this enumerated datatype are listed in
Chapter 6, DataWindow Constants.
Return value Returns -1 if an error occurs. If richtextstring is null, PasteRTF returns

null.
Usage A DataWindow in the RTE presentation style has only three bands. There
are no summary or trailer bands and there are no group headers and
footers.
PowerBuilder RichText Edit control

You can use the same syntax with any PowerBuilder RichTextEdit control.
See PasteRTF in the PowerScript Reference.
Examples This statement pastes rich text in the string ls_richtext into the header of
the RichTextEdit rte_message:
string ls_richtext
rte_message.PasteRTF(ls_richtext, Header!)
See also CopyRTF
PointerX
Description Determines the distance of the pointer from the left edge of the specified
object.
Applies to
Syntax PowerBuilder
integer objectname.PointerX ( )
728 PowerBuilder
objectname The name of the control or window for which you want the
pointer’s distance from the left edge. If you do not specify
objectname, PointerX reports the distance from the left edge of
the current sheet or window.
Return value Returns the pointer’s distance from the left edge of objectname in
PowerBuilder units if it succeeds and –1 if an error occurs.
Usage Inherited from DragObject. For information, see PointerX in the
PointerY
Description Determines the distance of the pointer from the top of the specified object.
Applies to
Syntax PowerBuilder
integer objectname.PointerY ( )
objectname The name of the control or window for which you want the
pointer’s distance from the top. If you do not specify
objectname, PointerY reports the distance from the top of the
current sheet or window.
Return value Returns the pointer’s distance from the top of objectname in PowerBuilder
units if it succeeds and –1 if an error occurs.
If objectname is null, PointerY returns null.
Usage Inherited from DragObject. For information, see PointerY in the

Position
Position
Reports the position of the insertion point in a DataWindow.
To report Use
The position of the insertion point in a DataWindow that does Syntax 1
not have a RichTextEdit presentation style
The position of the insertion point or the start and end of Syntax 2
selected text in a DataWindow whose object has the
RichTextEdit presentation style
Syntax 1 For DataWindows with standard presentation

styles
Description Determines the position of the insertion point in an edit control.
Applies to
Syntax PowerBuilder
long editname.Position ( )
editname A reference to a DataWindow control in which you want to find
the location of the insertion point
Return value Returns the location of the insertion point in editname if it succeeds and –
1 if an error occurs. If editname is null, Position returns null.
Usage Position reports the position number of the character immediately
following the insertion point. For example, Position returns 1 if the cursor
is at the beginning of editname. If text is selected in editname, Position
reports the number of the first character of the selected text.
Position reports the insertion point’s position in the edit control over the
current row and column.
For use with other PowerBuilder controls, see Position in the PowerScript
Reference.
730 PowerBuilder
Examples If mle_EmpAddress contains Boston Street, the cursor is immediately

after the n in Boston, and no text is selected, this statement returns 7:
mle_EmpAddress.Position()
If mle_EmpAddress contains Boston Street and Street is selected, this
statement returns 8 (the position of the S in Street):
mle_EmpAddress.Position()
See also SelectedLine
SelectedStart
Syntax 2 For DataWindows with RichTextEdit

presentation styles
Description Determines the line and column position of the insertion point or the start
and end of selected text in a RichTextEdit control.
Applies to
Syntax PowerBuilder
band rtename.Position ( long fromline, long fromchar {, long toline,
long tochar }
rtename A reference to a DataWindow control. The DataWindow object
in the DataWindow control must be a RichTextEdit
DataWindow.
fromline A variable in which you want to save the number of the line
where the insertion point or the start of the selection is.
fromchar A variable in which you want to save the number in the line of
the first character in the selection or after the insertion point.
toline A variable in which you want to save the number of the line
(optional) where the selection ends.
tochar A variable in which you want to save the number in the line of
(optional) the character before which the selection ends.
Return value Returns the band containing the selection or insertion point. The returned
value is a value of the Band enumerated datatype (Detail!, Header!, or
Footer!).

Position
Usage Position reports the position of the insertion point if you omit the toline and
tochar arguments. If text is selected, the insertion point can be at the
beginning or the end of the selection. For example, if the user dragged
down to select text, the insertion point is at the end.
If there is a selection, a character argument can be set to 0 to indicate that
the selection begins or ends at the start of a line, with nothing else selected
on that line. When the user drags up, the selection can begin at the start of
a line and fromchar is set to 0. When the user drags down, the selection
can end at the beginning of a line and tochar is set to 0.
Selection or insertion point To find out whether there is a selection or
just an insertion point, specify all four arguments. If toline and tochar are
set to 0, then there is no selection, only an insertion point. If there is a
selection and you want the position of the insertion point, you will have to
call Position again with only two arguments. This difference is described
next.
The position of the insertion point and end of selection can differ
When reporting the position of selected text, the positions are inclusive—
Position reports the first line and character and the last line and character
that are selected. When reporting the position of the insertion point,
Position identifies the character just after the insertion point. Therefore, if
text is selected and the insertion point is at the end, the values for the
insertion point and the end of the selection differ.
To illustrate, suppose the first four characters in line 1 are selected and the
insertion point is at the end. If you request the position of the insertion
point:
rte_1.Position(ll_line, ll_char)
Then:
• ll_line is set to 1
• ll_char is set to 5, the character following the insertion point
If you request the position of the selection:
rte_1.Position(ll_startline, ll_startchar, &
ll_endline, ll_endchar)
• ll_startline and ll_startchar are both set to 1
• ll_endline is 1 and ll_endchar is set to 4, the last character in the
selection
732 PowerBuilder
Passing values to SelectText Because values obtained with Position

provide more information than simply a selection range, you cannot pass
the values directly to SelectText. In particular, 0 is not a valid character
position when selecting text, although it is meaningful in describing the
selection.
Examples This example calls Position to get the band and the line and column values
for the beginning and end of the selection. The values are converted to
strings and displayed in the StaticText st_status:
integer li_rtn
long ll_startline, ll_startchar
long ll_endline, ll_endchar
string ls_s, ls_band
band l_band
// Get the band and start and end of the selection

l_band = rte_1.Position(ll_startline,ll_startchar,&
ll_endline, ll_endchar)
// Convert position values to strings

ls_s = "Start line/char: " + String(ll_startline) &
+ ", " + String(ll_startchar)
ls_s = ls_s + " End line/char: " &
+ String(ll_endline) + ", " +
String(ll_endchar)
// Convert Band datatype to string

CHOOSE CASE l_band
CASE Detail!
ls_band = " Detail"
CASE Header!
ls_band = " Header"
CASE Footer!
ls_band = " Footer"
CASE ELSE
ls_band = " No band"
END CHOOSE
ls_s = ls_s + ls_band
// Display the information

st_status.Text = ls_s
This example extends the current selection down 1 line. It takes into
account whether there is an insertion point or a selection, whether the
insertion point is at the beginning or end of the selection, and whether the
selection ends at the beginning of a line:

Position
integer rtn
long l1, c1, l2, c2, linsert, cinsert
long l1select, c1select, l2select, c2select
// Get selection start and end

rte_1.Position(l1, c1, l2, c2)
// Get insertion point
rte_1.Position(linsert, cinsert)
IF l2 = 0 and c2 = 0 THEN //insertion point

l1select = linsert
c1select = cinsert
l2select = l1select + 1 // Add 1 to end line
c2select = c1select
ELSEIF l2 > l1 THEN // Selection, ins pt at end

IF c2 = 0 THEN // End of selection (ins pt)
// at beginning of a line (char 0)
c2 = 999 // Change to end of prev line
l2 = l2 - 1
END IF
l1select = l1
c1select = c1
l2select = l2 + 1 // Add 1 to end line
c2select = c2
ELSEIF l2 < l1 THEN // selection, ins pt at start

IF c1 = 0 THEN // End of selection (not ins pt)
// at beginning of a line
c1 = 999 // Change to end of prev line
l1 = l1 - 1
END IF
l1select = l2
c1select = c2
l2select = l1 + 1 // Add 1 to end line
// (start of selection)
c2select = c1
ELSE // l1 = l2, selection on one line

l1select = l1
l2select = l2 + 1 // Add 1 to line
IF c1 < c2 THEN // ins pt at end
c1select = c1
c2select = c2
ELSE // c1 > c2, ins pt at start
734 PowerBuilder
c1select = c2
c2select = c1
END IF
END IF
// Select the extended selection

rtn = rte_1.SelectText( l1select, c1select, &
l2select, c2select )
For an example of selecting each word in a RichTextEdit control, see
SelectTextWord.
SelectedStart
SelectText
PostEvent
Description Adds an event to the end of the event queue of an object.
Applies to
Syntax PowerBuilder
boolean objectname.PostEvent ( TrigEvent event, { long word, long
long } )
boolean objectname.PostEvent ( TrigEvent event, { long word,
string long } )
objectname The name of any PowerBuilder object or control (except an
application) that has events associated with it.
event A value of the TrigEvent enumerated datatype that identifies a
PowerBuilder event (for example, Clicked!, Modified!, or
DoubleClicked!) or a string whose value is the name of an
event. The event must be a valid event for objectname and a
script must exist for the event in objectname.
word A value to be stored in the WordParm property of the system’s
(optional) Message object. If you want to specify a value for long, but not
for word, enter 0. (For cross-platform compatibility, WordParm
and LongParm are both longs.)

Print
long A value that you want to store in the LongParm property of the
(optional) system’s Message object. When you specify a string, a pointer
to the string is stored in the LongParm property, which you can
access with the String function (see Usage).
Return value Returns true if it is successful and false if the event is not a valid event for
objectname or no script exists for the event in objectname.
If any argument’s value is null, PostEvent returns null.
Usage Inherited from PowerObject. For information, see PostEvent in the
Print
Sends data to the current printer (or spooler, if the user has a spooler set
up). There are two syntaxes that you can use with DataWindows:
To Use
Send the contents of a DataWindow control or DataStore to the Syntax 1
printer as a print job.
Include a visual object, such as a window or a graph control, in Syntax 2
a print job. For the PowerBuilder environment only.
For a description of PowerBuilder system print commands, see
Syntax 1 For printing a single DataWindow or DataStore

Description Sends the contents of a DataWindow control or DataStore object to the
printer as a print job.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.Print ( { boolean canceldialog {, showprintdialog }
})
736 PowerBuilder
dwcontrol The name of the DataWindow control, DataStore, or child
DataWindow that contains the information to be printed.
canceldialog A boolean value indicating whether you want to display a
(optional) nonmodal dialog that allows the user to cancel printing.
Values are:
• True – (Default) Display the dialog.
• false – Do not display the dialog.
Working with DataStore objects

When working with DataStores, the canceldialog argument
must always be set to false.
showprintdialog A boolean value indicating whether you want to display the

(optional) system Print dialog box. Values are:
True – Display the dialog box
false – (default) Do not display the dialog box

When working with DataStores, the showprintdialog
argument must always be set to false.
Return value Returns 1 if it succeeds and -1 if an error occurs. If any argument’s value
is null, Print returns null.
Usage Printed output uses the same fonts and layout that appear on screen for the
DataWindow object.
When the DataWindow object’s presentation style is RichTextEdit, each
row begins a new page in the printed output.
PowerBuilder manages print jobs by opening the job, sending data, and
closing the job. When you use Syntax 1, print job management happens
automatically. You do not need to use the PrintOpen and PrintClose
functions.
Use Syntax 1 to print the contents of a DataWindow object. The Print
method prints all the rows that have been retrieved. To print several
DataWindows as a single job, do not use Print. Instead, open the print job
with PrintOpen, call the PowerScript system function PrintDataWindow for
each DataWindow, and close the job.

Print
Events for DataWindow printing

When you use Print for DataWindow controls or DataStores, it triggers a
PrintStart event just before any data is sent to the printer (or spooler), a
PrintPage event for each page break, and a PrintEnd event when printing
is complete.
The PrintPage event has return codes that let you control whether the page
about to be formatted is printed. You can skip the upcoming page by
returning a value of 1 in the PrintPage event.
Examples The following statements are equivalent. Each sends the contents of
dw_employee to the current printer. The Cancel dialog box displays,
allowing the user to cancel the printing, but the Print dialog box does not:
dw_employee.Print()
dw_employee.Print(true)
dw_employee.Print(true, false)
This statement sends the contents of dw_employee to the current printer.
The Print dialog box displays but the Cancel dialog box does not:
dw_employee.Print(false, true)
See also PrintDataWindow in the PowerScript Reference
Syntax 2 For printing a visual object in a print job

Description Includes a visual object, such as a window or a graph control, in a print job
that you have started with the PrintOpen function.
Applies to
Syntax PowerBuilder
integer objectname.Print ( long printjobnumber, integer x, integer y
{, integer width, integer height } )
objectname The name of the object that you want to print. The object
must either be a window or an object whose ancestor type is
DragObject, which includes all the controls that you can
place in a window.
printjobnumber The number the PrintOpen function assigns to the print job
738 PowerBuilder
x An integer whose value is the x coordinate on the page of
the left corner of the object, in thousandths of an inch.
y An integer whose value is the y coordinate on the page of
the left corner of the object, in thousandths of an inch.
width An integer specifying the printed width of the object in
(optional) thousandths of an inch. If omitted, PowerBuilder uses the
object’s original width.
height An integer specifying the printed height of the object in
(optional) thousandths of an inch. If omitted, PowerBuilder uses the
object’s original height.
is null, Print returns null.
Usage PowerBuilder manages print jobs by opening the job, sending data, and
closing the job. When you use Syntax 2, you must call the PrintOpen
function and the PrintClose or PrintCancel functions yourself to manage the
process. For more information, see the PowerScript Reference.
Print area and margins

The print area is the physical page size minus any margins in the printer
itself. Depending on the printer, you may be able to change margins using
PrintSend and printer-defined escape sequences.
Examples This example prints the CommandButton cb_close in its original size at
location 500, 1000:
long Job
Job = PrintOpen( )
cb_close.Print(Job, 500,1000)
PrintClose(Job)
This example opens a print job, which defines a new page, then prints a
title using the third syntax of Print. Then it uses this syntax of Print to print
a graph on the first page and a window on the second page:
long Job
Job = PrintOpen( )
Print(Job, "Report of Year-to-Date Sales")
gr_sales1.Print(Job, 1000,PrintY(Job)+500, &
6000,4500)
PrintPage(Job)
w_sales.Print(Job, 1000,500, 6000,4500)

PrintCancel
PrintClose(Job)
See also Print in the PowerScript Reference
PrintCancel
PrintClose in the PowerScript Reference
PrintOpen in the PowerScript Reference
PrintScreen in the PowerScript Reference
PrintCancel
Cancels printing and deletes the spool file, if any. There are two syntaxes.
To Use
Cancel printing of a DataWindow or DataStore printed with the Syntax 1
Print function.
Cancel a print job that you began with the PrintOpen function. Syntax 2
For the PowerBuilder environment only.
For a description of PowerBuilder system print commands, see
Syntax 1 For DataWindows and DataStores

Description Cancels the printing of a DataWindow or DataStore that was printed using
Syntax 1 of Print.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.PrintCancel ( )
dwcontrol A reference to a DataWindow control, DataStore object, or
child DataWindow.
Return value Returns 1 if it succeeds and –1 if an error occurs. If dwcontrol is null,

PrintCancel returns null.
740 PowerBuilder
Usage PrintCancel cancels the printing of the specified DataWindow or DataStore

by deleting the spool file, if any, and closing the job.
When you use the Print method to print the DataWindow or DataStore,
without using PrintOpen, use Syntax 1 to cancel printing. When you use
the PowerScript system function PrintDataWindow to print a DataWindow
as part of a print job, use Syntax 2 to cancel printing.
When you use Print for DataWindow controls or DataStores, it triggers a

PrintStart event just before any data is sent to the printer (or spooler), a
PrintPage event for each page break, and a PrintEnd event when printing
is complete. You can use PrintCancel in the PrintStart or PrintPage event
to cancel printing.
Examples This statement sends the contents of the DataWindow dw_employee to the
current printer without displaying the Cancel dialog:
dw_Employee.Print(FALSE)
This statement in the PrintStart event cancels printing:
dw_employee.PrintCancel()
See also Print
Syntax 2 For canceling a print job

Description Cancels printing of a print job that you opened with the PrintOpen
function. The print job is identified by the number returned by PrintOpen.
Applies to
Syntax PowerBuilder
integer PrintCancel ( long printjobnumber )
printjobnumber The number the PrintOpen function assigned to the print
job.
Return value Returns 1 if it succeeds and –1 if an error occurs. If printjobnumber is null,

PrintCancel returns null.

PrintCancel
Usage PrintCancel cancels the specified print job by deleting the spool file, if any,
and closing the job. Because PrintCancel closes the print job, do not call
the PrintClose function after you call PrintCancel.
Examples In this example, a script for a Print button opens a print job and then opens
a window with a cancel button. If the user clicks on the cancel button, its
script sets a global variable that indicates that the user wants to cancel the
job. After each printing command in the Print button’s script, the code
checks the global variable and cancels the job if its value is true.
The definition of the global variable is:
boolean gb_printcancel
The script for the Print button is:
long job, li
gb_printcancel = false
job = PrintOpen("Test Page Breaks")
IF job < 1 THEN
MessageBox("Error", "Can't open a print
job.")
RETURN
END IF
Open(w_printcancel)
PrintBitmap(Job, "d:\PB\bitmap1.bmp", 5, 10, 0, 0)

IF gb_printcancel = true THEN
PrintCancel(job)
RETURN
END IF
... // Additional printing commands,

... // including checking gb_printcancel
PrintClose(job)
Close(w_printcancel)
The script for the cancel button in the second window is:
gb_printcancel = true
Close(w_printcancel)
See also Print
PrintCancel in the PowerScript Reference
PrintClose in the PowerScript Reference
PrintOpen in the PowerScript Reference
742 PowerBuilder
ReplaceText
Description Replaces selected text in the edit control for the current row and column
with a specified string.
Applies to
Syntax PowerBuilder
long editname.ReplaceText ( string string )
editname A reference to a DataWindow control
string The string that replaces the selected text
Return value Returns the number of characters in string and –1 if an error occurs.
Usage If there is no selection, ReplaceText inserts the replacement text at the
cursor position.
To use the contents of the clipboard as the replacement text, call the Paste
method instead of ReplaceText.
For use with other PowerBuilder controls, see ReplaceText in the
Examples If the DataWindow edit control contains “Offer Good for 3 Months” and
the selected text is “3 Months”, this statement replaces “3 Months” with
“60 Days” and returns 7. The resulting text in the edit control is “Offer
Good for 60 Days”:
dw_salesoffer.ReplaceText("60 Days")
If there is no selected text, this statement inserts “New product” at the
cursor position in the edit control for dw_products:
dw_products.ReplaceText("New product")
See also Copy
Cut
Paste

ReselectRow
ReplaceText in the PowerScript Reference
ReselectRow
Description Accesses the database to retrieve values for all columns that can be
updated and refreshes all timestamp columns in a row in a DataWindow
control or DataStore. The values from the database are redisplayed in the
row.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.ReselectRow ( long row )
DataWindow in which you want to reselect a row
row A value identifying the row to reselect
Return value Returns 1 if it is successful and –1 if the row cannot be reselected (for
example, the DataWindow object cannot be updated or the row was
deleted by another user).
Usage ReselectRow is supported for SQLSelect DataWindows. Use ReselectRow
to discard values the user changed and replace them with values from the
database after an update fails (due to a concurrent access error, for
example).
744 PowerBuilder
About timestamp support

Timestamp support is not available in all DBMSs. For information on
timestamp columns, see the documentation for your DBMS.
Note If you are using ShareData and then use ReselectRow on the primary
DataWindow, the secondary DataWindow resets back to row 1, column 1.
Examples This statement reselects row 5 in the DataWindow control dw_emp:

dw_emp.ReselectRow(5)
This statement reselects the clicked row if the update is not successful:
IF dw_emp.Update( ) < 0 THEN
dw_emp.ReselectRow(dw_emp.GetClickedRow())
END IF
See also GetClickedRow
SelectRow
Update
Reset
Description Clears all the data from a DataWindow control or DataStore object.
For the syntax to use for deleting graphs within a DataWindow object that
have an external data source, see Reset on page 955. For the syntax to use
with other PowerBuilder controls, see Reset in the PowerScript Reference.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.Reset ( )
DataWindow

ResetInk
usually not used.
null.
Usage Reset is not the same as deleting rows from the DataWindow object or
child DataWindow. Reset affects the application only, not the database. If
you delete rows and then call the Update method, the rows are deleted from
the database table associated with the DataWindow object. If you call
Reset and then call Update, no changes are made to the table.
If you call Reset when the Retrieve As Needed option is set, Reset will
clear the rows that have been retrieved. However, because Retrieve As
Needed is on, the DataWindow immediately retrieves the next set of rows.
To prevent the rows from being retrieved, call DBCancel before calling
Reset. If all the rows have been retrieved (the cursor has been closed and
the RetrieveEnd event has occurred), then when Reset clears the
DataWindow, it stays empty.
Examples This statement completely clears the contents of dw_employee:

dw_employee.Reset()
In a DataWindow whose Retrieve As Needed option is on, this example
cancels the retrieval before resetting the DataWindow:
dw_employee.DBCancel()
dw_employee.Reset()
See also DeleteRow
ResetInk
Description Clears ink from an InkPicture control in a DataWindow.
Applies to
Syntax PowerBuilder
746 PowerBuilder
integer dwcontrol.ResetInk ( string name, long rownumber )

name The name of the InkPicture control from which you want to
clear the picture.
rownumber The number of the row that contains the picture to be cleared.
To clear all rows, set rownumber to 0.
Return value Integer. Returns 1 for success and –1 for failure.

Usage Use the ResetInk function to clear the ink from an InkPicture control.
Examples The following example clears the ink in an InkPicture control in row 3 of
a DataWindow object:
int li_return
li_return = dw_1.ResetInk(inkpic_1, 3)
See also SaveInk
SaveInkPic
ResetTransObject
Description Stops a DataWindow control or DataStore from using the programmer-
specified transaction object that is currently in effect through a call to the
SetTransObject method. After you call the ResetTransObject method, the
DataWindow control or DataStore uses its internal transaction object.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.ResetTransObject ( )
DataWindow
usually not used.

ResetUpdate

Usage If you reset the transaction object and SetTrans has never been called to set
the values in the internal transaction object, call SetTrans to set them or
SetTransObject to establish a new programmer-specified transaction
object.
ResetTransObject is almost never used because programmer-specified and
internal transaction objects in one application are generally not used
together. Programmer-specified transaction objects, specified with
SetTransObject, provide better application performance. To change the
programmer-specified transaction object, simply call SetTransObject
again.
Examples This statement stops dw_employee from using programmer-specified
transaction objects:
dw_employee.ResetTransObject()
See also GetTrans
SetTrans
SetTransObject
ResetUpdate
Description Clears the update flags in the primary and filter buffers and empties the
delete buffer of a DataWindow or DataStore.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.ResetUpdate ( )
DataWindow in which you want to reset the update flags

null.
748 PowerBuilder
Usage When a row is changed, inserted, or deleted, its update flag is set, making
it marked for update. By default the Update method turns these flags off.
If you want to coordinate updates of more than one DataWindow or
DataStore, however, you can prevent Update from clearing the flags. Then,
after you verify that all the updates succeeded, you can call ResetUpdate
for each DataWindow to clear the flags. If one of the updates failed, you
can keep the update flags, prompt the user to fix the problem, and try the
updates again.
You can find out which rows are marked for update with the GetItemStatus
method. If a row is in the delete buffer or if it is in the primary or filter
buffer and has NewModified! or DataModified! status, its update flag is
set. After update flags are cleared, all rows have the status NotModified!
or New! and the delete buffer is empty.
Examples These statements coordinate the update of two DataWindow objects:
int rtncode
dw_cust.SetTransObject(SQLCA)
dw_sales.SetTransObject(SQLCA)
rtncode = dw_cust.Update(true, false)

IF rtncode = 1 THEN
rtncode = dw_sales.Update(true, false)
IF rtncode = 1 THEN
dw_cust.ResetUpdate() // Both updates are
OK
dw_sales.ResetUpdate()// Clear update
flags
COMMIT USING SQLCA; // Commit them
ELSE
ROLLBACK USING SQLCA; // 2nd update failed
END IF
END IF
See also Update
Resize
Description Resizes an object or control by setting its Width and Height properties and
then redraws the object.

Retrieve
Applies to
Syntax PowerBuilder
integer objectname.Resize (integer width, integer height )
objectname A reference to the object or control you want to resize
width The new width in PowerBuilder units
height The new height in PowerBuilder units
Return value Returns 1 if it succeeds and –1 if an error occurs or if objectname is a

minimized or maximized window.
Usage You cannot use Resize for a child DataWindow.
Use with other PowerBuilder objects and controls

Resize does not resize a minimized or maximized sheet or window. If the
window is minimized or maximized, Resize returns –1.
For use with other PowerBuilder controls, see Resize in the PowerScript
Reference.
Examples This statement changes the Width and Height properties of gb_box1 and
redraws gb_box1 with the new properties:
gb_box1.Resize(100, 150)
This statement doubles the width and height of the picture control p_1:
p_1.Resize(p_1.Width*2, p_1.Height*2)
Retrieve
Description Retrieves rows from the database for a DataWindow control or DataStore.
If arguments are included, the argument values are used for the retrieval
arguments in the SQL SELECT statement for the DataWindow object or
child DataWindow.
750 PowerBuilder
Applies to
DataStore object
Syntax PowerBuilder
long dwcontrol.Retrieve ( { any argument, any argument . . . } )
DataWindow.
argument One or more values that you want to use as retrieval arguments
(optional with in the SQL SELECT statement defined in dwcontrol.
Retrieve, required
with RetrieveEx)
Return value Returns the number of rows displayed (that is, rows in the primary buffer)
if it succeeds and –1 if it fails. If there is no DataWindow object assigned
to the DataWindow control or DataStore, this method returns –1.
This method always returns –1 if the data source is external. Use a method
such as ImportFile to populate the DataWindow.
Usage After rows are retrieved, the DataWindow object’s filter is applied.
Therefore, any retrieved rows that do not meet the filter criteria are
immediately moved to the filter buffer and are not included in the return
count.
Before you can retrieve rows for a DataWindow control or DataStore, you
must specify a transaction object with SetTransObject or SetTrans. If you
use SetTransObject, you must also use a SQL CONNECT statement to
establish a database connection.
Normally, when you call Retrieve, any rows that are already in the
DataWindow control or DataStore are discarded and replaced with the
retrieved rows. You can return the code 2 in the RetrieveStart event to
prevent this. In this case, Retrieve adds any retrieved rows to the ones that
already exist in the buffers.
Retrieval arguments If arguments are expected but not specified, the
user is prompted for the retrieval arguments.
A retrieval argument can be null if the SELECT statement is designed to
handle null values. For example, if a two-part WHERE clause is separated
by OR, then either part can be null while the other matches values in the
database.

Retrieve
Events Retrieve may trigger these events:

DBError
RetrieveEnd
RetrieveRow
RetrieveStart
None of these events is triggered if the data source is external, because
Retrieve always fails. You must use one of the import methods to populate
the DataWindow.
Examples This statement causes dw_emp1 to retrieve rows from the database.
dw_emp1.Retrieve()
This example illustrates how to set up a connection and then retrieve rows
in the DataWindow control. A typical scenario is to establish the
connection in the application’s Open event and to retrieve rows in the
Open event for the window that contains the DataWindow control.
The following is a script for the application open event. SQLCA is the
default transaction object. The ProfileString function is getting information
about the database connection from an initialization file:
// Set up Transaction object from the INI file
SQLCA.DBMS = ProfileString("myapp.ini", &
"Database", "DBMS", " ")
SQLCA.DbParm = ProfileString("myapp.ini", &
"Database", "DbParm", " ")
// Connect to database
// Test whether the connect succeeded
IF SQLCA.SQLCode <> 0 THEN
MessageBox("Connect Failed", &
"Cannot connect to database." &
+ SQLCA.SQLErrText)
RETURN
END IF
Open(w_main)
To continue the example, the open event for w_main sets the transaction
object for the DataWindow control dw_main to SQLCA and retrieves
rows from the database.
If no rows were retrieved or if there is an error (that is, the return value is
negative), the script displays a message to the user:
long ll_rows
dw_main.SetTransObject(SQLCA)
752 PowerBuilder
ll_rows = dw_main.Retrieve()
IF ll_rows < 1 THEN MessageBox( &
"Database Error", &
"No rows retrieved.")
This example illustrates the use of retrieval arguments. Assume that
:Salary and :Region are declared as arguments in the DataWindow painter
and dw_emp has this SQL SELECT statement:
SELECT Name, emp.sal, sales.rgn From Employee, Sales
WHERE emp.sal > :Salary and sales.rgn =
:Region
Then this statement causes dw_emp1 to retrieve employees from the
database who have a salary greater than $50,000 and are in the northwest
region:
dw_1.Retrieve(50000, "NW")
This example also illustrates retrieval arguments. Assume dw_EmpHist
contains this SQL SELECT statement and emps is defined as a number
array:
SELECT EmpNbr, Sal, Rgn From Employee
WHERE EmpNbr IN (:emps)
These statements cause dw_EmpHist to retrieve Employees from the
database whose employee numbers are values in the array emps:
Double emps[3]
emps[1] = 100
emps[2] = 200
emps[3] = 300
dw_EmpHist.Retrieve(emps)
The following example illustrates how to use Retrieve twice to get data
meeting different criteria. Assume the SELECT statement for the
DataWindow object requires one argument, the department number. Then
these statements retrieve all rows in the database in which department
number is 100 or 200.
The script for the RetrieveStart event in the DataWindow control sets the
return code to 2 so that the rows and buffers of the DataWindow control
are not cleared before each retrieval:
RETURN 2
The script for the Clicked event for a Retrieve CommandButton retrieves
the data with two function calls. The Reset method clears any previously
retrieved rows, normally done by Retrieve.

RowCount
Here, Retrieve is prevented from doing it by the return code in the

RetrieveStart event:
dw_1.Reset( )
dw_1.Retrieve(100)
dw_1.Retrieve(200)
See also DeleteRow
GetLastError
GetLastErrorString
InsertRow
SetTrans
SetTransObject
Update
RowCount
Description Obtains the number of rows that are currently available in a DataWindow
control or DataStore. To determine the number of rows available, the
RowCount method checks the primary buffer.
Applies to
DataStore object
Syntax PowerBuilder
long dwcontrol.RowCount ( )
DataWindow
Return value Returns the number of rows that are currently available in dwcontrol, 0 if
no rows are currently available, and –1 if an error occurs.
null.
754 PowerBuilder
Usage The primary buffer for a DataWindow control or DataStore contains the
rows that are currently available for display or printing. These are the rows
counted by RowCount. The number of currently available rows equals the
total number of rows retrieved minus any deleted or filtered rows plus any
inserted rows. The deleted and filtered rows are stored in the
DataWindow’s delete and filter buffers.
Examples This statement returns the number of rows currently available in
dw_Employee:
long NbrRows
NbrRows = dw_Employee.RowCount()
This example determines when the user has scrolled to the end of a
DataWindow control. It compares the row count with the DataWindow
property LastRowOnPage:
dw_1.ScrollNextPage()
IF dw_1.RowCount() = Integer(dw_1.Describe( &
"DataWindow.LastRowOnPage")) THEN
... // Appropriate processing
END IF
See also DeleteRow
DeletedCount
Filter
FilteredCount
InsertRow
ModifiedCount
SetFilter
Update
RowsCopy
Description Copies a range of rows from one DataWindow control (or DataStore
object) to another, or from one buffer to another within a single
DataWindow control (or DataStore).
Applies to
DataStore object
Syntax PowerBuilder

RowsCopy
integer dwcontrol.RowsCopy ( long startrow, long endrow,

DWBuffer copybuffer, datawindow targetdw, long beforerow,
DWBuffer targetbuffer)
DWBuffer copybuffer, datastore targetdw, long beforerow,
DWBuffer targetbuffer )
DWBuffer copybuffer, datawindowchild targetdw, long
beforerow,
DataWindow from which you want to copy rows.
startrow The number of the first row you want to copy.
endrow The number of the last row you want to copy.
copybuffer A value of the dwBuffer enumerated datatype identifying the
DataWindow buffer from which you want to copy rows.
targetdw A reference to the DataWindow control or DataStore object to
which you want to copy the rows. Targetdw can be the same
DataWindow (or DataStore) or another DataWindow (or
DataStore).
beforerow The number of the row before which you want to insert the
copied rows. To insert after the last row, use any value that is
greater than the number of existing rows.
targetbuffer A value of the dwBuffer enumerated datatype identifying the
target DataWindow buffer for the copied rows.

Usage When you use the RowsCopy method, the status of the rows that are copied
to the primary buffer is NewModified!. If you issue an update request,
PowerBuilder sends SQL INSERT statements to the DBMS for the new
rows.
When you use RowsCopy, data is not automatically retrieved for drop-
down DataWindows in the target DataWindow or DataStore, as it is when
you call InsertRow. You must explicitly call Retrieve for child
DataWindows in the target.
756 PowerBuilder
When you use RowsCopy or RowsMove to populate another DataWindow,

the copied data is not automatically processed by filters or sort criteria in
effect on the target DataWindow. You might be required to call the Filter,
GroupCalc, or Sort methods to properly process the data.
Uses for RowsCopy include:

• Making copies of one or more rows so that the users can create new
rows based on existing data
• Printing a range of rows by copying selected rows to another
DataWindow and printing the second DataWindow
Buffer manipulation and query mode

A DataWindow cannot be in query mode when you call the RowsCopy
method.
Examples This statement copies all the rows starting with the current row in dw_1 to
the beginning of the primary buffer in dw_2:
dw_1.RowsCopy(dw_1.GetRow(), &
dw_1.RowCount(), Primary!, dw_2, 1, Primary!)
This example copies all the rows starting with the current row in dw_1 to
the beginning of the primary buffer in the drop-down DataWindow
state_id in dw_3:
datawindowchild dwc
dw_3.GetChild("state_id", dwc)
dw_1.RowCount(), Primary!, dwc, 1, Primary!)
This example copies all the rows starting with the current row in dw_1 to
the beginning of the primary buffer in the nested report d_employee:
datawindowchild dwc
dw_composite.GetChild("d_employee", dwc)
dw_1.RowCount(), Primary!, dwc, 1, Primary!)
See also RowsDiscard
RowsMove

RowsDiscard
RowsDiscard
Description Discards a range of rows in a DataWindow control. Once a row has been
discarded using RowsDiscard, you cannot restore the row. You have to
retrieve it again from the database.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.RowsDiscard (long startrow, long endrow,
DWBuffer buffer )
dwcontrol The reference to a DataWindow control or child DataWindow.
startrow The number of the first row you want to discard.
endrow The number of the last row you want to discard.
buffer A value of the dwBuffer enumerated datatype specifying the
DataWindow buffer containing the rows to be discarded.

Usage Use RowsDiscard when your application is finished with some of the rows
in a DataWindow control and you do not want an update to affect the rows
in the database. For example, you can discard rows in the delete buffer,
which prevents the rows from being deleted when you call Update.
Use Reset to clear all the rows from a DataWindow control.
The RowsDiscard method triggers the RowFocusChanging and
RowFocusChanged events only when the row number of the current row
is changed. The current row is simply a number that indicates which row
is the current row. A change in the content of the row does not trigger the
events if the number of the current row remains the same.
758 PowerBuilder
Suppose you have a DataWindow with two rows. If the current row is row
1 and RowsDiscard discards row 1, row 2 becomes the current row, but its
row number also changes from 2 to 1. The events are not fired because the
current row number is still row 1. If the current row is row 2 and
RowsDiscard discards row 1, the events are fired because the current row
number has changed from row 2 to row 1.
Examples This statement discards all the rows in the delete buffer for dw_1. As a
result if the application later calls dw_1.Update(), the DataWindow will
not submit SQL DELETE statements to the DBMS for these rows:
dw_1.RowsDiscard(1, dw_1.DeletedCount(), Delete!)
See also Reset
RowsCopy
RowsMove
RowsMove
Description Clears a range of rows from one DataWindow control (or DataStore) and
inserts them in another. Alternatively, RowsMove moves rows from one
buffer to another within a single DataWindow control (or DataStore).
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.RowsMove ( long startrow, long endrow,
DWBuffer movebuffer, datawindow targetdw, long beforerow,
DWBuffer movebuffer, datastore targetdw, long beforerow,
DWBuffer movebuffer, datawindowchild targetdw,
long beforerow, DWBuffer targetbuffer )
dwcontrol The name of a DataWindow control, DataStore, or child
DataWindow from which you want to move rows.
startrow The number of the first row you want to move.

RowsMove
endrow The number of the last row you want to move.
movebuffer A value of the dwBuffer enumerated datatype identifying
the DataWindow buffer from which you want to move the
rows.
targetdw The name of the DataWindow control or DataStore to
which you want to move the rows. Targetdw can be the
same DataWindow control (or DataStore) or a different
DataWindow control (or DataStore), but it cannot be a
child DataWindow.
beforerow The number of the row before which you want to insert
the moved rows. To insert after the last row, use any value
that is greater than the number of existing rows.
targetbuffer A value of the dwBuffer enumerated datatype identifying
the target buffer for the rows.

Usage When you use RowsMove, the rows have the status NewModified! in the
target DataWindow.
If you move rows between buffers in a single DataWindow control or
DataStore, PowerBuilder retains knowledge of where the rows came from,
and their status is changed accordingly. For example, if you move
unmodified rows from the primary buffer to the delete buffer, they are
marked for deletion. If you move the rows back to the primary buffer, their
status returns to NotModified!. Note, however, that if you move rows from
one DataWindow control (or DataStore) to another and back again, the
rows’ status is NewModified! because they came from a different
DataWindow.
The RowsMove method triggers the RowFocusChanging and
RowFocusChanged events only when the row number of the current row
is changed. The current row is simply a number that indicates which row
is the current row. A change in the content of the row does not trigger the
events if the number of the current row remains the same.
760 PowerBuilder
Suppose you have a DataWindow with two rows. If the current row is row
1 and RowsMove moves row 1, row 2 becomes the current row, but its row
number also changes from 2 to 1. The events are not fired because the
current row number is still row 1. If the current row is row 2 and
RowsMove moves row 1, the events are fired because the current row
number has changed from row 2 to row 1.
When you use RowsMove, data is not automatically retrieved for drop-
down DataWindows in the target DataWindow, as it is when you call
InsertRow. You must explicitly call Retrieve for child DataWindows in the
target.
When you use RowsCopy or RowsMove to populate another DataWindow,
the copied data is not automatically processed by filters or sort criteria in
effect on the target DataWindow. You might be required to call the Filter,
GroupCalc, or Sort methods to properly process the data.
Uses for RowsMove include:

• Moving several rows from the primary buffer to the delete buffer,
instead of deleting them one at a time
• Moving rows from the delete buffer to the primary buffer, to
implement an Undo capability in your application
Buffer manipulation and query mode

A DataWindow cannot be in query mode when you call the RowsMove
method.
Examples This statement moves all the rows starting with the first row in the delete
buffer for dw_1 to the primary buffer for dw_1, thereby undeleting these
rows:
dw_1.RowsMove(1, dw_1.DeletedCount(), Delete!, &
dw_1, 1, Primary!)
See also RowsCopy
RowsDiscard

SaveAs
SaveAs
Description Saves the contents of a DataWindow or DataStore in the format you
specify.
For syntax to save the contents of graphs in DataWindows and DataStores,
see SaveAs on page 957. For syntax to save objects in OLE controls and
OLE storage, see SaveAs in the PowerScript Reference.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.SaveAs ( { string filename, saveastype
saveastype,
boolean colheading { , encoding encoding } } )
DataWindow.
filename A string whose value is the name of the file in which to save
(optional for the contents. If you omit this argument, or specify an empty
PowerBuilder) string ("") for filename but include valid values for the
saveastype and colheading arguments, the DataWindow
prompts end users for a file name.

If you are working with a DataStore, you must supply the
filename argument.
saveastype A value of the SaveAsType enumerated datatype specifying

(optional for the format in which to save the contents of the DataWindow
PowerBuilder) object.
For a list of values, see SaveAsType on page 492.
colheading A boolean value indicating whether you want to include the
(optional for DataWindow’s column headings at the beginning of the file.
PowerBuilder) The default value is true. This argument is used for the
following formats: Clipboard, CSV, Excel, and Text. For most
other formats, column headings are always saved.
762 PowerBuilder
encoding Character encoding of the file to which the data is saved. This
(optional for parameter applies only to the following formats: TEXT, CSV,
PowerBuilder) SQL, HTML, and DIF. If you do not specify an encoding
parameter, the file is saved in ANSI format. Values are:
• EncodingANSI! (default)
• EncodingUTF8!
• EncodingUTF16LE!
• EncodingUTF16BE!
is null, SaveAs returns null.
Usage If you do not specify any arguments for SaveAs, PowerBuilder displays
the Save As dialog box. A drop-down list lets the user specify the format
of the saved data.
Report format (PSReport! value of SaveAsType) is the best choice if the
DataWindow is a composite report. Choosing PSReport! has no effect if
the DataWindow object has the RichText presentation style.
For XML!, the XML logical structure used is based on the current XML
export template for the DataWindow object. You can change the export
template by setting the value of the Export.XML.UseTemplate property. If
no export template is specified, the default template is used.
If you use date formats in your report, you must verify that yyyy is the
Short Date Style for year in the Regional Settings of the user’s Control
Panel. Your program can check this with the RegistryGet function. If the
setting is not correct, you can ask the user to change it manually or to have
the application change it (by calling the RegistrySet function). The user
When you save the contents of a DataWindow to a text file, double quotes
are handled in a way that enables the ImportFile method to produce the
same DataWindow when the text file is imported back into PowerBuilder.
Any field that is enclosed in a pair of double quotes is wrapped with three
pairs of double quotes in the saved text file. Double quotes at the
beginning of a text field that have no matching double quotes at the end of
the field are also replaced by three double quotes in the saved text file.
However, a double quote elsewhere in the field is saved as one double
quote.

SaveAs
The behavior of the SaveAs method with the EncodingANSI! parameter

or with no encoding parameter is platform dependent. On the Windows
and Solaris platforms, the file is always saved with ANSI encoding
whether you are connected to an ANSI or Unicode database. On the Linux
platform with an ANSI database connection, SaveAs saves the file with
ANSI encoding. On the Linux platform with a Unicode database
connection, if the data contains multilanguage characters, SaveAs
converts the characters to UTF-8 and saves the file with UTF-8 encoding.
Examples This statement saves the contents of dw_History to the file
G:\INVENTORY\EMPLOYEE.HIS. The saved file is in CSV format
without column headings:
dw_History.SaveAs("G:\INVENTORY\EMPLOYEE.HIS", &
CSV!, false)
The following statements set the template used by the DataWindow dw_1
to t_report, specify that metadata in the XMLSchema! format should be
generated in a separate file, and generate the files c:\myxml.xml containing
the DataWindow row data in XML format, and c:\myxml.xsd containing
the XML schema used in c:\myxml.xml:
dw_1.Modify("DataWindow.Export.XML.UseTemplate =
't_report'")
dw_1.Modify("DataWindow.Export.XML.MetaDataType =
XMLSchema!")
dw_1.Modify("DataWindow.Export.XML.SaveMetaData =
MetaDataExternal!")
dw_1.SaveAs("c:\myxml.xml", XML!, false)
The following statements generate the files c:\dw_one.fo containing the
DataWindow presentation and data in XSL-FO format, and c:\dw_one.pdf
containing the DataWindow presentation and data in PDF format:
dw_1.SaveAs("c:\dw_one.fo", XSLFO!, false)
dw_1.SaveAs("c:\dw_one.pdf", PDF!, false)
See also ImportFile
Print
SaveAsFormattedText
Update
764 PowerBuilder
SaveAsAscii
Description Saves the contents of a DataWindow or DataStore into a standard ANSI
text file.
Applies to
Syntax PowerBuilder
long dwcontrol.SaveAsAscii ( string filename {, string
separatorcharacter {,string quotecharacter {, string lineending {,
boolean retainnewlinechar } } } } )
filename A string whose value is the name of the file in which to
save the contents.
separatorcharacter A string whose value is the character to be used to
(optional) delimit values. If you omit separatorcharacter, the
default is a tab character.
quotecharacter A string whose value is the character to be used to wrap
(optional) values. If you omit quotecharacter, the default is double
quote.
lineending A string whose value is placed at the end of each line. If
(optional) you omit lineending, the default is a carriage return plus
a newline character (~r~n).
retainnewlinechar A boolean value that determines whether line feed and
(optional) carriage return characters contained within the row are
converted to white space. Values are:
True – line feed and carriage return characters within
the row are not converted to white space
False (default) – line feed and carriage return
characters within the row are converted to white
space

Usage SaveAsAscii always saves the file with ANSI encoding. To save to a file
with a different encoding, use SaveAsFormattedText.

SaveAsFormattedText
SaveAsAscii is like SaveAs with the Text SaveAsType. However, unlike

SaveAs, SaveAsAscii formats the text and saves column headers in the
form in which they are displayed in the DataWindow instead of as the
column name. For example, if the heading for the cust_id column is
Customer ID, SaveAsAscii saves Customer ID to the text file, whereas
SaveAs saves cust_id. SaveAsAscii also saves computed fields allows
you to customize formats in the file.
If you do not specify custom settings, values are wrapped in double quotes
and separated by tabs. A newline character (~r~n) is placed at the end of
each line. Line feed and carriage return characters within each row are
converted to white space.
PowerBuilder assigns a cell for each DataWindow object (which can
include computed columns and group totals). If a cell is empty,
PowerBuilder puts the quotecharacter between the separatorcharacter in
the output file.
Examples This statement saves the contents of dw_Quarter to the file
H:\Q2\RESULTS.TXT. The saved file uses ANSI encoding with the
ampersand (&) as the separator character, and single quotes (') as the
characters used to wrap values. A new line (~r~n) is automatically inserted
at each line ending. Computed columns are included with the saved
information:
dw_Quarter.SaveAsAscii("H:\Q2\RESULTS.TXT","&","'")
See also SaveAs
SaveAsFormattedText
SaveAsFormattedText
Description Saves the contents of a DataWindow or DataStore into a standard text file
with custom formatting.
Applies to
Syntax PowerBuilder
long dwcontrol.SaveAsFormattedText ( string filename {, string
encoding {, string separatorcharacter {,string quotecharacter {, string
lineending {, boolean retainnewlinechar } } } } )
766 PowerBuilder
filename A string whose value is the name of the file in which to
save the contents.
encoding (optional) Character encoding of the file to which the data is saved.
If you do not specify an encoding parameter, the file is
saved in ANSI format. Values are:
• EncodingUTF8!
separatorcharacter A string whose value is the character to be used to
(optional) delimit values. If you omit separatorcharacter, the
default is a tab character.
quotecharacter A string whose value is the character to be used to wrap
(optional) values. If you omit quotecharacter, the default is double
quote.
lineending A string whose value is placed at the end of each line. If
(optional) you omit lineending, the default is a carriage return plus
a newline character (~r~n).
retainnewlinechar A boolean value that determines whether line feed and
(optional) carriage return characters contained within the row are
converted to white space. Values are:
True – line feed and carriage return characters within
the row are not converted to white space
False (default) – line feed and carriage return
characters within the row are converted to white
space

Usage SaveAsFormattedText is like SaveAs with the Text SaveAsType. However,
unlike SaveAs, SaveAsFormattedText formats the text and saves column
headers in the form in which they are displayed in the DataWindow instead
of as the column name. For example, if the heading for the cust_id column
is Customer ID, SaveAsFormattedText saves Customer ID to the text file,
whereas SaveAs saves cust_id. SaveAsFormattedText also saves
computed fields allows you to customize formats in the file.
If you do not specify custom settings, values are wrapped in double quotes
and separated by tabs. A newline character (~r~n) is placed at the end of
each line. Line feed and carriage return characters within each row are
converted to white space.

SaveInk
PowerBuilder assigns a cell for each DataWindow object (which can

include computed columns and group totals). If a cell is empty,
PowerBuilder puts the quotecharacter between the separatorcharacter in
the output file.
Examples This statement saves the contents of dw_Quarter to the file
H:\Q2\RESULTS.TXT. The saved file uses UTF-16LE encoding with the
ampersand (&) as the separator character, single quote (') as the character
used to wrap values and the default line ending (~r~n). Computed columns
are included with the saved information:
dw_Quarter.SaveAsFormattedText("H:\Q2\RESULTS.TXT",
EncodingUTF16LE!, "&", "'")
See also SaveAs
SaveInk
Description Saves overlay ink to a file or blob from an InkPicture control.
Applies to
Syntax PowerBuilder
integer dwcontrol.SaveInk ( string name, long rownumber, blob blob
)
integer dwcontrol.SaveInk ( string name, long rownumber,
string filename {, inkpersistenceformat format {,
inkcompressionmode mode } } )
save the ink.
rownumber The number of the row that contains the ink to be saved.
blob The name of a blob passed by reference that will hold the ink
in the control.
filename A string containing the name and location of a file that will
hold the ink in the control.
768 PowerBuilder
format A value of the InkPersistenceFormat enumerated variable that
(optional) specifies the format in which you want to save the ink. Values
are:
• Base64GIFFormat!
• Base64InkSerializedFormat!
• GIFFormat!
• InkSerializedFormat! (default)
mode A value of the InkCompressionMode enumerated variable that
(optional) specifies the compression mode in which you want to save the
ink. Values are:
• DefaultCompression! (default)
• MaximumCompression!
• NoCompression!

Usage Use the SaveInk method to save annotations made to an image in an
InkPicture control in a DataWindow to a separate file or blob.
When you save ink to a blob, it is saved in Ink Serialized Format (ISF).
Saving ink to a blob provides the best performance because the ink is read
directly from the ink data cache.
InkSerializedFormat! provides the most compact persistent ink
representation. This format can be embedded inside a binary document
format or added to the clipboard. Base64InkSerializedFormat! encodes the
ISF format as a base64 stream, which allows the ink to be encoded in an
XML or HTML file.
GIFFormat! saves the image in a Graphics Interchange Format (GIF) file
in which ISF is embedded as metadata. This format can be viewed in
applications that are not ink enabled. Base64GIFFormat! is persisted by
using a base64 encoded fortified GIF. Use this format if the ink is to be
encoded directly in an XML or XHTML file and will be converted to an
image at a later time. It supports XSLT transformations to HTML.
Examples The following example saves the ink in an InkPicture control in row 3 of
a DataWindow object into an ISF file with default compression:
int li_return
string ls_pathname, ls_filename
GetFileSaveName("Save As", ls_pathname, &

ls_filename, "ISF")

SaveInkPic
li_return = dw_1.SaveInk("inkpic_1", 3, ls_pathname)

The following example saves the ink in an InkPicture control in row 5 of
a DataWindow object into a GIF file with maximum compression:
int li_return

ls_filename, "GIF")
li_return = dw_1.SaveInk("inkpic_1", 5, &
ls_pathname, GIFFormat!, MaximumCompression!)
The following example saves the ink in an InkPicture control in the current
row of a DataWindow object into a blob:
int li_return
blob lb_blob
li_return = dw_1.SaveInk("inkpic_1", &

dw_1.GetRow(), lb_blob)
See also ResetInk
SaveInkPic
SaveInkPic
Description Saves a picture and optionally overlay ink to a file from an InkPicture
control.
Applies to
Syntax PowerBuilder
integer dwcontrol.SaveInkPic ( string name, long rownumber, string
filename , integer format {, boolean withink } )
save the picture.
rownumber The number of the row that contains the picture to be saved.
770 PowerBuilder
filename A string containing the name and location of a file that will
hold the picture in the control.
format An integer specifying the format in which the picture is to be
saved. Values are:
0 – BMP (bitmap)
1 – JPEG (Joint Photographic Experts Group)
2 – GIF (Graphics Interchange Format)
3 – TIFF (Tagged Image File Format)
4 – PNG (Portable Network Graphics)
withink A boolean specifying whether overlay ink should be saved
(optional) with the picture. Values are:
True – overlay ink is saved with the picture (default)
False – overlay ink is not saved with the picture

Usage Use the SavInkPic method to save the image in an InkPicture control in a
DataWindow to a file with or without any ink annotations that have been
made to it. By default, the ink is saved with the image.
Examples The following example saves the image in an InkPicture control in row 3
of a DataWindow object into a GIF file without any ink annotations:
int li_return

ls_filename, "GIF")
li_return = dw_1.SaveInk(inkpic_1, 3, &
ls_pathname, 2, false)
See also ResetInk
SaveInkPic
Scroll
Description Scrolls the edit control of a DataWindow a specified number of lines up or
down.
Applies to

ScrollFirstPage
Syntax PowerBuilder
long dwcontrol.Scroll ( long number )
dwcontrol A reference to a DataWindow control. Scroll affects the edit
control of the DataWindow.
number A value specifying the direction and number of lines you want to
scroll. To scroll down, use a positive value. To scroll up, use a
negative value.
Return value Scroll returns the line number of the first visible line in dwcontrol if it
succeeds. Scroll returns –1 if an error occurs. If any argument’s value is
null, Scroll returns null.
Usage If the number of lines left in the list is less than the number of lines that
you want to scroll, then Scroll will scroll to the beginning or end,
depending on the direction specified.
Examples This statement scrolls mle_Employee down 4 lines:
mle_Employee.Scroll(4)
This statement scrolls mle_Employee up 4 lines:
mle_Employee.Scroll(-4)
See also The following related methods implement scrolling in a DataWindow or a
PowerBuilder RichTextEdit control:
ScrollNextPage
ScrollNextRow
ScrollPriorPage
ScrollPriorRow
ScrollToRow
ScrollFirstPage
Description Scrolls a Web DataWindow control to the first page, displaying the result
set’s first group of rows in the Web page. (A page is the number of rows
that are displayed in the DataWindow control at one time.) ScrollFirstPage
changes the current row, but not the current column.
772 PowerBuilder
Obsolete method
ScrollFirstPage is obsolete and should not be used, because the Web
Applies to
Web Client control

number dwcontrol.ScrollFirstPage ( )

Usage Calling ScrollFirstPage causes the page to be reloaded with another set of
rows from the result set.
If the DataWindow object has retrieval arguments, they must be specified
in the HTMLGen.SelfLinkArgs property. For more information, see the
HTMLGen.property and the Retrieve method.
All methods that reload the page perform an AcceptText before sending
data back to the server. If the method fails (returns –1), this means that
pending data changes were not accepted and nothing was sent back to the
server. In this situation the ItemError event occurs.
Events ScrollNextPage may trigger these events:
ItemChanged
ItemError
ItemFocusChanged
RowFocusChanged
RowFocusChanging
Examples This statement scrolls dw_employee to the first page:
dw_employee.ScrollFirstPage();
See also ScrollLastPage
ScrollNextPage
ScrollPriorPage

ScrollLastPage
ScrollLastPage
Description Scrolls a Web DataWindow control to the last page, displaying the result
set’s last group of rows in the Web page. (A page is the number of rows
that are displayed in the DataWindow control at one time.) ScrollLastPage
changes the current row, but not the current column.
Obsolete method
ScrollLastPage is obsolete and should not be used, because the Web
Applies to
Web Client control

number dwcontrol.ScrollLastPage ( )
Return value Returns 1 if it succeeds and –1 if an error occurs. If dwcontrol is null, the
Usage Calling ScrollLastPage causes the page to be reloaded with another set of
rows from the result set.
If the DataWindow object has retrieval arguments, they must be specified
in the HTMLGen.SelfLinkArgs property. For more information, see the
HTMLGen.property and the Retrieve method.
All methods that reload the page perform an AcceptText before sending
data back to the server. If the method fails (returns –1), this means that
pending data changes were not accepted and nothing was sent back to the
server. In this situation the ItemError event occurs.
Events ScrollNextPage may trigger these events:
ItemChanged
ItemError
ItemFocusChanged
RowFocusChanged
RowFocusChanging
774 PowerBuilder
Examples This statement scrolls dw_employee to the last page:

dw_employee.ScrollLastPage();
See also ScrollFirstPage
ScrollNextPage
ScrollPriorPage
ScrollNextPage
Scrolls to the next page in a DataWindow.
To scroll Use
To the next group of rows in a DataWindow (when the Syntax 1
DataWindow does not have the RichTextEdit presentation
style)
A RichTextEdit DataWindow to view the next page within Syntax 2
the document (PowerBuilder only)
Syntax 1 For DataWindow controls and child

DataWindows
Description Scrolls a DataWindow control forward one page, displaying the next
group of rows in the DataWindow’s display area. (A page is the number of
rows that can be displayed in the DataWindow control at one time.)
ScrollNextPage changes the current row, but not the current column.
Applies to
Syntax PowerBuilder
long dwcontrol.ScrollNextPage ( )

ScrollNextPage
Return value Returns the number of the row displayed at the top of the DataWindow
control when the scroll finishes or tries to scroll past the last row.
ScrollNextPage returns 1 with nested or composite reports and child
DataWindows since, in these cases, the current row cannot be changed.
ScrollNextPage returns –1 if an error occurs.

null.
Usage ScrollNextPage does not highlight the current row. Use SelectRow to let the
user know what row is current.
For an example that uses RowCount and Describe to check whether the user
has scrolled to the last page, see RowCount.
Events ScrollNextPage can trigger these events:
ItemChanged
ItemError
ItemFocusChanged
RowFocusChanged
RowFocusChanging
Examples This statement scrolls dw_employee forward one page:
dw_employee.ScrollNextPage()
See also Scroll
ScrollFirstPage
ScrollLastPage
ScrollNextRow
ScrollPriorPage
ScrollPriorRow
ScrollToRow
SelectRow
Syntax 2 For RichTextEdit DataWindows

Description Scrolls to the next page of the document in a RichTextEdit DataWindow.
Applies to
Syntax PowerBuilder
integer rtedwname.ScrollNextPage ( )
776 PowerBuilder
rtedwname A reference to a DataWindow control. The DataWindow object
in the DataWindow control must be a RichTextEdit
DataWindow.
Return value Returns 1 if it succeeds and -1 if an error occurs. If rtedwname is null, in

PowerBuilder and JavaScript the method returns null.
Usage A RichText DataWindow contains multiple instances of the document,
one instance for each row. When the last page of the document for one row
is visible, calling ScrollNextPage advances to the first page for the next
row.
PowerBuilder RichTextEdit control

You can use the same syntax with a PowerBuilder RichTextEdit control.
See ScrollNextPage in the PowerScript Reference.
Examples This statement scrolls to the next page of the RichText document in the
DataWindow control dw_rpt. If there are multiple instances of the
document, it can scroll to the next instance:
dw_rpt.ScrollNextPage()
See also Scroll
ScrollNextRow
ScrollPriorPage
ScrollPriorRow
ScrollNextRow
Scrolls to the next row in a DataWindow control.
To scroll Use
To the next row in a DataWindow, making the row current Syntax 1
(when the DataWindow does not have the RichTextEdit
presentation style)
To the next instance of a document associated with a row in a Syntax 2
RichTextEdit DataWindow (PowerBuilder only)

ScrollNextRow

DataWindows
Description Scrolls a DataWindow control to the next row (forward one row).
ScrollNextRow changes the current row, but not the current column.
Applies to
Syntax PowerBuilder
long dwcontrol.ScrollNextRow ( )
control when the scroll finishes or tries to scroll past the last row.
ScrollNextRow returns –1 if an error occurs.

null.
Usage After you call ScrollNextRow, the row after the current row becomes the
new current row. If that row is already visible, the displayed rows do not
change. If it is not visible, the displayed rows move up to display the row.
ScrollNextRow does not highlight the row. Use SelectRow to let the user
know what row is current.
Events ScrollNextRow triggers these events in the order shown:
RowFocusChanging
RowFocusChanged
ItemFocusChanged
ScrollVertical
You should not use ScrollNextRow in the ScrollVertical event. Doing so
causes this series of events to be triggered repeatedly until the last row in
the DataWindow is reached.
Examples This statement scrolls dw_employee to the next row:
dw_employee.ScrollNextRow()
See also Scroll
ScrollNextPage
ScrollPriorPage
ScrollPriorRow
778 PowerBuilder
ScrollToRow
SelectRow

Description Scrolls to the next instance of the document in a RichTextEdit
DataWindow.
Applies to
Syntax PowerBuilder
integer rtename.ScrollNextRow ( )
rtename A reference to a DataWindow control in which you want to scroll
to the next document instance. Each instance is associated with a
DataWindow row.
The DataWindow object in the DataWindow control must be a

Usage A DataWindow control with a RichText DataWindow object has multiple
instances of the RichText document, where each instance is associated
with one row of retrieved data.
ScrollNextRow advances to the next instance of the RichTextEdit
document. In contrast, repeated calls to ScrollNextPage advance through
all the pages of the document instance and then on to the pages for the next
row.

See ScrollNextRow in the PowerScript Reference.
Examples This statement scrolls to the next instance of the RichText document in the
DataWindow control dw_rpt. (Each document instance is associated with
a row of data):
dw_rpt.ScrollNextRow()

ScrollPriorPage
See also Scroll

ScrollNextPage
ScrollPriorPage
ScrollPriorRow
ScrollPriorPage
Scrolls to the prior page in a DataWindow control.
To scroll Use
To the prior group of rows in a DataWindow (when the Syntax 1
DataWindow does not have the RichTextEdit presentation style)
A RichTextEdit DataWindow to view the prior page within the Syntax 2
document (PowerBuilder only)

DataWindows
Description Scrolls a DataWindow control backward one page, displaying another
group of rows in the DataWindow’s display area. (A page is the number of
rows that can be displayed in the DataWindow control at one time.)
ScrollPriorPage changes the current row but not the current column.
Applies to
Syntax PowerBuilder
long dwcontrol.ScrollPriorPage ( )
dwcontrol The name of the DataWindow control or child DataWindow
you want to page (scroll) to the prior page
control when the scroll finishes or tries to scroll past the first row.
ScrollPriorPage returns -1 if an error occurs.

null.
780 PowerBuilder
Usage ScrollPriorPage does not highlight the current row. Use SelectRow to let the
user know what row is current.
Events ScrollPriorPage can trigger these events:
ItemChanged
ItemError
ItemFocusChanged
RowFocusChanged
RowFocusChanging
Examples This statement scrolls dw_employee backward one page:
dw_employee.ScrollPriorPage()
See also Scroll
ScrollFirstPage
ScrollLastPage
ScrollNextPage
ScrollNextRow
ScrollPriorRow
ScrollToRow
SelectRow

Description Scrolls to the prior page of the document in a RichTextEdit DataWindow.
Applies to
Syntax PowerBuilder
integer rtename.ScrollPriorPage ( )
rtename The name of the DataWindow control in which you want to scroll
to the prior page.

Usage A RichText DataWindow contains multiple instances of the document,
one instance for each row. When the first page of the document for one row
is visible, calling ScrollPriorPage goes to the last page for the prior row.

ScrollPriorRow

See ScrollPriorPage in the PowerScript Reference.
Examples This statement scrolls to the prior page of the RichText document in the
DataWindow control dw_rpt. If there are multiple instances of the
document, it can scroll to the prior instance:
dw_rpt.ScrollPriorPage()
See also Scroll
ScrollNextPage
ScrollNextRow
ScrollPriorRow
ScrollPriorRow
Scrolls to the prior row in a DataWindow control.
To scroll Use
To the prior row in a DataWindow, making the row current (when Syntax 1
the DataWindow does not have the RichTextEdit presentation style)
To the prior instance of a document associated with a row in a Syntax 2
RichTextEdit control or RichTextEdit DataWindow

DataWindows
Description Scrolls a DataWindow control backward one row. ScrollPriorRow
changes the current row but not the current column.
Applies to
Syntax PowerBuilder
long dwcontrol.ScrollPriorRow ( )
782 PowerBuilder
dwcontrol A reference to a DataWindow or child DataWindow
control when the scroll finishes or tries to scroll past the first row.
ScrollPriorRow returns –1 if an error occurs.

null.
Usage After you call ScrollPriorRow, the row before the current row becomes the
new current row. If that row is already visible, the displayed rows do not
change. If it is not visible, the displayed rows move down to display the
row.
ScrollPriorRow does not highlight the row. Use SelectRow to let the user
know what row is current.
Events ScrollPriorRow triggers these events in the order shown:
RowFocusChanging
RowFocusChanged
ItemFocusChanged
ScrollVertical
You should not use ScrollPriorRow in the ScrollVertical event. Doing so
causes this series of events to be triggered repeatedly until the first row in
the DataWindow is reached.
Examples This statement scrolls dw_employee to the prior row:
dw_employee.ScrollPriorRow()
See also Scroll
ScrollNextPage
ScrollNextRow
ScrollPriorPage
ScrollToRow
SelectRow

Description Scrolls to the prior instance of the document in a RichTextEdit
DataWindow.

ScrollPriorRow
Applies to
Syntax PowerBuilder
integer rtename.ScrollPriorRow ( )
rtename The name of the DataWindow control in which you want to scroll
to the prior document instance. Each instance is associated with
a DataWindow row.
RichTextEdit DataWindow

Usage A DataWindow control with a RichText DataWindow object has multiple
instances of the RichText document, where each instance is associated
with one row of retrieved data.
ScrollPriorRow goes to the prior instance of the RichTextEdit document. In
contrast, repeated calls to ScrollPriorPage pages back through all the pages
of the document instance and then back to the pages for the prior row.

See ScrollPriorRow in the PowerScript Reference.
Examples This statement scrolls to the prior instance of the RichText document in the
DataWindow control dw_1. (Each document instance is associated with a
row of data):
dw_rpt.ScrollPriorRow()
See also Scroll
ScrollNextPage
ScrollNextRow
ScrollPriorPage
784 PowerBuilder
ScrollToRow
Description Scrolls a DataWindow control to the specified row. ScrollToRow changes
the current row but not the current column.
Applies to
Syntax PowerBuilder
integer dwcontrol.ScrollToRow ( long row )
row A value identifying the row to which you want to scroll. If row
is 0, ScrollToRow scrolls to the first row. If row is greater than
the last row number, it scrolls to the last row. If row is visible
without scrolling, the DataWindow does not scroll.
Return value Returns the number of the row to which the DataWindow scrolls if it
succeeds and –1 if an error occurs.
Usage After you call ScrollToRow, the specified row becomes the new current
row. If that row is already visible, the displayed rows do not change. If the
row is not visible, the displayed rows change to display the row.
ScrollToRow does not highlight the row. Use SelectRow to let the user know
what row is current.
Events ScrollToRow can trigger these events:
ItemChanged
ItemError
ItemFocusChanged
RowFocusChanged
Examples This statement scrolls to row 10 and makes it current in the DataWindow
control dw_employee:
dw_employee.ScrollToRow(10)
See also Scroll
ScrollNextPage
ScrollNextRow
ScrollPriorPage

SelectedLength
ScrollPriorRow
SelectRow
SelectedLength
Description Determines the total number of characters in the selected text in an edit
control, including spaces and line endings.
Applies to
Syntax PowerBuilder
long dwcontrol.SelectedLength ( )
dwcontrol A reference to a DataWindow control. SelectedLength reports
the length of the selected text in the edit control over the current
row and column.
Return value Returns the length of the selected text in dwcontrol. If no text is selected,
SelectedLength returns 0. If an error occurs, it returns –1.

null.
Usage The characters that make up a line ending, produced by typing Ctrl+Enter
or Enter, are different on different platforms. On Windows, they are a
carriage return plus a line feed and equal two characters when calculating
the length. On other platforms, a line ending can be a single character. A
line that wraps has no line-ending character.
RichText DataWindows
For rich text controls, a carriage return plus a line feed always count as a
single character when calculating the text length.
For use with other PowerBuilder controls, see SelectedLength in the
786 PowerBuilder
Examples If the selected text in the DataWindow dw_Contact is John Smith, then this
example sets the variable to 10, the number of selected characters:
integer li_length
li_length = dw_Contact.SelectedLength()
SelectedStart
TextLine
SelectedLine
Description Obtains the number of the line that contains the insertion point in an
editable control.
Applies to
Syntax PowerBuilder
long dwcontrol.SelectedLine ( )
dwcontrol A reference to a DataWindow control. It reports the line number
in the edit control over the current row and column.
Return value Returns the number of the line containing the insertion point in dwcontrol.
If an error occurs, SelectedLine returns –1. If dwcontrol is null,
SelectedLine returns null.
Usage The insertion point can be at the beginning or end of the selection.
Therefore, SelectedLine can return the first or last selected line, depending
on the position of the insertion point.
For use with other PowerBuilder controls, see SelectedLine in the
Examples If the insertion point is positioned anywhere in line 5 of the MultiLineEdit

mle_Contact, the following example sets li_SL to 5:
integer li_SL

SelectedStart
li_SL = mle_Contact.SelectedLine()
In this example, the line the user selects in the MultiLineEdit
mle_winselect determines which window to open:
integer li_SL
li_SL = mle_winselect.SelectedLine()
IF li_SL = 1 THEN
Open(w_emp_data)
ELSEIF li_SL = 2 THEN
Open(w_dept_data)
END IF
See also Position
SelectedText
TextLine
SelectedStart
Description Reports the position of the first selected character in the edit control.
Applies to
Syntax PowerBuilder
long dwcontrol.SelectedStart ( )
dwcontrol A reference to a DataWindow control. It reports the starting
position in the edit control over the current row and column.
Return value Returns the starting position of the selected text in dwcontrol. If no text is
selected, SelectedStart returns the position of the character immediately
following the insertion point. If an error occurs, SelectedStart returns –1.
null.
Usage SelectedStart counts from the start of the text and includes spaces and line
endings.
788 PowerBuilder
For use with RichTextEdit and other PowerBuilder controls, see
SelectedStart in the PowerScript Reference.
Examples If the edit control for the DataWindow control dw_rpt contains Closed for
Vacation July 3 to July 10, and Vacation is selected, then this example sets
the variable to 12 (the position of the first character in Vacation):
integer li_Start
li_Start = dw_rpt.SelectedStart()
See also Position
SelectedLength
SelectedLine
SelectedText
Description Obtains the selected text in the edit control of a DataWindow control.
Applies to
Syntax PowerBuilder
string dwcontrol.SelectedText ( )
dwcontrol A reference to a DataWindow control. The method reports the
selected text in the edit control over the current row and column.
Return value Returns the selected text in dwcontrol. If there is no selected text or if an
error occurs, SelectedText returns the empty string (“”).
null.
For use with RichTextEdit and other PowerBuilder controls, see
SelectedText in the PowerScript Reference.

SelectRow
Examples If the text in the edit control of the DataWindow dw_rpt is James B. Smith
and James B. is selected, these statements set the value of the string
variable to James B:
string ls_emp_fname
ls_emp_fname = dw_rpt.SelectedText()
See also SelectText
SelectRow
Description Highlights or removes highlights from rows in a DataWindow control or
DataStore. You can select all rows or a single row. SelectRow does not
affect which row is current. It does not select rows in the database.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.SelectRow ( long row, boolean select )
DataWindow.
row A value identifying the row you want to select or deselect.
Specify 0 to select or deselect all rows.
select A boolean value that determines whether the row is selected or
not selected:
• True – Select the row(s) so that they are highlighted.
• False – Deselect the row(s) so that they are not highlighted.
is null, in PowerBuilder and JavaScript the method returns null. If there is
no DataWindow object assigned to the DataWindow control or DataStore,
the method returns 1.
Usage If a row is already selected and you specify that it be selected (boolean is
true), it remains selected. If a row is not selected and you specify that it not
be selected (boolean is false), it remains unselected.
Examples This statement selects the fifteenth row in dw_employee:
790 PowerBuilder
dw_employee.SelectRow(15, true)
As the script for a DataWindow’s Clicked event, this example removes
highlighting from all rows and then highlights the row the user clicked.
Row is an argument passed to the event script:
This.SelectRow(0, false)
This.SelectRow(row, true)
See also IsSelected
SelectText
Selects text in an edit control.
To select text in Use
A DataWindow when the DataWindow does not have the Syntax 1
RichTextEdit presentation style, or a RichText edit-style
column in such a DataWindow
A DataWindow whose object has the RichTextEdit presentation Syntax 2
style (PowerBuilder only)
Syntax 1 For DataWindows with standard edit styles

Description Selects text in an editable control. You specify where the selection begins
and how many characters to select.
This method works for DataWindows with standard edit styles (non-
RichTextEdit style), or columns which have the RichText edit style in such
DataWindows.
Applies to
Syntax PowerBuilder
long dwcontrol.SelectText ( long start, long length )
start A numeric value specifying the position at which you want to
start the selection.

SelectText
length A numeric value specifying the number of characters you want to
select. If length is 0, no text is selected but SelectText moves the
insertion point to the location specified in start.
Return value Returns the number of characters selected. If an error occurs, SelectText
returns –1.
Usage If the control does not have the focus when you call SelectText, then the
text is not highlighted until the control has focus. To set focus on the
control so that the selected text is highlighted, call the SetFocus function.
To select text in a DataWindow with the RichTextEdit presentation style,
use Syntax 2.
For use with other PowerBuilder controls, see SelectText in the
Backward selection in a RichText edit-style column

Both the new control and the old control cannot correctly handle the
backward selection in a RichText edit-style column via the SelectText
(although forward selection is well supported).
When backward selecting a string (which means length is a negative
number) in a RichText edit-style column, the old control will only select
the character before the last one and return 1. The new control will select
two more extra characters and returns the number of the actual selected
characters. For example, in the following statement, the old control selects
the 9th characters and returns 1; while the new control will select 7
characters from 4th to 10th, and returns 7.
dw_1.selectText(10,-5)
Examples This statement sets the insertion point at the end of the text in the
DataWindow edit control:
dw_1.SelectText(dw_1.GetText(), 0)
This statement selects the entire contents of the DataWindow edit control:
792 PowerBuilder
dw_1.SelectText(1, Len(dw_1.GetText()))
The rest of these examples assume the DataWindow edit control contains
Boston Street.
The following statement selects the string ost and returns 3:
dw_1.SelectText(2, 3)
The next statement selects the string oston Street and returns 12:
dw_1.SelectText(2, Len(dw_1.GetText()))
These statements select the string Bos, returns 3, and sets the focus to the
DataWindow control so that Bos is highlighted:
dw_1.SelectText(1, 3)
dw_1.SetFocus()
See also Position
SelectedText
TextLine

Description Selects text beginning and ending at a line and character position in a
RichText DataWindow.
Applies to
Syntax PowerBuilder
long rtedwcontrol.SelectText ( long fromline, long fromchar, long
toline, long tochar { band band } )
rtedwcontrol A reference to the DataWindow control in which you want to
select text. The DataWindow object in the DataWindow control
must have the RichText presentation style.
fromline A value specifying the line number where the selection starts.
fromchar A value specifying the number in the line of the first character
in the selection.
toline A value specifying the line number where the selection ends. To
specify an insertion point, set toline and tochar to 0.
tochar A value specifying the number in the line of the character before
which the selection ends.

SelectText
band A value of the Band enumerated datatype specifying the band in
(optional) which to make the selection. Values are:
• Detail!
• Header!
• Footer!
Return value Returns the number of characters selected. A carriage return with a line
feed counts as a single character. If an error occurs SelectText returns –1.
If any argument’s value is null, it returns null.
Usage The insertion point is at the “to” end of the selection—that is, the position
specified by toline and tochar. If toline and tochar are before fromline and
fromchar, then the insertion point is at the beginning of the selection.
You cannot specify 0 for a character position when making a selection.
You cannot always use the values returned by Position to make a selection.
Position can return a character position of 0 when the insertion point is at
the beginning of a line.
To select an entire line, set the insertion point and call SelectTextLine. To
select the rest of a line, set the insertion point and call SelectText with a
character position greater than the line length.
For use with other PowerBuilder controls, see SelectText in the
Examples SelectText is used in the same way for RichTextEdit controls and RichText
DataWindow controls. For sample code, see the examples for the
RichTextEdit control in the PowerScript Reference.
See also SelectedText
SelectTextAll
SelectTextLine
SelectTextWord
794 PowerBuilder
SelectTextAll
Description Selects all the contents of a RichTextEdit control including any special
characters such as carriage return and end-of-file markers.
Applies to
Syntax PowerBuilder
integer rtename.SelectTextAll ( band band )
rtename A reference to a DataWindow control in which you want to select
all the contents. The DataWindow object in the DataWindow
control must be a RichTextEdit DataWindow.
band A value of the Band enumerated datatype specifying the band in
(optional) which you want to select all the text. Values are:
• Detail!
• Header!
• Footer!
Return value Returns the number of characters selected. A carriage return with a line
feed counts as a single character. If an error occurs, SelectTextAll returns –
1.
Usage PowerBuilder RichTextEdit control
You can use the same syntax with a PowerBuilder RichTextEdit control.
See SelectTextAll in the PowerScript Reference.
Examples This statement selects all the text in the detail band:
dw_1.SelectTextAll()
This statement selects all the text in the header band:
dw_1.SelectTextAll(Header!)
SelectText
SelectTextLine
SelectTextWord

SelectTextLine
SelectTextLine
Description Selects the line containing the insertion point in a RichTextEdit control.
Applies to
Syntax PowerBuilder
integer rtename.SelectTextLine ( )
rtename A reference to a DataWindow control. The DataWindow object
in the DataWindow control must be a RichTextEdit DataWindow.
Return value Returns the number of characters selected if it succeeds and –1 if an error
occurs.
Usage If the RichTextEdit control contains a selection, the insertion point can be
at the beginning or end of the selection. The way the text was selected
determines the location.
If the user made the selection by dragging toward the end, then calling
SelectTextLine selects the line at the end of the selection. If the user
dragged back, then SelectTextLine selects the line at the beginning of the
selection.
SelectTextLine does not select the line-ending characters (carriage return
and linefeed).

You can use the same syntax with a PowerBuilder RichText Edit control.
See SelectTextLine in the PowerScript Reference.
Examples This statement selects the current line:

dw_1.SelectTextLine()
SelectText
SelectTextAll
SelectTextWord
796 PowerBuilder
SelectTextWord
Description Selects the word containing the insertion point in a RichTextEdit control.
Applies to
Syntax PowerBuilder
integer rtename.SelectTextWord ( )
rtename A reference to a DataWindow control in which you want to select
a word. The DataWindow object in the DataWindow control
must be a RichTextEdit DataWindow.
Return value Returns the number of characters selected if it succeeds and –1 if a word
cannot be selected or an error occurs.
Usage A word is any group of alphanumeric characters. A word can include
underscores and single quotes but doesn’t include punctuation and special
characters such as $ or #.
If punctuation or special characters follow the selected word, they are not
selected. If the character after the insertion point is a space, punctuation,
special character, or end-of-line mark, SelectTextWord does not select
anything and returns –1.

You can use the same syntax with a PowerBuilder RichText Edit control.
See SelectTextWord in the PowerScript Reference.
Examples The following statement selects the word containing the insertion point:
dw_1.SelectTextWord()
For more examples, see examples for the RichTextEdit control in the
SelectText
SelectTextAll
SelectTextLine

SelectTreeNode
SelectTreeNode
Description Selects or deselects a TreeView node in a TreeView DataWindow.
Applies to
Syntax PowerBuilder
Integer dw_control.SelectTreeNode(long row, long groupLevel,
boolean bSelect)
row The number of the row that belongs to the group
groupLevel The TreeView level of the group
bSelect Indicates whether the TreeView node is selected or not
Return value Returns 1 if the SelectTreeNode operation succeeds and one of the
following negative values if it fails:
Usage A TreeView DataWindow has several TreeView nodes that can be selected
or deselected. You can use the SelectTreeNode method to select or deselect
a TreeView node in a TreeView DataWindow that has a particular
TreeView level.
The SelectTreeNode method triggers the TreeNodeSelecting and
TreeNodeSelected events with a row argument of –1.
Examples The following example selects the node specified by the text box values:
long row
long level
row=long(sle_row.text)
level=long(sle_level.text)
dw_1.SelectTreeNode(row,level,true)
798 PowerBuilder
SetAction
Description Accepts action and context information about user interaction with the
Web DataWindow client control in a Web browser so that generated
HTML reflects any requested changes.
Obsolete method
SetAction is obsolete and should not be used, because the Web
Applies to

integer dwcomponent.SetAction ( string action, string context )
dwcomponent A reference to a Web DataWindow server component.
action A string describing an action associated with a button click or
method call in a Web DataWindow client control on a Web
page. The value of action is stored in a page parameter called
HTMLGenObjectName_action.
context A string describing the context of action in the Web
DataWindow client control. The string is generated by a Web
DataWindow script and the value is stored in a page parameter
called HTMLGenObjectName_context.
Return value Returns 1 if it succeeds and one of these negative values if an error occurs:
-1 Reloading the current context failed
-2 The action was attempted but it failed
-3 The action could not be performed (for example, the action was
InsertRow but the DataWindow has no editable fields for entering
new data)
-4 The action was aborted by the HTMLContextApplied event

SetActionCode
Usage When the user clicks a button in the Web DataWindow client control, the
JavaScript for the control stores the action in a page parameter called
HTMLGenObjectName_action, and it stores the context in a page
parameter called HTMLGenObjectName_context. These parameters are
passed to the page server which uses them to call the SetAction method for
the server component.
The SetAction method uses the SetHTMLAction method of the
DataWindow.
Call GetLastError and GetLastErrorString to get information about database
errors that cause SetAction, Update, Retrieve, and RetrieveEx to return –1.
Examples This JSP example calls SetAction for the server component called dwGen:
int retVal;
String dw_1_action =(String)request.GetParameter
("dw_1_action");
String dw_1_context = (String)request.GetParameter
("dw_1_context");
if (dw_1_context == null){
dw_1_context = " ";
}
// Check if we need to perform the action
if (dw_1_action!=null){
retVal = dwGen.SetAction(dw_1_action,
dw_1_context);
if (retVal < 0 ) {
out.print("Error on SetAction: "+ retVal +
"<BR>");
out.print(dwGen.GetLastErrorString()+ "<BR>");
}
}
See also GetLastError
GetLastErrorString
SetHTMLAction
SetActionCode
Description Sets the action code for an event in a DataWindow control. The action
code determines the action that PowerBuilder takes following the event.
The default action code is 0.
800 PowerBuilder
Where to use SetActionCode

SetActionCode is obsolete in PowerBuilder. To return a value, include a
RETURN statement in the event script using the return codes documented
for that event.
Applies to
Syntax PowerBuilder
integer dwcontrol.SetActionCode ( long code )
code A value specifying the action you want to take in the
DataWindow control. The meaning of the action code depends
on the event.
is null, SetActionCode returns null.
Usage Use SetActionCode to change the action that occurs following a
DataWindow event. Not all DataWindow events have action codes, only
those events that can have different outcomes.
SetActionCode last statement in script

Although SetActionCode is not required to be the last statement in a script,
it may not perform as expected if other statements follow it.
Examples In the ItemChanged event script for dw_Employee, these statements set
the action code in dw_Employee to reject data that is less than the
employee’s age:
integer a, age
age = Integer(sle_Age.Text)
a = Integer(dw_Employee.GetText())
IF a < age THEN dw_Employee.SetActionCode(1)
This example shows a script for the DBError event script that displays a
version of the error message to the user. Because PowerBuilder also
displays a message to the user after the event, the script calls
SetActionCode to set the action code to 1, which suppresses the
PowerBuilder error message:

SetBorderStyle
integer errnum
errnum = dw_emp.DBErrorCode()
// Show error code and message to the user

MessageBox("Database Error", &
"Number " + String(errnum) + " " + &
dw_emp.DBErrorMessage(), StopSign!)
// Stop PowerBuilder from displaying its message

dw_emp.SetActionCode(1)
SetBorderStyle
Description Sets the border style of a column in a DataWindow control or DataStore.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.SetBorderStyle ( integer column, border
borderstyle )
integer dwcontrol.SetBorderStyle ( string column, border
borderstyle )
DataWindow.
column The column in which you want to change the border style.
borderstyle A value of the Border enumerated datatype identifying the border
style you want to use for the column.
For a list of valid values, see Border on page 483.
is null, in PowerBuilder and JavaScript the method returns null.
Examples This example checks the border of column 2 in dw_emp and, if there is no
border, gives it a shadow box border:
Border B3
B3 = dw_emp.GetBorderStyle(2)
802 PowerBuilder
IF B3 = NoBorder! THEN &

dw_emp.SetBorderStyle(2, ShadowBox!)
See also GetBorderStyle
SetBrowser
Description Specifies the Web browser for which you want to generate optimized
HTML.
Obsolete method
SetBrowser is obsolete and should not be used, because the Web
Applies to

string dwcomponent.SetBrowser ( string browsername )
browsername A string identifying the browser and version. The value should
match the string passed to the Web server in the HTTP header.
The corresponding server variable is HTTP_USER_AGENT.
Sets the value of the HTMLGen.Browser property for the
For information on recognized browsers, see
HTMLGen.property.
Return value Returns an empty string if successful and the syntax error message from
the Modify method if it fails.
Usage If the DataWindow recognizes the browser identifier, it will generate
HTML optimized for that browser. A server-side script can get the browser
identifier from the server variable HTTP_USER_AGENT.
This method calls the Modify method of the server component’s DataStore
to set the property.

SetChanges
Examples This JSP example identifies the current browser for the component called
dwGen:
String browser = (String)request.getHeader
("User-Agent");
dwGen.SetBrowser(browser);
In ASP, you can use the ServerVariables method of the Request object to
get the HTTP_USER_AGENT value:
var clientbrowser =
Request.ServerVariables("HTTP_USER_AGENT");
dwGen.SetBrowser(clientbrowser);
See also Generate
Modify
SetAction
HTMLGen.property
SetChanges
Description Applies changes captured with GetChanges to a DataWindow or
DataStore. This method is used primarily in distributed applications.
Applies to
Syntax PowerBuilder
long dwcontrol.SetChanges ( blob changeblob {,
dwConflictResolution resolution } )
changeblob A read-only change blob created with GetChanges from which
you want to apply changes.
resolution A value of the dwConflictResolution enumerated datatype
(obsolete) indicating how conflicts should be resolved:
• FailOnAnyConflict! (default)
• AllowPartialChanges!
This argument is obsolete and will be disabled in a future
release.
804 PowerBuilder
Return value Returns one of the following values:

1 All changes were applied
2 A partial update was successful; conflicting changes were discarded
-1 Method failed
-2 There is a conflict between the state of the DataWindow changeblob
and the state of the DataWindow
-3 Column specifications do not match
Usage Use this method in conjunction with GetChanges to synchronize two or
more DataWindows or DataStores. GetChanges retrieves data buffers and
status flags for changed rows in a DataWindow or DataStore and places
this information in a blob. SetChanges then applies the contents of this
blob to another DataWindow or DataStore.
Calling SetChanges when no changes are pending

GetChanges returns 0 if no changes are pending. This can happen if
AcceptText is not called after rows are modified. In this case, calling
SetChanges will fail, with a return code of –1.
If you call GetChanges on a DataWindow and apply the data passed in the
changeblob argument to another DataWindow using SetChanges, you
must call GetChanges on the second DataWindow before you reapply
changes to it from the first DataWindow. The GetChanges call on the
second DataWindow updates the original timestamp on that DataWindow
so that it matches the current timestamp. (You cannot use the Reset,
ResetUpdate, or AcceptText calls to update the original timestamp.) If you
try to reapply changes without first calling GetChanges on the second
DataWindow, you will get an error due to the conflict between the state of
the DataWindow changeblob and the state of the second DataWindow.
Examples The following example is a script for a remote object function. The script
uses SetChanges to apply changes made to a DataWindow control on a
client to a DataStore on a server. The changes made on the client are
contained in a change blob that is passed as an argument to the function.
After applying changes to the DataStore, the server updates the database:
// Instance variable:datastore ids_datastore
// Function argument: blob ablb_data
long ll_rv

SetColumn
ids_datastore.SetChanges(ablb_data)
ll_rv = ids_datastore.Update()
IF ll_rv > 0 THEN

COMMIT;
ELSE
ROLLBACK;
END IF
RETURN ll_rv
See also GetChanges
GetFullState
GetStateStatus
SetFullState
SetColumn
Description Sets the current column in a DataWindow control or DataStore.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.SetColumn ( string column)
integer dwcontrol.SetColumn ( integer column)
DataWindow.
column The column you want to make current. Column can be a column
number or a column name.
Return value Returns 1 if it succeeds and –1 if an error occurs. If column is less than 1
or greater than the number of columns, SetColumn fails.
Usage SetColumn moves the cursor to the current column but does not scroll the
DataWindow control.
806 PowerBuilder
Only an editable column can be current. (A column is editable when its tab
order value is greater than 0.) Do not try to set a noneditable column as the
current column.
For use with PowerBuilder ListView controls, see SetColumn in the
Events SetColumn can trigger these events:

ItemChanged
ItemError
ItemFocusChanged
Avoiding infinite loops

Never call SetColumn in the ItemChanged, ItemError, or
ItemFocusChanged event. Because SetColumn can trigger these events,
such a recursive call can cause a stack fault.
Examples This statement makes the 15th column in dw_Employee the current
column:
dw_Employee.SetColumn(15)
See also GetColumn
GetRow
SetRow
SetColumnLink
Description Specifies information used for constructing hyperlinks for data in a
column in generated HTML.
Obsolete method
SetColumnLink is obsolete and should not be used, because the Web

SetColumnLink
Applies to

string dwcomponent.SetColumnLink ( string columnname, string
link, string linkargs, string linktarget )
columnname The name of a column in the DataWindow object associated
with the server component whose values you want formatted
as hyperlinks in the generated HTML.
link A URL that is the target of a link (HTML A element) generated
for each data item in the column.
The URL can include parameters. Additional parameters from
linkargs may be added when the HTML is generated.
Sets the value of the HTML.Link property.
linkargs A string in the form:
Argname is an page parameter to be passed to the server.
Exp is a DataWindow expression that is evaluated, and whose
value is converted using URL encoding and included in the
string.
The evaluated linkargs string is appended to URL in link when
HTML is generated to produce a hyperlink for each data item.
For information on constants and quotation marks in linkargs
expressions, see SetSelfLink.
Sets the value of the HTML.LinkArgs property.
linktarget The name of a target frame or window for the hyperlink
specified in the Link property. The target is included in the
HTML element using the HTML TARGET attribute.
You can use linktarget to implement a master/detail page
design by directing the detail page for a data item to a different
window or frame.
If linktarget is null or an empty string (“”), then no TARGET
attribute is generated.
Sets the value of the HTML.LinkTarget property.
808 PowerBuilder
Usage This method calls the Modify method of the server component’s DataStore
Examples This JavaScript example for a server-side script sets up hyperlinks for data
in the empid column. The data links to a detailed employee report in an
HTML template called empdetail.stm.
The employee id is passed as a page parameter so the empdetail scripts can
use it as a retrieval argument. The column name is specified as the
expression. Empid is a numeric column so its value has to be converted to
a string for the page parameter value. When the server component
generates the HTML, it evaluates empid for each row and includes the data
value as the link argument:
dwMine.SetColumnLink ("empid", "empdetail.stm",
"pagearg_empid=’String(empid)’", "");
See also Generate
Modify
SetAction
HTML.property
SetCultureFormat
Description The culture format set by this function does not affect the DataWindow
display. It is used only for rendering HTML, XHTML, and XML for the
DataWindow control.
Applies to
Syntax PowerBuilder
integer dwcontrol.SetCultureFormat( string cultureStr )
dwcontrol A reference to a DataWindow control for which you want to set
the culture format.

SetDetailHeight
cultureStr A string that defines the formats for displaying information. For
example:
sDecimal=,sTime=:sThousand= sShortDate=dd/MM/yyyy
iDate=1sDate=/sLongDate=dddd d MMMM yyyy
sCurrency=€iCurrDigits=2iNegCurr=8iCurrency=3
iMeasure=0iTime=1
sDecimal is the symbol used to indicate the decimal place.
sTime is the symbol used to separate the hours and minutes in
time displays.
sThousand is
Each definition is delimited by a tab.
Return value Returns 1 if successful and -1 if it fails. Does not work for .NET targets,
and will always return -1 if used in a target of that type.
SetDetailHeight
Description Sets the height of each row in the specified range to the specified value.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.SetDetailHeight ( long startrow, long endrow ,
long height )
dwcontrol A reference to a DataWindow control or DataStore for which you
want to set the height of one or more rows in the detail area
startrow The first row in the range of rows for which you want to set the
height
endrow The last row in the range of rows for which you want to set the
height
height The height of the detail area for the specified rows in the units
specified for the DataWindow object
810 PowerBuilder

Usage Call SetDetailHeight in a script to vary the amount of space assigned to
rows in a DataWindow control or DataStore. You cannot specifically set
the height for different rows when you define a DataWindow object in the
DataWindow painter, although you can turn on the Autosize Height
property for the detail band so that the height of each row is determined by
the data.
You can set the detail height of one or more rows to zero, which hides them
from view.
Examples This statement sets the height of rows 2 and 3 to 500:
dw_1.SetDetailHeight(2, 3, 500)
This script retrieves rows for a DropDownDataWindow associated with
the Company_Name column. It then hides rows 2 and 3 of the
DropDownDataWindow by setting their detail height to 0:
DataWindowChild dwc;
integer rtncode;
rtncode = dw_1.GetChild("company_name", dwc)

IF rtncode < 0 THEN HALT
dwc.SetTransObject(SQLCA)
dwc.Retrieve( )
dwc.SetDetailHeight(2, 3, 0)
SetDWObject
Description Specifies the DataWindow library and object that the Web DataWindow
server component will use for generating HTML.
Obsolete method
SetDWObject is obsolete and should not be used, because the Web
Applies to

SetFilter

int dwcomponent.SetDWObject ( string sourcefile,
string dwobjectname )
int dwcomponent.SetDWObjectEx ( string dwobjectname )
sourcefile The name of a PowerBuilder library (PBL) or dynamic library
(PBD) containing DataWindow object definitions
or
A source definition file (SRD)
or
A Powersoft report (PSR) containing a DataWindow object
definition and data.
The file must be located in the file system of the machine
hosting the server component.
dwobjectname When sourcefile is a PBL or PBD, the name of a DataWindow
object in the library.
When sourcefile is a PSR or SRD, dwobjectname should be an
empty string (“”).

Examples This example identifies the library and DataWindow object for the server
component called dwGen:
int retVal = dwGen.SetDWObject("htgenex.pbl",
"d_tabular_dept")
See also Generate
SetAction
SetFilter
Description Specifies filter criteria for a DataWindow control or DataStore.
Applies to
DataStore object
Syntax PowerBuilder
812 PowerBuilder
integer dwcontrol.SetFilter ( string format )

DataWindow in which you want to define the filter.
format A string whose value is a boolean expression that you want to use
as the filter criteria. The expression includes column names or
numbers. A column number must be preceded by a pound sign
(#). If format is null, PowerBuilder prompts you to enter a filter.
Return value Returns 1 if it succeeds and –1 if an error occurs. If no DataWindow object

has been assigned to the DataWindow or DataStore, SetFilter returns –1.
The return value is usually not used.
Usage A DataWindow object can have filter criteria specified as part of its
definition. After data is retrieved, rows that do not meet the criteria are
immediately transferred from the primary buffer to the filter buffer.
The SetFilter method replaces the existing filter criteria—if any are
defined for the DataWindow object—with a new set of criteria. Call the
Filter method to apply the filter criteria and transfer rows that do not meet
the filter criteria to the filter buffer.
The filter expression consists of columns, relational operators, and values
against which column values are compared. Boolean expressions can be
connected with logical operators AND and OR. You can also use NOT, the
negation operator. Use parentheses to control the order of evaluation.
Sample expressions are:
item_id > 5
NOT item_id = 5
(NOT item_id = 5) AND customer > "Mabson"
item_id > 5 AND customer = "Smith"
#1 > 5 AND #2 = "Smith"
The filter expression is a string and does not contain variables. However,
you can build the string in your script using the values of script variables.
Within the filter string, string constants must be enclosed in quotation
marks (see the examples).
Dictionary or ASCII order By default, PowerBuilder performs
comparisons in dictionary order. For example, the following expression
shows all the rows in which column 2 begins with A, a, B or b:
#2 >= 'a' and #2 < 'c'

SetFilter
To perform comparisons in ASCII order, append “\s” to the format string.

For example, the following expression shows only rows in which column
2 begins with a or b, because the ASCII values of uppercase letters are
lower than the ASCII values of lowercase letters:
#2 >= 'a' and #2 < 'c' \s
Number format The formatting that you enter for numbers and currency
in filter expressions display the same way in any country. Changing the
regional settings of the operating system does not modify the formatting
displayed for numbers and currency at runtime.
Escape keyword If you need to use the % or _ characters as part of the
string, you can use the escape keyword to indicate that the character is part
of the string. For example, the _ character in the following filter string is
part of the string to be searched for, but is treated as a wildcard:
comment LIKE ~'%o_a15progress%~'
The escape keyword designates any character as an escape character (do
not use a character that is part of the string you want to match). In the
following example, the asterisk (*) character is inserted before the _
character and designated as an escape character, so that the _ character is
treated as part of the string to be matched:
comment like ~'%o*_a15progress%~' escape ~'*~'
User-specified filters To let users specify their own filter expression for
a DataWindow control, you can pass a null string to the SetFilter method.
PowerBuilder displays its Specify Filter dialog box with the filter
expression blank. Then you can call Filter to apply the user’s filter
expression to the DataWindow. You cannot pass a null string to the
SetFilter method for a DataStore object.
Removing a filter To remove a filter, call SetFilter with the empty string
(“”) for format and then call Filter. The rows in the filter buffer will be
restored to the primary buffer and positioned after the rows that already
exist in the primary buffer.
Examples This statement defines the filter expression for dw_Employee as the value
of format1:
dw_Employee.SetFilter(format1)
The following statements define a filter expression and set it as the filter
for dw_Employee. With this filter, only those rows in which the cust_qty
column exceeds 100 and the cust_code column exceeds 30 are displayed.
The final statement calls Filter to apply the filter:
814 PowerBuilder
string DWfilter2
DWfilter2 = "cust_qty > 100 and cust_code >30"
dw_Employee.SetFilter(DWfilter2)
dw_Employee.Filter( )
The following statements define a filter so that emp_state of
dw_Employee displays only if it is equal to the value of var1 (in this case
ME for Maine). The filter expression passed to SetFilter is emp_state =
ME:
string Var1
Var1 = "ME"
dw_Employee.SetFilter("emp_state = '"+ var1 +" '")
The following statements define a filter so that column 1 must equal the
value in min_qty and column 2 must equal the value in max_qty to pass
the filter. The resulting filter expression is:
#1=100 and #2=1000
The sample code is:
integer max_qty, min_qty
min_qty = 100
max_qty = 1000
dw_inv.SetFilter("#1="+ String( min_qty) &
+ " and #2=" + String(max_qty))
The following example sets the filter expression to null, which causes
PowerBuilder to display the Specify Filter dialog box. Then it calls Filter,
which applies the filter expression the user specified:
string null_str
SetNull(null_str)
dw_main.SetFilter(null_str)
dw_main.Filter()
See also Filter
SetFormat
Description Specifies a display format for a column in a DataWindow control or
DataStore.

SetFormat
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.SetFormat ( string column, string format )
integer dwcontrol.SetFormat ( integer column, string format )
DataWindow.
column The column for which you are specifying the display format.
format A string whose value is the display format for the DataWindow
column.
usually not used.
Usage For information on valid display formats for different datatypes, see the
Users Guide.
If you are specifying the display format for a number, the format must use
U.S. notation. For example, comma (,) represents the thousands delimiter
and period (.) represents the decimal place. At runtime, the locally correct
symbols will be displayed.
An EditMask edit style supersedes any display format applied to the
column. When the column has an EditMask edit style, calling SetFormat
has no effect.
Examples These statements define the display format for column 15 of dw_employee
to the contents of format1:
string format1
format1 = "$#,##0.00"
dw_employee.SetFormat(15, format1)
See also GetFormat
816 PowerBuilder
SetFullState
Description Applies the contents of a DataWindow blob retrieved by GetFullState to a
DataWindow or DataStore.
Applies to
Syntax PowerBuilder
long dwcontrol.SetFullState ( blob dwasblob )
dwcontrol A reference to a DataWindow control or DataStore
dwasblob A blob that contains the state information you want to apply to the
DataWindow control or DataStore
Return value Returns –1 if an error occurs and one of the following values if it succeeds:
1 DataWindow objects match; old data and state overwritten.
2 DataWindow objects do not match; old object, data, and state
replaced.
3 No DataWindow object associated with DataWindow control or
DataStore; the DataWindow object associated with the blob is used.
The value of the DataObject property remains an empty string.
Null If any argument’s value is null in PowerBuilder or JavaScript, the
If any argument’s value is null, in PowerBuilder and JavaScript the method
returns null.
Usage GetFullState retrieves the entire state of a DataWindow or DataStore into a
blob, including the DataWindow object specification, the data buffers, and
the status flags. When you use SetFullState to apply the blob created by
GetFullState to another DataWindow, the target DataWindow has enough
information to recreate the source DataWindow.
Because the blob created by GetFullState contains the DataWindow object
specification, a subsequent call to SetFullState will overwrite the
DataWindow object for the target DataWindow control or DataStore. If the
target of SetFullState does not have a DataWindow object associated with
it, the DataWindow object associated with the blob is used. The value of
the DataObject property remains null.

SetFullState
When you use GetFullState and SetFullState to synchronize a DataWindow

control on a client with a DataStore on a server, you need to make sure that
the DataWindow object for the DataStore contains the presentation style
you want to display on the client.
Limitation on calling SetFullState from the current DataWindow

SetFullState destroys the referenced DataWindow and creates a new one
using the contents of the DataWindow blob that you specify as an
argument to SetFullState. If you call SetFullState from an event in the
current DataWindow, the DataWindow is destroyed before the event code
can be completed and you might cause the application to crash. Therefore
you should never use the “this” pronoun when calling SetFullState.
Examples These statements in a distributed client application call a remote object

function that retrieves database information into a DataStore and puts the
contents of the DataStore into a blob by using GetFullState. After the server
passes the blob back to the client, the client uses SetFullState to apply the
blob to a DataWindow control:
// Global variable:connection myconnect
// Instance variable: uo_employee iuo_employee
blob lblb_data
long ll_rv
myconnect.CreateInstance(iuo_employee)
iuo_employee.RetrieveData(lblb_data)
ll_rv = dw_empdata.SetFullState(lblb_data)
IF ll_rv = -1 THEN
MessageBox("Error", "SetFullState failed!")
END IF
See also GetChanges
GetFullState
GetStateStatus
SetChanges
818 PowerBuilder
SetHTMLAction
Description Accepts action and context information about user interaction with the
Web DataWindow client control in a Web browser so that newly generated
HTML can reflect any requested changes.
Obsolete method
SetHTMLAction is obsolete and should not be used, because the Web
Applies to
Syntax PowerBuilder
integer dwcontrol.SetHTMLAction ( string action, string context )
action A string describing an action associated with a button click or
method call in a Web DataWindow client control on a Web page.
The value is stored in a page parameter called
HTMLGenObjectName_action. action must be a valid action and
cannot be an empty string or the value none.
context A string describing the context of action in the Web DataWindow
client control. The string is generated by a Web DataWindow
script and the value is stored in a page parameter called
HTMLGenObjectName_context.
Return value Returns 1 if it succeeds and one of these negative values if an error occurs:
-1 Reloading the current context failed.
-2 The action was attempted but it failed.
-3 The action could not be performed (for example, the action was
InsertRow but the DataWindow has no editable fields for entering
new data).
-4 The action was aborted by the HTMLContextApplied event.
-5 The action is invalid.

SetHTMLObjectName
Usage SetHTMLAction triggers the HTMLContextApplied event after restraining

the context but before performing the action. You can use the event to
perform data validation using methods of a server component.
If you write your own server component in PowerBuilder instead of using
the generic Web DataWindow server component, you use this method to
update the generated HTML to reflect user actions.
See also SetAction
SetHTMLObjectName
Description Specifies a name for the Web DataWindow client control.
Obsolete method
SetHTMLObjectName is obsolete and should not be used, because the Web
Applies to

string dwcomponent.SetHTMLObjectName ( string objectname )
objectname A string specifying a name used in generated code for the Web
DataWindow client control, page parameters, and client side
events.
Sets the value of the HTMLGen.ObjectName property for the
Usage You must specify a unique object name when there will be more than one
Web DataWindow on a Web page so names will not conflict.
820 PowerBuilder
Examples This example specifies a name to be used in generated HTML for the
server component called webDW:
webDW.SetHTMLObjectName ("dwMine");
See also Generate
Modify
OneTrip
HTMLGen.property
SetItem
Description Sets the value of a row and column in a DataWindow control or DataStore
to the specified value.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.SetItem ( long row, integer column, any value )
integer dwcontrol.SetItem ( long row, string column, any value )
DataWindow in which you want to set a specific row and
column to a value.
row The row location of the data.
number or a column name. The column number is the number
of the column as it is listed in the Column Specification view of
the DataWindow painter—not necessarily the number of the
value The value to which you want to set the data at the row and
column location. The datatype of the value must be the same
datatype as the column.

SetItem
Usage SetItem sets a value in a DataWindow buffer. It does not affect the value
currently in the edit control over the current row and column, which is the
data the user has changed or might change. The value in the edit control
does not become the value of the DataWindow item until it is validated and
accepted (see AcceptText). In a script, you can change the value in the edit
control with the SetText method.
You can use SetItem when you want to set the value of an item in a
DataWindow control or DataStore that has script as the source.
Displaying data in character columns When you use SetItem (or dot
notation) to assign a value to a character column that is defined to have 512
characters or less, the actual size of the column in the DataWindow
definition is ignored. If the assigned value has more than 512 characters,
the value displayed in the DataWindow is truncated at 512 characters. If
the DataWindow column is defined to have more than 512 characters, its
size is respected. For example, if the DataWindow column is defined to
have 1, 10, or 100 characters, up to 512 characters of the assigned value
are displayed. If the DataWindow column is defined to have 1000
characters, up to 1000 characters are displayed.
Group and TreeView DataWindows In Group and TreeView
DataWindow objects, you must call GroupCalc after you call SetItem to
display data correctly.
Using SetItem in the ItemChanged and ItemError events In the
ItemChanged and ItemError events, you can call SetItem to set the value
of an item when the data the user entered is not valid. If you want the user
to have an opportunity to enter a different value, after calling SetItem you
can call SetText to put that same value in the edit control so that the user
sees the value too. In the script, use a return code that rejects the value in
the edit control, avoiding further processing, but does not allow the focus
to change. To retain focus and display an error message, return 1 for
ItemChanged or 0 for ItemError.
When you use a return code that rejects the data the user entered but allows
the focus to change (a return code of 2 in the script for the ItemChanged
event or 3 in the ItemError event), you do not need to call SetText because
the value set with SetItem displays.
If PowerBuilder cannot properly convert the string the user entered, you
must include statements in the script for the ItemChanged or ItemError
event to convert the data and use SetItem with the converted data. For
example, if the user enters a number with commas and a dollar sign (for
example, $1,000), PowerBuilder is unable to convert the string to a
number and you must convert it in the script.
822 PowerBuilder
For use with PowerBuilder ListView and TreeView controls, see SetItem
in the PowerScript Reference.
Examples This statement sets the value of row 3 of the column named hire_date of
the DataWindow control dw_order to 2003-06-07:
dw_order.SetItem(3, "hire_date", 2003-06-07)
When a user starts to edit a numeric column and leaves it without entering
any data, PowerBuilder tries to assign an empty string to the column. This
fails the datatype validation test. In this example, code in the ItemError
event sets the column’s value to null and allows the focus to change.
This example assumes that the datatype of column 2 is numeric. If it is
date, time, or datetime, replace the first line (integer null_num) with a
declaration of the appropriate datatype:
integer null_num //to contain null value
SetNull(null_num)
// Special processing for column 2

IF dwo.ID = 2 THEN
// If user entered nothing (""), set to null
IF data = "" THEN
This.SetItem(row, dwo.ID, null_num)
RETURN 2
END IF
END IF
The following example is a script for a DataWindow’s ItemError event. If
the user specifies characters other than digits for a numeric column, the
data will fail the datatype validation test. You can include code to strip out
characters such as commas and dollar signs and use SetItem to assign the
now valid numeric value to the column. The return code of 3 causes the
data in the edit control to be rejected because the script has provided a
valid value:
string snum, c
integer cnt
// Extract the digits from the user's data

FOR cnt = 1 to Len(data)
c = Mid(data, cnt, 1) // Get character
IF IsNumber(c) THEN snum = snum + c

SetItemDate
NEXT
This.SetItem(row, dwo.ID, Long(snum))
RETURN 3
GetItemDateTime
GetItemNumber
GetItemString
GetItemTime
GetText
SetText
SetItemDate
Description Sets the value of a row and column in a DataWindow control to the
specified value.
Obsolete method
SetItemDate is obsolete and should not be used, because the Web
Applies to
Web Server component (see SetItem for equivalent client
control method)

short dwcontrol.SetItemDate ( long row, string column, string value )
short dwcontrol.SetItemDateByColNum ( long row, short column,
string value )
dwcontrol The name of the Web DataWindow control in which you want
to set a specific row and column to a value.
column location.
824 PowerBuilder
Usage Although JavaScript does not distinguish between the Date, DateTime,
and Time datatypes, the DataStore will give an error if the wrong type is
passed. You can use the SetItemDateTime and SetItemTime methods to set
values in columns with the DateTime and Time datatypes.
Because the Web DataWindow server component does not support
overloading, you must use the SetItemDateByColNum variant instead of the
standard SetItemDate method when you want to refer to the column by
number.
See also SetItem
SetItemDateTime
SetItemTime
SetItemDateTime
specified value.
Obsolete method
SetItemDateTime is obsolete and should not be used, because the Web
Applies to
control method)

short dwcontrol.SetItemDateTime ( long row, string column,
string value )
short dwcontrol.SetItemDateTimeByColNum ( long row, short
column,
string value )

SetItemNumber
column location.
passed. You can use the SetItemDate and SetItemTime methods to set
values in columns with the Date and Time datatypes.
Because the Web DataWindow server component does not support
overloading, you must use the SetItemDateTimeByColNum variant instead
of the standard SetItemDateTime method when you want to refer to the
column by number.
See also SetItem
SetItemDate
SetItemTime
SetItemNumber
specified value.
Obsolete method
SetItemNumber is obsolete and should not be used, because the Web
Applies to
control method)

short dwcontrol.SetItemNumber ( long row, string column,
double value )
short dwcontrol.SetItemNumberByColNum ( long row, short
column,
double value )
826 PowerBuilder
column location.
Usage Because the Web DataWindow server component does not support
overloading, you must use the SetItemNumberByColNum variant instead of
the standard SetItemNumber method when you want to refer to the column
by number.
See also SetItem
SetItemStatus
Description Changes the modification status of a row or a column within a row. The
modification status determines the type of SQL statement the Update
method will generate for the row.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.SetItemStatus ( long row, integer column,
dwbuffer dwbuffer, dwitemstatus status )
integer dwcontrol.SetItemStatus ( long row, string column,
dwbuffer dwbuffer, dwitemstatus status )
DataWindow.
row The row location in which you want to set the status.
column The column location in which you want to set the status. Column
can be a column number or a column name. To set the status for
the row, enter 0 for column.

SetItemStatus
dwbuffer A value identifying the DataWindow buffer that contains the row.
status A value of the dwItemStatus enumerated datatype specifying the
new status.
For a list of valid values, see DWItemStatus on page 486.
Usage How statuses are set There are four DataWindow item statuses, two of
which apply only to rows:
Table 9-6: Possible statuses for DataWindow items
Status Applies to
New! Rows
NewModified! Rows
NotModified! Rows and columns
DataModified! Rows and columns
When data is retrieved When data is retrieved into a DataWindow, all

rows and columns initially have a status of NotModified!.
After data has changed in a column in a particular row, either because the
user changed the data or the data was changed programmatically, such as
through the SetItem method, the column status for that column changes to
DataModified!. Once the status for any column in a retrieved row changes
to DataModified!, the row status also changes to DataModified!.
When rows are inserted When a row is inserted into a DataWindow, it
initially has a row status of New!, and all columns in that row initially have
a column status of NotModified!. After data has changed in a column in
the row, either because the user changed the data or the data was changed
programmatically, such as through the SetItem method, the column status
changes to DataModified!. Once the status for any column in the inserted
row changes to DataModified!, the row status changes to NewModified!.
When a DataWindow column has a default value, the column’s status does
not change to DataModified! until the user makes at least one actual
change to a column in that row.
When Update is called A row’s status flag determines what SQL
command the Update method uses to update the database. INSERT or
UPDATE is called, depending upon the following row statuses:
828 PowerBuilder
Table 9-7: Effect of row status on SQL command called by Update

method
Row status SQL statement generated
NewModified! INSERT
DataModified! UPDATE
A column is included in an UPDATE statement only if the following two

conditions are met:
• The column is on the updatable column list maintained by the
DataWindow object
For more information about setting the update characteristics of the
DataWindow object, see the Users Guide.
• The column has a column status of DataModified!
The DataWindow control includes all columns in INSERT statements it
generates. If a column has no value, the DataWindow attempts to insert a
null. This causes a database error if the database does not allow nulls in
that column.
Changing statuses using SetItemStatus Use SetItemStatus when you
want to change the way a row will be updated. Typically, you do this to
prevent the default behavior from taking place. For example, you might
copy a row from one DataWindow to another. After the user modifies the
row, you want to issue an UPDATE statement instead of an INSERT
statement.
Changing column status You use SetItemStatus to change the column
status from DataModified! to NotModified!, or the converse.
Change column status when you change row status

Changing the row status changes the status of all columns in that row to
NotModified!, so if the Update method is called, no SQL update is
produced. You must change the status of columns to be updated after you
change the row status.
Changing row status Changing row status is a little more complicated.

The following table illustrates the effect of changing from one row status
to another:

SetItemStatus
Table 9-8: Effect of changing from one row status to another

Original
status Specified status
New Data Not
— New! Modified! Modified! Modified!
New! - Yes Yes No
NewModified! No - Yes New!
DataModified! NewModified! Yes - Yes
NotModified! Yes Yes Yes -
In the table, Yes means the change is valid. For example, issuing
SetItemStatus on a row that has the status NotModified! to change the
status to New! does change the status to New!. No means that the change
is not valid and the status is not changed.
Issuing SetItemStatus to change a row status from NewModified! to
NotModified! actually changes the status to New!. Issuing SetItemStatus
to change a row status from DataModified! to New! actually changes the
status to NewModified!.
Changing a row’s status to NotModified! or New! causes all columns in
that row to be assigned a column status of NotModified!. Change the
column’s status to DataModified! to ensure that an update results in a SQL
UPDATE.
Changing the status of a retrieved row from NotModified! to New!

If you change the status of a retrieved row to New! and then make a change
to data in a column, all the columns in that row change status to
DataModified! All the columns change status because the Update method
generates a SQL INSERT command that includes the changed data as well
as the data that already existed in the other columns.
Changing status indirectly When you cannot change to the desired

status directly, you can usually do it indirectly. For example, change New!
to DataModified! to NotModified!.
Resetting status for the whole DataWindow object To reset the
update status of the entire DataWindow object, use the ResetUpdate
method. This sets all status flags to NotModified! except for New! status
flags, which remain unchanged.
Examples This statement sets the status of row 5 in the Salary column of the primary
buffer of dw_history to NotModified!:
830 PowerBuilder
dw_history.SetItemStatus(5, "Salary", &

Primary!, NotModified!)
This statement sets the status of row 5 in the emp_status column of the
primary buffer of dw_new_hire to DataModified!:
dw_new_hire.SetItemStatus(5, "emp_status", &
Primary!, DataModified!)
This code sets the status of row 5 in the primary buffer of dw_rpt to
DataModified! if its status is currently NewModified!:
l_status = dw_rpt.GetItemStatus(5, 0, Primary!)
IF l_status = NewModified! THEN
dw_rpt.SetItemStatus(5, 0,
Primary!, DataModified!)
END IF
ResetUpdate
SetItemString
specified value.
Obsolete method
SetItemString is obsolete and should not be used, because the Web
Applies to
control method)

short dwcontrol.SetItemString ( long row, string column, string
value )
short dwcontrol.SetItemStringByColNum ( long row, short column,
string value )

SetItemTime
column location.
Usage Because the Web DataWindow server component does not support
overloading, you must use the SetItemStringByColNum variant instead of
the standard SetItemString method when you want to refer to the column
by number.
See also SetItem
SetItemTime
specified value.
Obsolete method
SetItemTime is obsolete and should not be used, because the Web
Applies to
control method)

short dwcontrol.SetItemTime ( long row, string column, string value
)
short dwcontrol.SetItemTimeByColNum ( long row, short column,
string value )
832 PowerBuilder
column location.
passed. You can use the SetItemDate and SetItemDateTime methods to set
values in columns with the Date and DateTime datatypes. Because the
Web DataWindow server component does not support overloading, you
must use the SetItemTimeByColNum variant instead of the standard
SetItemTime method when you want to refer to the column by number.
See also SetItem
SetItemDate
SetItemDateTime
SetPageSize
Description Specifies the number of rows to include in a generated Web page for the
Web DataWindow.
Obsolete method
SetPageSize is obsolete and should not be used, because the Web
Applies to

string dwcomponent.SetPageSize ( long pagesize )

SetPosition
pagesize The number of rows of data to include in a generated Web
page. If the Web page does not include all available rows, you
can include Button controls in the DataWindow object for
navigating other subsets of rows. To include all available rows
in the page, specify 0 for PageSize.
Sets the value of the HTMLGen.PageSize property for the
to set the property. It is particularly useful for the XML Web DataWindow
where you typically want to limit the number of rows per page.
Examples This example specifies that the HTML generated by the webDW
component will have 20 rows of data:
webDW.SetPageSize(20);
See also Generate
Modify
HTMLGen.property
SetPosition
Description Moves a control within the DataWindow to another band or changes the
front-to-back order of controls within a band.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.SetPosition ( string controlname, string band ,
boolean bringtofront )
834 PowerBuilder
controlname The name of the control within the DataWindow that you want
to move. You assign names to the controls in the DataWindow
painter.
band A string whose value is the name of the band or layer in which
you want to position controlname. Layer names are
background and foreground.
Band names are detail, header, footer, summary, header.#, and
trailer.#, where # is the group level number. Enter the empty
string (“”) if you do not want to change the band.
bringtofront A boolean indicating whether you want to bring controlname
to the front within the band:
• True – Bring it to the front.
• False – Do not bring it to the front.
Return value Returns 1 when it succeeds and –1 if an error occurs. If any argument’s
value is null, in PowerBuilder and JavaScript the method returns null.
For setting the position of controls in the front-to-back order of a
PowerBuilder window, see SetPosition in the PowerScript Reference.
Examples This statement moves oval_red in dw_rpt to the header and brings it to the
front:
dw_rpt.SetPosition("oval_red", "header", true)
This statement does not change the position of oval_red , but does bring it
to the front:
dw_rpt.SetPosition("oval_red", "", true)
This statement moves oval_red to the footer, but does not bring it to the
front:
dw_rpt.SetPosition("oval_red", "footer", false)
SetRedraw
Description Controls the automatic redrawing of an object or control after each change
to its properties.

SetRichTextAlign
Applies to
Syntax PowerBuilder
integer objectname.SetRedraw ( boolean redraw )
objectname The name of the object or control for which you want to change
the redraw setting.
redraw A boolean value that controls whether PowerBuilder redraws
an object automatically after a change. Values are:
• True – Automatically redraw the object or control after each
change to its properties.
• False – Do not redraw after each change.
Return value Returns 1 if it succeeds and –1 if an error occurs. If redraw is null,

SetRedraw returns null.
Usage By default, PowerBuilder redraws a control after each change to properties
that affect appearance. Use SetRedraw to turn off redrawing temporarily
in order to avoid flicker and reduce redrawing time when you are making
several changes to the properties of an object or control. If the window is
not visible, SetRedraw fails.
Inherited from DragObject. For more details on use with PowerBuilder
objects, see SetRedraw in the PowerScript Reference.
SetRichTextAlign
Description Sets the alignment value to use while editing columns with the RichText
edit style.
Syntax Integer dwcontrol.SetRichTextAlign ( Alignment sAlign )
836 PowerBuilder
sAlign Value for specifying the alignment that you want to set
for columns with the RichText edit style. Allowable
values are:
Left!
Right!
Center!
Justified!
Return value Returns 0 if it succeeds and –1 if an error occurs. If the argument’s value
is null, SetRichTextAlign returns null.
0 Success
set display characteristics of columns with the RichText edit style.
Examples This example sets the alignment value for editing columns that have a
RichText edit style:
Integer ll_temp
Alignment l_align
l_align = Right!
ll_temp = dw_1.SetRichTextAlign(l_align)
GetRichTextColor
GetRichTextFaceName
GetRichTextSize
GetRichTextStyle
SetRichTextColor
Description Sets the color to use while editing columns with the RichText edit style.
Syntax Integer dwcontrol.SetRichTextColor ( long color )
color A long value specifying the color that you want to set for
editing columns with the RichText edit style

SetRichTextFaceName
is null, SetRichTextColor returns null.
0 Success
Usage If the color for columns with the RichText edit style is white, background
transparency and gradient and text transparency will not work properly.
You can call this method from a button in a custom toolbar that you use to
Examples This example sets green as the current color to use for editing columns that
have a RichText edit style:
Integer l_rtn
Long l_color
l_color = RGB(0, 255, 0)
l_rtn = dw_1.SetRichTextColor(l_color)
See also GetRichTextColor
GetRichTextAlign
GetRichTextFaceName
GetRichTextSize
GetRichTextStyle
SetRichTextFaceName
Description Sets the typeface to use while editing columns with the RichText edit style.
Syntax Integer dwcontrol.SetRichTextFaceName ( string typeface )
typeface A string value for the typeface that you want to set for
editing columns with the RichText edit style
is null, SetRichTextFaceName returns null.
0 Success
838 PowerBuilder
Examples This example sets Arial as the current typeface to use for editing columns
that have a RichText edit style:
Integer li_rtn
li_rtn = dw_1.SetRichTextFaceName("Arial")
See also GetRichTextFaceName
GetRichTextAlign
GetRichTextColor
GetRichTextSize
GetRichTextStyle
SetRichTextSize
Description Sets the size of the font to use while editing columns with the RichText
edit style.
Syntax Integer dwcontrol.SetRichTextSize ( long size )
size A long value for the point size of the font that you want
to set for editing columns with the RichText edit style
is null, SetRichTextSize returns null.
0 Success
Examples This example sets 16 as the current point size to use for editing columns
that have a RichText edit style:
Integer li_rtn
li_rtn = dw_1.SetRichTextSize(16)
See also GetRichTextSize
GetRichTextAlign

SetRichTextStyle
GetRichTextColor
GetRichTextFaceName
GetRichTextStyle
SetRichTextStyle
Description Sets the style of the font to use while editing columns with the RichText
edit style.
Syntax Integer dwcontrol.SetRichTextStyle ( boolean bold, boolean underline,
boolean italic, boolean strikeout, )
bold A boolean for the bold style
underline A boolean for the underlined style
italic A boolean for the italic style
strikeout A boolean for the strikeout style
is null, SetRichTextStyle returns null.
0 Success
Examples This example sets an underlined, bolded font as the current font for editing
columns with a RichText edit style:
Integer li_rtn
li_rtn = dw_1.SetRichTextStyle(true, false, false, &
false)
See also GetRichTextStyle
GetRichTextAlign
GetRichTextColor
GetRichTextFaceName
GetRichTextSize
840 PowerBuilder
SetRow
Description Sets the current row in a DataWindow control or DataStore.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.SetRow ( long row )
DataWindow in which you want to set the current row
row The row you want to make current
Return value Returns 1 if it succeeds and –1 if an error occurs. If row is less than 1 or
greater than the number of rows, SetRow fails.
Usage SetRow moves the cursor to the current row but does not scroll the
DataWindow control or DataStore.
Events SetRow can trigger these events:
ItemChanged
ItemError
ItemFocusChanged
RowFocusChanged
Avoiding infinite loops

Never call SetRow in the ItemChanged event or any of the other events
listed above. Because SetRow can trigger these events, such a recursive
call can cause a stack fault.
Examples This statement sets the current row in dw_employee to 15:

dw_employee.SetRow(15)
This example unhighlights all highlighted rows, if any. It then sets the
current row to 15 and highlights it. If row 15 is not visible, you can use
ScrollToRow instead of SetRow:
dw_employee.SelectRow(0, false)

dw_employee.SetRow(15)
dw_employee.SelectRow(15, true)
See also GetColumn
GetRow
SetColumn
Description Specifies the visual indicator that identifies the current row in the
DataWindow control. You can use the standard dotted-line rectangle of
Windows, PowerBuilder’s pointing hand, or an image stored in a
PowerBuilder Picture control.
Applies to
Syntax PowerBuilder
integer dwcontrol.SetRowFocusIndicator ( RowFocusInd
focusindicator
{, integer xlocation {, integer ylocation } } )
integer dwcontrol.SetRowFocusIndicator ( Picture picturename
{, integer xlocation {, integer ylocation } } )
in which you want to set the row focus indicator.
focusindicator The visual indicator for the current row. In PowerBuilder, a
or picturename value of the RowFocusInd enumerated datatype or the name
of a PowerBuilder Picture control whose image you want to
use.
For a list of valid enumerated datatype values, see
RowFocusInd on page 492.
xlocation The x coordinate in PowerBuilder units of the position of the
(optional) hand or bitmap relative to the upper-left corner of the row.
ylocation The y coordinate in PowerBuilder units of the position of the
(optional) hand or bitmap relative to the upper-left corner of the row.
is null, SetRowFocusIndicator returns null.
842 PowerBuilder
Usage Sets the current row indicator in dwcontrol to focusindicator. If you select
Hand or a Picture control as the indicator, PowerBuilder displays the
indicator at the left side of the body of the DataWindow unless you specify
location coordinates (xlocation, ylocation). The default location is 0,0 (the
left side of the body of the DataWindow control).
You must assign a DataWindow object to the DataWindow control before
you call SetRowFocusIndicator. If you change the DataWindow object at
runtime, you must call SetRowFocusIndicator again to reset the indicator.
Pictures as row focus indicators

To use a picture as the row focus indicator, set up the Picture control in the
Window painter. Place the Picture control in the window that contains the
DataWindow control and then reference it in the SetRowFocusIndicator
method. You can hide the picture or place it under the DataWindow control
so the user does not see the control itself.
Examples This statement sets the row focus indicator in dw_employee to the
pointing hand:
dw_employee.SetRowFocusIndicator(Hand!)
If p_arrow is a Picture control in the window, the following statement sets
the row focus indicator in dw_employee to p_arrow:
dw_employee.SetRowFocusIndicator(p_arrow)
See also GetRow
SetRow
SetSelfLink
Description Specifies the URL and page parameters for the current page of the Web
DataWindow.
Obsolete method
SetSelfLink is obsolete and should not be used, because the Web

SetSelfLink
Applies to

string dwcomponent.SetSelfLink ( string selflink, string selflinkargs )
dwcomponent A reference to an Web DataWindow server component.
selflink The URL for the current page. It cannot include parameters.
Parameters may be added when HTML is generated.
Selflink is used to generate URLs for navigation buttons that
obtain additional rows from the result set and for other buttons
that reload the page, such as Update and Retrieve.
Sets the value of the HTMLGen.SelfLink property for the
selflinkargs A string in the form:
Exp is a DataWindow string expression that is evaluated,
converted using URL encoding, and used as the value of
argname in generated HTML.
The evaluated selflinkargs expressions are included in the
generated HTML as hidden fields. The arguments supply
information, such as retrieval arguments, that the server needs
to render additional pages of the result set.
Reason for self-link information The first time the client browser
requests the page template, it can pass page specific information using
GET or POST and the page can use those values in the server-side scripts.
However, when the page is reloaded because of user interactions with the
Web DataWindow, that information will not be passed to the page
automatically.
To make the information available, you specify a selflinkargs string that
becomes page parameters in the reloaded page. Typically, you would use
self-link parameters to provide:
• Login information from another page
844 PowerBuilder
• DataWindow object name

• Retrieval arguments for the DataWindow object
Getting the URL for the page To correctly reload the page in response
to user actions, the server component needs to know the URL of the page
template. You can get this information from the name property of the
document object header or the SCRIPT_NAME server variable.
In a JSP page, you must parse the return value from a
request.getRequestURI call:
String URI = request.getRequestURI();
String [] myArray = URI.split ("/");
String pageName = myArray [myArray.length-1];
In ASP, use the ServerVariables method of the Request object:
var pageName =Request.ServerVariables(
"SCRIPT_NAME" );
Self-link arguments for SetSelfLink The syntax for specifying self-
link arguments is:
pageparam='expression'|pageparam='expression'
The expression is a DataWindow expression that is evaluates to a string.
Usually, you will be passing constant string values that have already been
passed to the page as page parameters.
The expression is enclosed in quotes, and if the value is a constant, it must
also be enclosed in quotes. For example, if a page parameter has the value
Johnson, the value of the expression must be enclosed in two sets of quote
marks: '"Johnson"'.
To get the value from the current Logname parameter, which is already
defined for the page, you build the expression using the Logname page
parameter. The single quotes and inner double quotes are embedded in the
expression. The current value is inserted between the quotes:
String logname = (String)
request.getParameter("Logname");
String linkargs =
"logname='\"" + logname + "\"'";
If the DataWindow object requires retrieval arguments, they must be
provided to the reloaded page in selflinkargs. For an example of using
SetSelfLink for setting up retrieval arguments as page parameters, see
Retrieve.

SetServerServiceClasses
Examples This server-side script specifies hyperlink information for the page. The
value of the empid column is stored in the page parameter EMPID:
webDW.SetSelfLink("mydwpage.html", "EMPID =
'String(empid)'");
This hyperlink information refers to the JSP page by name. The page is
regenerated by calling the template again. There are no link arguments:
webDW.SetSelfLink("salesrpt.jsp", "");
This ASP example uses the ServerVariables method of the Request object
to get the SCRIPT_NAME variable:
var pageName =Request.ServerVariables(
"SCRIPT_NAME" );
webDW.SetSelfLink(pageName,"");
In JSP you must parse the return value from a request.getRequestURI call.
This example also sets up a page parameter for the reloaded page using the
page parameter Logname:
String URI = request.getRequestURI();
String [] myArray = URI.split ("/");
String pageName = myArray [myArray.length-1];
String logname = (String)
request.getParameter("Logname");
String linkargs =
"Logname='\"" + logname + "\"'";
webDW.SetSelfLink( pageName, linkargs);
See also Generate
Modify
SetAction
HTMLGen.property
SetServerServiceClasses
Description Tells the server component to trigger custom events defined in user objects
for data validation. These user objects, referred to as service classes, must
be defined in the PBL or PBD containing the DataWindow object for the
server component.
846 PowerBuilder
Obsolete method
SetServerServiceClasses is obsolete and should not be used, because the
Web DataWindow technology is obsolete.
Applies to

short dwcomponent.SetServerServiceClasses ( string
serviceclassnames )
serviceclassnames A string whose value is a list of PowerBuilder custom
class user objects. The user objects must be in the PBL or
PBD containing the DataWindow for the server
component. Separate user object names with a semicolon.
Return value Returns 1 if it succeeds and –1 if a specified service class does not exist.
Usage The main use of service classes is to provide data validation using server-
side business logic.
Service classes implement one or more user-defined events with these
names and signatures:
long dberror ( long sqldbcode, string sqlerrtext, string sqlsyntax,
dwbuffer buffer, long row, datastore ds )
long retrievestart ( datastore ds )
long retrieveend ( long rowcount, datastore ds )
long sqlpreview ( sqlpreviewfunction request, sqlpreviewtype
sqltype, string sqlsyntax, dwbuffer buffer, long row, datastore ds )
long updatestart ( datastore ds )
long updateend ( long rowsinserted, long rowsupdated, long
rowsdeleted, datastore ds )
long htmlcontextapplied ( string action, datastore ds )
The custom events can use the same return codes as the corresponding
standard DataWindow events documented in Chapter 8, DataWindow
Events. By setting a return code, a custom event can cause the event action
to be canceled in the server component.

SetServerSideState
When the standard DataWindow event occurs in the server component, the
component triggers the custom event in each of the listed service classes.
One or more of the components can implement the event. A service class
only needs to implement the events whose outcome it wants to influence.
Any of the service classes can set an event return code that cancels the
event action in the server component.
Runtime errors
Instantiated service objects run in the same objects space as the server
component. If a runtime error occurs in the service object, it could cause
HTML generation to fail.
Examples This JavaScript example for a server-side script specifies a list of service
classes that implement events:
dwMine.SetServerServiceClasses(
"uo_update;uo_retrieve;uo_dberror" );
See also Events:
HTMLContextApplied
DBError
RetrieveStart
RetrieveEnd
SQLPreview
UpdateStart
UpdateEnd
SetServerSideState
Description Tells the server component whether to attempt to maintain its state by
saving the retrieved data and leaving the transaction open. Keeping the
retrieved data means that the component does not need to reconnect and
retrieve data every time a method is called.
Obsolete method
SetServerSideState is obsolete and should not be used, because the Web
848 PowerBuilder
Applies to

string dwcomponent.SetServerSideState ( boolean maintainstate )
dwcomponent A reference to a Web DataWindow server component
maintainstate Specifies whether the server will attempt to maintain its state
between method calls. Values are:
• True – The server component will keep the result set and
keep the transaction open if possible.
• False – (Default) The result set is not saved and the server
component uses information passed back from the client to
retrieve the result set again and remember any uncommitted
changes.
Return value Returns an empty string if it succeeds and an error message from server if
it fails.
Usage How state is maintained for a stateless component The Web
DataWindow can run in a fully stateless server environment. Variables in
the Web page keep information about the rows being viewed and changes
the user makes and this information is communicated to the server
component as needed so the component can restore its state each time it is
called. Restoring its state includes retrieving data from the database each
time the page is reloaded, including each time the user navigates to another
page.
Performance impact of a stateless component Operating in a
stateless mode minimizes use of server resources but can decrease
performance. The client maintains the state of the server component in
string form and the information is sent back and forth with every request.
Also, when state is not maintained on the server, the component must
connect to the database and retrieve data each time it is called. If the
component server does not do connection caching, response time for the
client could be very slow.
Maintaining state on the server You can increase performance by
maintaining state on the server. To maintain state, the page server’s session
object keeps a reference to the server component.

SetSort
Maintaining state on the server will provide faster response time if the
same component is accessed again. However, it also increases the server
resources used for each client connection.
To minimize impact on server resources, a short timeout on a session lets
the server get rid of a component that might not be requested again. If the
component is called again, its state can be restored from the client state
information.
You can also increase performance by calling Update frequently.
Examples This example specifies that the server component should maintain state:
webDW.SetServerSideState( true );
See also Update
SetSort
Description Specifies sort criteria for a DataWindow control or DataStore.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.SetSort ( string format )
DataWindow.
format A string whose value is valid sort criteria for the DataWindow
(see Usage). The expression includes column names or numbers.
A column number must be preceded by a pound sign (#). If
format is null, PowerBuilder prompts you to enter the sort
criteria.

Usage A DataWindow object can have sort criteria specified as part of its
definition. SetSort overrides the definition, providing new sort criteria for
the DataWindow. However, it does not actually sort the rows. Call the Sort
method to perform the actual sorting.
850 PowerBuilder
The sort criteria for a column have one of the forms shown in the following
table, depending on whether you specify the column by name or number.
Table 9-9: Examples for specifying sort order
Syntax for sort order Examples
columnname order "emp_lname A"
"emp_lname asc, dept_id desc"
# columnnumber order "#3 A"
The following table shows the recognized values for order. These values
are case insensitive. For example, as, s, AS, or S all specify a case-
sensitive sort in ascending order.
Table 9-10: Recognized values for sort order
Order value Resulting sort order
a, asc, ascending, ai, i Case-insensitive ascending
d, desc, descending, di Case-insensitive descending
as, s Case-sensitive ascending
ds Case-sensitive descending
If you omit order or specify an unrecognized string, the sort is performed

in ascending order and is case insensitive. You can specify secondary
sorting by specifying criteria for additional columns in the format string.
Separate each column specification with a comma.
To let the user specify the sort criteria for a DataWindow control, you can
pass a null string to the SetSort method. PowerBuilder displays the Specify
Sort Columns dialog with the sort specifications blank. Then you can call
Sort to apply the user’s criteria. You cannot pass a null string to the SetSort
method for a DataStore object.
Examples This statement sets the sort criteria for dw_employee so emp_status is
sorted in ascending order and within each employee status, emp_salary is
sorted in descending order:
dw_employee.SetSort("emp_status asc, emp_salary
desc")
If emp_status is column 1 and emp_salary is column 5 in dw_employee,
then the following statement is equivalent to the sort specification above:
dw_employee.SetSort("#1 A, #5 D")

SetSQLPreview
This example defines sort criteria to sort the status column in ascending
order and the salary column in descending order within status. Both sorts
are case-sensitive. After assigning the sort criteria to the DataWindow
control dw_emp, it sorts dw_emp:
string newsort
newsort = "emp_status as, emp_salary ds"
dw_emp.SetSort(newsort)
dw_emp.Sort( )
The following example sets the sort criteria for dw_main to null, causing
PowerBuilder to display the Specify Sort Columns dialog so that the user
can specify sort criteria. The Sort method applies the criteria the user
specifies:
string null_str
SetNull(null_str)
dw_main.SetSort(null_str)
dw_main.Sort( )
See also Sort
SetSQLPreview
Description Specifies the SQL statement for a DataWindow control or DataStore that
PowerBuilder is about to send to the database.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.SetSQLPreview ( string sqlsyntax )
DataWindow
sqlsyntax A string whose value is valid SQL syntax for the SQL statement
that will be submitted to the database server
Return value Returns 1 if it succeeds and 0 if an error occurs. If any argument’s value is
null, in PowerBuilder and JavaScript the method returns null.
852 PowerBuilder
Usage Use SetSQLPreview to modify syntax before you update the database with
changes in the DataWindow object.
To obtain the current SQL statement in the SQLPreview event, look at the
sqlsyntax argument.
When to call SetSQLPreview

Call this method only in the script for the SQLPreview event.
Examples This statement sets the current SQL string for the DataWindow dw_1:
dw_1.SetSQLPreview( &
"INSERT INTO billings VALUES(100, " + &
String(Current_balance) + ")")
See also GetSQLPreview
GetUpdateStatus
SetSQLSelect
Description Specifies the SQL SELECT statement for a DataWindow control or
DataStore.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.SetSQLSelect ( string statement )
DataWindow for which you want to change the SELECT
statement.
statement A string whose value is the SELECT statement for the
DataWindow object. The statement must structurally match the
current SELECT statement (that is, it must return the same
number of columns, the columns must be the same datatype, and
the columns must be in the same order).

SetSQLSelect
Return value SetSQLSelect returns 1 if it succeeds and –1 if the SELECT statement

cannot be changed. If any argument’s value is null, in PowerBuilder and
JavaScript the method returns null.
Usage Use SetSQLSelect to dynamically change the SQL SELECT statement for
a DataWindow object in a script.
If the DataWindow is updatable, PowerBuilder validates the SELECT
statement against the database and DataWindow column specifications
when you call the SetSQLSelect method. Each column in the SQL
SELECT statement must match the column type in the DataWindow
object. The statement is validated only if the DataWindow object is
updatable.
You must use the SetTrans or SetTransObject method to set the transaction
object before the SetSQLSelect method will execute.
If the new SELECT statement has a different table name in the FROM
clause and the DataWindow object is updatable, then PowerBuilder must
change the update information for the DataWindow object. PowerBuilder
assumes the key columns are in the same positions as in the original
definition. The following conditions would make the DataWindow not
updatable:
• There is more than one table in the FROM clause
• A DataWindow update column is a computed column in the SELECT
statement
If changing the SELECT statement makes the DataWindow object not
updatable, the DataWindow control cannot execute an Update method call
for the DataWindow object in the future.
Limitations to using SetSQLSelect

Use SetSQLSelect only if the data source for the DataWindow object is a
SQL SELECT statement without retrieval arguments and you want
PowerBuilder to modify the update information for the DataWindow
object:
dw_1.Modify("DataWindow.Table.Select='select...'")
Modify does not verify the SELECT statement or change the update
information, so it is faster but more susceptible to user error. Although you
can use Modify when arguments are involved, this is not recommended
because of the lack of verification.
854 PowerBuilder
Examples If the current SELECT statement for dw_emp retrieves no rows, the
following statements replace it with the syntax in NewSyn:
string OldSyn, NewSyn
OldSyn = &
'SELECT employee.EMP_Name FROM employee' &
+ 'WHERE salary < 70000'
NewSyn = 'SELECT employee.EMP_Name FROM employee' &
+ 'WHERE salary < 100000'
IF dw_emp.Retrieve( ) = 0 THEN
dw_emp.SetSQLSelect(NewSyn)
dw_emp.Retrieve()
END IF
See also Modify
Retrieve
SetTrans
SetTransObject
Update
SetTabOrder
Description Changes the tab sequence number of a column in a DataWindow control
to the specified value.
Applies to
Syntax PowerBuilder
integer dwcontrol.SetTabOrder ( integer column, integer tabnumber
)
integer dwcontrol.SetTabOrder ( string column, integer tabnumber )
dwcontrol A reference to a DataWindow control or child DataWindow in
which you want to define the tab order.
column The column to which you are assigning a tab value. Column can
be a column number or a column name. The column number is
the number of the column as it is listed in the Column
Specification view of the DataWindow painter—not necessarily
the number of the column in the Design view.

SetText
tabnumber The tab sequence number (0 - 9999) you want to assign to the
DataWindow column. 0 removes the column from the tab order,
which makes it read-only.
Return value Returns the previous tab value of the column if it succeeds and –1 if an
error occurs. If any argument’s value is null, in PowerBuilder and
JavaScript the method returns null.
Usage You can change a column in a DataWindow object to read-only by
changing the tab sequence number of the column to 0.
Examples This statement changes column 4 of dw_Employee to read-only:
dw_Employee.SetTabOrder(4, 0)
These statements change column 4 of dw_employee to read-only and later
restore the column to its original tab value with read/write status:
integer OldTabNum
// Set OldTabNum to the previous tab order value
OldTabNum = dw_employee.SetTabOrder(4, 0)
... // Some processing
// Return column 4 to its previous tab value.
dw_employee.SetTabOrder(4, OldTabNum)
SetText
Description Replaces the text in the edit control over the current row and column in a
DataWindow control or DataStore.
Applies to
Syntax PowerBuilder
integer dwcontrol.SetText ( string text )
dwcontrol The name of the DataWindow control or DataStore in which you
want to specify the text in the current row and column.
text A string whose value you want to put in the current row and
column. The value must be compatible with the datatype of the
column.
856 PowerBuilder
Usage SetText only sets the value in the edit control. When the user changes
focus to another row and column, PowerBuilder accepts the text as the
item in the row and column.
Using SetText in the ItemChanged and ItemError events In the
ItemChanged or ItemError event, PowerBuilder or your own script might
determine that the value in the edit control is invalid or that it needs further
processing. You can call SetItem to specify a new item value for the row
and column.
If you want the user to have an opportunity to enter a different value, after
calling SetItem you can call SetText to put that same value in the edit
control so that the user sees the value too. You can also call SetText without
calling SetItem. In the script, use a return code that rejects the value in the
edit control, avoiding further processing, but does not allow the focus to
change. To retain focus and display an error message, return 1 for
ItemChanged or 0 for ItemError.
When you use a return code that rejects the data the user entered but allows
the focus to change (a return code of 2 in the script for the ItemChanged
event or 3 in the ItemError event), you do not need to call SetText because
the value set with SetItem displays when the focus changes.
Examples These statements replace the value of the current row and column in
dw_employee with Tex and then call AcceptText to accept and move Tex
into the current column. (Do not use this code in the ItemChanged or
ItemError event because it calls AcceptText.)
dw_employee.SetText("Tex")
dw_employee.AcceptText()
This example converts a number that the user enters in the column called
credit to a negative value and sets both the item and the edit control’s text
to the negative number. This code is the script for the ItemChanged event.
The data argument holds the newly entered value:
integer negative
IF dwo.Name = "credit" THEN

IF Integer(data) > 0 THEN
// Convert to negative if it's positive
negative = Integer(data) * -1
// Change the primary buffer value.

SetTrans
This.SetItem(row, "credit", negative)
// Change the value in the edit control

This.SetText(String(negative))
RETURN 1
END IF
END IF
See also AcceptText
GetText
SetItem
SetTrans
Description Sets the values in the internal transaction object for a DataWindow control
or DataStore to the values from the specified transaction object. The
transaction object supplies connection settings, such as the database name.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.SetTrans ( transaction transaction )
DataWindow in which you want to set the values of the internal
transaction object
transaction The name of the transaction object from which you want
dwcontrol to get values
is null, the method returns null.
Usage In most cases, use the SetTransObject method to specify the transaction
object. It is more efficient and allows you to control when changes get
committed to the database.
858 PowerBuilder
SetTrans copies the values from a specified transaction object to the

internal transaction object for the DataWindow control or DataStore.
When you use SetTrans in a script, the DataWindow uses its internal
transaction object and automatically connects and disconnects as needed;
any errors that occur cause an automatic rollback. With SetTrans, you do
not specify SQL statements, such as CONNECT, COMMIT, and
DISCONNECT. The DataWindow control connects and disconnects after
each Retrieve or Update function.
Use SetTransObject with composite DataWindows

You must use SetTransObject with DataWindow objects that use the
Composite presentation style. Composite DataWindows are containers for
other DataWindow objects and do not have any internal transaction
information of their own.
If you use SetTrans with each nested DataWindow in a composite
DataWindow, disconnect does not occur until the PowerBuilder session
ends.
Use SetTrans when you want PowerBuilder to manage the database

connections automatically because you have a limited number of available
connections or expect to use the application from a remote location.
SetTrans is appropriate when you are only retrieving data and do not need
to hold database locks on records the user is modifying. For better
performance, however, you should use SetTransObject.
DBMS connection settings You must set the parameters required to

connect to your DBMS in the transaction object before you can use the
transaction object to set the DataWindow’s internal transaction object and
connect to the database.
Updating more than one table When you use SetTrans to specify the
transaction object, you cannot update multiple DataWindow objects or
multiple tables within one object.
Examples This statement sets the values in the internal transaction object for
dw_employee to the values in the default transaction object SQLCA:
dw_employee.SetTrans(SQLCA)

SetTransObject
The following statements change the database type and password of

dw_employee. The first two statements create the transaction object
emp_TransObj. The next statement uses the GetTrans method to store the
values of the internal transaction object for dw_employee in
emp_TransObj. The next two statements change the database type and
password. The SetTrans method assigns the revised values to
dw_employee:
// Name the transaction object.
transaction emp_TransObj
// Create the transaction object.

// Fill the new object with the original values.

dw_employee.GetTrans(emp_TransObj)
// Change the database type.
emp_TransObj.DBMS ="Sybase"
// Change the password.
emp_TransObj.LogPass = "cam2"
// Put the revised values into the

// DataWindow transaction object.
dw_employee.SetTrans(emp_TransObj)
See also GetTrans
SetTransObject
SetTransObject
Description Causes a DataWindow control or DataStore to use a programmer-specified
transaction object. The transaction object provides the information
necessary for communicating with the database.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.SetTransObject ( transaction transaction )
860 PowerBuilder
DataWindow in which you want to use a programmer-specified
transaction object rather than the DataWindow control’s internal
transaction object
transaction The name of the transaction object you want to use in the
dwcontrol
Usage Transaction objects in PowerBuilder A programmer-specified
transaction object gives you more control over the database transactions
and provides efficient application performance. You control the database
connection by using SQL statements such as CONNECT, COMMIT, and
ROLLBACK.
Since the DataWindow control does not have to connect to the database for
every RETRIEVE and UPDATE statement, these statements run faster. You
are responsible for committing and rolling back transactions after you call
the Update method, using code like the following:
IF dw_Employee.Update()>0 THEN
COMMIT USING emp_transobject;
ELSE
ROLLBACK USING emp_transobject;
END IF
You must set the parameters required to connect to your DBMS in the
transaction object before you can use the transaction object to connect to
the database. PowerBuilder provides a global transaction object called
SQLCA, which is all you need if you are connecting to one database. You
can also create additional transaction objects, as shown in the examples.
To use SetTransObject, write code that does the following tasks:
1 Set up the transaction object by assigning values to its fields (usually
in the application’s Open event).
2 Connect to the database using the SQL CONNECT statement and the
transaction object (in the Open event for the application or window).
3 Call SetTransObject to associate the transaction object with the
DataWindow control or DataStore (usually in the window’s Open
event).

SetTransObject
4 Check the return value from the Update method and follow it with a
SQL COMMIT or ROLLBACK statement, as appropriate.
If you change the DataWindow object associated with the DataWindow
control (or DataStore) or if you disconnect and reconnect to a database, the
connection between the DataWindow control (or DataStore) and the
transaction object is severed. You must call SetTransObject again to
reestablish the connect.
SetTransObject versus SetTrans

In most cases, use the SetTransObject method to specify the transaction
object because it is efficient and gives you control over when transactions
are committed.
The SetTrans method provides another way of managing the database
connection. SetTrans, which sets transaction information in the internal
transaction object for the DataWindow control or DataStore, manages the
connection automatically. You do not explicitly connect to the database;
the DataWindow connects and disconnects for each database transaction,
which is less efficient but necessary in some situations.
For more information, see SetTrans.
Examples This statement causes dw_employee to use the default transaction object
SQLCA:
dw_employee.SetTransObject(SQLCA)
This statement causes dw_employee to use the programmer-defined
transaction object emp_TransObj. In this example, emp_TransObj is an
instance variable, but your script must allocate memory for it with the
CREATE statement before you use it:
... // Assign values to the transaction object
dw_employee.SetTransObject(emp_TransObj)
This example has two parts. The first script, for the application’s Open
event, reads database parameters from an initialization file called
MYAPP.INI and stores the values in the default transaction object
(SQLCA). The Database section of MYAPP.INI has the same keywords as
PowerBuilder’s own PB.INI file. The parameters shown are for a SQL
Server or Oracle database. The second script, for the window’s Open
event, establishes a connection and retrieves data from the database.
The application’s Open event script populates SQLCA:
862 PowerBuilder
SQLCA.DBMS = ProfileString("myapp.ini", &

"database", "DBMS", " ")
SQLCA.Database = ProfileString("myapp.ini", &
"database", "Database", " ")
SQLCA.LogId = ProfileString("myapp.ini", &
"database", "LogId", " ")
SQLCA.LogPass = ProfileString("myapp.ini", &
"database", "LogPassword", " ")
SQLCA.ServerName = ProfileString("myapp.ini", &
"database", "ServerName", " ")
SQLCA.UserId = ProfileString("myapp.ini", &
"database", "UserId", " ")
SQLCA.DBPass = ProfileString("myapp.ini", &
"database", "DatabasePassword", " ")
SQLCA.lock = ProfileString("myapp.ini", &
"database", "lock", " ")
The Open event script for the window that contains the DataWindow
control connects to the database, assigns the transaction object to the
DataWindow, and retrieves data:
long RowsRetrieved
string LastName
// Connect to the database.

// Test whether the connect succeeded.

MessageBox("Connect Failed", &
"Cannot connect to database " &
+ SQLCA.SQLErrText)
RETURN
END IF
// Set the transaction object to SQLCA.

// Retrieve the rows.

LastName = ...
RowsRetrieved = dw_employee.Retrieve(LastName)
// Test whether the retrieve succeeded.
IF RowsRetrieved < 0 THEN
MessageBox("Retrieve Failed", &
"Cannot retrieve data from the database.")
END IF

SetValidate
See also GetTrans

SetTrans
SetValidate
Description Sets the input validation rule for a column in a DataWindow control or
DataStore.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.SetValidate ( string column, string rule )
integer dwcontrol.SetValidate ( integer column, string rule )
DataWindow.
column The column for which you want to set the input validation rule.
rule A string whose value is the validation rule for validating the data.
Usage Validation rules are boolean expressions that usually compare the value in
the column’s edit control to some other value. When data the user enters
fails to meet the criteria established in the validation rule, an ItemError
event occurs.
You can specify validation rules in the Database painter or the
DataWindow painter, and you can change the rules in scripts using
SetValidate. A validation rule can include any DataWindow painter
function. For more information, see the Users Guide.
If you want to change a column’s validation rule temporarily, you can use
GetValidate to get and save the current rule. To include the value the user
entered in the validation rule, use the GetText method. You can compare its
return value to the validation criteria.
864 PowerBuilder
If the validation rule contains numbers, the DataWindow expects the

numbers in U.S. format. In PowerBuilder, be aware that the String function
formats numbers using the current system settings. If you use it to build
the rule, specify a display format that produces U.S. notation.
Examples The following assigns a validation rule to the current column in
dw_employee. The rule ensures that the data entered is greater than zero:
dw_employee.SetValidate(dw_employee.GetColumn(), &
"Number(GetText( )) > 0")
The following assigns a validation rule to the current column in
dw_employee. The rule checks that the value entered is less than the value
in the Full_Price column:
dw_employee.SetValidate(dw_employee.GetColumn(), &
"Number(GetText( )) < Full_Price")
This example defines a new validation rule for the column emp_state in
the DataWindow control dw_employee. The new rule is [A-Z]+ , meaning
the data in emp_state must be all uppercase characters. The text pattern
must be enclosed in quotes within the quoted validation rule. The
embedded quotes are specified with ~". The script saves the old rule,
assigns the new rule, performs some processing, and then sets the
validation rule back to the old rule:
string OldRule, NewRule
NewRule = "Match(GetText(), ~"[A-Z]+~")"
OldRule = dw_employee.GetValidate("emp_state")
dw_employee.SetValidate("emp_state", NewRule)
... //Process data using the new rule.
// Set the validation rule back to the old rule.

dw_employee.SetValidate("emp_state", OldRule)
See also GetValidate

SetValue
SetValue
Description Sets the value of an item in a value list or code table for a column in a
DataWindow control or DataStore. (A value list is called a code table
when it has both display and data values.) SetValue does not affect the data
stored in the column.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.SetValue ( string column, integer index, string
value )
integer dwcontrol.SetValue ( integer column, integer index, string
value )
column The column that contains the value list or code table. Column can
be a column number or a column name.
The edit style of the column can be DropDownListBox, Edit, or
RadioButton. SetValue has no effect when column has the
EditMask or DropDownDataWindow edit style.
index The number of the item in the value list or code table for which
you want to set the value.
value A string whose value is the new value for the item. For a code
table, use a tab (~t in PowerBuilder) to separate the display value
from the data value ("Texas~tTX"). The data value must be a
string that can be converted to the datatype of the column.
Return value Returns 1 if it succeeds and -1 if an error occurs. If any argument’s value
Examples This statement sets the value of item 3 in the value list for the column
emp_state of dw_employee to Texas:
dw_employee.SetValue("emp_state", 3, "Texas")
This statement sets the display value of item 3 in the code table for the
column named emp_state of dw_employee to Texas and the data value to
TX:
dw_employee.SetValue("emp_state", 3, "Texas~tTX")
866 PowerBuilder
The following statements use a SQL cursor and FETCH statement to

populate the ListBox portion of a DropDownListBox style column called
product_col of a DataWindow object with code table values:
integer prod_code, i = 1
string prod_name
DECLARE prodcur CURSOR FOR

SELECT product.name, product.code
FROM product USING SQLCA;

MessageBox("Status","Connect Failed " &
+ SQLCA.SQLErrText)
RETURN
END IF
OPEN prodcur;
MessageBox("Status","Cursor Open Failed " &
+ SQLCA.SQLErrText)
RETURN
END IF
FETCH prodcur INTO :prod_name, :prod_code;
DO WHILE SQLCA.SQLCode = 0
dw_products.SetValue("product_col", i, &
prod_name + "~t" + String(prod_code))
i = i + 1
FETCH prodcur INTO :prod_name, :prod_code;
LOOP
CLOSE prodcur;
DISCONNECT USING SQLCA;
See also GetValue
SetWeight
Description Specifies the types of JavaScript code that will be included in the
generated HTML or XHTML.

SetWeight
Obsolete method
SetWeight is obsolete and should not be used, because the Web
Applies to

integer dwcomponent.SetWeight ( boolean allowupdate, boolean
validation, boolean events, boolean clientscriptable, boolean
clientformatting )
allowupdate Specifies whether the generated HTML will be a form with
INPUT elements so that the user can change the data. Values
are:
• True – The generated HTML is a form. The user can
change the data.
• False – The generated HTML is a table. The user cannot
change the data.
When allowupdate is false, validation and clientformatting
are ignored and no validation or formatting scripts are
generated.
validation Specifies whether the generated HTML will include scripts
for validating data the user enters. The scripts implement
validation rules defined in the DataWindow object. Values
are:
• True – The generated HTML has scripts that implement
validation rules.
• False – The generated HTML does not validate user-
entered data.
Sets the value of the HTMLGen.ClientValidation property
for the DataWindow object associated with the server
component.
868 PowerBuilder
events Specifies whether the generated HTML will include code
for triggering events. Values are:
• True – The generated HTML has scripts that trigger
events.
• False – The generated HTML does not trigger events.
Sets the value of the HTMLGen.ClientEvents property for
the DataWindow object associated with the server
component.
The available events are listed in the DataWindow event
cross-reference on page 503.
clientscriptable Specifies whether the generated HTML allows client-side
scripts to call methods of the client control. Values are:
• True – The generated HTML includes methods that the
client scripts can call.
• False – The generated HTML does not include methods.
This option adds approximately 100K to the generated
HTML.
Sets the value of the HTMLGen.ClientScriptable property
component.
clientformatting Specifies whether the generated HTML will include scripts
for formatting data the user enters. The scripts implement
display formats defined in the DataWindow object. Values
are:
• True – The generated HTML has scripts that format user-
entered data.
• False – The generated HTML does not format user-
entered data.
Sets the value of the HTMLGen.ClientFormatting property
component.
Usage When code for more features is included, the Web DataWindow becomes
a more robust tool for data entry and manipulation, allowing data
validation, formatting, and client-side scripts that react to user actions.
However, if your application does not use some of these features, you can
decrease the size of the generated code by setting the appropriate options
to false.

SetWSObject
to set the properties.
These properties can also be set in the DataWindow painter so that the
settings are part of the DataWindow object definition.
Examples This example specifies updating of data is not supported in the server
component webDW, but events are supported so client-side scripts can
respond to user actions:
webDW.SetWeight( false, false, true, true, false );
This example specifies that all features are supported except client-side
scripting. Scripts in the Web page will not be able to call Web
DataWindow client methods:
webDW.SetWeight( true, true, true, false, true );
This example specifies that all features are supported:
webDW.SetWeight( true, true, true, true, true );
See also Generate
Modify
SetAction
HTMLGen.property
SetWSObject
Description Causes a DataWindow control or DataStore to use a programmer-specified
Web service connection object. The connection object provides the
information necessary for communicating with a Web service data source.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.SetWSObject ( wsconnection wsobject )
DataWindow in which you want to use a programmer-specified
Web service connection object
870 PowerBuilder
wsobject The name of the connection object you want to use in the
dwcontrol
Return value Returns 1 if it succeeds and –1 if an error occurs. If the WSConnection

object is null, in PowerBuilder the method returns null.
Usage You call the SetWSObject method to pass an instance of the
WSConnection object and connect to a Web service data source.when the
Web service requires user-related, session-related, or authentication
information. If the Web service does not require this information, you do
not need to use the WSConnection object (or call SetWSObject) to access
Web service data.
Examples The following code instantiates a WSConnection object, then sets the
object as the connection object for a Web service data source:
int ii_return
wsconnection ws_1
ws_1 = create wsconnection
ws_1.username = "johndoe"
ws_1.password = "mypassword"
ws_1.endpoint = "myendpoint"
ws_1.authenticationmode = "basic"
ws_1.usewindowsintegratedauthentication = true
ii_return = dw_1.setwsobject (ws_1)
See also SetTransObject
ShareData
Description Shares data retrieved by one DataWindow control (or DataStore), which is
referred to as the primary DataWindow, with another DataWindow control
(or DataStore), referred to as the secondary DataWindow.
The controls do not share formatting; only the data is shared, including
data in the primary buffer, the delete buffer, the filter buffer, and the sort
order.
Note If you are using ShareData and then use ReselectRow on the primary
DataWindow, the secondary DataWindow resets back to row 1, column 1.

ShareData
Applies to
DataStore object
Syntax PowerBuilder
integer dwprimary.ShareData ( datawindow dwsecondary )
integer dwprimary.ShareData ( datastore dwsecondary )
integer dwprimary.ShareData ( datawindowchild dwsecondary )
dwprimary The name of the primary DataWindow. The primary
DataWindow is the owner of the data. When you destroy this
DataWindow, the data disappears. Dwprimary can be a child
DataWindow but it cannot be a report in a composite
DataWindow object or a Crosstab DataWindow object.
dwsecondary The name of the secondary DataWindow with which the control
dwprimary will share the data. The secondary DataWindow can
be a child DataWindow or a report in a composite DataWindow
object but it cannot be a Crosstab DataWindow object.

Usage The columns must be the same for the DataWindow objects in the primary
and secondary DataWindow controls, but the SELECT statements may be
different. For example, you could share data between DataWindow objects
with these SELECT statements:
SELECT dept_id from dept
SELECT dept_id from dept where dept_id = 200
SELECT dept_id from employee
WHERE clause in secondary has no effect

The WHERE clause in the DataWindow object in the secondary
DataWindow control has no effect on the number of rows returned. The
number of rows returned to both DataWindow controls is determined by
the WHERE clause in the primary DataWindow object.
You could also share data with a DataWindow object that has an external
data source and columns defined to be like the columns in the primary. To
share data between a primary DataWindow and more than one secondary
DataWindow control, call ShareData for each secondary DataWindow
control.
872 PowerBuilder
ShareData shares only the primary buffer of the primary DataWindow

with the primary buffer of the secondary DataWindow. A
DropDownDataWindow in the secondary DataWindow will not display
any data unless you explicitly populate it. You can do this by getting a
handle to the DropDownDataWindow (by calling the GetChild method)
and either retrieving the DropDownDataWindow or using ShareData to
share data from an appropriate data source with the
DropDownDataWindow.
To turn off sharing in a primary or secondary DataWindow, call the
ShareDataOff method. When sharing is turned off for the primary
DataWindow, the secondary DataWindows are disconnected and the data
disappears. However, turning off sharing for a secondary DataWindow
does not affect the data in the primary DataWindow or other secondary
DataWindows.
When you call methods in either the primary or secondary DataWindow
that change the data, PowerBuilder applies them to the primary
DataWindow control and all secondary DataWindow controls are affected.
For example, when you call any of the following methods for a secondary
DataWindow control, PowerBuilder applies it to the primary
DataWindow. Therefore, all messages normally associated with the
method go to the primary DataWindow control. Such methods include:
DeleteRow
Filter
GetSQLSelect
ImportFile
ImportString
ImportClipboard
InsertRow
ReselectRow
Reset
Retrieve
SetFilter
SetSort
SetSQLSelect
Sort
Update
There are some restrictions on the use of ShareData:

• Computed fields in secondary DataWindow controls

ShareData
A secondary DataWindow control can have only data that is in the

primary DataWindow control. If you add a computed field to a
secondary control, it will not display when you run the application
unless you also add it to the primary control.
• Query mode and secondary DataWindows
When you are sharing data, you cannot turn on query mode for a
secondary DataWindow. Trying to set the QueryMode or QuerySort
DataWindow object properties results in an error.
• Crosstab DataWindows
You cannot use ShareData with a Crosstab DataWindow as the
primary or secondary DataWindow.
• Composite and child DataWindows
You can use a report in a Composite DataWindow as the secondary
DataWindow, but not the primary DataWindow. You can use
ShareData with a child DataWindow as the primary or secondary
DataWindow.
• Distributed applications
You cannot share data between a DataWindow control in a client
application and a DataStore in a server application.
Use DataSource with RichTextEdit controls

To share data between a DataStore or DataWindow and a RichTextEdit
control, use the DataSource method.
Examples In this example, the programmer wants to allow the user to view two
portions of the same data retrieved from the database and uses the
ShareData method to accomplish this in the script for the Open event for
the window.
The SELECT statement for both DataWindow objects is the same, but the
DataWindow object in dw_dept displays only two of the five columns
displayed in dw_employee:
dw_employee.Retrieve()
dw_employee.ShareData(dw_dept)
874 PowerBuilder
These statements share data between two DataWindow controls in

different sheets within an MDI frame window:
mdi_sheet_1.dw_dept.SetTransObject(SQLCA)
mdi_sheet_1.dw_dept.Retrieve()
mdi_sheet_1.dw_dept.ShareData(mdi_sheet_2.dw_dept)
This example shares data in a tabular DataWindow with a report in a
Composite DataWindow. The name of the report in the Composite
DataWindow is dw_1:
DataWindowChild dwreport
// Get a reference to the nested report

dw_composite.GetChild("dw_1", dwreport)
dw_tabular.ShareData(dwreport)
See also ShareDataOff
ShareDataOff
Description Turns off the sharing of data buffers for a DataWindow control or
DataStore.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.ShareDataOff ( )
DataWindow
Return value Returns 1 if it succeeds and –1 if an error occurs. If dwcontrol is null,

ShareDataOff returns null.
Usage Two or more DataWindow controls (or DataStores) can share data. See
ShareData for more information about shared data buffers and primary and
secondary DataWindows.

Show
When you call ShareDataOff for a secondary DataWindow, that control no

longer contains data, but the primary DataWindow and other secondary
controls are not affected. When you call ShareDataOff for the primary
DataWindow, all secondary DataWindows are disconnected and no longer
contain data.
Examples These statements establish the sharing of data among three DataWindow
controls and then turn off sharing for one of the secondary DataWindow
controls:
dw_corp.SetTransObject(SQLCA)
dw_corp.Retrieve()
dw_corp.ShareData(dw_emp)
dw_corp.ShareData(dw_dept)
dw_emp.ShareDataOff()
See also ShareData
Show
Description Makes an object or control visible, if it is hidden. If the object is already
visible, Show brings it to the top.
Applies to
Syntax PowerBuilder
integer objectname.Show ( )
objectname The name of the object or control you want to make visible
(show)
Return value Returns 1 if it succeeds and –1 if an error occurs. If objectname is null,

Show returns null.
Inherited from GraphicObject. For more details on use with PowerBuilder
objects, see Show in the PowerScript Reference.
876 PowerBuilder
See also Hide
ShowHeadFoot
Description Displays the panels for editing the header and footer in a RichTextEdit
control or hides the panels and returns to editing the main text.
Applies to
PowerBuilder DataWindow control with RichTextEdit
presentation style
Syntax PowerBuilder
integer rtename.ShowHeadFoot ( boolean editheadfoot,
{headerfooter} )
rtename A reference to the DataWindow control for which you want to
edit header and footer information. The DataWindow must have
a RichTextEdit presentation style.
editheadfoot A boolean value specifying the editing panel to display. Values
are:
• True – Display the header and footer editing panels.
• False – Display the detail editing panel for the document
body.
headerfooter A boolean value specifying whether the insertion point (caret)
(optional) for editing the header/footer panel is in the header or the footer
section. Values are:
• True Caret is in the header section.
• False Caret is in the footer section.

Usage ShowHeadFoot takes effect when the control is in preview mode or when
it is in edit mode for the main text. If the control is in preview mode,
calling ShowHeadFoot returns to edit mode. The value of editheadfoot
determines whether the main text or the header and footer panels display.
The headerfooter argument is ignored if the editheadfoot argument is
false. The headerfooter argument defaults to “true” if a value is not
provided. The header and footer can include input fields for page numbers
and dates.

Sort

You can use the same syntax with any RichTextEdit control. See
ShowHeadFoot in the PowerScript Reference.
See also Preview for RichTextEdit controls in the PowerScript Reference
Sort
Description Sorts the rows in a DataWindow control or DataStore using the
DataWindow’s current sort criteria.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.Sort ( )
DataWindow
Return value Returns 1 if it succeeds and –1 if an error occurs. If dwcontrol is null, Sort
returns null.
Usage Sort uses the current sort criteria for the DataWindow. To change the sort
criteria, use the SetSort method. The SetSort method is equivalent to using
the Sort command on the Rows menu of the DataWindow painter. If you
do not call SetSort to set the sort criteria before you call Sort, Sort uses the
sort criteria specified in the DataWindow object definition.
When the Retrieve method retrieves data for the DataWindow,
PowerBuilder applies the sort criteria that were defined for the
DataWindow object, if any. You need to call Sort only after you change the
sort criteria with SetSort or if the data has changed because of processing
or user input.
For information on letting the user specify sort criteria using the built-in
dialog box, see SetSort.
878 PowerBuilder
When you sort a DataWindow on a specified column, rows with null data
remain at the top, regardless of whether you choose ascending or
descending order for your sort criteria. The sort order is performed on a
result set returned from a database, but is not necessarily the same sort
order used by the database (to return the result set) when an ORDER BY
clause is used in a SQL query.
The Sort method uses a typical lexical sort, with symbols, such as a hyphen
or underline, ranked higher than alphanumeric characters. It compares
characters in the same manner as does a dictionary.
When the Retrieve As Needed option is set, the Sort method cancels its
effect. Sort causes all rows to be retrieved so that they are sorted correctly.
It also changes the current row to 1 without causing the
RowFocusChanged or RowFocusChanging events to fire. These events
should be triggered programmatically after the Sort method is called.
Sort has no effect on the DataWindows in a composite report.
Sorting and groups

To sort a DataWindow object with groups or TreeView levels, call
GroupCalc after you call Sort.
For use with PowerBuilder ListView and TreeView controls, see Sort in
Examples This example sets dw_employee to be sorted by column 1 ascending and

then by column 2 descending. Then it sorts the rows:
dw_employee.SetRedraw(false)
dw_employee.SetSort("#1 A, #2 D")
dw_employee.Sort()
dw_employee.SetRedraw(true)
In this example, the rows in the DataWindow dw_depts are grouped based
on department and the rows are sorted based on employee name. If the user
has changed the department of several employees, then the following
commands apply the sort criteria so that each group is in alphabetical order
and then regroup the rows:
dw_depts.SetRedraw(false)
dw_depts.Sort()
dw_depts.GroupCalc()

TextLine
dw_depts.SetRedraw(true)
See also GroupCalc
SetSort
TextLine
Description Obtains the text of the line that contains the insertion point. TextLine
works for controls that can contain multiple lines.
Applies to
Syntax PowerBuilder
string editname.TextLine ( )
editname A reference to a DataWindow control
Return value Returns the text on the line with the insertion point in editname. If an error
occurs, TextLine returns the empty string (“”). If editname is null, TextLine
returns null.
Usage TextLine reports information about the edit control over the current row
and column.
For use with other PowerBuilder controls, see TextLine in the PowerScript
Reference.
Examples In the DataWindow control dw_letter, if the insertion point is on line 4 in

the edit control and the text on the line is North Carolina, then this example
sets linetext to North Carolina:
string linetext
linetext = dw_letter.TextLine()
See also SelectTextLine
880 PowerBuilder
TriggerEvent
Description Triggers an event associated with the specified object, which executes the
script for that event immediately.
Applies to
DataStore object
Syntax PowerBuilder
integer objectname.TriggerEvent ( trigevent event {, long word,
long long } )
integer objectname.TriggerEvent ( trigevent event {, long word,
string long } )
objectname The name of any PowerBuilder object or control that has events
associated with it.
event A value of the TrigEvent enumerated datatype that identifies a
PowerBuilder event (for example, Clicked!, Modified!, or
DoubleClicked!) or a string whose value is the name of an
event. The event must be a valid event for objectname and a
script must exist for the event in objectname.
word A value to be stored in the WordParm property of the system’s
(optional) Message object. If you want to specify a value for long, but not
word, enter 0. (For cross-platform compatibility, WordParm and
LongParm are both longs.)
long A value or a string that you want to store in the LongParm
(optional) property of the system’s Message object. When you specify a
string, a pointer to the string is stored in the LongParm property,
which you can access with the String function (see Usage).
Return value Returns 1 if it is successful and the event script runs and –1 if the event is
not a valid event for objectname, or no script exists for the event in
objectname. If any argument’s value is null, TriggerEvent returns null.
Usage Inherited from PowerObject. For information, see TriggerEvent in the
See also Post in the PowerScript Reference
PostEvent in the PowerScript Reference
Send in the PowerScript Reference

TypeOf
TypeOf
Description Determines the type of an object or control, reported as a value of the
Object enumerated datatype.
Applies to
DataStore object
Syntax PowerBuilder
object objectname.TypeOf ( )
objectname The name of the object or control for which you want the type
Return value Object enumerated datatype. Returns the type of objectname. If

objectname is null, TypeOf returns null.
Usage Inherited from PowerObject. For information, see TypeOf in the
See also ClassName
Undo
Description Cancels the last edit in an edit control, restoring the text to the content
before the last change.
Applies to
Syntax PowerBuilder
integer editname.Undo ( )
editname A reference to a DataWindow control. Reverses the last edit in
the edit control over the current row and column.
Return value Returns 1 when it succeeds and –1 if an error occurs. If editname is null,
Undo returns null.
882 PowerBuilder
Usage To determine whether the last action can be canceled, call the CanUndo
method.
For examples and for use with other PowerBuilder controls, see Undo in
See also CanUndo
Update
Description Updates the database with the changes made in a DataWindow control or
DataStore. Update can also call AcceptText for the current row and column
before it updates the database.
Applies to
DataStore object
Syntax PowerBuilder
integer dwcontrol.Update ( { boolean accept {, boolean resetflag } } )
DataWindow.
accept A boolean value specifying whether the DataWindow control or
(optional) DataStore should automatically perform an AcceptText prior to
performing the update:
• True – (Default) Perform AcceptText. The update is canceled
if the data fails validation.
• False – Do not perform AcceptText.
resetflag A boolean value specifying whether dwcontrol should
(optional) automatically reset the update flags:
• True – (Default) Reset the flags.
• False – Do not reset the flags.

Update
is null, Update returns null. If there is no DataWindow object assigned to
the DataWindow control or DataStore, this method returns 1.
Usage In PowerBuilder, you must use the SetTrans or the SetTransObject method
to specify the database connection before the Update method will execute.
When you use SetTransObject, the more efficient of the two, you must do
your own transaction management, which includes issuing the SQL
COMMIT or ROLLBACK statement to finalize the update.
Test success/failure code

It is good practice to test the success/failure code after calling Update. You
can also verify the number of rows inserted, updated, and deleted by a
DataWindow update by examining the values of the arguments of the
UpdateEnd event.
By default, Update resets the update flags after successfully completing

the update. However, you can prevent the flags from being reset until you
perform other validations and commit the changes. When you are satisfied
with the update, call ResetUpdate to clear the flags so that items are no
longer marked as modified.
Use SetTransObject when resetflag is False

You would typically use SetTransObject, not SetTrans, to specify the
transaction object for the DataWindow control or DataStore when you
plan to update with the resetflag argument set to false. Only
SetTransObject allows you to control when changes are committed.
If you want to update several tables in one DataWindow control or

DataStore, you can use Modify to change the Update property of columns
in each table. To preserve the status flags of the rows and columns, set the
resetflag argument to false. Because the updates all occur in the same
DataWindow control or DataStore, you cannot allow the flags to be
cleared until all the tables have used them. When all the updates are
successfully completed and committed, you can call ResetUpdate to clear
the changed flags in the DataWindow. For an example of this technique,
see Modify.
884 PowerBuilder
If you are updating multiple DataWindow controls or DataStores as part of

one transaction, set the resetflag argument to false. This will prevent the
DataWindow from “forgetting” which rows to update in case one of the
updates fails. You can roll back, try to correct the situation, and update
again. Once all of the DataWindows have been updated successfully, use
COMMIT to finalize the transaction and use ResetUpdate to reset the
DataWindow’s status flags.
If you call Update with the resetflag argument set to false and do not call
ResetUpdate, the DataWindow will attempt to issue the same SQL
statements again the next time you call Update.
Caution
If you call Update in an ItemChanged event, be sure to set the accept
argument to false to avoid an endless loop and a stack fault. Because
AcceptText triggers an ItemChanged event, you cannot call it in that event
(see AcceptText).
If you call Update in the ItemChanged event, then the item’s old value is
updated in the database, not the newly entered value. The newly entered
value in the edit control is still being validated and does not become the
item value until the ItemChanged event is successfully completed. If you
want to include the new value in an update in the ItemChanged event, use
the appropriate SetItem method first.
Apply GetChanges after deleting rows in a distributed application

If a DataWindow or data store is populated using SetChanges or
SetFullState, and an Update is done that includes deleted rows, the deleted
rows remain in the delete buffer until a subsequent GetChanges is applied
to the DataWindow or data store.
Events Update can trigger these events:

DBError
SQLPreview
UpdateEnd
UpdateStart
If AcceptText is performed, it can trigger these events:
ItemChanged
ItemError

Update
Examples This example connects to the database, specifies a transaction object for
the DataWindow control with SetTransObject, and then updates the
database with the changes made in dw_employee. By default, AcceptText
is performed on the data in the edit control for the current row and column
and the status flags are reset:
This example connects to the database, specifies a transaction object for
the DataWindow control with SetTransObject, and then updates the
database with the changes made in dw_employee. The update resets the
status flags but does not perform AcceptText before updating the database:
dw_Employee.Update(false, true)
As before, this example connects to the database, specifies a transaction
object for the DataWindow control with SetTransObject, and then updates
the database with the changes made in dw_employee. After Update is
executed, the example checks the return code and, depending on the
success of the update, executes a COMMIT or ROLLBACK:
integer rtn

rtn = dw_employee.Update()
IF rtn = 1 THEN
COMMIT USING SQLCA;
ELSE
END IF
See also AcceptText
Modify
ResetUpdate
Print
SaveAs
SetTrans
SetTransObject
886 PowerBuilder

Update
888 PowerBuilder

Update
890 PowerBuilder

Update
892 PowerBuilder

Update
894 PowerBuilder

Update
896 PowerBuilder

Update
898 PowerBuilder

Update
900 PowerBuilder

Update
902 PowerBuilder

Update
904 PowerBuilder

Update
906 PowerBuilder

Update
908 PowerBuilder

Update
910 PowerBuilder

Update
912 PowerBuilder

Update
914 PowerBuilder

Update
916 PowerBuilder
C H A P T E R 1 0 Methods for Graphs in the
DataWindow Control
About this chapter This chapter documents the methods that you can use to manipulate
DataWindow graphs in the PowerBuilder and Web environments. You
will find syntax, notes, and examples for both environments.
Other methods for DataWindows and DataStores are in a separate chapter.
Contents The graph methods are in alphabetical order.
CategoryCount
Description Counts the number of categories on the category axis of a graph.
Applies to PowerBuilder DataWindow DataWindow control
Syntax PowerBuilder
integer dwcontrol.CategoryCount ( string graphcontrol )
dwcontrol A reference to a DataWindow control containing the graph
graphcontrol A string whose value is the name of the graph in the
DataWindow for which you want the number of categories
Return value Returns the count if it succeeds and -1 if an error occurs. If any argument’s
value is null, CategoryCount returns null.
Examples These statements get the number of categories in the graph gr_revenues in
the DataWindow control dw_findata:
integer li_count
li_count = &
dw_findata.CategoryCount("gr_revenues")
See also DataCount
SeriesCount

CategoryName
CategoryName
Description Obtains the category name associated with the specified category number.
Syntax PowerBuilder
string dwcontrol.CategoryName ( string graphcontrol, integer
categorynumber )
dwcontrol A reference to the DataWindow control containing the graph
DataWindow for which you want the name of a specific
category
categorynumber The number of the category for which you want the name
Return value Returns the name of categorynumber in the graph named in graphcontrol. If an
error occurs, it returns the empty string (“”). If any argument’s value is null,
CategoryName returns null.
Usage Categories are numbered consecutively, from 1 to the value returned by
CategoryCount. When you delete a category, the categories are renumbered to
keep the numbering consecutive. You can use CategoryName to find out the
named category associated with a category number.
Examples These statements obtain the name of category 5 in the graph gr_revenues in the
DataWindow control dw_findata:
string ls_name
ls_name = &
dw_findata.CategoryName("gr_revenues", 5)
See also CategoryCount
SeriesName
Clipboard
Description Replaces the contents of the system clipboard with a bitmap image of a graph.
You can paste the image into other applications.
Syntax PowerBuilder
918 PowerBuilder
CHAPTER 10 Methods for Graphs in the DataWindow Control
integer dwcontrol.Clipboard ( string graphcontrol )

DataWindow object
Return value Returns 1 if it succeeds and -1 if an error occurs. If any argument’s value is null,
Clipboard returns null.
Examples This statement copies the graph gr_employees in the DataWindow control
dw_emp_data to the clipboard:
dw_emp_data.Clipboard("gr_employees")
See also Clipboard in the PowerScript Reference
Copy
DataCount
Description Reports the number of data points in the specified series in a graph.
Syntax PowerBuilder
long dwcontrol.DataCount ( string graphcontrol, string seriesname )
graphcontrol The name of the graph in the DataWindow control
seriesname A string whose value is the name of the series for which you want
the number of data points
Return value Returns the number of data points in the specified series if it succeeds and -1 if
an error occurs. If any argument’s value is null, DataCount returns null.
Examples These statements store in ll_count the number of data points in the series
named Salary in the graph gr_dept in the DataWindow control dw_employees:
long ll_count
ll_count = &
dw_employees.DataCount("gr_dept", "Salary")
See also SeriesCount

FindCategory
FindCategory
Description Obtains the number of a category in a graph when you know the category’s
label. The category values label the category axis.
Syntax PowerBuilder
integer dwcontrol.FindCategory ( string graphcontrol,
date categoryvalue )
datetime categoryvalue )
double categoryvalue )
string categoryvalue )
time categoryvalue )
dwcontrol A reference to the DataWindow control containing the graph.
graphcontrol A string whose value is the name of the graph in the DataWindow
control.
categoryvalue A value that is the category for which you want the number. The
value you specify must be the same datatype as the datatype of
the category axis.
Return value Returns the number of the category named in categoryvalue in the graph. If an
error occurs, FindCategory returns -1. If any argument’s value is null,
FindCategory returns null.
Usage Most of the category manipulation functions require a category number, rather
than a name. However, when you delete and insert categories, existing
categories are renumbered to keep the numbering consecutive. Use
FindCategory when you know only a category’s label or when the numbering
might have changed.
Examples These statements obtain the number of the category named Qty in the graph
gr_computers in the DataWindow control dw_equipment:
integer CategoryNbr
CategoryNbr = &
dw_equipment.FindCategory("gr_computers", "Qty")
See also FindSeries
920 PowerBuilder
FindSeries
Description Obtains the number of a series in a graph when you know the series’ name.
Syntax PowerBuilder
integer dwcontrol.FindSeries ( string graphcontrol, string seriesname )
control
seriesname A string whose value is the name of the series for which you want
the number
Return value Returns the number of the series named in seriesname in the graph. If an error
occurs, FindSeries returns -1. If any argument’s value is null, FindSeries returns
null.
Usage Most of the series manipulation functions require a series number, rather than
a name. Use FindSeries when you know only a series’ name or when the
numbering might have changed.
Examples These statements obtain the number of the series named PCs in the graph
gr_computers in the DataWindow control dw_equipment and store it in
SeriesNbr:
integer SeriesNbr
SeriesNbr = &
dw_equipment.FindSeries("gr_computers", "PCs")
See also FindCategory
GetData
Description Gets the value of a data point in a series in a graph when the values axis has
numeric values.
Syntax PowerBuilder
double dwcontrol.GetData ( string graphcontrol, integer seriesnumber,
long datapoint , { grDataType datatype } )

GetData
DataWindow control.
seriesnumber The number that identifies the series from which you want
data.
datapoint The number of the data point for which you want the value.
datatype A value of the grDataType enumerated datatype (in
(scatter graph only) PowerBuilder) specifying whether you want the x or y value
(optional) of the data point in a scatter graph.
Values are:
• xValue! – The x value of the data point.
• yValue! – (Default) The y value of the data point.
For more information, see grDataType on page 488.
Return value Returns the value of the data in datapoint if it succeeds, 0 if the series does not
exist, and -1 if an error occurs. If any argument’s value is null, GetData returns
null.
Usage You can use GetData only for graphs whose values axis is numeric. For graphs
with other types of values axes, use the GetDataValue method instead.
Examples These statements obtain the data value of data point 3 in the series named Costs
in the graph gr_computers in the DataWindow control dw_equipment:
integer SeriesNbr
double data_value
// Get the number of the series.

SeriesNbr = &
dw_equipment.FindSeries("gr_computers", "Costs")
data_value = dw_equipment.GetData( &
"gr_computers" , SeriesNbr, 3)
These statements obtain the x value of the data point in the scatter graph
gr_sales_yr in the DataWindow dw_sales and store it in data_value:
integer SeriesNbr, ItemNbr
double data_value
dw_sales.ObjectAtPointer("gr_sales_yr", SeriesNbr, &

ItemNbr)
data_value = dw_sales.GetData("gr_sales_yr", &
SeriesNbr, ItemNbr, xValue!)
922 PowerBuilder
See also FindSeries

GetDataValue
ObjectAtPointer
GetDataDateVariable
Description Returns the value associated with a data point in a graph in a DataWindow
object when the values axis has the date datatype. You must call GetDataDate
first to retrieve the line style information. (GetDataDate is based on
GetDataValue and is documented in that entry.)
Obsolete method
GetDataDateVariable is obsolete and should not be used, because the
Applies to DataWindow Web ActiveX DataWindow control

Syntax Web ActiveX
Date dwcontrol.GetDataDateVariable ( )
Return value Returns a date value associated with a data point in a graph.
Usage To find out the value of a data point, call one of the GetData methods to retrieve
the information, then immediately afterward, call one of the GetDataVariable
methods and examine the return value.
For a values axis of Call this method to set Then call this method
type up the value to return the value
Date, DateTime, or time GetDataDate GetDataDateVariable
Number or double GetDataNumber GetDataNumberVariable
String GetDataString GetDataStringVariable
For information on the GetData methods, see GetDataValue.

See also GetDataValue

GetDataLabelling
GetDataLabelling
Description Determines whether the data at a given data point is labeled in a DirectX 3D
graph.
Syntax integer dwcontrol.GetDataLabelling (string graphcontrol, string series, int
datapoint, REF boolean value)
DataWindow control.
series The string that identifies the series in which you want the data
labelling value.
datapoint The data point for which you want to obtain a label.
value Boolean passed by reference to indicate whether the data point
has a label.
GetDataLabelling returns null.
Usage GetDataLabelling determines whether a data label is set for data points from
DirectX 3D Area, Bar, Col, or Line graphs. You cannot use this method with
DirectX 3D Pie graphs.
Examples In a DataWindow Clicked event, these statements obtain the number of the
series and data point clicked by the user and determine whether the label is set
for that data point.
boolean refB
grObjectType clickedtype
// Get the number of the series and data point

clickedtype = this.ObjectAtPointer("gr_1", &
SeriesNbr, ItemNbr)
// Get data label

this.GetDataLabelling("gr_1", SeriesNbr, &
ItemNbr, refB)
See also GetSeriesLabelling
SetDataLabelling
SetSeriesLabelling
924 PowerBuilder
GetDataNumberVariable
object when the values axis has a numeric datatype. You must call
GetDataNumber first to retrieve the line style information. (GetDataNumber is
based on GetDataValue and is documented in that entry.)
Obsolete method
GetDataNumberVariable is obsolete and should not be used, because the

Syntax Web ActiveX
number dwcontrol.GetDataNumberVariable ( )
Return value Returns a number value associated with a data point in a graph.

GetDataPieExplode
Description Reports the percentage of the pie graph’s radius that a pie slice is moved away
from the center of the pie graph. An exploded slice is moved away from the
center of the pie in order to draw attention to the data.

GetDataPieExplode
Syntax PowerBuilder
integer dwcontrol.GetDataPieExplode ( string graphcontrol, integer
series, integer datapoint, REF integer percentage )
DataWindow control
series The number that identifies the series
datapoint The number of the exploded data point (that is, the pie slice)
percentage An integer variable in which you want to store the percentage
that the pie slice is exploded
GetDataPieExplode returns null.
Examples This example reports the percentage that a pie slice is exploded when the user
clicks on that slice. The code checks whether the graph is a pie graph using the
property GraphType. It then finds out whether the user clicked on a pie slice by
checking the series and data point values set by ObjectAtPointer. The script is
for the DoubleClicked event of a graph control:
integer series, datapoint
integer percentage
percentage = 50
IF (This.GraphType <> PieGraph! and &
This.GraphType <> Pie3D!) THEN RETURN
clickedtype = This.ObjectAtPointer(series, &
datapoint)
IF (series > 0 and datapoint > 0) THEN

This.GetDataPieExplode("gr_sales_yr", series, &
datapoint, percentage)
MessageBox("Explosion Percentage", &
"Data point " + This.CategoryName(datapoint)
&
+ " in series " + This.SeriesName(series) &
+ " is exploded " + String(percentage) + "%")
END IF
See also GetDataPieExplodePercentage
SetDataPieExplode
926 PowerBuilder
GetDataPieExplodePercentage
Description Returns the percentage value that a slice is exploded in a pie graph in a
DataWindow object. You must call GetDataPieExplode first to retrieve the
information and then call this method to get the value.
Obsolete method
GetDataPieExplodePercentage is obsolete and should not be used, because the

Syntax Web ActiveX
number dwcontrol.GetDataPieExplodePercentage ( )
Return value Returns a number specifying how much the pie slice is exploded.
Usage To find out the percentage of the pie graphs’s radius that a pie slice is moved
away from the center of the pie graph, call GetDataPieExplode to retrieve the
information, then immediately afterward, call GetDataPieExplodePercentage
and examine the return value.
See also GetDataPieExplode
SetDataPieExplode
GetDataStringVariable
object when the values axis has the string datatype. You must call
GetDataString first to retrieve the line style information. (GetDataString is based
on GetDataValue and is documented in that entry.)
Obsolete method
GetDataStringVariable is obsolete and should not be used, because the

GetDataStyle
Syntax Web ActiveX

string dwcontrol.GetDataStringVariable ( )
Return value String. Returns a string value associated with a data point in a graph.

GetDataStyle
Finds out the appearance of a data point in a graph. Each data point in a series
can have individual appearance settings. There are different syntaxes,
depending on what settings you want to check.
To get the Use
Data point’s colors (called GetDataStyleColor in JavaScript) Syntax 1
Line style and width used by the data point (called Syntax 2
GetDataStyleLine in JavaScript)
Fill pattern for the data point (called GetDataStyleFill in Syntax 3
JavaScript)
Symbol for the data point (called GetDataStyleSymbol in Syntax 4
JavaScript)
928 PowerBuilder
GetDataStyle provides information about a single data point. The series to

which the data point belongs has its own style settings. In general, the style
values for the data point are the same as its series’ settings. Use SetDataStyle
to change the style values for individual data points. Use GetSeriesStyle and
SetSeriesStyle to get and set style information for the series.
The graph stores style information for properties that do not apply to the
current graph type. For example, you can find out the fill pattern for a data
point or a series in a 2-dimensional line graph, but that fill pattern will not be
visible.
Syntax 1 For the colors of a data point

Description Obtains the colors associated with a data point in a graph.
Syntax PowerBuilder
integer dwcontrol.GetDataStyle ( string graphcontrol, integer
seriesnumber, integer datapointnumber, grColorType colortype, REF
long colorvariable )
DataWindow control.
seriesnumber The number of the series in which you want the color of a data
point.
datapointnumber The number of the data point for which you want the color.
colortype A value of the grColorType enumerated datatype (in
PowerBuilder) or an integer (in JavaScript) specifying the
aspect of the data point for which you want the color.
For a list of values, see grColorType on page 488.
colorvariable In PowerBuilder, a long variable in which you want to store
the color.
Return value Returns 1 if it succeeds and -1 if an error occurs. In PowerBuilder, GetDataStyle

stores an RGB color value in colorvariable. If any argument’s value is null,
GetDataStyle returns null.
Examples This example gets the background color used for data point 6 in the series
entered in the SingleLineEdit sle_series in the DataWindow graph
gr_emp_data. It stores the color value in the variable color_nbr:

GetDataStyle
long color_nbr
integer SeriesNbr
// Get the number of the series

SeriesNbr = &
FindSeries("gr_emp_data", sle_series.Text)
// Get the color

dw_emp_data.GetDataStyle("gr_emp_data", &
SeriesNbr, 6, Background!, color_nbr)
See also FindSeries
GetSeriesStyle
SetDataStyle
SetSeriesStyle
Syntax 2 For the line style and width used by a data point
Description Obtains the line style and width for a data point in a graph.
Syntax PowerBuilder
seriesnumber, integer datapointnumber, REF LineStyle linestyle, REF
integer linewidth )
DataWindow control.
seriesnumber The number of the series in which you want the line style and
width of a data point.
datapointnumber The number of the data point for which you want the line style
and width.
linestyle In PowerBuilder, a variable of type LineStyle in which you
want to store the line style.
For a list of line style values, see LineStyle on page 490.
linewidth In PowerBuilder, an integer variable in which you want to
store the width of the line. The width is measured in pixels.
930 PowerBuilder
Return value Returns 1 if it succeeds and -1 if an error occurs. In PowerBuilder, for the
specified series and data point, GetDataStyle stores its line style in linestyle and
the line’s width in linewidth. If any argument’s value is null, GetDataStyle
returns null.
Examples This example gets the line style and width for data point 6 in the series entered
in the SingleLineEdit sle_series in the graph gr_depts in the DataWindow
control dw_employees. The information is stored in the variables line_style
and line_width:
integer SeriesNbr, line_width
LineStyle line_style

SeriesNbr = dw_employees.FindSeries( &
"gr_depts", sle_series.Text)
// Get the line style and width

dw_employees.GetDataStyle("gr_depts", SeriesNbr, &
6, line_style, line_width)
See also FindSeries
GetDataStyleLineStyle
GetDataStyleLineWidth
GetSeriesStyle
SetDataStyle
SetSeriesStyle
Syntax 3 For the fill pattern of a data point

Description Obtains the fill pattern of a data point in a graph.
Syntax PowerBuilder
seriesnumber, integer datapointnumber, REF FillPattern fillvariable )
DataWindow control.
seriesnumber The number of the series in which you want the fill pattern of
a data point.

GetDataStyle
datapointnumber The number of the data point for which you want the fill
pattern.
fillvariable In PowerBuilder, a variable of type FillPattern in which you
want to store the fill pattern value.
For a list of values, see FillPattern on page 487.
Return value Returns 1 if it succeeds and -1 if an error occurs. In PowerBuilder, GetDataStyle

stores a value of the FillPattern enumerated datatype representing the fill
pattern used for the specified data point. If any argument’s value is null,
Examples This example gets the pattern used to fill data point 6 in the series entered in
the SingleLineEdit sle_series in the graph gr_depts in the DataWindow control
dw_employees. The information is assigned to the variable data_pattern:
integer SeriesNbr
FillPattern data_pattern

SeriesNbr = dw_employees.FindSeries("gr_depts", &
sle_series.Text)
// Get the pattern

6, data_pattern)
See also FindSeries
GetDataStyleFillPattern
GetSeriesStyle
SetDataStyle
SetSeriesStyle
Syntax 4 For the symbol of a data point

Description Obtains the symbol of a data point in a graph.
Syntax PowerBuilder
seriesnumber, integer datapointnumber, REF grSymbolType
symbolvariable )
932 PowerBuilder
DataWindow control.
seriesnumber The number of the series in which you want the symbol type
of a data point.
datapointnumber The number of the data point for which you want the symbol
type.
symbolvariable In PowerBuilder, a variable of type grSymbolType in which
you want to store the symbol type.
For a list of values, see grSymbolType on page 490.
Return value Returns 1 if it succeeds and -1 if an error occurs. Stores, according to the type
of symbolvariable, a value of that enumerated datatype representing the
symbol used for the specified data point. If any argument’s value is null,
Examples These statements store the symbol for a data point in the variable symbol_type.
The data point is the sixth point in the series named in the SingleLineEdit
sle_series in the graph gr_depts in the DataWindow control dw_employees:
integer SeriesNbr
grSymbolType symbol_type

SeriesNbr = dw_employees.FindSeries("gr_depts", &
sle_series.Text)
// Get the symbol

6, symbol_type)
See also FindSeries
GetDataStyleSymbolValue
GetSeriesStyle
SetDataStyle
SetSeriesStyle

GetDataStyleColorValue
GetDataStyleColorValue
Description Returns the color value associated with a data point in a graph in a
DataWindow object. You must call GetDataStyleColor first to retrieve the color
information. (See GetDataStyle for information about this method.)
Obsolete method
GetDataStyleColorValue is obsolete and should not be used, because the

Syntax Web ActiveX
number dwcontrol.GetDataStyleColorValue ( )
Return value Returns an RGB color value.

Usage To find out the color associated with a data point, call GetDataStyleColor to
retrieve the information, then immediately afterward, call
GetDataStyleColorValue and examine the return value.
The color for a data point overrides the color setting for the series.
GetDataStyleFillPattern
Description Returns the fill pattern associated with a data point in a graph in a DataWindow
object. You must call GetDataStyleFill first to retrieve the fill information. (See
GetDataStyle for information about this method.)
Obsolete method
GetDataStyleFillPattern is obsolete and should not be used, because the

Syntax Web ActiveX
934 PowerBuilder
number dwcontrol.GetDataStyleFillPattern ( )
Return value Returns an integer representing the fill pattern.

For a list of values and their meanings, see FillPattern on page 487.
Usage To find out the fill pattern associated with a data point, call GetDataStyleFill to
GetDataStyleFillPattern and examine the return value.
The fill pattern for a data point overrides the fill pattern setting for the series.
Description Returns the line style associated with a data point in a graph in a DataWindow
object. You must call GetDataStyleLine first to retrieve the line style
Obsolete method
GetDataStyleLineStyle is obsolete and should not be used, because the

Syntax Web ActiveX
number dwcontrol.GetDataStyleLineStyle ( )
Return value Returns an integer representing the line style.

For a list of values and their meanings, see LineStyle on page 490.
Usage To find out the line width or line style associated with a data point, call
GetDataStyleLine to retrieve the information, then immediately afterward, call
GetDataStyleLineWidth and GetDataStyleLineStyle and examine the return
values.

The line style for a data point overrides the setting for the series.
Description Returns the line width associated with a data point in a graph in a DataWindow
object. You must call GetDataStyleLine first to retrieve the line style
Obsolete method
GetDataStyleLineWidth is obsolete and should not be used, because the

Syntax Web ActiveX
number dwcontrol.GetDataStyleLineWidth ( )
Return value Returns the width of the line in pixels.

Usage To find out the line width or line style associated with a data point, call
GetDataStyleLine to retrieve the information, then immediately afterward, call
GetDataStyleLineWidth and GetDataStyleLineStyle and examine the return
values.
The line width for a data point overrides the setting for the series.
GetDataStyleSymbolValue
Description Returns the symbol associated with a data point in a graph in a DataWindow
object. You must call GetDataStyleSymbol first to retrieve the symbol
936 PowerBuilder
Obsolete method
GetDataStyleSymbolValue is obsolete and should not be used, because the

Syntax Web ActiveX
number dwcontrol.GetDataStyleSymbolValue ( )
Return value Returns an integer representing data point’s symbol. For a list of values and
their meanings, see grSymbolType on page 490.
Usage To find out the symbol associated with a data point, call GetDataStyleSymbol to
GetDataStyleSymbolValue and examine the return value.
The symbol for a data point overrides the setting for the series.
GetDataTransparency
Description Obtains the transparency percentage of a data point in a DirectX 3D graph
(those with 3D rendering).
Syntax integer dwcontrol.GetDataTransparency ( string graphcontrol, integer
seriesnumber, int datapoint, REF int transparency)
DataWindow control.
data.
datapoint The number of the data point for which you want the
transparency value.

GetDataValue
transparency Integer value for percent transparency. A value of 0 means that
the data point is opaque and a value of 100 means that it is
completely transparent.
GetDataTransparency returns null.
Usage GetDataTransparency retrieves data from any DirectX 3D graph (those with 3D
rendering).
Examples These statements obtain the transparency percentage of data point 3 in the
series named Costs in the graph gr_computers in the DataWindow control
dw_equipment:
integer SeriesNbr, rtn, transp_value

SeriesNbr = dw_equipment.FindSeries( &
"gr_computers", "Costs")
rtn = dw_equipment.GetDataTransparency( &
"gr_computers" , SeriesNbr, 3, transp_value)
See also FindSeries
GetSeriesTransparency
SetSeriesTransparency
SetDataTransparency
GetDataValue
Description Obtains the value of a data point in a series in a graph.
Syntax PowerBuilder
integer dwcontrol.GetDataValue ( string graphcontrol,
integer seriesnumber, long datapoint, REF date datavariable
{, grDataType XorY } )
integer seriesnumber, long datapoint, REF datetime datavariable
integer seriesnumber, long datapoint, REF double datavariable
938 PowerBuilder

integer seriesnumber, long datapoint, REF string datavariable
integer seriesnumber, long datapoint, REF time datavariable
DataWindow control.
data.
datapoint The number of the data point for which you want the value.
datavariable The name of a variable that will hold the data value. The
variable’s datatype can be date, DateTime, double, string, or
time. The variable must have the same datatype as the values
axis of the graph.
xory A value of the grDataType enumerated datatype (in
(scatter graph only) PowerBuilder) specifying whether you want the x or y value
(optional) of the data point in a scatter graph.
For values, see grDataType on page 488.
GetDataValue returns null.
Usage GetDataValue retrieves data from any graph. The data is stored in datavariable,
whose datatype must match the datatype of the graph’s values axis, or returned
by a method that corresponds to the axis datatype. If the values axis is numeric,
you can also use the GetData function.
Calling GetDataValue when the datatype of datavariable is not the same as the
datatype of the data produces undefined results.
If a variable’s datatype is non-numeric and the datatype of datavariable is
double, GetDataValue returns the number of the datapoint in datavariable.
If a variable’s datatype is date, time, or DateTime, GetDataValue returns 1 when

the datatype of datavariable is any of those datatypes. However, if the
variable’s datatype is time and the datatype of datavariable is date,
GetDataValue returns 00/00/00 in datavariable, and if the variable’s datatype is
date and the datatype of datavariable is time, GetDataValue returns 00:00:00 in
datavariable.
Examples These statements obtain the data value of data point 3 in the series named Costs

GetSeriesLabelling
integer SeriesNbr, rtn

double data_value

rtn = dw_equipment.GetDataValue( &
"gr_computers" , SeriesNbr, 3, data_value)
See also FindSeries
ObjectAtPointer
GetSeriesLabelling
Description Determines whether the data for a given series is labeled in a DirectX 3D
graph.
Syntax integer dwcontrol.GetSeriesLabelling (string graphcontrol, string series,
REF boolean value)
DataWindow control.
series The string that names the series in which you want the series
label setting.
value A boolean passed by reference to indicate whether the series
has labels.
GetSeriesLabelling returns null.
Usage GetSeriesLabelling retrieves the data from DirectX 3D Area, Bar, Col, or Line
graphs. You cannot use this method with DirectX 3D Pie graphs.
Examples These statements obtain the number of the series and data point for the graph
gr_1 in the DataWindow control dw_employee and then get the series label
setting.
boolean refB
string ls_SeriesName
940 PowerBuilder
// Get the number of the series and datapoint

SeriesNbr, ItemNbr)
//Get the name of series

ls_SeriesName = dw_employee.SeriesName("gr_1", &
SeriesNbr)
// Get Series label

dw_employee.GetSeriesLabelling("gr_1", &
ls_SeriesName, refB)
See also GetDataLabelling
SetDataLabelling
SetSeriesLabelling
GetSeriesStyle
Finds out the appearance of a series in a graph. The appearance settings for
individual data points can override the series settings, so the values obtained
from GetSeriesStyle might not reflect the current state of the graph. There are
several syntaxes, depending on what settings you want.
To Use
Get the series’ colors Syntax 1
Get the line style and width used by the series Syntax 2
Get the fill pattern for the series Syntax 3
Get the symbol for data points in the series Syntax 4
Find out if the series is an overlay (a series shown as a line on top of Syntax 5
another graph type)
GetSeriesStyle provides information about a series. The data points in the series
can have their own style settings. Use SetSeriesStyle to change the style values
for a series. Use GetDataStyle to get style information for a data point and
SetDataStyle to override series settings and set style information for individual
data points.

GetSeriesStyle
current graph type. For example, you can find out the fill pattern for a data
point or a series in a two-dimensional line graph, but that fill pattern will not
be visible.
Syntax 1 For the colors of a series

Description Obtains the colors associated with a series in a graph.
Syntax PowerBuilder
integer dwcontrol.GetSeriesStyle ( string graphcontrol, string
seriesname, grColorType colortype, REF long colorvariable )
DataWindow control.
seriesname A string whose value is the name of the series for which you
want the color.
PowerBuilder) specifying the aspect of the series for which
you want the color.
colorvariable In PowerBuilder, a long variable in which you want to store
the color’s RGB value.
Return value Returns 1 if it succeeds and -1 if an error occurs. In PowerBuilder, stores in

colorvariable the RGB value of the specified series and item. If any argument’s
value is null, GetSeriesStyle returns null.
Examples These statements store in the variable color_nbr the background color used for
the series PCs in the graph gr_computers in the DataWindow control
dw_equipment:
long color_nbr
// Get the color.
dw_equipment.GetSeriesStyle("gr_computers", &
"PCs", Background!, color_nbr)
GetSeriesStyleColorValue
FindSeries
942 PowerBuilder
SetDataStyle
SetSeriesStyle
Syntax 2 For the line style and width used by a series

Description Obtains the line style and width for a series in a graph.
Syntax PowerBuilder
seriesname, REF LineStyle linestyle {, REF integer linewidth } )
DataWindow control.
want the line style information.
linestyle In PowerBuilder, a variable of type LineStyle in which you
want to store the line style of seriesname. For a list of values,
see LineStyle on page 490.
linewidth In PowerBuilder, an integer variable in which you want to
(optional) store the line width for seriesname. The width is measured in
pixels.

linestyle a value of the LineStyle enumerated datatype and in linewidth the
width of the line used for the specified series. If any argument’s value is null,
GetSeriesStyle returns null.
Examples These statements store in the variables line_style and line_width the line style
and width for the series under the mouse pointer in the graph gr_product_data:
string SeriesName
integer SeriesNbr, Data_Point, line_width
grObjectType MouseHit
MouseHit = dw_equipment.ObjectAtPointer &

("gr_product_data", SeriesNbr, Data_Point)
IF MouseHit = TypeSeries! THEN

SeriesName = &

GetSeriesStyle
dw_equipment.SeriesName("gr_product_data", &
SeriesNbr)
dw_equipment.GetSeriesStyle ("gr_product_data", &

SeriesName, line_style, line_width)
END IF
GetSeriesStyleLineWidth
FindSeries
SetDataStyle
SetSeriesStyle
Syntax 3 For the fill pattern of a series

Description Obtains the fill pattern of a series in a graph.
Syntax PowerBuilder
seriesname, REF FillPattern fillvariable )
DataWindow control.
want the style information.
fillvariable In PowerBuilder, a variable of type FillPattern in which you
want to store the fill pattern value. For a list of values, see
FillPattern on page 487.

fillvariable identifying the fill pattern for the specified series. If any argument’s
value is null, GetSeriesStyle returns null.
Examples This example stores in the variable data_pattern the fill pattern for the series
under the pointer in the graph gr_depts in the DataWindow control
dw_employees. It then sets the fill pattern for the series Total Salary in the
graph gr_dept_data to that pattern:
string SeriesName
integer SeriesNbr, Data_Point
944 PowerBuilder
FillPattern data_pattern
MouseHit = dw_employees.ObjectAtPointer("gr_depts" , &

SeriesNbr, Data_Point)

SeriesName = &
dw_employees.SeriesName("gr_depts" ,
SeriesNbr)
dw_employees.GetSeriesStyle("gr_depts" , &
SeriesName, data_pattern)
gr_dept_data.SetSeriesStyle("Total Salary", &

data_pattern)
END IF
GetSeriesStyleFillPattern
FindSeries
SetDataStyle
SetSeriesStyle
Syntax 4 For the symbol of a series

Description Obtains the symbol used for data points in a series in a graph.
Syntax PowerBuilder
seriesname, REF grSymbolType symbolvariable )
DataWindow control.
want the style information.
symbolvariable In PowerBuilder, the variable of type grSymbolType in which
you want to store the symbol value.

GetSeriesStyle

symbolvariable a value of the grSymbolType enumerated datatype for the
symbol used for the specified series. If any argument’s value is null,
GetSeriesStyle returns null.
Examples This example stores in the variable data_pattern the fill pattern for the series
under the pointer in the graph gr_depts in the DataWindow control
dw_employees. It then sets the fill pattern for the series Total Salary in the
graph gr_dept_data to that pattern:
string SeriesName
grSymbolType symbol
MouseHit = dw_employees.ObjectAtPointer("gr_depts" , &

SeriesNbr, Data_Point)

SeriesName = &
dw_employees.SeriesName("gr_depts" , SeriesNbr)
dw_employees.GetSeriesStyle("gr_depts" , &
SeriesName, symbol
gr_dept_data.SetSeriesStyle("Total Salary", &
symbol)
END IF
GetSeriesStyleSymbolValue
FindSeries
SetDataStyle
SetSeriesStyle
Syntax 5 For determining whether a series is an overlay

Description Reports whether a series in a graph is an overlay—whether it is shown as a line
on top of another graph type.
Syntax PowerBuilder
seriesname, REF boolean overlayindicator )
946 PowerBuilder
DataWindow control.
want the overlay status.
overlayindicator In PowerBuilder, a boolean variable in which you want to
store a value indicating whether the series is an overlay.
GetSeriesStyle sets overlayindicator to true if the series is an
overlay and false if it is not.

overlayindicator true if the specified series is an overlay and false if it is not.
If any argument’s value is null, GetSeriesStyle returns null.
See also GetSeriesStyleOverlayValue
GetSeriesStyleColorValue
Description Returns the color value associated with a series in a graph in a DataWindow
object. You must call GetSeriesStyleColor first to retrieve the color information.
(See GetSeriesStyle for information about this method.)
Obsolete method
GetSeriesStyleColorValue is obsolete and should not be used, because the

Syntax Web ActiveX
number dwcontrol.GetSeriesStyleColorValue ( )
Return value Returns an RGB color value.

Usage To find out the color associated with a series, call GetSeriesStyleColor to
GetSeriesStyleColorValue and examine the return value.

Since data points in a series can have their own style settings, the color setting
for a series might not match the color for a specific data point within that series.
See also GetSeriesStyle
Description Returns the fill pattern associated with a series in a graph in a DataWindow
object. You must call GetSeriesStyleFill first to retrieve the fill information.
Obsolete method
GetSeriesStyleFillPattern is obsolete and should not be used, because the

Syntax Web ActiveX
number dwcontrol.GetSeriesStyleFillPattern ( )
Return value Returns an integer representing the fill pattern.

For a list of values and their meanings, see FillPattern on page 487.
Usage To find out the fill pattern associated with a series, call GetSeriesStyleFill to
GetSeriesStyleFillPattern and examine the return value.
Since data points in a series can have their own style settings, the fill pattern
for a series might not match the fill pattern for a specific data point within that
series.
948 PowerBuilder
GetSeriesStyleLineStyle
Description Returns the line style associated with a series in a graph in a DataWindow
object. You must call GetSeriesStyleLine first to retrieve the line style
information. (See GetSeriesStyle for information about this method.)
Obsolete method
GetSeriesStyleLineStyle is obsolete and should not be used, because the

Syntax Web ActiveX
number dwcontrol.GetSeriesStyleLineStyle ( )
Return value Returns an integer representing the line style.

For a list of possible values and their meanings, see LineStyle on page 490.
Usage To find out the line width or line style associated with a series, call
GetSeriesStyleLine to retrieve the information, then immediately afterward,
call GetSeriesStyleLineWidth and GetSeriesStyleLineStyle and examine the
return values.
Since data points in a series can have their own style settings, the line style for
a series might not match the line style for a specific data point within that
series.
GetSeriesStyleLineWidth
Description Returns the line width associated with a series in a graph in a DataWindow
object. You must call GetSeriesStyleLine first to retrieve the line style
information. (See GetSeriesStyle for information about this method.)

GetSeriesStyleOverlayValue
Obsolete method
GetSeriesStyleLineWidth is obsolete and should not be used, because the

Syntax Web ActiveX
number dwcontrol.GetSeriesStyleLineWidth ( )
Return value Returns the width of the line in pixels.

Usage To find out the line width or line style associated with a series, call
GetSeriesStyleLine to retrieve the information, then immediately afterward,
call GetSeriesStyleLineWidth and GetSeriesStyleLineStyle and examine the
return values.
Since data points in a series can have their own style settings, the line width for
a series might not match the line width for a specific data point within that
series.
GetSeriesStyleLineStyle
GetSeriesStyleOverlayValue
Description Returns a value indicating whether a series is an overlay, that is, whether it is
shown on top of another graph type. You must call GetSeriesStyleOverlay first
to retrieve the overlay information. (See GetSeriesStyle for information about
this method.)
Obsolete method
GetSeriesStyleOverlayValue is obsolete and should not be used, because the

Syntax Web ActiveX
boolean dwcontrol.GetSeriesStyleOverlayValue ( )
950 PowerBuilder
Return value Returns true if the series is an overlay and false if it is not.
Usage To find out whether a series is an overlay, call GetSeriesStyleOverlay to retrieve
the information, then immediately afterward, call GetSeriesStyleOverlayValue
and examine the return value.
GetSeriesStyleSymbolValue
Description Returns the symbol associated with a series in a graph in a DataWindow object.
You must call GetSeriesStyleLine first to retrieve the line style information.
Obsolete method
GetSeriesStyleOverlayValueGetSeriesStyleSymbolValue is obsolete and should
not be used, because the DataWindow Web Control for ActiveX technology is
obsolete.

Syntax Web ActiveX
number dwcontrol.GetSeriesStyleSymbolValue ( )
Return value Returns an integer representing a data point’s symbol.

For a list of values and their meanings, see grSymbolType on page 490.
Usage To find out the symbol associated with a series, call GetSeriesStyleSymbol to
GetSeriesStyleSymbolValue and examine the return value.
Since data points in a series can have their own style settings, the symbol for a
series might not match the symbol for a specific data point within that series.

Description Obtains the transparency percentage of a series in a DirectX 3D graph (those
with 3D rendering).
Syntax integer dwcontrol.GetSeriesTransparency ( string graphcontrol, string
series, REF int transparency)
DataWindow control.
series The string that identifies the series from which you want the
transparency value.
the series is opaque and a value of 100 means that it is
GetSeriesTransparency returns null.
Usage GetSeriesTransparency retrieves data from any DirectX 3D graph (those with
3D rendering).
Examples These statements obtain the transparency percentage of the series named Costs
integer SeriesNbr, rtn, ser_transp_value

rtn = dw_equipment.GetSeriesTransparency( &
"gr_computers" , SeriesNbr, ser_transp_value)
See also FindSeries
GetDataTransparency
SetDataTransparency
952 PowerBuilder
ObjectAtPointer
Description Finds out where the user clicked in a graph. ObjectAtPointer reports the region
of the graph under the pointer and stores the associated series and data point
numbers in the designated variables.
Syntax PowerBuilder
grObjectType dwcontrol.ObjectAtPointer ( string graphcontrol, REF
integer seriesnumber, REF integer datapoint )
control.
seriesnumber In PowerBuilder, an integer variable in which you want to store the
number of the series under the pointer.
datapoint In PowerBuilder, an integer variable in which you want to store the
number of the data point under the pointer.
Return value Returns a value of the grObjectType enumerated datatype identifying the type
of object under the pointer if the user clicks anywhere in the graph (including
an empty area) and a null value if the user clicks outside the graph.
For a list of type values, see grObjectType on page 489.
Usage The ObjectAtPointer function allows you to find out how the user is interacting
with the graph. The function returns a value of the grObjectType enumerated
datatype identifying the part of the graph. When the user clicks in a series, data
point, or category, ObjectAtPointer stores the series and/or data point numbers
in designated variables.
When the user clicks a data point (or other data mark, such as line or bar), or
on the series labels in the legend, ObjectAtPointer stores the series number in
the designated variable. When the user clicks on a data point or category
tickmark label, ObjectAtPointer stores the data point number in the designated
variable.
When the user clicks in a series, but not on the actual data point,
ObjectAtPointer stores 0 in datapoint and when the user clicks in a category,
ObjectAtPointer stores 0 in seriesnumber. When the user clicks other parts of
the graph, ObjectAtPointer stores 0 in both variables.

ObjectAtPointerDataPoint
Examples PowerBuilder These statements store the series number and data point
number at the pointer location in the graph named gr_computers in the
DataWindow control dw_equipment in SeriesNbr and ItemNbr:
dw_equipment.ObjectAtPointer("gr_computers", &
SeriesNbr, ItemNbr)
Description Returns the number of the data point under the pointer. You must call
ObjectAtPointer first to retrieve the pointer position information.
Obsolete method
ObjectAtPointerDataPoint is obsolete and should not be used, because the

Syntax Web ActiveX
number dwcontrol.ObjectAtPointerDataPoint ( )
Return value Returns the number of the data point.

Usage To find out the data point and series under the pointer, call ObjectAtPointer to
ObjectAtPointerDataPoint and ObjectAtPointerSeries and examine the return
values.
ObjectAtPointerSeries
ObjectAtPointerSeries
Description Returns the number of the series under the pointer. You must call
ObjectAtPointer first to retrieve the pointer position information.
954 PowerBuilder
Obsolete method
ObjectAtPointerSeries is obsolete and should not be used, because the

Syntax Web ActiveX
number dwcontrol.ObjectAtPointerSeries ( )
Return value Returns the number of the series.

Usage To find out the data point and series under the pointer, call ObjectAtPointer to
ObjectAtPointerDataPoint and ObjectAtPointerSeries and examine the return
values.
Reset
Description Deletes the data, the categories, or the series from a graph.
Reset is for graphs within a DataWindow object with an external data source.
It does not apply to other graphs in DataWindow objects because their data
comes directly from the DataWindow.
Syntax PowerBuilder
integer dwcontrol.Reset ( grResetType graphresettype )

ResetDataColors
graphresettype A value of the grResetType enumerated datatype specifying
whether you want to delete only data values or all series and
all data values:
• All! – Delete all series, categories, and data in dwcontrol.
• Category! – Delete categories and data in dwcontrol.
• Data! – Delete data in dwcontrol.
• Series! – Delete the series and data in dwcontrol.
Reset returns null. The return value is usually not used.
Usage Use Reset to clear the data in a graph before you add new data.
Examples PowerBuilder This statement deletes the series and data, but leaves the
categories, in the graph gr_product_data in the DataWindow dw_prod. The
DataWindow object has an external data source:
dw_prod.Reset("gr_product_data", Series!)
ResetDataColors
Description Restores the color of a data point to the default color for its series.
Syntax PowerBuilder
integer dwcontrol.ResetDataColors ( string graphcontrol, integer
seriesnumber, long datapointnumber )
DataWindow control
seriesnumber The number of the series in which you want to reset the color
of a data point
datapointnumber The number of the data point for which you want to reset the
color
ResetDataColors returns null.
956 PowerBuilder
Default color for data points

To set the color for a series, use SetSeriesStyle. The color you set for the series
is the default color for all data points in the series.
Examples PowerBuilder These statements change the color of data point 10 in the
dw_equipment to the color for the series:
SeriesNbr = dw_equipment.FindSeries("gr_computers", &
"Costs")
dw_equipment.ResetDataColors("gr_computers", &
SeriesNbr, 10)
GetSeriesStyle
SetDataStyle
SetSeriesStyle
SaveAs
Description Saves the data in a graph in the format you specify.
Syntax PowerBuilder
integer dwcontrol.SaveAs ( string graphcontrol {, string filename,
SaveAsType saveastype, boolean colheading { , encoding } } )
control.
filename A string whose value is the name of the file in which you want to
(optional) save the data in the graph. If you omit filename or specify an empty
string (“”), the user is prompted for a file name.
saveastype A value of the SaveAsType enumerated datatype (in
(optional) PowerBuilder) specifying the format in which to save the data
represented in the graph.
For a list of values, see SaveAsType on page 492.

SeriesCount
colheading A boolean value indicating whether you want column headings
(optional) with the saved data. The default value is true. This argument is
used for the following formats: Clipboard, CSV, Excel, and Text.
For most other formats, column headings are always saved.
encoding Character encoding of the file to which the data is saved. This
(optional) parameter applies only to the following formats: TEXT, CSV,
SQL, HTML, and DIF. If you do not specify an encoding
parameter, the file is saved in ANSI format. Values are:
• EncodingUTF8!
SaveAs returns null.
If you do not specify any arguments, PowerBuilder saves the DataWindow data
rather than the data in the graph control. In this case, or in the case where you
specify only the graph control name as an argument, PowerBuilder displays the
Save As dialog box, letting the user specify the format of the saved data.
Examples PowerBuilder This statement saves the contents of gr_computers in the
DataWindow control dw_equipmt to the file G:\INVENTORY\SALES.XLS.
The format is comma-separated values with column headings:
dw_equipmt.SaveAs("gr_computers", &
"G:\INVENTORY\SALES.XLS", CSV!, true)
See also Print
SaveAs
SeriesCount
Description Counts the number of series in a graph.
Syntax PowerBuilder
integer dwcontrol.SeriesCount ( string graphcontrol )
958 PowerBuilder
DataWindow control
Return value Returns the number of series in the graph if it succeeds and -1 if an error occurs.
If any argument’s value is null, SeriesCount returns null.
Examples PowerBuilder These statements store in the variable li_series_count the
number of series in the graph gr_computers in the DataWindow control
dw_equipment:
integer li_series_count
li_series_count = &
dw_equipment.SeriesCount("gr_computers")
See also CategoryCount
DataCount
SeriesName
Description Obtains the series name associated with the specified series number.
Syntax PowerBuilder
integer dwcontrol.SeriesName ( string graphcontrol, integer
seriesnumber )
DataWindow control
seriesnumber The number of the series for which you want to obtain the
name
Return value Returns the name assigned to the series. If an error occurs, it returns the empty
string (“”). If any argument’s value is null, SeriesName returns null.
Usage Series are numbered consecutively, from 1 to the value returned by
SeriesCount. When you delete a series, the series are renumbered to keep the
numbering consecutive. You can use SeriesName to find out the name of the
series associated with a series number.

SetDataLabelling
Examples PowerBuilder These statements store in the variable ls_SeriesName the

name of series 5 in the graph gr_computers in the DataWindow control
dw_equipment:
ls_SeriesName = &
dw_equipment.SeriesName("gr_computers", 5)
See also CategoryName
GetData
SetDataLabelling
Description Set the data label for a DirectX 3D graph.
Syntax integer dwcontrol.SetDataLabelling (string graphcontrol, int seriesnumber,
int datapoint, boolean value)
DataWindow control.
seriesnumber The number that identifies the series in which you want to set
the data labelling value.
datapoint The datapoint.
value Indicates whether to label the data with its value.
SetDataLabelling returns null.
Usage SetDataLabelling is used to indicate whether or not to label the data with the
numbers for data in DirectX 3D Area, Bar, Col, or Line graphs. You cannot use
this method with DirectX 3D Pie graphs.
Examples These statements obtain the series and datapoint for the graph gr_1 in the
DataWindow control dw_employee.

960 PowerBuilder
SeriesNbr, ItemNbr)
// Set data label

dw_employee.SetDataLabelling("gr_1", &
SeriesNbr, ItemNbr, true)
GetSeriesLabelling
SetSeriesLabelling
SetDataPieExplode
Description Explodes a pie slice in a pie graph. The exploded slice is moved away from the
center of the pie, which draws attention to the data. You can explode any
number of slices of the pie.
Syntax PowerBuilder
integer dwcontrol.SetDataPieExplode ( string graphcontrol, integer
seriesnumber, integer datapoint, integer percentage )
DataWindow control.
seriesnumber The number that identifies the series.
datapoint The number of the data point (that is, the pie slice) to be
exploded.
percentage A number between 0 and 100 that is the percentage of the
radius that the pie slice is moved away from the center. When
percentage is 100, the tip of the slice is even with the
circumference of the pie’s circle.
SetDataPieExplode returns null.
Usage If the graph is not a pie graph, SetDataPieExplode has no effect.

SetDataStyle
Examples PowerBuilder This example explodes the pie slice under the pointer to 50%
when the user double-clicks within the graph. The code checks the property
GraphType to make sure the graph is a pie graph. It then finds out whether the
user clicked on a pie slice by checking the series and data point values set by
ObjectAtPointer. The script is for the DoubleClicked event of the DataWindow
control:
integer series, datapoint
integer percentage
percentage = 50
IF (This.GraphType <> PieGraph! AND &
This.GraphType <> Pie3D!) THEN RETURN
clickedtype = This.ObjectAtPointer( "gr_equipment", &

series, datapoint)
IF (series > 0 and datapoint > 0) THEN

This.SetDataPieExplode("gr_equipment", series, &
datapoint, percentage)
END IF
See also GetDataPieExplode
SetDataStyle
Specifies the appearance of a data point in a graph. The data point’s series has
appearance settings that you can override with SetDataStyle.
To Use
Set the data point’s colors Syntax 1
Set the line style and width for the data point Syntax 2
Set the fill pattern for the data point Syntax 3
Set the symbol for the data point Syntax 4
Syntax 1 For setting a data point’s colors

Description Specifies the colors of a data point in a graph.
962 PowerBuilder
Syntax PowerBuilder
integer dwcontrol.SetDataStyle ( string graphcontrol, integer
seriesnumber, integer datapointnumber, grColorType colortype, long
color )
DataWindow control.
seriesnumber The number of the series in which you want to set the color of
a data point.
datapointnumber The number of the data point for which you want to set the
color.
PowerBuilder) specifying the aspect of the data point for
which you want to set the color.
color A long whose value is the new color for colortype.
SetDataStyle returns null.
Usage To change the appearance of a series, use SetSeriesStyle. The settings you make
for the series are the defaults for all data points in the series.
To reset the color of individual points back to the series color, call
ResetDataColors.
You can specify the appearance of a data point in the graph before the
application draws the graph. To do so, define a user event for
pbm_dwngraphcreate and call SetDataStyle in the script for that event. The
event pbm_dwngraphcreate is triggered just before a graph is created in a
DataWindow object.
Using SetDataStyle with DirectX 3D Graphs

You can only set the color for the foreground. Background, line color, and
shade are not supported.
Examples PowerBuilder These statements set the text (foreground) color to black for
data point 6 in the series named Salary in the graph gr_depts in the
DataWindow control dw_employees:
integer SeriesNbr

SetDataStyle

SeriesNbr = &
dw_employees.FindSeries("gr_depts" , "Salary")
// Set the background color

dw_employees.SetDataStyle("gr_depts" , SeriesNbr, &
6, Background!, 0)
GetSeriesStyle
ResetDataColors
SetSeriesStyle
Syntax 2 For the line associated with a data point

Description Specifies the style and width of a data point’s line in a graph.
Syntax PowerBuilder
seriesnumber, integer datapointnumber, LineStyle linestyle, { integer
linewidth } )
DataWindow control.
seriesnumber The number of the series in which you want to set the line style
and width of a data point.
datapointnumber The number of the data point for which you want to set the line
style and width.
linestyle A value of the LineStyle enumerated datatype (in
PowerBuilder) specifying a line style pattern of dots, dashes,
and solid lines. For a list of line style values, see LineStyle on
page 490.
linewidth (optional An integer whose value is the width of the line in pixels.
for PowerBuilder)
964 PowerBuilder
DataWindow object.
Examples PowerBuilder This example checks the line style used for data point 10 in the
dw_equipment. If it is dash-dot, the SetDataStyle sets it to continuous. The line
width stays the same:
integer SeriesNbr, line_width

// Get the current line style

dw_equipment.GetDataStyle("gr_computers", &
SeriesNbr, 10, line_style, line_width)
// If the pattern is dash-dot, change to continuous

IF line_style = DashDot! THEN &
dw_equipment.SetDataStyle("gr_computers", &
SeriesNbr, 10, Continuous!, line_width)
GetSeriesStyle
SetSeriesStyle
Syntax 3 For the fill pattern of a data point

Description Specifies the fill pattern for a data point in a graph.
Syntax PowerBuilder
seriesnumber, integer datapointnumber, FillPattern fillvalue )
DataWindow control.

SetDataStyle
seriesnumber The number of the series in which you want to set the
appearance of a data point.
appearance.
fillvalue A value of the FillPattern enumerated datatype (in
PowerBuilder) specifying the fill pattern for the data point.
DataWindow object.

You cannot use a fill pattern for a data point.

GetSeriesStyle
SetSeriesStyle
Syntax 4 For the symbol of a data point

Description Specifies the symbol for a data point in a graph.
Syntax PowerBuilder
seriesnumber, integer datapointnumber, grSymbolType symbolvalue )
DataWindow control.
966 PowerBuilder
seriesnumber The number of the series in which you want to set the
appearance of a data point.
appearance.
symbolvalue A value of the grSymbolType enumerated datatype (in
PowerBuilder) specifying the symbol for the data point.
DataWindow object.

You cannot specify specific symbols for the data point.

GetSeriesStyle
SetSeriesStyle
SetDataTransparency
Description Sets the transparency percentage for a data point in a series in a DirectX 3D
graph.
Syntax integer dwcontrol.SetDataTransparency ( string graphcontrol, integer
seriesnumber, int datapoint, int transparency)

SetSeriesLabelling
DataWindow control.
seriesnumber The number that identifies the series in which you want to set
the transparency value of a data point.
datapoint The number of the data point for which you want to set a
transparency value.
the data point is opaque and a value of 100 means that it is
SetDataTransparency returns null.
Usage SetDataTransparency sets the transparency value of a data point in any DirectX
3D graph (those with 3D rendering).
Examples These statements set the transparency percentage to 50% for data point 3 in the
series named Costs in the graph gr_1 in the DataWindow control dw_employee:
integer SeriesNbr, ItemNbr, TransNbr
SeriesNbr, ItemNbr)
//The following statement sets Transparency to 50%
TransNbr = 50
dw_employee.SetDataTransparency("gr_1", &
SeriesNbr, ItemNbr, TransNbr)
See also FindSeries
GetDataTransparency
SetSeriesLabelling
Description Set the series label for a DirectX 3D graph.
968 PowerBuilder
Syntax integer dwcontrol.SetSeriesLabelling (string graphcontrol, string series,

boolean value)
DataWindow control.
series The string that names the series in which you want to change
the series label setting.
value Indicates whether to label the series with its values.
SetSeriesLabelling returns null.
Usage SetDataLabelling is used to indicate whether or not to label the series with the
data numbers for data in DirectX 3D Area, Bar, Col, or Line graphs. You
cannot use this method with DirectX 3D Pie graphs.
Examples These statements obtain the series and datapoint of graph gr_1 and the
DataWindow control dw_employee.

SeriesNbr, ItemNbr)

SeriesNbr)
// Set Series label

dw_employee.SetSeriesLabelling("gr_1", &
ls_SeriesName, true)
GetSeriesLabelling
SetDataLabelling

SetSeriesStyle
SetSeriesStyle
Specifies the appearance of a series in a graph. There are several syntaxes,
depending on what settings you want to change.
To Use
Set the series’ colors Syntax 1
Set the line style and width Syntax 2
Set the fill pattern for the series Syntax 3
Set the symbol for the series Syntax 4
Specify that the series is an overlay Syntax 5
Syntax 1 For setting a series’ colors

Description Specifies the colors of a series in a graph.
Syntax PowerBuilder
integer dwcontrol.SetSeriesStyle ( string graphcontrol, string
seriesname, grColorType colortype, long color )
DataWindow control.
want to set the color.
colortype A value of the grColorType enumerated datatype specifying
the item for which you want to set the color.
color A long specifying an RGB value for the new color.
SetSeriesStyle returns null.
Usage Data points in a series can have their own style settings. Settings made with
SetDataStyle set the style of individual data points and override series settings.
current graph type. For example, you can set the fill pattern in a
two-dimensional line graph or the line style in a bar graph, but that fill pattern
or line style will not be visible.
970 PowerBuilder
You can specify the appearance of a series in the graph before the application
draws the graph. To do so, define a user event for pbm_dwngraphcreate and
call SetSeriesStyle in the script for that event. The event pbm_dwngraphcreate
is triggered just before a graph is created in a DataWindow object.
Using SetSeriesStyle with DirectX 3D Graphs

You can only set the color for the foreground. Background, line color, and
shade are not supported.
Examples PowerBuilder This statement sets the background color of the series named
Salary in the graph gr_depts in the DataWindow control dw_employees to
black:
dw_employees.SetSeriesStyle("gr_depts", &
"Salary", Background!, 0)
These statements in the Clicked event of the graph control gr_product_data
coordinate line color between it and the graph gr_sales_data. The script stores
the line color for the series under the mouse pointer in the graph
gr_product_data in the variable line_color. Then it sets the line color for the
series Northeast in the graph gr_sales_data within the DataWindowcontrol
dw_sales to that color:
string SeriesName
integer SeriesNbr, Series_Point
long line_color
MouseHit = This.ObjectAtPointer( &
SeriesNbr,Series_Point)

SeriesName = &
gr_product_data.SeriesName(SeriesNbr)
gr_product_data.GetSeriesStyle(SeriesName, &
LineColor!, line_color)
dw_sales.SetSeriesStyle("gr_sales_data", &
"Northeast", LineColor!, line_color)
END IF
GetSeriesStyle
SetSeriesStyle

SetSeriesStyle
Syntax 2 For lines in a graph

Description Specifies the style and width of a series’ lines in a graph.
Syntax PowerBuilder
seriesname, LineStyle linestyle {, integer linewidth } )
DataWindow control.
want to set the line style and width.
linestyle A value of the LineStyle enumerated datatype (in
PowerBuilder) specifying the line style.
For a list of values, see LineStyle on page 490.
linewidth (optional An integer specifying the width of the line in pixels.
for PowerBuilder)
Examples PowerBuilder This statement sets the line style and width for the series
named Costs in the graph gr_product_data in the DataWindow dw_prod:
dw_prod.SetSeriesStyle("gr_product_data", "Costs", &
Dot!, 5)
GetSeriesStyle
SetDataStyle
972 PowerBuilder
Syntax 3 For the fill pattern in a graph

Description Specifies the fill pattern for data markers in a series.
Syntax PowerBuilder
seriesname, FillPattern fillvalue )
DataWindow control.
seriesname A string whose value is the name of the series in which you
want to set the appearance.
fillvalue A value of the FillPattern enumerated datatype specifying the
fill pattern for the series.

You cannot use a fill pattern for a series.
Examples PowerBuilder This statement sets the fill pattern used for the series named
Costs in the graph gr_computers in the DataWindow control dw_equipment to
Horizontal:
dw_equipment.SetSeriesStyle("gr_computers", &
"Costs", Horizontal!)

SetSeriesStyle

GetSeriesStyle
SetDataStyle
Syntax 4 For the symbols in a graph

Description Specifies the symbol for data markers in a series.
Syntax PowerBuilder
seriesname, grSymbolType symbolvalue )
DataWindow control.
seriesname A string whose value is the name of the series in which you
want to set the appearance.
symbolvalue A value of the grSymbolType enumerated datatype specifying
the symbol for the series.

You cannot specify specific symbols for the data markers in a series.
974 PowerBuilder
Examples PowerBuilder This statement sets the symbol for the series named Costs in
the graph gr_computers in the DataWindow control dw_equipment to X:
dw_equipment.SetSeriesStyle("gr_computers", &
"Costs", SymbolX!)
GetSeriesStyle
SetDataStyle
Syntax 5 For creating an overlay in a graph

Description Specifies whether a series is an overlay, meaning that the series is represented
by a line on top of another graph type.
Syntax PowerBuilder
integer dwcontrol.SetSeriesStyle ( string graphcontrol, string series,
boolean overlaystyle )
DataWindow control.
series A string whose value is the name of the series whose overlay
status you want to change.
overlaystyle A boolean value indicating whether you want the series to be
an overlay, meaning that the series is shown in front as a line.
Set overlaystyle to true to make the specified series an overlay.
Set it to false to remove the overlay setting.
Usage You can specify the appearance of a series in the graph before the application

You cannot use the overlay style for a series.

Examples PowerBuilder These statements in the Clicked event of the DataWindow

control dw_employees store the style of the series under the pointer in the
graph gr_depts in the variable style_type. If the style of the series is overlay
(true), the script changes the style to normal (false):
string SeriesName
boolean overlay_style
MouseHit = dw_employees.ObjectAtPointer( &

"gr_depts", SeriesNbr, Data_Point)

SeriesName = &
dw_employees.SeriesName("gr_depts",SeriesNbr)
dw_employees.GetSeriesStyle("gr_depts", &
SeriesName, overlay_style)
IF overlay_style THEN &

dw_employees.SetSeriesStyle("gr_depts", &
SeriesName, false)
END IF
GetSeriesStyle
SetDataStyle
Description Sets the transparency percentage of a series in a DirectX 3D type graph.
Syntax integer dwcontrol.SetSeriesTransparency ( string graphcontrol, stringseries,
int transparency)
DataWindow control.
series The string that identifies the series in which you want to set
the transparency value.
976 PowerBuilder
transparency Integer value for percentage transparency. A value of 0 means
that the series is opaque and a value of 100 means that it is
SetSeriesTransparency returns null.
Usage SetSeriesTransparency sets the transparency value for a series in a DirectX 3D
graph (those with 3D rendering).
Examples These statements set the transparency percentage to 50% for the series named
Costs in the graph gr_1 in the DataWindow control dw_employee:
integer SeriesNbr, ItemNbr, TransNbr

SeriesNbr, ItemNbr)

SeriesNbr)
//The following statement sets Transparency to 50%

TransNbr = 50
dw_employee.SetSeriesTransparency("gr_1", &
ls_SeriesName, TransNbr)
See also FindSeries
GetDataTransparency
SetDataTransparency

978 PowerBuilder
Symbols
= (relational) 6
Numerics
3D (Checkbox.property) 209
3D (RadioButtons.property) 355
A
Abs function 29
absolute value 29
Accelerator property 179
AcceptText method
about 556
calling from Update 883
AccessibleDescription property 180
AccessibleName property 180
AccessibleRole enumerated datatype 480
AccessibleRole property 181
ACos function 29
action code 800
Action property 182
Activation property 184
addition operator 5
ADO Recordset 613
aggregate functions
Avg 33
Count 40
CrosstabMax 48
CrosstabMaxDec 50
CrosstabMin 51
CrosstabMinDec 53
CrosstabSum 54
CrosstabSumDec 55
CumulativePercent 56
CumulativeSum 58
First 70
Large 83
Last 85

Max 96
Median 98
Min 102
Mode 105
Percent 114
restrictions 18, 19, 21
Small 134
StDev 137
StDevP 139
Sum 144
Var 150
VarP 153
Alignment enumerated data type 483
Alignment property 185
ALLBASE 715
AllowEdit (dddw.property) 231
AllowEdit (ddlb.property) 235
AllowPartialChanges constant 486
AND operator 9
angle
calculating arc cosine 29
calculating arc sine 31
calculating arc tangent 32
calculating cosine 39
calculating sine 133
calculating tangent 146
AntiAliased (Ink.property) 309
Any data type for property expressions 461
AppendedHTML (HTML.property) 292
appending a string 124, 125
application, remote 858
arc cosine 29
arc sine 31
arc tangent 32
arguments
in SetSQLSelect method 855
980 PowerBuilder
retrieval 750
Arguments (Table.property) 384
Arguments (Table.sqlaction.property) 388
Arguments property 186
arithmetic operators 5
Asc function 30
AscA function 31
ASCII values, converting characters to 30, 31
ASin function 31
asterisks (*), in text patterns 95
ATan function 32
Attributes property 187
average value
columns 33
crosstabs 42, 46
Avg function 33
AutoErase (InkPic.property) 314
AutoHScroll (dddw.property) 231
AutoHScroll (ddlb.property) 235
AutoHScroll (Edit.property) 244
AutoHScroll (InkEdit.property) 311
AutoRetrieve (dddw.property) 231
AutoScale (Axis.property) 188
AutoSelect (Edit.property) 244
AutoSelect (InkEdit.property) 311
Autosize Height property 811
Autosize Height property for bands 199
AutoSkip (EditMask.property) 248
AutoVScroll (Edit.property) 244
AutoVScroll (InkEdit.property) 311
Axis properties 188
Axis property 187
axis, categories in graphs 917
B
BackColor (InkPic.property) 314
BackColor property 193

background color, graphs
data points 963
series 942, 970
Background constant 488
background layer of DataWindow 834
Background properties 193
BackImage property 196
backslash character
escape character in JavaScript 456
backslash character, in text patterns 95
BackTabOut event 504
Band enumerated data type 483
Band property 197
Bandname properties 197
Bandname.Text property (RichText only) 202
Bands property 202
bands, DataWindow
associated row 74
locating 619
moving objects to 834
reporting on 584
setting row height 810
BDiagonal constant 487
BETWEEN operator 6, 7
BinaryIndex property 203
binding 673
Bitmap controls, table of DataWindow object properties 171, 174
Bitmap function 35
BitmapName property 203
bitmaps
deleting and adding 706
under pointer 662
blobs
setting up columns 721
boolean values, property expressions 461
border
982 PowerBuilder
determining distance from 728, 729
determining style 620
setting style, for columns 802
Border (HTMLTable.property) 304
Border enumerated data type 483
Border property (DataWindow object)
examples of setting 448
Border property (DataWindow object), about 203
BorderStyle enumerated data type 484
bottom layer of DataWindow 834
Box border style 620
Box constant 483
brackets in text patterns 95
breaks 684
Browser (HTMLGen.property) 296
Brush properties 205
buffer, DataWindow
copying rows 756
editing items 677
moving rows 759
of updated row 680
retrieving data 638, 643, 647, 651, 653
returning modified rows 660
setting values of rows and columns 821, 832
sharing data 871, 875
Button controls, table of DataWindow object properties 164
ButtonClicked event 504
ButtonClicking event 506
Buttons (Print.Preview.property) 341
Buttons (Print.property) 342
C
cancellation
of edits 882
of printing 740
of row retrieval 576
CanUndo method 558

CanUseDefaultPrinter (Print.property) 342
capitalization
first letter 155
lowercase 93
uppercase 149
caret in text patterns 95
carriage return character in PowerBuilder 455
Case (dddw.property) 231
Case (ddlb.property) 235
Case (Edit.property) 244
Case function 36
categories, graphs
clicked 953
counting 917
deleting 956
identifying 918
Category property. See Axis properties
CategoryCount method 917
CategoryName method 918
Ceiling function 37
CellPadding (HTMLTable.property) 304
CellSpacing (HTMLTable.property) 304
Center constant 483
century 156
Char function 38
CharA function 38
characters
case of 30, 31
changing capitalization 93, 149, 155
converting to ASCII values 30, 31
extracting 101, 102
matching 94
returning leftmost 88, 89
returning rightmost 128
selected 786, 788
selecting 791
984 PowerBuilder
CharSet enumerated data type 485
CharSetANSI constant 485
CharSetArabic constant 485
CharSetDBCSJapanese constant 485
CharSetHebrew constant 485
CharSetUnicode constant 485
CheckBox property 209
child windows, retrieving data for 624
ClassName method 559
Clear method 560
clearing text 560
ClearValues method 561
Clicked event 507, 627, 628, 702
client control methods
DeletedCount 581
DeleteRow 583
GetColumn 630
GetItemStatus 649
GetRow 668
InsertRow 699
ModifiedCount 704
Retrieve 750
RowCount 754
SetColumn 806
SetItem 821
SetRow 841
SetSort 850
Sort 878
Update 883
ClientComputedFields (HTMLGen.property) 296
ClientEvents (HTMLGen.property) 296
ClientFormatting (HTMLGen.property) 296
ClientName property 210
ClientScriptable (HTMLGen.property) 296
ClientValidation (HTMLGen.property) 296
clipboard

copying 565
cutting 575
importing data from 686
pasting from 726
saving DataWindow to 762
Clipboard constant 492
Clipboard method 918
ClipText (Print.property) 342
code table 93, 561, 683, 866
CodeTable (Edit.property) 244
CodeTable (EditMask.property) 248
Collapse method 561
CollapseAll method 562
CollapseAllChildren method 563
Collapsed event 509
CollapseLevel method 564
CollapseTreeNodeIconName (Tree.Level property) 403
Collapsing event 509
Collate (Print.property) 342
CollectionMode (InkPic.property) 314
Color (Background.property) 193
Color (Bandname.property) 197
Color (Brush.property) 205
Color (Ink.property) 309
Color (Pen.property) 334
Color (Print.property) 342
Color property 211
colors
changing DataWindow object 706, 709
data points 929, 956, 962
red, green, and blue components of 126
series 942, 970
table of standard colors 126
ColType property 213
Column controls, table of DataWindow object properties 165
column headings
986 PowerBuilder
when importing data from files 691
when inserting a string 695
Column.Count property 214
columns
average value 33
checking for null value 80
clicked 627
computed 854
counting null values, example 20
cumulative percent 56
cumulative sum 58
current 630, 631, 806
data 435
deleting values 561
determining border style 620
determining insertion point position 730
display value 93
first value 70
format of 632, 815
in DataWindow expressions 451
initializing 699
large value 83
last value 85
maximum value 96
median value 98
minimum value 102
modification status of 649, 827
most frequently occurring value 105
number of rows 40
pasting text into 726
percent of range 114
properties of 584, 588
range of data 439
reading from database 744
replacing text 856
retrieving dates from 638, 641

retrieving from buffer 651, 653
retrieving numbers from 643, 647
selected data 437
setting border style 802
setting tab order 855
setting to read-only 855
sharing data 871
small value 134
specified dynamically when setting properties 457
standard deviation 137, 139
total of values 144
total of values, example 20, 22
validation rule of 677, 682, 864
value in code table 93
values of 683, 821, 832
variance 150, 153
under pointer 662
updating 883
Columns (Crosstab.property) 217
Columns (Print.property) 342
Columns (RadioButtons.property) 355
Columns.Width (Print.property) 342
command button, activating OLE object 721
CommonJSFile (HTMLGen.property) 296
comparing strings 8
Composite presentation style, property expressions for included reports
471
composite reports
no filtering 595
no sorting 879
Computed field controls, table of DataWindow object properties 167
computed fields
data 435
range of data 439
selected data 437
988 PowerBuilder
computed fields, expressions 17
concatenation operator 10
conditional expressions
DataWindow example 22, 23, 27
with Evaluate 14
conditional expressions, IF function 76
configuration settings, reading 119, 120
constants for DataWindows
about 479
list 480
Constructor event 510
ContentsAllowed property 214
Continuous constant 490
continuous line style
setting for data points 490
setting for series 972
controls
determining type 882
dragging 589
hiding 685, 720
moving 720
redrawing 835
resizing 749
conventions xvii
Copies (Print.property) 342
Copy method 565
copying
importing from clipboard 686
range of rows 755
to clipboard 565
CopyRTF method 567
Cos function 39
cosine 39
count
of data points in a series 919
of rows marked for deletion 581

Count function 40
count of values
columns 40
crosstabs 47
example 20
Create method 569
CreateFrom method 572
creating DataWindow objects 706
criteria
input 864
sort 850, 878
Criteria properties 216
Criteria property 215
Crosstab properties 217
CrosstabAvg function 42
CrosstabAvgDec function 46
CrosstabCount function 47
CrosstabData (Table.property) 384
CrosstabDialog method 574
CrosstabMax function 48
CrosstabMaxDec function 50
CrosstabMin function 51
CrosstabMinDec function 53
crosstabs
and ShareData method 874
defining 574
obtaining message text 659
CrosstabSum function 54
CrosstabSumDec function 55
CSS generation properties 219
CSSGen.PublishPath 219
CSSGen.ResourceBase 219
CSSGen.SessionSpecific 219
CSV constant 492
CumulativePercent function 56
CumulativeSum function 58
990 PowerBuilder
currency, and rows 74
current
column 806
row 668, 790, 841
row and scrolling 777, 781, 782, 785
row before inserting 699
cursor
and current row 841
hand pointer 842
CustomPage.Length (Print.property) 342
CustomPage.Width (Print.property) 342
Cut method 575
cutting, to clipboard 575
D
Dash constants for graphs 490
dash line style
about 490, 972
data
accessing all 444
block or range 439, 442
column 435, 437, 439
computed field 435, 437, 439
converting to type long 92
counting nulls 20
finding in DataWindow 597
importing 686
retrieving for child window or report 625
retrieving from buffers 638, 641, 643, 647, 651, 653
rows 444
selected 437, 445
sharing 871, 875
single items 435, 441
validating 864
data expressions
defined 448

DWObject versus data 436, 463
PowerBuilder 426
syntax overview (PowerBuilder) 427
data points
clicked 953
getting colors 929
getting fill patterns 931
getting style 930
reporting appearance of 928
reporting explosion percent 925
resetting colors 956
setting style 962
value of 921, 938
Data property 220
data source 706, 717
data type checking and conversion functions
Asc 30
AscA 31
Char 38
CharA 38
Date 61
DateTime 62
Dec 66
Integer 78
IsDate 78
IsNull 80
IsNumber 80
IsTime 83
Long 92
Number 109
Real 122
String 142
Time 147
data types
mismatch when pasting 726
of columns 584, 589
992 PowerBuilder
real 122
string 142
time 147
Data.HTML property 221
Data.HTMLTable property 222
Data.Storage (Table.property) 384
Data.XHTML property 223
Data.XML property 225
Data.XMLDTD property 225
Data.XMLSchema property 226
Data.XMLWeb property 226
Data.XSLFO property 228
Database painter, validation rules 3
databases
canceling row retrieval 576
communicating with 860, 870
deleted rows 581
modified rows 704
preventing deletion on update 758
reading 744
reporting errors 580
retrieving data 638, 641, 643, 647, 651, 653, 750
returning error codes 578
SQL statement 673, 852, 853
updating 680, 883
DataColumn (dddw.property) 231
DataModified constant 486
DataModified item status
about 660
setting 749
DataObject property 228
DataStore methods
AcceptText 556
ClearValues 561
CopyRTF 567
Create 569

CreateFrom 572
DBCancel 576
DeletedCount 581
DeleteRow 583
Describe 584
Drag 589
Filter 594
FilteredCount 595
Find 597
FindGroupChange 601
FindRequired 604
GenerateHTMLForm 612
GetBorderStyle 620
GetChanges 621
GetChild 624
GetClickedColumn 627
GetClickedRow 628
GetColumn 630
GetColumnName 631
GetFormat 632
GetFullState 635
GetItemDate 638
GetItemDateTime 641
GetItemDecimal 643
GetItemNumber 647
GetItemStatus 649
GetItemString 651
GetItemTime 653
GetNextModified 660
GetObjectAtPointer 662
GetParent 663
GetRow 668
GetRowFromRowId 669
GetRowIdFromRow 671
GetSelectedRow 672
GetSQLSelect 673
994 PowerBuilder
GetStateStatus 675
GetText 677
GetTrans 678
GetValidate 682
GetValue 683
GroupCalc 684
Import Clipboard 686
ImportFile 689
ImportString 693
InsertDocument 697, 699
IsSelected 702
ModifiedCount 704
Modify 705
ReselectRow 744
Reset 745
ResetTransObject 747
ResetUpdate 748
Retrieve 750
RowCount 754
RowsCopy 755
RowsDiscard 758
SaveAsAscii 765
SaveAsFormattedText 766
SetBorderStyle 802
SetChanges 804
SetColumn 806
SetDetailHeight 810
SetFilter 812
SetFormat 815
SetFullState 817
SetItem 821
SetItemStatus 827
SetPosition 834
SetRow 841
SetSort 850
SetSQLPreview 852

SetSQLSelect 853
SetText 856
SetTransObject 860
SetValidate 864
SetValue 866
SetWSObject 870
ShareData 871
ShareDataOff 875
Sort 878
Update 883
DataWindow constants
about 479
list 480
DataWindow control
row height 131
rows available for display 130, 754
DataWindow data expressions. See data expressions
DataWindow expression functions 17
Abs in painter expressions 29
Asc in painter expressions 30, 31
Avg in painter expressions 33
Bitmap in painter expressions 35
Case in painter expressions 36
Ceiling in painter expressions 37
Char in painter expressions 38
Cos in painter expressions 39
Count in painter expressions 40
CrosstabAvg in painter expressions 42
CrosstabAvgDec in painter expressions 46
CrosstabCount in painter expressions 47
CrosstabMax in painter expressions 48
CrosstabMaxDec in painter expressions 50
CrosstabMin in painter expressions 51
CrosstabMinDec in painter expressions 53
CrosstabSum in painter expressions 54
CrosstabSumDec in painter expressions 55
996 PowerBuilder
CumulativePercent in painter expressions 56
CumulativeSum in painter expressions 58
Date in painter expressions 61
DateTime in painter expressions 62
Day in painter expression 63
DayName in painter expressions 63
DayNumber in painter expressions 64
DaysAfter in painter expressions 65
Dec in painter expressions 66
Describe in painter expressions 67
Exp in painter expressions 67
Fact in painter expressions 68
Fill in painter expressions 68, 69
First in painter expressions 70
GetPaintDC in painter expressions 71
GetPaintRectHeight in painter expressions 72
GetPaintRectWidth in painter expressions 73
GetPaintRectX in painter expressions 73
GetPaintRectY in painter expressions 74
GetRow in painter expressions 74
Hour in painter expressions 75
If in painter expressions 76
Int in painter expressions 77
Integer in painter expressions 78
IsDate in painter expressions 78
IsNull in painter expressions 80
IsNumber in painter expressions 80
IsRowModified in painter expressions 81
IsRowNew in painter expressions 81
IsSelected in painter expressions 82
IsTime in painter expressions 83
Large in painter expressions 83
Last in painter expressions 85
Left in painter expressions 88, 89
LeftTrim in painter expressions 89

Len in painter expressions 90
Log in painter expressions 91
LogTen in painter expressions 92
Long in painter expressions 92
LookUpDisplay in painter expressions 93
Lower in painter expressions 93
Match in painter expressions 94
Max in painter expressions 96
Median in painter expressions 98
Mid in painter expressions 101, 102
Min in painter expressions 102
Minute in painter expressions 104
Mod in painter expressions 105
Mode in painter expressions 105
Month in painter expressions 108
Now in painter expressions 108
Number in painter expressions 109
Page in painter expressions 110
PageAbs in painter expressions 110
PageAcross in painter expressions 111
PageCount in painter expressions 112
PageCountAcross in painter expressions 112
Paint in painter expressions 113
Percent in painter expressions 114
Pi in painter expressions 117
Pos in painter expressions 117, 118
ProfileInt in painter expressions 119
ProfileString in painter expressions 120
Rand in painter expressions 122
Real in painter expressions 122
RelativeDate in painter expressions 123
RelativeTime in painter expressions 123
Replace in painter expressions 124, 125
RGB in painter expressions 126
Right in painter expressions 128
RightTrim in painter expressions 129
998 PowerBuilder
RowCount in painter expressions 130
RowHeight in painter expressions 131
Round in painter expressions 130
Second in painter expressions 132
SecondsAfter in painter expressions 132
Sign in painter expressions 133
Sin in painter expressions 133
Small in painter expressions 134
Space in painter expressions 136
Sqrt in painter expressions 136
StDev in painter expressions 137
StDevP in painter expressions 139
String in painter expressions 142
StripRTF in painter expressions 144
Sum in painter expressions 144
Tan in painter expressions 146
Time in painter expressions 147
Today in painter expressions 148
Trim in painter expressions 148
Truncate in painter expressions 149
Var in painter expressions 150
VarP in painter expressions 153
WordCap in painter expressions 155
Upper in painter expressions 149
Year in painter expressions 156
DataWindow expressions 1
as values for properties 448
defined 448
examples 452
format in painter versus code 451
in property expressions 469
DataWindow methods
AcceptText 556
CanUndo 558
ClassName 559
Clear 560

ClearValues 561
Collapse 561
CollapseAll 562
CollapseAllChildren 563
CollapseLevel 564
Copy 565
CopyRTF 567
Create 569
CrosstabDialog 574
Cut 575
DBCancel 576
DBErrorCode 578
DBErrorMessage 580
DeletedCount 581
DeleteRow 583
Describe 584
Drag 589
Expand 590
ExpandAll 591
ExpandAllChildren 592
ExpandLevel 593
Filter 594
FilteredCount 595
Find 597
FindGroupChange 601
FindNext 603
FindRequired 604
GenerateHTMLForm 612
GetBandAtPointer 619
GetBorderStyle 620
GetChanges 621
GetChild 624
GetClickedColumn 627
GetClickedRow 628
GetColumn 630
GetColumnName 631
1000 PowerBuilder
GetContextService 632
GetFormat 632
GetFullState 635
GetItemDate 638
GetItemDateTime 641
GetItemDecimal 643
GetItemNumber 647
GetItemStatus 649
GetItemString 651
GetItemTime 653
GetMessageText 659
GetNextModified 660
GetObjectAtPointer 662
GetParent 663
GetRow 668
GetRowFromRowId 669
GetRowIdFromRow 671
GetSelectedRow 672
GetSQLPreview 673
GetSQLSelect 673
GetStateStatus 675
GetText 677
GetTrans 678
GetValidate 682
GetValue 683
GetUpdateStatus 680
GroupCalc 684
Hide 685
ImportClipboard 686
ImportFile 689
ImportString 693
InsertDocument 697
InsertRow 699
IsExpanded 700
IsSelected 702
LineCount 703

ModifiedCount 704
Modify 705
Move 720
OLEActivate 721
Paste 726
PasteRTF 727
PointerX 728
PointerY 729
Position 730
PostEvent 735
Print 736
PrintCancel 740
ReplaceText 743
ReselectRow 744
Reset 745
ResetInk 746
ResetTransObject 747
ResetUpdate 748
Resize 749
Retrieve 750
RowCount 754
RowsCopy 755
RowsDiscard 758
RowsMove 759
SaveAs 762
SaveAsAscii 765
SaveAsFormattedText 766
SaveInk 768, 770
Scroll 771
ScrollNextPage 775
ScrollNextRow 777
ScrollPriorPage 780
ScrollPriorRow 782
ScrollToRow 785
SelectedLength 786
SelectedLine 787
1002 PowerBuilder
SelectedStart 788
SelectedText 789
SelectRow 790
SelectText 791
SelectTreeNode 798
SetActionCode 800
SetBorderStyle 802
SetChanges 804
SetColumn 806
SetCultureFormat 809
SetDetailHeight 810
SetFilter 812
SetFormat 815
SetFullState 817
SetItem 821
SetItemStatus 827
SetItemTime 832
SetPosition 834
SetRedraw 835
SetRow 841
SetRowFocusIndicator 842
SetSort 850
SetSQLPreview 852
SetSQLSelect 853
SetTabOrder 855
SetText 856
SetTransObject 860
SetValidate 864
SetValue 866
SetWSObject 870
ShareData 871
ShareDataOff 875
Show 876
ShowHeadFoot 877
Sort 878
TextLine 880

TriggerEvent 881
TypeOf 882
Undo 882
Update 883
DataWindow object properties 159
for controls in a DataWindow 158
overview 157
DataWindow object properties, table 159
DataWindow objects
changing text 712
controls in 460
creating 569
data 426
DataWindow expression functions 17
expressions 17
properties of 447, 584
DataWindow objects. See also DWObject object
DataWindow properties
PowerBuilder 497
DataWindow property expressions. See property expressions
date columns, and different DBMSs 213
Date function 61
date, day, and time functions
Day 63
DayName 63
DayNumber 64
DaysAfter 65
Hour 75
Minute 104
Month 108
Now 108
RelativeDate 123
RelativeTime 123
Second 132
SecondsAfter 132
Today 148
1004 PowerBuilder
Year 156
DateJSFile (HTMLGen.property) 296
dates
checking string 78
converting to 61
DateTime data type 62
day of week 63, 64
determining interval 65
obtaining current 148
obtaining day of month 63
retrieving from buffer 638, 641
DateTime data type, retrieving from buffers 641
DateTime function 62
Day function 63
DayName function 63
DayNumber function 64
DaysAfter function 65
dbAlias property 229
dBASE constants 492
dBase file
importing data from 689, 693
saving to 762
DBCancel method 576
DBError event 511, 578, 580, 673, 680
DBErrorCode method 578
DBErrorMessage method 580
DBMS
setting connection parameters 859, 861
timestamp support 745
dbName property 230
DDCal_AlignRight (EditMask.property) 248
DDCal_BackColor (EditMask.property) 248
DDCalendar (EditMask.property) 248
DDCal_TextColor (EditMask.property) 248
DDCal_TitleBackColor (EditMask.property) 248
DDCal_TitleTextColor (EditMask.property) 248

DDCal_TrailingTextColor (EditMask.property) 248
dddw properties 231
ddlb properties 235
debugging, debug mode 709
Dec function 66
decimal data type, retrieving from buffers 643
decimal, converting to 66
default values 699
DefaultExpandToLevel (Tree.property) 400
DefaultPicture property 237
definition, changing DataWindow object 705
Delete (Table.property) 384
delete buffer
discarding rows from 758
emptying 748
retrieving data 638, 641, 643, 647, 651, 653
Delete constant 485
DeletedCount method 581
DeleteRow method 583
Depth property 238
Describe function
evaluating expressions 12
Describe method 584
error handling 459
getting property values 450
pros and cons 457
versus property expressions 450
using in JavaScript 475
destroying DataWindow objects 706
Destructor event 513
detail bands
locating 619
1006 PowerBuilder
setting row height 811
Detail constant 483
Detail properties. See Bandname properties
Detail_Bottom_Margin property 239
Detail_Top_Margin property 239
diagonal fill pattern 487
Dialog (Criteria.property) 216
dialog, defining crosstabs 574
Diamond constant 487
diamond fill pattern 487
DIF constant 492
DIF file 762
DISCONNECT statement 858
DispAttr (Axis.property) 188
DispAttr font properties 240
display format
of columns 632, 815
display formats
applying to strings 142
DisplayColumn (dddw.property) 231
displayed value from code table 93
DisplayEveryNLabels (Axis.property) 188
DisplayOnly (Edit.property) 244
DisplayOnly (InkEdit.property) 311
DisplayType property 243
distributed applications
GetChanges method 621
GetFullState method 635
GetStateStatus method 675
SetChanges method 804
SetFullState method 817
division 105
division operator 5
DocumentName (Print.property) 342
dollar sign in text patterns 95
Dot constant 490

dot notation for DataWindow objects 426
dotted line style
setting row focus indicator 842
DoubleClicked event 514, 627, 629
Drag method 589
DragDrop event 515
DragEnter event 516
DragLeave event 517
DragWithin event 517
drawing controls, setting color of 126
DropDown event 518
DropDownDataWindows, property expressions 471
DropDownListBox control
deleting values 561
obtaining values of 683
DropLines (Axis.property) 188
DWBuffer enumerated data type 485
DWConflictResolution enumerated data type 486
DWItemStatus enumerated data type 486
dwItemStatus enumerated data type 649
DWObject object
DataWindow object type 464
event arguments 464
OLE methods 565
part of property expression 460
variables for simplifying property expressions 462
using Type and Name properties 464
Duplex (Print.property) 342
DynamicRendering (InkPic.property) 314
E
edit control
applying contents of 556
counting lines in 703
deleting text from 560
1008 PowerBuilder
obtaining value in 677
replacing text 743
selected text 786, 788
setting value of 856
Edit properties 244
EditChanged event 519
EditMask properties 248
EditMode (InkPic.property) 314
Elevation property 252
EllipseHeight property 252
EllipseWidth property 253
Enabled property 254
EncodeSelfLinkArgs (HTMLGen.property) 296
enumerated data types for DataWindows
about 479
list 480
EraserMode (InkPic.property) 314
EraserWidth (InkPic.property) 314
Error event 553
about 519
property expressions 466
error handling
DataWindow properties in JavaScript 476
Describe and Modify methods 459
property expressions 466
reporting on database 578, 580
update 680
escape character
backslash 456
tilde 454
escape keyword 7, 814
escape sequences 737
Evaluate function 12, 586
events
adding to queue 735

and hidden objects 685
for DataWindow printing 737
return codes 501
triggering 881
Excel constants 492
Excel file 762
ExceptionAction enumerated data type, property expression errors 466
exclamation point for invalid property, Describe method 459
Exp function 67
Expand method 590
ExpandAll method 591
ExpandAllChildren method 592
Expanded event 522
Expanding event 523
ExpandLevel method 593
ExpandTreeNodeIconName (Tree.Level property) 403
exponent 67
exponentiation operator 5
Export.PDF.Distill.CustomPostScript property 254
Export.PDF.XSLFOP.Print property 257, 258, 259
Export.XHTML.UseTemplate property 262
Export.XML.HeadGroups property 263
Export.XML.IncludeWhitespace property 264
Export.XML.MetaDataType property 256, 265
Export.XML.SaveMetaData property 266
Export.XML.TemplateCount property 260, 261, 267, 268
Export.XML.UseTemplate property 269
Expression property 270
expressions
checking for null 80
conditional evaluation 76
conditional for DataWindow properties 14
DataWindow 1
evaluating 584
for DataWindow object 17
for Modify method 707
1010 PowerBuilder
F
Fact function 68
Factoid (InkEdit.property) 311
Factoid property 313
FailOnAnyConflict constant 486
FDiagonal constant 487
Filename (Print.property) 342
files, importing data from 689
Fill function 68
fill patterns 931, 965
FillA function 69
FillPattern enumerated data type 487
Filter (Table.property) 384
filter buffer
modified rows 704
resetting update flags 748
retrieving data from 638, 641, 643, 647, 651, 653
Filter constant 485
Filter method 594
FilteredCount method 595
filters
applying 751
functions in expressions for 17
setting criteria 812
Find method 597
FindCategory method 920
FindGroupChange method 601
FindNext method 603
FindRequired method 604
FindSeries method 921
First function 70
FirstRowOnPage property 272
flags, update 748
focus

column 630, 631
selected text 787, 789, 790, 792
setting 842
FocusRect constant 492
FocusRectangle (Edit.property) 244
FocusRectangle (EditMask.property) 248
FocusRectangle (InkEdit.property) 311
FocusRectangle property 272
Font properties 273
Font.Bias property 273
footer
locating 619
Footer constant 483
Footer properties. See Bandname properties
foreground color
data points 963
series 942, 970
Foreground constant 488
foreground layer of DataWindow 834
Format (Edit.property) 244
Format property 276
formats
of columns 632, 815
of filter criteria 813
sort criteria 850
Frame (Axis.property) 188
functions
aggregate 18, 19, 21
example, counting data 21
example, counting NULLs 20
example, displaying data 26
example, row indicator 25
G
Generate Securely Inline (XMLGen.property) 418
GenerateCSS (HTMLTable.property) 304
1012 PowerBuilder
GenerateDDDWFrames (HTMLGen.property) 296
GenerateHTMLForm method 612
GenerateJavaScript (HTMLGen.property) 296
GetBandAtPointer method 619
GetBorderStyle method 620
GetChanges method 621
GetChild method 624
GetClickedColumn method 627
GetClickedRow method 628
GetColumn method 630
GetColumnName method 631
GetContextService method 632
GetData method 921
GetDataPieExplode method 925
GetDataStyle function 928
GetDataTransparency method 937
GetDataValue method 938
GetFocus event 523
GetFormat method 632
GetFullState method 635
GetItemDate method 638
GetItemDateTime method 641
GetItemDecimal method 643
GetItemFormattedString method 646
GetItemNumber method 647
GetItemStatus method 649
GetItemString method 651
GetItemTime method 653
GetItemUnformattedString method 656
GetMessageText method 659
GetNextModified method 660
GetObjectAtPointer method 662
GetPaintDC function 71
GetPaintRectHeight function 72
GetPaintRectWidth function 73
GetPaintRectX function 73

GetPaintRectY function 74
GetParent method 663
GetRichTextAlign method 664
GetRichTextColor method 665
GetRichTextFaceName method 665
GetRichTextSize method 666, 667
GetRow function 74
GetRow method 668
GetRowFromRowId method 669
GetRowIdFromRow method 671
GetSelectedRow method 672
GetSeriesStyle method 941
GetSeriesTransparency method 952
GetSQLPreview method 673
GetSQLSelect method 673
GetStateStatus method 675
GetText method 677
GetTrans method 678
GetValidate method 682
GetValue method 683
GetUpdateStatus method 680
global transaction objects 861
Graph controls, table of DataWindow object properties 168
graph methods
CategoryCount 917
CategoryName 918
Clipboard 918
DataCount 919
FindCategory 920
FindSeries 921
GetData 921
GetDataPieExplode 925
GetDataStyle 928
GetDataTransparency 937
GetDataValue 938
GetSeriesStyle 941
1014 PowerBuilder
GetSeriesTransparency 952
ObjectAtPointer 953
Reset 955
ResetDataColors 956
SaveAs 957
SeriesCount 958
SeriesName 959
SetDataPieExplode 961
SetDataStyle 962
SetDataTransparency 967
SetSeriesStyle 970
SetSeriesTransparency 976
GraphCreate event 524
graphics
properties of 584
under pointer 662
graphs, overlay 946
GraphType property 279, 358
grColorType enumerated data type 488
grDataType enumerated data type 488, 922
greater than operator 6
greater than or equal to operator 6
Grid.ColumnMove property 279
Grid.Lines property 280
GridColumns (Table.property) 384
grObjectType enumerated data type 489
Group keyword, table of DataWindow object properties 171
GroupBox controls, table of DataWindow object properties 170
GroupBy property 281
GroupCalc method 684
groups
filtering 595
recalculating levels 684
sorting 879
grResetType enumerated data type 956
grSymbolType enumerated data type 490

H
Hand constant 492
Hatch (Brush.property) 205
header band
locating 619
Header constant 483
Header properties. See Bandname properties
Header.# properties. See Bandname properties
Header_Bottom_Margin property 282
Header_Top_Margin property 282
Height (Bandname.property) 197
Height property 283
height, object 749
Height.AutoSize (Bandname.property) 197
Height.AutoSize property 284
Height.Autosize property for bands 199
Help properties 285
hidden objects 876
Hide method 685
HideGrayLine property 286
HideSnaked property 287
HighContrastInk (InkPic.property) 314
highlighting
rows 702, 790
scrolling 778, 781, 782, 785
Horizontal constant 487
horizontal fill pattern 487
HorizontalScrollMaximum property 289
HorizontalScrollMaximum2 property 289
HorizontalScrollPosition property 290
HorizontalScrollPosition2 property 290
HorizontalScrollSplit property 291
Horizontal_Spread property 288
Hour function 75
HScrollBar (dddw.property) 231
1016 PowerBuilder
HScrollBar (Edit.property) 244
HScrollBar (InkEdit.property) 311
HSplitScroll (dddw.property) 231
HTextAlign property 292
HTML generation properties 296, 417
HTML link generation properties 292
HTMLContextApplied event 524
HTMLDW property 294
HTMLGen properties 296
HTMLTable constant 492
HTMLTable properties 304
HTMLVersion (HTMLGen.property) 296
J
ID property 305
Identity property 305
If function 76
IgnorePressure (Ink.property) 309
image
in computed field 35
setting row focus indicator 842
Import.XML.Trace property 306
Import.XML.TraceFile property 307
Import.XML.UseTemplate property 308
ImportClipboard method 686
ImportFile method 689
importing, data 689, 693
ImportString method 693
IN operator 6
Indent (Tree.property) 400
InfoMaker functions
Len 90
Mid 102
Pos 118
Right 128
Initial property 309
initialization files, reading 119, 120

Ink properties 309
InkControl, clearing ink 746
InkControl, saving a picture 770
InkControl, saving ink 768
InkEdit properties 311
InkEnabled (InkPic.property) 314
InkMode (InkEdit.property) 311
InkPic properties 314
InkPicture control (DataWindows) 171
InkPicture properties 314
Inline (XMLGen.property) 418
Insert (Table.property) 384
InsertDocument method 697
inserting strings 124, 125
insertion point
in text line 787, 880
when pasting from clipboard 726
InsertRow method 699
Int function 77
integer
converting to 78
converting to char 38
Integer function 78
internal transaction object 747
Invert property 316
IsDate function 78
IsExpanded function 79
IsExpanded method 700
IsNull function 80
IsNumber function 80
IsRowModified function 81
IsRowNew function 81
IsSelected function 82
IsSelected method 702
IsTime function 83
ItemChanged event 526, 557, 588, 677, 885
1018 PowerBuilder
ItemError event 527, 557, 677
ItemFocusChanged event 529
items
editing 677
setting value of 866
Justify constant 483
K
Key property 318
keyboard, selecting text 566
KeyClause property 319
KeyDown event 530
L
Label (Axis.property) 188
Label properties 319
label, under pointer 662
LabelDispAttr (Axis.property) 188
LabelDispAttr font properties. See DispAttr font properties
language escape character, versus DataWindow escape character 456
Large function 83
Last function 85
LastRowOnPage property 322
Left constant 483
Left function 88
LeftA function 89
Left_Margin property 322
LeftText (Checkbox.property) 209
LeftText (RadioButtons.property) 355
LeftTrim function 89
Legend property 322
Legend.DispAttr font properties. See DispAttr font properties
Len function 90
LenA function 90
length
selected text 786
string 90
less than operator 6

less than or equal to operator 6
Level property 323
LIKE operator 6
limit 37
Limit (dddw.property) 231
Limit (ddlb.property) 235
Limit (Edit.property) 244
Limit (InkEdit.property) 311
line breaks on different platforms 455
Line controls, table of DataWindow object properties 172
LineColor constant 488
LineCount method 703
LineRemove property (RichText only) 324
lines
counting number of 703
graphs, color for data points 963
graphs, color for series 942, 970
graphs, style for data points 930, 964
graphs, style for series 943, 944, 945, 972
scrolling 771
selected text 787
text 880
width 931
under pointer 662
Lines (dddw.property) 231
LineStyle enumerated data type 490
Link (HTML.property) 292
LinkArgs (HTML.property) 292
LinkTarget (HTML.property) 292
LinkUpdateOptions property 324
locks 859
Log function 91
logarithms 91, 92
logical expressions, truth table 9
logical operators 9
1020 PowerBuilder
LogTen function 92
Long function 92
LongParm, posting events 736
longs, converting to 92
LookUpDisplay function 93
loops, avoiding infinite 807, 841, 885
LoseFocus event 530, 557
Lotus 1-2-3 format 762
Lower function 93
lowercase 93
Lowered constant 483
M
MajorDivisions (Axis.property) 188
MajorGridLine (Axis.property) 188
MajorTic (Axis.property) 188
Margin (Print.property) 342
Mask (EditMask.property) 248
masks, matching 94
Match function 94
Max function 96
maximum value
below a limit 77
columns 96
crosstabs 48, 50
MaximumValue (Axis.property) 188
Median function 98
Message.Title property 325
messages
database error 580
retrieving text 659
MessageText event 531
metacharacters 94
MetaDataType enumerated datatype 491
Method (Table.sqlaction.property) 388
Microsoft Multiplan format 762
Mid function 101

MidA function 102
Min function 102
minimum value
above a limit 37
columns 102
crosstabs 51, 53
MinimumValue (Axis.property) 188
MinorDivisions (Axis.property) 188
MinorGridLine (Axis.property) 188
MinorTic (Axis.property) 188
Minute function 104
Mod function 105
Mode (Background.property) 193
Mode function 105
ModifiedCount method 704
Modify method 705
error handling 459
pros and cons 457
versus property expressions 450
using in JavaScript 475
modulus 105
Month function 108
month, obtaining the day of 63
Move method 720
Moveable property 326
mouse, selecting text 566
MouseMove event 531
MouseUp event 533
MTS method, GenerateResultSet 613
Multiline property (RichText only) 327
multiplication operator 5
N
Name (dddw.property) 231
Name (Edit.property) 244
Name property 327
negative numbers 133
1022 PowerBuilder
Nest_Arguments property 328
nested objects, property expressions 471
Nested property 329
nested reports
associated row number 473
property expression syntax 471
nested strings
about 454
JavaScript 456
PowerBuilder 454
NetscapeLayers (HTMLGen.property) 296
New constant 486
New item status, resetting 749
newline character in PowerBuilder 455
NewModified constant 486
NewModified item status
resetting 749
returning next row with 660
NewPage property 329, 330
NilIsNull (dddw.property) 231
NilIsNull (ddlb.property) 235
NilIsNull (Edit.property) 244
NilIsNull (InkEdit.property) 311
NoBorder border style 620
NoBorder constant 483
NoSymbol constant 490
NOT BETWEEN operator 6, 7
not equal operator 6
NOT IN operator 6, 8
NOT LIKE operator 6
NOT operator 6, 9
NotModified constant 486
NotModified item status, resetting 749
Now function 108
NoWrap (HTMLTable.property) 304
NoUserPrompt property 330

null
checking 80
ignored in aggregate 34, 40, 57, 98, 100, 104, 106, 116
values, in sort criteria format 851
null data items in exported XML 265
Number function 109
NumberJSFile (HTMLGen.property) 296
numbers
category 918
checking string 80
determining maximum 37
determining sign of 133
logarithm of 91, 92
multiplying by pi 117
of day of week 64
of lines, counting 703
of rows in buffers 681
random 122
retrieving from buffers 643, 647
returning remainder 105
rounding 130
truncating 149
U.S. format 18, 19
numeric functions
Abs 29
ACos 29
ASin 31
ATan 32
Ceiling 37
Cos 39
Exp 67
Fact 68
Int 77
Log 91
Mod 105
Pi 117
1024 PowerBuilder
Rand 122
Round 130
Sign 133
Sin 133
Sqrt 136
Tan 146
Truncate 149
numeric values, property expressions 461
O
Object property
data expressions 427
in property expressions 460
ObjectAtPointer method 953
ObjectName (HTMLGen.property) 296
objects
changing position 834
determining type 882
hiding 685
naming 586
parent object 663
posting events 735
redrawing 835
specifying as a column 586
triggering events 881
under pointer 662, 953
Objects property 331
Off (Checkbox.property) 209
Off constant 492
OLE Object controls, table of DataWindow object properties 172
OLE.Client properties 332
OLEActivate method 721
OLEClass property 332
On (Checkbox.property) 209
OneTripEx method 722
operators

arithmetic 5
concatenation 10
logical 9
precedence 11
relational 5
OR operator 9
Oracle, quotes in DataWindow painter 715
Orientation (Print.property) 342
OriginLine (Axis.property) 188
Other (Checkbox.property) 209
Oval controls, table of DataWindow object properties 173
OverlapPercent property 334
overlay 946, 975
Override_Edit (Criteria.property) 216
OverridePrintJob (Print.property) 342
Outline (Print.Preview.property) 341
P
page
absolute 110
current 110
current horizontal 111
total 112
total across 112
Page (Print.property) 342
Page function 110
PageAbs function 110
PageAcross function 111
PageCount function 112
PageCountAcross function 112
PageSize (HTMLGen.property) 296
paging methods
ScrollNextPage 775
ScrollPriorPage 780
paging, client-side 299
PagingMethod (HTMLGen.property) 296
PagingMethod enumerated datatype 495
1026 PowerBuilder
Paint function 113
Paper (Print.property) 342
parameters, setting in transaction object 859, 861
parsing strings 88, 89, 117, 118
Password (Edit.property) 244
Paste method 726
PasteRTF method 727
pasting, from clipboard 726
pattern matching 94
pbm_dwngraphcreate event 970
PBSELECT statement 585, 673
Pen properties 334
Pentip (Ink.property) 309
Percent function 114
PercentWidth (dddw.property) 231
performance
and SetTrans method 859
and SetTransObject method 861
and transaction objects 748
DWObject variables 463
getting DataWindow data 426
Modify method versus property expression 458
period in text patterns 95
Perspective property 336
Pi function 117
pictures
as row focus indicators 843
in computed fields 25, 35
PictureSizeMode (InkPic.property) 314
pie graphs 925, 961
Pie.DispAttr font properties. See DispAttr font properties
PlotNullData property 339
plus sign in text patterns 95
pointer
determining distance from edge 728
distance from top 729

locating bands 619
returning object under 662, 953
Pointer (Bandname.property) 197
Pointer property 340
PointerX method 728
PointerY method 729
pointing hand 842
Pos function 117
PosA function 118
Position method 730
position, of insertion point 730
positive numbers 133
PostEvent method 735
PowerBuilder, event return codes 501
precedence of operators 11
Preview (Print.property) 342
PreviewDelete constant 495
PreviewFunctionReselectRow constant 494
PreviewFunctionRetrieve constant 494
PreviewFunctionUpdate constant 494
PreviewInsert constant 495
PreviewSelect constant 495
PreviewUpdate constant 495
primary buffer 130
modified rows 704
resetting update flags 748
restoring rows to 814
row count 754
Primary constant 485
primary DataWindow control 872, 875
PrimaryLine (Axis.property) 188
Print method 736
print methods
1028 PowerBuilder
Print 736
PrintCancel 740
Print properties 342
Print.Preview properties 341
PrintCancel method 740
PrintEnd event 534
Printer property 350
PrinterName (Print.property) 342
PrintMarginChange event 535
PrintPage event 536
PrintPreview display 706
PrintStart event 537
Procedure (Table.property) 384
ProcessEnter event 537
Processing property 351
profile files, reading 119, 120
ProfileInt function 119
ProfileString function 120
Prompt (Print.property) 342
Prompt For Criteria 706, 715
properties
about 447
conditional values using expressions 450
DataWindow 709
DataWindow expressions as property values 448
examples of setting 448
in expressions 67
null value 459
reporting values of 584
setting width and height 749
syntax 585
values in code 448, 450
values in painter 448, 449
property expressions
Any data type 461
boolean values 461

conditional 14
data type 461
DWObject variables 462
error handling 466
nested objects 471
numeric values 461
row associated with nested report 473
syntax, basic 468
versus Describe and Modify 450
when to use 450
Protect property 352
PSReport constant 492
PSWebDataWindowClass methods
ClearValues 561
Create 569
DeletedCount 581
DeleteRow 583
Describe 584
Filter 594
FilteredCount 595
Find 597
FindGroupChange 601
GetColumn 630
GetColumnName 631
GetFormat 632
GetItemDate 638
GetItemDateTime 641
GetItemNumber 647
GetItemStatus 649
GetItemString 651
GetItemTime 653
GetRow 668
GetValidate 682
GetValue 683
GroupCalc 684
ImportString 693
1030 PowerBuilder
InsertRow 699
ModifiedCount 704
Modify 705
ReselectRow 744
Reset 745
ResetUpdate 748
Retrieve 750
RowCount 754
RowsDiscard 758
SaveAs 762
SetColumn 806
SetDetailHeight 810
SetFilter 812
SetFormat 815
SetItem 821
SetItemStatus 827
SetItemTime 832
SetPosition 834
SetRow 841
SetSort 850
SetSQLSelect 853
SetValidate 864
SetValue 866
Sort 878
Update 883
PublishPath (CSSGen.property) 217
PublishPath (JSGen.property) 317
PublishPath (XMLGen.property) 418
PublishPath (XSLTGen.property) 420
Q
Quality (Print.property) 342
Query mode 706, 715
QueryClear property 353
QueryMode property 354
QuerySort property 354
question mark

in text patterns 95
undefined property value, Describe method 459
quote characters
escape sequences in PowerBuilder 455
for nested strings 454
quotes
in Modify method 708, 715
in property values 586
in sort criteria 850
R
RadioButtons properties 355
Raised constant 483
Rand function 122
random numbers, obtaining 122
Range property 356
RButtonDown event 538
ReadOnly (EditMask.property) 248
Real function 122
RecognitionTimer (InkEdit.property) 311
Rectangle controls, table of DataWindow object properties 173
rectangle, setting row focus indicator 842
recursive call 807
references, to child window 625
RegEdit utility 721
relational operators 5
RelativeDate function 123
RelativeTime function 123
remainder 105
remote access 859
Replace function 124
ReplaceA function 125
ReplaceTabWithSpace property 359
ReplaceText method 743
Report controls, table of DataWindow object properties 175
Report property 359
reports, nested 625
1032 PowerBuilder
Required (Criteria.property) 216
Required (dddw.property) 231
Required (ddlb.property) 235
Required (Edit.property) 244
Required (EditMask.property) 248
Required (InkEdit.property) 311
ReselectRow method 744
reset flag argument 884
Reset method 745, 955
ResetDataColors method 956
ResetInk method 746
ResetPageCount property 360
ResetTransObject method 747
ResetUpdate method 748
Resize event 538
Resize method 749
Resizeable property 360
ResizeBorder constant 483
ResourceBase (CSSGen.property) 217
ResourceBase (HTMLGen.property) 296
ResourceBase (JSGen.property) 317
ResourceBase (XMLGen.property) 418
ResourceBase (XSLTGen.property) 420
Retrieve method 750
Retrieve Only As Needed 706, 717
Retrieve property 361
RETRIEVE statement 861
Retrieve.AsNeeded property 361
RetrieveEnd event 539
RetrieveRow event 540, 577
RetrieveStart event 541, 751
return codes for events 501
return count 751
return values, SQL 861
RGB function 126
rich text

copying with formatting 567, 727
editing header and footer 877
find again 603
selecting 793
selecting a line 796
selecting a word 797
selecting all 795
RichEdit properties 362
RichText properties 364
RichTextEdit methods
CopyRTF 567
FindNext 603
Paste 726
PasteRTF 727
Position 731
ReplaceText 743
ScrollNextPage 776
ScrollNextRow 779
ScrollPriorPage 781
ScrollPriorRow 783
SelectedLine 787
SelectText 793
SelectTextAll 795
SelectTextLine 796
SelectTextWord 797
ShowHeadFoot 877
RichTextError event 543
RichTextGainFocus event 542
RichTextLoseFocus event 542
RichTextToolbarActivation enumerated data type 491
Right constant 483
Right function 128
RightA function 128
RightTrim function 129
Rotation property 368
1034 PowerBuilder
Row.Resize property 369
RowCount function 130
RowCount method 754
RowFocusChanged event 543
RowFocusChanging event 544
RowFocusInd enumerated data type 492
RowHeight function 131
Round function 130
RoundRectangle controls, table of DataWindow object properties 173, 174
RoundTo (Axis.property) 188
RoundToUnit (Axis.property) 188
rows
and bands 74
canceling retrieval 576
checking if modified 81
checking if new 81
clicked 628
copying 755
data 444
deleting 581, 583
displaying in DataWindow 594
getting current 25, 74, 668
getting from ID 669
getting ID 671
height 131
hiding 811
importing 686, 689, 693
in primary buffer 130, 754
inserting 699
modification status 81, 649, 660, 680, 704, 827
moving 759
refreshing timestamp columns 744
replacing text 856
reporting number not displayed 595

retrieving from database 750
scrolling 775, 777, 782
selected data 445
selecting 82, 672, 702, 790
setting current 841
setting height 810
setting value of 821, 831, 832
sorting 878
validating 677
under pointer 662
updating 883
Rows (Crosstab.property) 217
Rows Per Page (HTMLGen.PageSize) 296
RowsCopy method 755
RowsDiscard method 758
RowsMove method 759
Rows_Per_Detail property 369
Rulers (Print.Preview.property) 341
S
Save As dialog box 763, 958
SaveAs method 762, 957
SaveAsAscii method 765
SaveAsFormattedText method 766
SaveAsType enumerated data type 492
SaveInk method 768
SaveInkPic method 770
SaveMetaData enumerated datatype 494
Scale (Checkbox.property) 209
Scale (Print.property) 342
Scale (RadioButtons.property) 355
ScaleType (Axis.property) 188
ScaleValue (Axis.property) 188
scatter graphs, obtaining data point values 922
scripts
last statement 801
triggering events 881
1036 PowerBuilder
Scroll method 771
ScrollHorizontal event 546
scrolling methods
Scroll 771
ScrollNextPage 775
ScrollNextRow 777
ScrollPriorPage 780
ScrollPriorRow 782
ScrollToRow 699, 785
ScrollNextPage method 775
ScrollNextRow method 777
ScrollPriorPage method 780
ScrollPriorRow method 782
ScrollToRow method 785
ScrollVertical event 547
searching
rich text 603
rows 597
Second function 132
secondary DataWindow control 872, 875
SecondaryLine (Axis.property) 188
SecondsAfter function 132
Select (Table.property) 384
selected data 437, 445
Selected property 370
Selected.Data property 371
Selected.Mouse property 371
SelectedLength method 786
SelectedLine method 787
SelectedStart method 788
SelectedText method 789
selection, of rows 82, 702
SelectNodeByMouse (Tree.property) 400
SelectRow method 790
SelectText method
about 791

copying to clipboard 566
SelectTextAll method 795
SelectTextLine method 796
SelectTextWord method 797
SelectTreeNode method 798
SelfLink (HTMLGen.property) 296
SelfLinkArgs (HTMLGen.property) 296
Series property. See Axis properties
series, graphs
clicked 953
counting 958
data points 919, 922, 938, 956
deleting 956
finding number of 921
obtaining name 959
reporting appearance of 941
setting style 970
SeriesCount method 958
SeriesName method 959
server application, sending verb to 721
SessionSpecific (CSSGen.property) 217
SetActionCode method 800
SetBorderStyle method 802
SetChanges method 804
SetColumn method 806
SetCultureFormat method 809
SetDataPieExplode method 961
SetDataStyle method 962
SetDataTransparency method 967
SetDetailHeight method 810
SetFilter method 812
SetFormat method 815
SetFullState method 817
SetHTMLAction method 819
SetItem method 821
SetItemDateByColNum method 824
1038 PowerBuilder
SetItemNumberByColNum method 826
SetItemStatus method 827
SetItemStringByColNum method 831
SetItemTime method 832
SetItemTimeByColNum method 832
SetPosition method 834
SetRedraw method 835
SetRichTextAlign method 836
SetRichTextColor method 837
SetRichTextFaceName method 838
SetRichTextSize method 839
SetRichTextStyle method 840
SetRow method 841
SetRowFocusIndicator method 842
SetSeriesStyle method 970
SetSeriesTransparency method 976
SetSort method 850
SetSQLPreview method 852
SetSQLSelect method 853
SetTabOrder method 855
SetText method 856
SetTransObject method 860
SetValidate method 864
SetValue method 866
SetWSObject method 870
shade
data points 963
series 942, 970
Shade constant 488
ShadeBackEdge (Axis.property) 188
ShadeColor property 372
ShadowBox border style 620
ShadowBox constant 483
ShareData method 871
ShareDataOff method 875
sharing data 871

Show method 876
ShowBackColorOnXP property 373
ShowConnectLines (Tree.property) 400
ShowDefinition property 374
ShowHeadFoot method 877
ShowLeafNodeConnectLines (Tree.property) 400
ShowList (dddw.property) 231
ShowList (ddlb.property) 235
ShowTreeNodeIcon (Tree.property) 400
Sign function 133
Sin function 133
sine 133
size
changing 749
of string 90
SizeToDisplay property 375
SlideLeft property 375
SlideUp property 376
Small function 134
Solid constant 487
solid fill pattern 487
Sort (Axis.property) 188
Sort (Table.property) 384
Sort method 878
sort order
sharing data 871
specifying criteria 850
Sort property 377
Sorted (ddlb.property) 235
SourceNames (Crosstab.property) 217
Space function 136
spaces
deleting leading 89
deleting trailing 129
inserting in a string 136
removing from strings 148
1040 PowerBuilder
Spacing property 377
Sparse property 378
special characters in strings 454
Specify filter dialog box 813
Specify Sort Columns dialog 851
Spin (EditMask.property) 248
SpinIncr (EditMask.property) 248
SpinRange (EditMask.property) 248
SQL Anywhere 715
SQL statements
and modification status 649
and SetTrans method 858
and SetTransObject method 861
and Update method 884
changing during execution 852, 853
CONNECT 751
modifying WHERE clause of SELECT 706
previewing 673
saving DataWindow SQL 762
SELECT and sharing data 871
SELECT, obtaining 585
specifying retrieval arguments 750
SQLCA 861
SQLInsert constant 492
SQLPreview event 548, 673, 680, 852
SQLPreviewFunction enumerated data type 494
SQLPreviewType enumerated data type 495
SQLSelect (Table.property) 384
Sqrt function 136
Square constant 487
square fill pattern 487
square root 136
stack faults, avoiding 807, 885
standard deviation 137, 139
StateIconAlignMode (Tree.property) 400
StaticMode (Crosstab.property) 217

status
changing 749, 827
of rows and columns 649, 680
StDev function 137
StDevP function 139
Storage property 379
String function 142
string functions
Asc 30
AscA 31
Char 38
CharA 38
Fill 68
FillA 69
Left 88
LeftA 89
LeftTrim 89
Len 90
LenA 90
Lower 93
Match 94
Mid 101
MidA 102
Pos 117
PosA 118
Replace 124
ReplaceA 125
Right 128
RightA 128
RightTrim 129
Space 136
Trim 148
WordCap 155
Upper 149
StringJSFile (HTMLGen.property) 296
strings
1042 PowerBuilder
comparing 8
concatenating 10
converting 61, 92, 109, 122
deleting leading spaces 89
detecting contents 78, 80, 83
extracting 101, 102
finding substrings 117, 118
lowercase 93
retrieving from buffers 651
uppercase 149
StripRTF function 144
structure of DataWindow 585
Style (Edit.property) 244
Style (Pen.property) 334
Style keyword, table of DataWindow object properties 176
style, border 620
StyleBox constant 484
StyleLowered constant 484
StyleRaised constant 484
StyleShadowBox constant 484
StyleSheet (HTMLTable.property) 304
substring
extracting 101, 102
finding 117, 118
replacing 124, 125
subtraction operator 5
Sum function 144
Summary properties. See Bandname properties
summary, moving objects to 834
Suppress (Bandname.property) 197
SuppressEventProcessing property 380
SYLK constant 492
Symbol constants for graphs 490
symbol types in graphs, for data points 931, 965, 966
Syntax property 381

syntax, for creating objects 719
Syntax.Data property 381
Syntax.Modified property 382
system and environment functions
ProfileInt 119
ProfileString 120
system date 148
system time 108
T
tab character
in PowerBuilder 455
property expression syntax 451
tab order 855
TabDownOut event 550
TabIndexBase (HTMLGen.property) 296
Table properties 384
Table property
Create function 382
InkPicture objects 383
TableBlob objects 383
Table SQLAction properties 388
TableBlob controls, table of DataWindow object properties 177
tables, database
accessing multiple 859
changing update status 706
names 854
updating multiple 713
TabUpOut event 551
Tag property 391
Tan function 146
tangent 146
Target property 391
Template property 392
text
deleting from edit controls 560
finding in RichTextEdit 603
1044 PowerBuilder
finding substrings 117, 118
importing data from string 693
metacharacters 94
obtaining current line 880
on clipboard 566, 575
pasting over 726
replacing 743, 856
restoring 882
selecting 786, 789, 791
setting color of 126
Text (Checkbox.property) 209
Text constant 492
Text controls, table of DataWindow object properties 177
text file
saving to 762, 957
Text property 393
TextLine method 880
Texture properties 336
tilde character
about 708
escape sequence in PowerBuilder 455
in nested strings 454, 456
SpinRange property 455, 457
time
checking string 83
converting to data type 147
DateTime data type 62
minutes 104
now 108
relative 123
retrieving data from 641
retrieving from buffers 653
seconds 132
Time function 147
Timer_Interval property 393

timestamps 744
Title keyword, table of DataWindow object properties 178
Title property 394
Title.DispAttr font properties. See DispAttr font properties
Today function 148
Tooltip properties 395
top
bringing object to 876
determining distance from 729
total of values
columns 144
crosstabs 54, 55
running 58
trailer
locating 619
Trailer.# properties. See Bandname properties
Trail_Footer property 397
Transaction objects
getting values of 678
resetting 747
specifying 861
specifying before row retrieval 751
Transparency (Ink.property) 309
Transparent constant 490
transparent line style, graphs
Tree properties 400
Tree.Level properties 403
TreeNodeIconName (Tree.Leaf property) 403
TreeNodeSelected event 551
TreeNodeSelecting event 552
TreeView DataWindow methods
1046 PowerBuilder
Collapse 561
CollapseAll 562
CollapseAllChildren 563
CollapseLevel 564
Expand 590
ExpandAll 591
ExpandAllChildren 592
ExpandLevel 593
IsExpanded 700
SelectTreeNode 798
TrigEvent enumerated data type 735
TriggerEvent method 881
Trim function 148
Truncate function 149
truth table for boolean expressions 9
Type (Table.sqlaction.property) 388
Type property 404
TypeOf method 882
Types of graphs, constants 489
typographical conventions xvii
W
ValidateCode (Edit.property) 244
Validation property 407
validation rules
and SetItem method 822
checking on update 884
obtaining 682
setting 864
validation rules, and expressions 17
ValidationMsg property 408
ValueIsHTML (HTML.property) 292
values
checking for null 80
data points 938
detecting numeric 80
edit control 677

obtaining column 683
setting item 866
setting text in edit control 856
Values (Crosstab.property) 217
Values properties, graphs. See Axis property
Values property, columns 409
Var function 150
variables, in Modify function 458, 475
variables, in Modify method 708
variance 150, 153
VarP function 153
week, day of 63, 64
Vertical constant 487
vertical fill pattern 487
VerticalScrollMaximum property 411
VerticalScrollPosition property 411
Vertical_Size property 410
Vertical_Spread property 410
WHERE clause 706, 709, 714, 715
width
data point's line 964
series line 972
setting 749
Width (HTMLTable.property) 304
Width (Ink.property) 309
Width (Pen.property) 334
Width property 413
Width.Autosize property (RichText only) 414
Visible property
about 412
setting 876
WK1/WKS file 762
WKS, WK1 constants 492
WMF constant 492
underline border style 620
Underline constant 483
1048 PowerBuilder
Undo
providing capability 761
testing 559
Undo method 882
Units property 406
units, distance from edge 728
WordCap function 155
WordParm field, posting events 736
Update (Table.property) 384
update flags 748
Update method 883
Update property 406
update status
after row copy 756
changing 706, 827
resetting flags 748
UpdateEnd event 552
UpdateKeyInPlace (Table.property) 384
UpdateStart event 553
UpdateTable (Table.property) 384
UpdateWhere (Table.property) 384
UpdateWhere (Table.sqlaction.property) 388
Upper function 149
uppercase 149
VScrollBar (dddw.property) 231
VScrollBar (ddlb.property) 235
VScrollBar (Edit.property) 244
VScrollBar (InkEdit.property) 311
UseAsBorder (dddw.property) 231
UseAsBorder (ddlb.property) 235
UseEllipsis (Edit.property) 247
UseEllipsis (EditMask.property) 251
UseFormat (EditMask.property) 248
UseMouseForInput (InkEdit.property) 311
user events, pbm_dwngraphcreate 970

user-defined functions in DataWindow expressions 18, 451
UserJSFile (HTMLGen.property) 296
VTextAlign property 413
X
X property 415
x value, data point 922
X1, X2 properties 416
XHTMLGen.Browser 417
XHTMLGen.PublishPath 317, 418, 420
XHTMLGen.ResourceBase 317, 418, 420
XML generation properties 317, 418, 420
xValue constant 488
xValue enumerated data type 922
Y
Y property 421
y value, data point 922
Y1, Y2 properties 422
Year function 156
yValue constant 488
yValue enumerated data type 922
Z
zero, determining 133
Zoom (Print.Preview.property) 341
Zoom property 422
1050 PowerBuilder

Datawindow Reference

Uploaded by

Datawindow Reference

Uploaded by

DataWindow® Reference

LAST REVISED: July 2017

Copyright © 2017 by Appeon Limited. All rights reserved.

About This Book ........................................................................................................................ xvii

CHAPTER 1 DataWindow Operators and Expressions..................................... 1

CHAPTER 2 DataWindow Expression Functions ............................................ 17

DataWindow Reference iii

RelativeTime ......................................................................... 123

CHAPTER 3 DataWindow Object Properties .................................................. 157

Properties for GroupBox controls in DataWindow objects .... 170

CHAPTER 4 Accessing Data in Code ............................................................. 425

CHAPTER 5 Accessing DataWindow Object Properties in Code ................ 447

DataWindow Reference vii

Basic structure of DataWindows and property expressions in

CHAPTER 6 DataWindow Constants............................................................... 479

CHAPTER 7 Properties of the DataWindow Control and DataStore ............ 497

CHAPTER 8 DataWindow Events .................................................................... 501

WSError ....................................................................................... 553

CHAPTER 9 Methods for the DataWindow Control ....................................... 555

GenerateXMLWeb ....................................................................... 617

GetText ........................................................................................ 677

SaveInk ........................................................................................ 768

DataWindow Reference xiii

SetRedraw ................................................................................... 835

CHAPTER 10 Methods for Graphs in the DataWindow Control...................... 917

The installation guide in PDF format can be accessed from the

DataWindow Reference xvii

Where you use DataWindow expressions

Table 1-1: Using DataWindow expressions in painters

Other types of expressions you use

Expressions for graphs and crosstabs

Table 1-4: Using expressions with values from other columns

Operators used in DataWindow expressions

Arithmetic operators in DataWindow expressions

Relational operators in DataWindow expressions

Table 1-7: Using expressions with relational operators

For example, the following expression for the Background.Color property of

Comparing strings in DataWindow expressions

For information about these functions, see Using DataWindow expression

Logical operators in DataWindow expressions

Table 1-10: Combining expressions with logical operators

Concatenation operator in DataWindow expressions

Table 1-11: Using expressions with concatenation operator

Operator precedence in DataWindow expressions

To force evaluation in a different order, group expressions with parentheses.

Evaluating DataWindow expressions in scripts

Evaluating DataWindow expressions in the Describe

ls_modstring = "Evaluate('Page()'," + ls_rownum +")"

Evaluating conditional DataWindow expressions with

IF NOT IsNumber(ls_protect) THEN

// Get the expression following the tab (~t)

// Build string for Describe. Include a leading

Using DataWindow expression functions

Decimal support in DataWindow expressions

If either operand is not a decimal, the returned value is converted to a double

The following functions return a decimal result instead of a double:

The Dec function converts a constant string to a decimal.

Example 1: counting null values in a column

counts the number of IDs (which is also the number of rows);

Example 2: counting male and female employees

An aggregate function is a function that operates on a range of values in a

About crosstab functions

 To display the males and females in each department:

counts the number of males in each department;

Example 3: creating a row indicator

Example 4: displaying all data when a column allows nulls

Alphabetical list of DataWindow expression functions

Return value The datatype of n. Returns the absolute value of n.

Return value Double. Returns the arc cosine of n if it succeeds.

Return value Double. Returns the arc sine of n if it succeeds.

This expression returns .520311 (rounded to six places):

Return value Double. Returns the arc tangent of n if it succeeds.

Not in validation rules or filter expressions

Using an aggregate function cancels the effect of setting Retrieve Rows As

For computed fields only

Syntax Bitmap ( string )