GetBandAtPointer – PB Docs 150

GetBandAtPointer method (DataWindows)

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.

Controls

DataWindow type

Method applies to

PowerBuilder

DataWindow control

Web ActiveX

DataWindow control

Syntax

[PowerBuilder]

[Web ActiveX]

Argument

Description

dwcontrol

A reference to a DataWindow control.

Return Values

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.

If dwcontrol is null, the method returns
null.

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 DataWindow object

The row at the pointer. If rows do not
fill 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 DataWindow object

The first row visible in the DataWindow body.

header.n

In the header of group level n

The first row of the group.

trailer.n

In the trailer of group level n

The last row of the group.

footer

In the footer of the DataWindow object

The last row visible in the DataWindow body.

summary

In the summary of the DataWindow object

The last row before the summary.

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:

Some possible return values are:

Table 9-4: 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


Document get from Powerbuilder help
Thank you for watching.
Was this article helpful?
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x