iHLine (Function)

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

iChangeSubReportSource

iInitReportQueryConnection

iReportPrintingStatus

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

iHLine (Function)

In french: iTraitH

Prints an horizontal line at specified coordinates. Unlike iNewLine, the end of line is squared (instead of being rounded). The line is drawn at cursor location (configured by iYPos).

The print is not started (only iEndPrinting can be used to start the print).

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

The lines will be printed only if the printer supports this feature. See Characteristics of a print on Pocket PC for more details.

Versions 18 and later

This function is now available for the iPhone/iPad applications.

New in version 18

This function is now available for the iPhone/iPad applications.

Versions 19 and later

This function is now available for the Android applications.

This function is now available in Android Widget mode.

New in version 19

This function is now available for the Android applications.

This function is now available in Android Widget mode.

This function is now available for the Android applications.

This function is now available in Android Widget mode.

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

// Draws a line across the page width
// Thickness: 2.5 Pica
iHLine(0, iPageWidth(), 2.5)
iEndPrinting()

Syntax

<Result> = iHLine(<X1> , <X2> [, <Thickness> [, <Color> [, <Style>]]])

<Result>: Boolean

True if the line was printed,
False otherwise.

<X1>: Real

Horizontal coordinate of the beginning of line (in millimeters). Value included between 0 and the page width (returned by iPageWidth).

<X2>: Real

Horizontal coordinate of the end of line (in millimeters). Value included between 0 and the page width (returned by iPageWidth).

<Thickness>: Optional real

Line thickness (in picas). By default, this thickness is equal to 1 (one Pica = 0,353 mm).
To get a thickness of 1 pixel, <Thickness> must be equal to 0. When the thickness increases, it is proportionally distributed between the two sides of line.

<Color>: Optional integer

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

<Style>: Optional integer constant

Type of line.
iContinuous
(default value) Solid line
iDotted Dotted line (....)
iDotAndDash Dot-and-dash line (-.-.)
iDashed Dashed line (-----)
Caution: To get a dotted line, <Thickness> must be equal to 0. If <Thickness> is greater than or equal to 1, the line will always be a solid line. This parameter can be ignored if it is not supported by the printer driver.
This parameter always corresponds to a solid line. If one of the constants corresponding to the other types of lines is used, this constant will be ignored.

Remarks

The line is drawn at vertical cursor location (configured by iYPos).
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 : wd240prn.dll