gAlignment (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Controls, pages and windows / Graphic string functions

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

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.

In a window, this sequence of characters is used to align a text or an image:

in an element of a List Box or Combo Box control.
in the title bar and/or status bar of a window.
in a Static Text control.

Note The function gAlignment function only works for image display (gImage function) and text display.

Example

// Cadrage à droite des 20 premiers éléments dans la liste "LISTE_ListeClient" 
FOR Indice = 1 TO 20
	ListAdd(LISTE_ListeClient, gAlignment("D", Nom[Indice]))
END

// Cadrage horizontal et vertical dans un champ Libellé 
LIB_Libellé1 = gAlignment("GV", "BOB")
LIB_Libellé1 = gAlignment("GB", "BOB")

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.
This sequence of characters can be:
used in ListAdd, ListInsert or ListModify.
assigned to a Static Text control.
used in the title bar or status bar of a window.
This sequence of characters is not interpreted by the controls in WEBDEV. This function can be used to format the string returned by a WEBDEV web service consumed by a WINDEV or WINDEV Mobile application.

<Type of alignment>: Character

Type of alignment for the elements to align. The vertical alignment must necessarily be specified after the horizontal alignment.
"B" Vertical alignment at the bottom.
"C" Centered.
"D" Right-aligned.
"G" Left-aligned.
"H" Vertical alignment at the top.
"V" Vertical alignment in the middle.
"X" Same horizontal alignment as the previous element.
"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:

Example for a List Box control:

ListInsert(LISTE_Ville, gCircle(0, 0, 15, 15, LightBlue) + ...
	gCoord(15, 0) + gAlignment("C", "Avignon", 15, 80) + ...
	gRectangle(80, 0, 115, 15, LightRed))

ListInsert(LISTE_Ville, gCircle(0, 0, 15, 15, LightBlue) + ...
	gCoord(15, 0) + gAlignment("C", "Lyon", 15, 80) + ...
	gRectangle(80, 0, 115, 15, LightRed))

ListInsert(LISTE_Ville, gCircle(0, 0, 15, 15, LightBlue) + ...
	gCoord(15, 0) + gAlignment("C", "Montpellier", 15, 80) + ...
	gRectangle(80, 0, 115, 15, LightRed))

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).

Reminder: For a List (or Combo) field, the height of the field line is defined in the field's "Detail" window.

Checking the display

gAlignment controls how elements are displayed 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: wd300mdl.dll