iBorder (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Lightness of black color

Various

See also

iBorder (Function)

In french: iCadre

Prints a border at specified coordinates.

Remark: The origin (0,0) is located in the top left corner of the sheet. It takes the physical margins of printer into account.

Caution: The borders will be printed only if the printer supports this feature. See Characteristics of a print on Mobile Device (Pocket PC) for more details.

Versions 18 and later

This function is now available for iPhone/iPad applications.

New in version 18

This function is now available for iPhone/iPad applications.

Versions 19 and later

This function is now available in Android Widget mode.

This function is now available for Android applications.

New in version 19

This function is now available in Android Widget mode.

This function is now available for Android applications.

This function is now available in Android Widget mode.

This function is now available for Android applications.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

See additional examples

iPrint(iXPos(50) + CU.CUSTNAME)
// Encloses the text in a line equal to 2 Pica point
// The background of the border is gray at 50%
iBorder(0, 0, iPageWidth(), 10, 2, 50)

Syntax

iBorder(<X1> , <Y1> , <X2> , <Y2> [, <Thickness> [, <Fill> [, <Color> [, <Line> [, <Brush> [, <Border>]]]]]])

<X1>: Real

Horizontal coordinate of top left corner of border (in millimeters). This corner defines the external side of border.
Value included between 0 and the page width (returned by iPageWidth).

<Y1>: Real

Vertical coordinate of top left corner of border (in millimeters). This corner defines the external side of border.
Value included between 0 and the page height (returned by iPageHeight).

<X2>: Real

Horizontal coordinate of bottom right corner of border (in millimeters). This corner defines the external side of border.
Value included between 0 and the page width (returned by iPageWidth).

<Y2>: Real

Vertical coordinate of bottom right corner of border (in millimeters). This corner defines the external side of border.
Value included between 0 and the page height (returned by iPageHeight).

<Thickness>: Optional real

Thickness of border line (in picas). Default value = 1 (one Pica = 0.353 mm).

Caution: Depending on the value of this parameter, the thickness is achieved by adding several lines next to each others from the outside to the inside.

This parameter must correspond to an integer value. Otherwise, the thickness will be rounded to the nearest integer value.

<Fill>: Optional integer (included between 1 and 200)

Rate for the line color and for the background color. If this parameter is:
Equal to 0 (default value): no fill.
Equal to 100: entirely filled with the specified color.
Less than 100: the closer this parameter is to 0, the more the color brightens.
Greater than 100: the closer this parameter is to 200, the more the color darkens.

<Color>: Optional integer

Color used for the background and for the border. If this parameter is not specified, the color used is black.
This color can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a preset color of WLanguage.

<Line>: Optional integer constant

Type of line.
iContinuous
(Default value) Solid line
iDotAndDash Dot-and-dash line (-.-.)
iDotted Dotted line (....)
iDashed Dashed line (-----)
This parameter is not available in this version. A WLanguage error will occur if this parameter is specified.

<Brush>: Optional integer constant

Pattern used to fill the border.
iCrossed Crossed brush
iDiagonalCrossed Brush crossed diagonally
iUpwardDiagonal Upward diagonal brush
iDownwardDiagonal Downward diagonal brush
iHorizontal Horizontal brush
iSolid
(default value) Solid brush
iVertical Vertical brush
This parameter is not available in this version. A WLanguage error will occur if this parameter is specified.
This parameter is ignored.

<Border>: Optional integer constant

Sides of border to draw:
iBorderNone The border has no side
iBorderAll
(Default value) All the border sides are drawn
iBorderRight The right side is drawn
iBorderLeft The left side is drawn
iBorderTop The top side is drawn
iBorderBottom The bottom side is drawn.
This parameter is not available in this version. A WLanguage error will occur if this parameter is specified.

Remarks

Lightness of black color

For the black color, the rate corresponds to a rate of gray whose values are included between 1 (white) and 100 (solid black). In this case, the values greater than 100 will be processed like the value 100.

Various

The cursor position is not modified when the outline is drawn.
The dotted type (iDotted) or the mixed type (iDotAndDash) combined with a thick border may produce unpleasant effects.

Component : wd260prn.dll