DataWindow Reference
Accessing Data in Code

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 errors

If the datatype of the expression is not compatible with how the expression is 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.

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

Data structures for data

Single row and column

When your data expression refers to a single row 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 structures

The following table presents some examples of data specified by an expression and the type of data structures you might define for storing the data:

Assigning data to arrays

When a data expression is assigned to an array, values are assigned beginning 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.

Any datatype and data expressions

The actual datatype of a DataWindow data expression is Any, which allows the 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:

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[2] = CREATE uo_empdata
luo_empdata[3] = CREATE uo_empdata
luo_empdata = dw_1.Object.Data[1,1,3,4]

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 array

When your data expression refers to a single row and column, you can set the 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 whole rows

When the expression refers to more than one column, you can assign the data 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 values

You do not have to know in advance how many rows are involved when you 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:

If the target expression is all rows but not all columns, then:

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

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