gAlignment (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Aligning a text between two shapes (a circle and a rectangle)
Vertically centered
Checking the display
Background color
Component

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

gAlignment (Function)

In french: gCadrage

Builds a sequence of characters containing an aligned text or an aligned image.

Remark: gAlignment only operates on the display of images (gImage) and on the display of text.

Versions 22 and later

This function is now available for WEBDEV sites in Windows.

New in version 22

This function is now available for WEBDEV sites in Windows.

Example

Syntax

<Result> = gAlignment(<Type of alignment> , <String to align> [, <X1> [, <X2>]])

<Result>: Character string

Sequence of characters defining the alignment of a text or image.

<Type of alignment>: Character

Type of alignment for the elements to align. The vertical alignment must necessarily be specified after the horizontal alignment.
"D" Right-aligned.
"C" Centered.
"G" Left-aligned.
Versions 21 and later
"X"
New in version 21
"X"
"X" Same horizontal alignment as the previous element.
"H" Vertical alignment at the top.
"V" Vertical alignment in the middle.
"B" Vertical alignment at the bottom.
Versions 21 and later
"Y"
New in version 21
"Y"
"Y" Same vertical alignment as the previous element.

<String to align>: Character string

Elements to align. This parameter can contain functions for graphic formatting (starting with the letter "g") used to:
add drawings to the text,
modify the text formatting (background color, text color, etc.).

<X1>: Optional real

Horizontal position of the left corner for the reference rectangle of the alignment area. If this parameter is not specified, the vertical position will be set to 0 (see the Notes).

<X2>: Optional real

Horizontal position of the right corner for the reference rectangle of the alignment area. If this parameter is not specified, the vertical position will be equal to the right border of the element where the string will be displayed (see the Notes).

Remarks

Aligning a text between two shapes (a circle and a rectangle)

To perform this operation, all you have to do is specify <x1> and <x2>. For example:

Vertically centered

The elements displayed in the reference rectangle of the alignment area are vertically centered in relation to the height of the element that displays the sequence of characters (in relation to the height of the row found in the List Box or Combo Box control for example).

Checking the display

gAlignment checks the display in the specified area. Any image or text that is displayed outside the alignment area will be truncated.

Background color

The reference rectangle where the alignment is performed is filled with the current background color.

Component

Until version 21, gAlignment was available in the wdxxxobj component. From version 22, this function is now available in the wdxxxmdl component.

Component : wd250mdl.dll