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

El método StringFormat::GetTabStops obtiene los desplazamientos de las tabulaciones de este objeto StringFormat .

Sintaxis

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

Parámetros

[in] count

Tipo: INT

Entero que especifica el número de desplazamientos de tabulación en la matriz tabStops .

[out] firstTabOffset

Tipo: REAL*

Puntero a un valor REAL que recibe la posición de desplazamiento inicial. Esta posición de desplazamiento inicial es relativa al origen de la cadena y el desplazamiento de la primera tabulación es relativo a la posición de desplazamiento inicial.

[out] tabStops

Tipo: REAL*

Puntero a una matriz de tipo REAL que recibe los desplazamientos de tabulación. El desplazamiento de la primera tabulación es el primer valor de la matriz, el desplazamiento de la segunda tabulación, el segundo valor de la matriz, etc.

Valor devuelto

Tipo: Estado

Si el método se ejecuta correctamente, devuelve Ok, que es un elemento de la enumeración Status .

Si se produce un error en el método, devuelve uno de los otros elementos de la enumeración Status .

Comentarios

Cada desplazamiento de tabulación de la matriz tabStops , excepto el primero, es relativo al anterior. El primer desplazamiento de tabulación es relativo a la posición de desplazamiento inicial indicada por firstTabOffset. Por ejemplo, si la posición de desplazamiento inicial es 8 y el primer desplazamiento de tabulación es 50, la primera tabulación está en la posición 58. Si la posición de desplazamiento inicial es cero, el primer desplazamiento de tabulación es relativo a la posición 0, el origen de la cadena.

Ejemplos

En el ejemplo siguiente se crea un objeto StringFormat , se establecen las tabulaciones y se usa el objeto StringFormat para dibujar una cadena que contiene caracteres de tabulación (\t). El código también dibuja el rectángulo de diseño de la cadena. A continuación, el código obtiene las tabulaciones y continúa usando o inspeccionando las tabulaciones de alguna manera.

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 compatible	Windows XP, Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	gdiplusstringformat.h (include Gdiplus.h)
Library	Gdiplus.lib
Archivo DLL	Gdiplus.dll

Consulte también

Formato de texto

Estado

StringFormat