Navigation:  Classes > bBrowser >

bBrowser:GetCaptionRect()

Print this Topic    Previous pageReturn to chapter overviewNext page

Purpose

Calculates the rectangle for the column caption.

Class

bBrowser

Type

Method

Syntax

<oBrowser>:GetCaptionRect(

<uColumn>,

<srcArea>

) Æ lSuccess

Arguments

<uColumn>The column for which the area is to be calculated. The column must be contained in the list of opened columns (see also bBrowser:ColumnOpenList).
Data type:String | Symbol | Integer | bDataColumn

 

<srcArea>The rectangle structure in which the calculated area for the column caption is returned.

The structure must be specified by reference.

Data type:_winRect

Return Value

lSuccessA logical value that indicates whether the area for the column caption was calculated.
TRUEThe area was calculated.
FALSEThe area could not be calculated.
Data type:Logic

Description

bBrowser:GetCaptionRect() calculates the area within which the caption is displayed.

Samples

The following sample determines the caption area of the first column.

 

LOCAL odbsCUSTOMER AS DBServer

LOCAL oBrowser     AS bBrowser

LOCAL srcArea      IS _winRECT

 

// Create browser and show it

odbsCUSTOMER := DBServer{"CUSTOMER"}

oBrowser := bBrowser{oOwner,;

                     1000,;

                     Point{0, 0},;

                     Dimension{300, 250}}

oBrowser:Use(odbsCUSTOMER)

oBrowser:Show()

 

// Determine the caption area of the first column

oBrowser:GetCaptionRect(1, @srcArea)

 

? srcArea.Left

? srcArea.Top

? srcArea.Right

? srcArea.Bottom

See Also

bBrowser:GetCellFocusRect()

bBrowser:GetCellRect()

bBrowser:GetCellToPoint()

bBrowser:GetColumnRect()

bBrowser:GetColumnToPoint()

bBrowser:GetEditRect()

bBrowser:GetFooterRect()

bBrowser:GetInfoRect()

bBrowser:GetRowRect()

bBrowser:GetSelectorRect()

bBrowser:GetValueRect()

 


Page url: http://www.YOURSERVER.com/index.html?bbrowser_getcaptionrect.htm