StringFormat.GetTabStops Method (Single)

.NET Framework (current version)

Note
The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the tab stops for this StringFormat object.

Namespace: System.Drawing
Assembly: System.Drawing (in System.Drawing.dll)

Syntax

C++

public float[] GetTabStops(
	out float firstTabOffset
)

Parameters

firstTabOffset: Type: System.Single
The number of spaces between the beginning of a text line and the first tab stop.

Return Value

Type: System.Single[]

An array of distances (in number of spaces) between tab stops.

Examples

The following example is designed for use with Windows Forms, and it requires PaintEventArgse, which is a parameter of the Paint event handler. The code performs the following actions:

Sets the tab stops of the StringFormat.
Draws the string and the layout rectangle. Note that the string contains tabs. The tab settings of the StringFormat specify the offsets of the tabbed text.
Gets the tab stops and uses or inspects the values.

C++

public void GetSetTabStopsExample1(PaintEventArgs e)
{
    Graphics     g = e.Graphics;

    // Tools used for drawing, painting.
    Pen          redPen = new Pen(Color.FromArgb(255, 255, 0, 0));
    SolidBrush   blueBrush = new SolidBrush(Color.FromArgb(255, 0, 0, 255));

    // Layout and format for text.
    Font         myFont = new Font("Times New Roman", 12);
    StringFormat myStringFormat = new StringFormat();
    Rectangle    enclosingRectangle = new Rectangle(20, 20, 500, 100);
    float[]      tabStops = {150.0f, 100.0f, 100.0f};

    // Text with tabbed columns.
    string       myString =
        "Name\tTab 1\tTab 2\tTab 3\nGeorge Brown\tOne\tTwo\tThree";

    // Set the tab stops, paint the text specified by myString, and draw the

    // rectangle that encloses the text.
    myStringFormat.SetTabStops(0.0f, tabStops);
    g.DrawString(myString, myFont, blueBrush,
        enclosingRectangle, myStringFormat);
    g.DrawRectangle(redPen, enclosingRectangle);

    // Get the tab stops.
    float   firstTabOffset;
    float[] tabStopsObtained = myStringFormat.GetTabStops(out firstTabOffset);
    for(int j = 0; j < tabStopsObtained.Length; j++)
    {

        // Inspect or use the value in tabStopsObtained[j].
        Console.WriteLine("\n  Tab stop {0} = {1}", j, tabStopsObtained[j]);
    }
}

Version Information

.NET Framework
Available since 1.1