StringFormat::GetTabStops, méthode (gdiplusstringformat.h)

La méthode StringFormat::GetTabStops obtient les décalages des taquets de tabulation dans cet objet StringFormat .

Syntaxe

Status GetTabStops(
  [in]  INT  count,
  [out] REAL *firstTabOffset,
  [out] REAL *tabStops
);

Paramètres

[in] count

Type : INT

Entier qui spécifie le nombre de décalages de taquet de tabulation dans le tableau tabStops .

[out] firstTabOffset

Type : REAL*

Pointeur vers un REAL qui reçoit la position de décalage initiale. Cette position de décalage initiale est relative à l’origine de la chaîne et le décalage du premier taquet de tabulation est relatif à la position de décalage initiale.

[out] tabStops

Type : REAL*

Pointeur vers un tableau de type REAL qui reçoit les décalages de taquet de tabulation. Le décalage du premier taquet de tabulation est la première valeur du tableau, le décalage du deuxième taquet de tabulation, la deuxième valeur du tableau, etc.

Valeur retournée

Type : État

Si la méthode réussit, elle retourne Ok, qui est un élément de l’énumération Status .

Si la méthode échoue, elle retourne l’un des autres éléments de l’énumération Status .

Notes

Chaque décalage de taquet de tabulation dans le tableau tabStops , à l’exception du premier, est relatif au précédent. Le premier décalage de taquet de tabulation est relatif à la position de décalage initiale indiquée par firstTabOffset. Par exemple, si la position de décalage initiale est 8 et que le premier décalage de taquet de tabulation est 50, le premier taquet de tabulation se trouve à la position 58. Si la position de décalage initiale est zéro, le premier décalage de taquet de tabulation est relatif à la position 0, l’origine de la chaîne.

Exemples

L’exemple suivant crée un objet StringFormat , définit des taquets de tabulation et utilise l’objet StringFormat pour dessiner une chaîne contenant des caractères de tabulation (\t). Le code dessine également le rectangle de disposition de la chaîne. Ensuite, le code obtient les taquets de tabulation et continue d’utiliser ou d’inspecter les taquets de tabulation d’une manière ou d’une autre.

VOID Example_GetTabStop(HDC hdc)
{
   Graphics graphics(hdc);

   REAL         tabs[] = {150, 100, 100};
   FontFamily   fontFamily(L"Courier New");
   Font         font(&fontFamily, 12, FontStyleRegular, UnitPoint);
   SolidBrush   solidBrush(Color(255, 0, 0, 255));

   StringFormat stringFormat;
   stringFormat.SetTabStops(0, 3, tabs);
   graphics.DrawString(
      L"Name\tTest 1\tTest 2\tTest 3", 
      25, 
      &font, 
      RectF(20, 20, 500, 100), 
      &stringFormat, 
      &solidBrush);

   // Draw the rectangle that encloses the text.
   Pen pen(Color(255, 255, 0, 0));
   graphics.DrawRectangle(&pen, 20, 20, 500, 100);

   // Get the tab stops.
   INT   tabStopCount = 0;
   REAL  firstTabOffset = 0;
   REAL* tabStops = NULL;

   tabStopCount = stringFormat.GetTabStopCount();
   tabStops = (REAL*)malloc(tabStopCount*sizeof(REAL));
   stringFormat.GetTabStops(tabStopCount, &firstTabOffset, tabStops);

   for(INT j = 0; j < tabStopCount; ++j)
   {
      // Inspect or use the value in tabStops[j].
   }
}

Configuration requise

Client minimal pris en charge	Windows XP, Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	gdiplusstringformat.h (inclure Gdiplus.h)
Bibliothèque	Gdiplus.lib
DLL	Gdiplus.dll

Voir aussi

Mise en forme du texte

État

StringFormat