TextFormatFlags Enumeration
TOC
Collapse the table of content
Expand the table of content

TextFormatFlags Enumeration

 

Specifies the display and layout information for text strings.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

[FlagsAttribute]
public enum TextFormatFlags

Member nameDescription
Bottom

Aligns the text on the bottom of the bounding rectangle. Applied only when the text is a single line.

Default

Applies the default formatting, which is left-aligned.

EndEllipsis

Removes the end of trimmed lines, and replaces them with an ellipsis.

ExpandTabs

Expands tab characters. The default number of characters per tab is eight. The WordEllipsis, PathEllipsis, and EndEllipsis values cannot be used with ExpandTabs.

ExternalLeading

Includes the font external leading in line height. Typically, external leading is not included in the height of a line of text.

GlyphOverhangPadding

Adds padding to the bounding rectangle to accommodate overhanging glyphs.

HidePrefix

Applies to Windows 2000 and Windows XP only:

HorizontalCenter

Centers the text horizontally within the bounding rectangle.

Internal

Uses the system font to calculate text metrics.

Left

Aligns the text on the left side of the clipping area.

LeftAndRightPadding

Adds padding to both sides of the bounding rectangle.

ModifyString

Has no effect on the drawn text.

NoClipping

Allows the overhanging parts of glyphs and unwrapped text reaching outside the formatting rectangle to show.

NoFullWidthCharacterBreak

Applies to Windows 98, Windows Me, Windows 2000, or Windows XP only:

NoPadding

Does not add padding to the bounding rectangle.

NoPrefix

Turns off processing of prefix characters. Typically, the ampersand (&) mnemonic-prefix character is interpreted as a directive to underscore the character that follows, and the double-ampersand (&&) mnemonic-prefix characters as a directive to print a single ampersand. By specifying NoPrefix, this processing is turned off. For example, an input string of "A&bc&&d" with NoPrefix applied would result in output of "A&bc&&d".

PathEllipsis

Removes the center of trimmed lines and replaces it with an ellipsis.

PrefixOnly

Applies to Windows 2000 or Windows XP only:

PreserveGraphicsClipping

Preserves the clipping specified by a Graphics object. Applies only to methods receiving an IDeviceContext that is a Graphics.

PreserveGraphicsTranslateTransform

Preserves the transformation specified by a Graphics. Applies only to methods receiving an IDeviceContext that is a Graphics.

Right

Aligns the text on the right side of the clipping area.

RightToLeft

Displays the text from right to left.

SingleLine

Displays the text in a single line.

TextBoxControl

Specifies the text should be formatted for display on a TextBox control.

Top

Aligns the text on the top of the bounding rectangle.

VerticalCenter

Centers the text vertically, within the bounding rectangle.

WordBreak

Breaks the text at the end of a word.

WordEllipsis

Trims the line to the nearest word and an ellipsis is placed at the end of a trimmed line.

The TextFormatFlags enumeration is used by the TextRenderer when drawing and measuring text. The TextRenderer does not support adding tab stops to drawn text, although you can expand existing tab stops using the ExpandTabs flag.

The following code example demonstrates how to use the TextFormatFlags enumeration. To run this example, paste the following code into a Windows Form. Call RenderText6 from the form's Paint event handler, passing e as PaintEventArgs.

private void RenderText6(PaintEventArgs e)
{
    TextFormatFlags flags = TextFormatFlags.Bottom | TextFormatFlags.EndEllipsis;
    TextRenderer.DrawText(e.Graphics, "This is some text that will be clipped at the end.", this.Font,
        new Rectangle(10, 10, 100, 50), SystemColors.ControlText, flags);
}

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft