GdipGetStringFormatTabStops()


Syntaxe
Resultat.i = GdipGetStringFormatTabStops(*format, count.l, @firstTabOffset.f, *tabStopf)
Paramètres
*format

[in] Pointeur sur un objet StringFormat existant.

count.l

[in] Nombre entier signé qui spécifie le nombre d'éléments du tableau des offsets pour les taquets de tabulation (paramètre *tabStops).

firstTabOffset.f

[out] firstTabOffset recevra un nombre flottant qui indique la position de l'offset (décalage) initiale. La position de l'offset initiale est relative à l'origine de la chaîne et l'offset du premier taquet de tabulation est relatif à la position de l'offset initial.

*tabStops

[out] Pointeur sur un tableau de nombres flottants (tableau dimensionné avec redim ou zone mémoire allouée) qui recevra les valeurs correspondantes aux distances entre les taquets de tabulation dans les unités spécifiées par la fonction GdipSetPageUnit(). L'offset du premier taquet de tabulation est la première valeur du tableau, celle du second taquet de tabulation est la deuxième valeur du tableau etc.

Description

Cette fonction permet de retrouver les taquets de tabulation pour l'objet StringFormat et l' l'offset initial relatif à l'origine de la chaîne.

Chaque offset de taquet de tabulation dans le tableau est relatif au précédent sauf le premier qui est relatif à la position de l'offset initiale spécifiée par firstTabOffset. Par exemple, si la position d'offset initiale est 8 et que le premier offset de taquet de tabulation est 50, le premier taquet de tabulation se trouve à la position 58. Si la position d'offset initiale est zéro, le premier offset de taquet de tabulation est relatif à la position 0, l'origine de la chaîne et se trouve à la position 50.

L'exemple est le même que celui de la fonction GdipSetStringFormatTabStops() et crée un image sur laquelle la chaîne sera affichée. Avec un TrackBarGadget, on peut régler la position d'offset initiale entre 0 et 200. La chaîne à afficher comporte 3 tabulations qu'il faut définir soit avec CHR(9) soit avec la constante Purebasic #TAB$. La première vaut 0 pixel, la seconde 190 et la troisième 210. Le nombre de tabulation est retrouvé ainsi que leurs valeurs puis affichées.
Résultat de la fonction
Si la fonction réussit, elle retourne #Ok qui est une constante de l'énumération status.
Si la fonction échoue, elle retourne une des autres valeurs de l'énumération status.
PB - OS
PureBasic v4.30 bêta 4 (Windows - x86)
Testé avec Windows Vista édition familiale Premium