Método StringFormat::GetTabStops (gdiplusstringformat.h)

O método StringFormat::GetTabStops obtém os deslocamentos das paradas de tabulação neste objeto StringFormat .

Sintaxe

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

Parâmetros

[in] count

Tipo: INT

Inteiro que especifica o número de deslocamentos de parada de tabulação na matriz tabStops .

[out] firstTabOffset

Tipo: REAL*

Ponteiro para um REAL que recebe a posição inicial de deslocamento. Essa posição de deslocamento inicial é relativa à origem da cadeia de caracteres e o deslocamento da primeira parada de tabulação é relativo à posição inicial de deslocamento.

[out] tabStops

Tipo: REAL*

Ponteiro para uma matriz do tipo REAL que recebe os deslocamentos de parada de tabulação. O deslocamento da primeira parada de tabulação é o primeiro valor na matriz, o deslocamento da segunda parada de tabulação, o segundo valor na matriz e assim por diante.

Valor retornado

Tipo: Status

Se o método for bem-sucedido, ele retornará Ok, que é um elemento da enumeração Status .

Se o método falhar, ele retornará um dos outros elementos da enumeração Status .

Comentários

Cada deslocamento de parada de tabulação na matriz tabStops , exceto o primeiro, é relativo ao anterior. O primeiro deslocamento de parada de tabulação é relativo à posição de deslocamento inicial indicada por firstTabOffset. Por exemplo, se a posição inicial de deslocamento for 8 e o primeiro deslocamento de parada de tabulação for 50, a primeira parada de tabulação estará na posição 58. Se a posição inicial de deslocamento for zero, o primeiro deslocamento de parada de tabulação será relativo à posição 0, a origem da cadeia de caracteres.

Exemplos

O exemplo a seguir cria um objeto StringFormat , define paradas de tabulação e usa o objeto StringFormat para desenhar uma cadeia de caracteres que contém caracteres de tabulação (\t). O código também desenha o retângulo de layout da cadeia de caracteres. Em seguida, o código obtém as paradas de tabulação e continua a usar ou inspecionar as paradas de tabulação de alguma forma.

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].
   }
}

Requisitos

Cliente mínimo com suporte	Windows XP, Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	gdiplusstringformat.h (inclua Gdiplus.h)
Biblioteca	Gdiplus.lib
DLL	Gdiplus.dll

Confira também

Formatação de texto

Status

StringFormat