1 <?xml version="1.0" encoding="utf-8"?>
2 <Type Name="TextFormatFlags" FullName="System.Windows.Forms.TextFormatFlags">
3 <TypeSignature Language="C#" Value="public enum TextFormatFlags" />
5 <AssemblyName>System.Windows.Forms</AssemblyName>
6 <AssemblyVersion>2.0.0.0</AssemblyVersion>
9 <BaseTypeName>System.Enum</BaseTypeName>
13 <AttributeName>System.Flags</AttributeName>
17 <since version=".NET 2.0" />
19 <attribution license="cc4" from="Microsoft" modified="false" />
20 <para>The <see cref="T:System.Windows.Forms.TextFormatFlags" /> enumeration is used by the <see cref="T:System.Windows.Forms.TextRenderer" /> when drawing and measuring text. The <see cref="T:System.Windows.Forms.TextRenderer" /> does not support adding tab stops to drawn text, although you can expand existing tab stops using the <see cref="F:System.Windows.Forms.TextFormatFlags.ExpandTabs" /> flag.</para>
23 <attribution license="cc4" from="Microsoft" modified="false" />
24 <para>Specifies the display and layout information for text strings.</para>
28 <Member MemberName="Bottom">
29 <MemberSignature Language="C#" Value="Bottom" />
30 <MemberType>Field</MemberType>
32 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
35 <since version=".NET 2.0" />
37 <attribution license="cc4" from="Microsoft" modified="false" />
38 <para>Aligns the text on the bottom of the bounding rectangle. Applied only when the text is a single line.</para>
42 <AssemblyVersion>2.0.0.0</AssemblyVersion>
45 <Member MemberName="Default">
46 <MemberSignature Language="C#" Value="Default" />
47 <MemberType>Field</MemberType>
49 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
52 <since version=".NET 2.0" />
54 <attribution license="cc4" from="Microsoft" modified="false" />
55 <para>Applies the default formatting, which is left-aligned.</para>
59 <AssemblyVersion>2.0.0.0</AssemblyVersion>
62 <Member MemberName="EndEllipsis">
63 <MemberSignature Language="C#" Value="EndEllipsis" />
64 <MemberType>Field</MemberType>
66 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
69 <since version=".NET 2.0" />
71 <attribution license="cc4" from="Microsoft" modified="false" />
72 <para>Removes the end of trimmed lines, and replaces them with an ellipsis.</para>
76 <AssemblyVersion>2.0.0.0</AssemblyVersion>
79 <Member MemberName="ExpandTabs">
80 <MemberSignature Language="C#" Value="ExpandTabs" />
81 <MemberType>Field</MemberType>
83 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
86 <since version=".NET 2.0" />
88 <attribution license="cc4" from="Microsoft" modified="false" />
89 <para>Expands tab characters. The default number of characters per tab is eight. The <see cref="F:System.Windows.Forms.TextFormatFlags.WordEllipsis" />, <see cref="F:System.Windows.Forms.TextFormatFlags.PathEllipsis" />, and <see cref="F:System.Windows.Forms.TextFormatFlags.EndEllipsis" /> values cannot be used with <see cref="F:System.Windows.Forms.TextFormatFlags.ExpandTabs" />.</para>
93 <AssemblyVersion>2.0.0.0</AssemblyVersion>
96 <Member MemberName="ExternalLeading">
97 <MemberSignature Language="C#" Value="ExternalLeading" />
98 <MemberType>Field</MemberType>
100 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
103 <since version=".NET 2.0" />
105 <attribution license="cc4" from="Microsoft" modified="false" />
106 <para>Includes the font external leading in line height. Typically, external leading is not included in the height of a line of text.</para>
110 <AssemblyVersion>2.0.0.0</AssemblyVersion>
113 <Member MemberName="GlyphOverhangPadding">
114 <MemberSignature Language="C#" Value="GlyphOverhangPadding" />
115 <MemberType>Field</MemberType>
117 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
120 <since version=".NET 2.0" />
122 <attribution license="cc4" from="Microsoft" modified="false" />
123 <para>Adds padding to the bounding rectangle to accommodate overhanging glyphs. </para>
127 <AssemblyVersion>2.0.0.0</AssemblyVersion>
130 <Member MemberName="HidePrefix">
131 <MemberSignature Language="C#" Value="HidePrefix" />
132 <MemberType>Field</MemberType>
134 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
137 <since version=".NET 2.0" />
139 <attribution license="cc4" from="Microsoft" modified="false" />
140 <para>Ignores the ampersand (&) prefix character in the text. The letter that follows will not be underlined, but other mnemonic-prefix characters are still processed. For example, an input string of "A&bc&&d" with <see cref="F:System.Windows.Forms.TextFormatFlags.HidePrefix" /> applied would result in output of "Abc&d".</para>
141 <para>Compare with <see cref="F:System.Windows.Forms.TextFormatFlags.NoPrefix" /> and <see cref="F:System.Windows.Forms.TextFormatFlags.PrefixOnly" />.</para>
144 <attribution license="cc4" from="Microsoft" modified="false" />
145 <para>Applies to Windows 2000 and Windows XP only: </para>
149 <AssemblyVersion>2.0.0.0</AssemblyVersion>
152 <Member MemberName="HorizontalCenter">
153 <MemberSignature Language="C#" Value="HorizontalCenter" />
154 <MemberType>Field</MemberType>
156 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
159 <since version=".NET 2.0" />
161 <attribution license="cc4" from="Microsoft" modified="false" />
162 <para>Centers the text horizontally within the bounding rectangle.</para>
166 <AssemblyVersion>2.0.0.0</AssemblyVersion>
169 <Member MemberName="Internal">
170 <MemberSignature Language="C#" Value="Internal" />
171 <MemberType>Field</MemberType>
173 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
176 <since version=".NET 2.0" />
178 <attribution license="cc4" from="Microsoft" modified="false" />
179 <para>Uses the system font to calculate text metrics.</para>
183 <AssemblyVersion>2.0.0.0</AssemblyVersion>
186 <Member MemberName="Left">
187 <MemberSignature Language="C#" Value="Left" />
188 <MemberType>Field</MemberType>
190 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
193 <since version=".NET 2.0" />
195 <attribution license="cc4" from="Microsoft" modified="false" />
196 <para>Aligns the text on the left side of the clipping area.</para>
200 <AssemblyVersion>2.0.0.0</AssemblyVersion>
203 <Member MemberName="LeftAndRightPadding">
204 <MemberSignature Language="C#" Value="LeftAndRightPadding" />
205 <MemberType>Field</MemberType>
207 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
210 <since version=".NET 2.0" />
212 <attribution license="cc4" from="Microsoft" modified="false" />
213 <para>Adds padding to both sides of the bounding rectangle.</para>
217 <AssemblyVersion>2.0.0.0</AssemblyVersion>
220 <Member MemberName="ModifyString">
221 <MemberSignature Language="C#" Value="ModifyString" />
222 <MemberType>Field</MemberType>
224 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
227 <since version=".NET 2.0" />
229 <attribution license="cc4" from="Microsoft" modified="false" />
230 <para>Has no effect on the drawn text.</para>
234 <AssemblyVersion>2.0.0.0</AssemblyVersion>
237 <Member MemberName="NoClipping">
238 <MemberSignature Language="C#" Value="NoClipping" />
239 <MemberType>Field</MemberType>
241 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
244 <since version=".NET 2.0" />
246 <attribution license="cc4" from="Microsoft" modified="false" />
247 <para>Allows the overhanging parts of glyphs and unwrapped text reaching outside the formatting rectangle to show.</para>
251 <AssemblyVersion>2.0.0.0</AssemblyVersion>
254 <Member MemberName="NoFullWidthCharacterBreak">
255 <MemberSignature Language="C#" Value="NoFullWidthCharacterBreak" />
256 <MemberType>Field</MemberType>
258 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
261 <since version=".NET 2.0" />
263 <attribution license="cc4" from="Microsoft" modified="false" />
264 <para>Prevents a line break at a double-wide character string, so that the line-breaking rule is equivalent to single-wide character strings. For example, <see cref="F:System.Windows.Forms.TextFormatFlags.NoFullWidthCharacterBreak" /> increases the readability of icon labels in Korean windows. This value has no effect unless <see cref="F:System.Windows.Forms.TextFormatFlags.WordBreak" /> is also specified.</para>
267 <attribution license="cc4" from="Microsoft" modified="false" />
268 <para>Applies to Windows 98, Windows Me, Windows 2000, or Windows XP only:</para>
272 <AssemblyVersion>2.0.0.0</AssemblyVersion>
275 <Member MemberName="NoPadding">
276 <MemberSignature Language="C#" Value="NoPadding" />
277 <MemberType>Field</MemberType>
279 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
282 <since version=".NET 2.0" />
284 <attribution license="cc4" from="Microsoft" modified="false" />
285 <para>Does not add padding to the bounding rectangle.</para>
289 <AssemblyVersion>2.0.0.0</AssemblyVersion>
292 <Member MemberName="NoPrefix">
293 <MemberSignature Language="C#" Value="NoPrefix" />
294 <MemberType>Field</MemberType>
296 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
299 <since version=".NET 2.0" />
301 <attribution license="cc4" from="Microsoft" modified="false" />
302 <para>Compare with <see cref="F:System.Windows.Forms.TextFormatFlags.HidePrefix" /> and <see cref="F:System.Windows.Forms.TextFormatFlags.PrefixOnly" />.</para>
305 <attribution license="cc4" from="Microsoft" modified="false" />
306 <para>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 <see cref="F:System.Windows.Forms.TextFormatFlags.NoPrefix" />, this processing is turned off. For example, an input string of "A&bc&&d" with <see cref="F:System.Windows.Forms.TextFormatFlags.NoPrefix" /> applied would result in output of "A&bc&&d".</para>
310 <AssemblyVersion>2.0.0.0</AssemblyVersion>
313 <Member MemberName="PathEllipsis">
314 <MemberSignature Language="C#" Value="PathEllipsis" />
315 <MemberType>Field</MemberType>
317 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
320 <since version=".NET 2.0" />
322 <attribution license="cc4" from="Microsoft" modified="false" />
323 <para>Removes the center of trimmed lines and replaces it with an ellipsis. </para>
327 <AssemblyVersion>2.0.0.0</AssemblyVersion>
330 <Member MemberName="PrefixOnly">
331 <MemberSignature Language="C#" Value="PrefixOnly" />
332 <MemberType>Field</MemberType>
334 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
337 <since version=".NET 2.0" />
339 <attribution license="cc4" from="Microsoft" modified="false" />
340 <para>Draws only an underline at the position of the character following the ampersand (&) prefix character. Does not draw any other characters in the string. For example, an input string of "A&bc&&d" would result in output of " _ ".</para>
341 <para>Compare with <see cref="F:System.Windows.Forms.TextFormatFlags.HidePrefix" /> and <see cref="F:System.Windows.Forms.TextFormatFlags.NoPrefix" />.</para>
344 <attribution license="cc4" from="Microsoft" modified="false" />
345 <para>Applies to Windows 2000 or Windows XP only: </para>
349 <AssemblyVersion>2.0.0.0</AssemblyVersion>
352 <Member MemberName="PreserveGraphicsClipping">
353 <MemberSignature Language="C#" Value="PreserveGraphicsClipping" />
354 <MemberType>Field</MemberType>
356 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
359 <since version=".NET 2.0" />
361 <attribution license="cc4" from="Microsoft" modified="false" />
362 <para>Preserves the clipping specified by a <see cref="T:System.Drawing.Graphics" /> object. Applies only to methods receiving an <see cref="T:System.Drawing.IDeviceContext" /> that is a <see cref="T:System.Drawing.Graphics" />.</para>
366 <AssemblyVersion>2.0.0.0</AssemblyVersion>
369 <Member MemberName="PreserveGraphicsTranslateTransform">
370 <MemberSignature Language="C#" Value="PreserveGraphicsTranslateTransform" />
371 <MemberType>Field</MemberType>
373 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
376 <since version=".NET 2.0" />
378 <attribution license="cc4" from="Microsoft" modified="false" />
379 <para>Preserves the transformation specified by a <see cref="T:System.Drawing.Graphics" />. Applies only to methods receiving an <see cref="T:System.Drawing.IDeviceContext" /> that is a <see cref="T:System.Drawing.Graphics" />.</para>
383 <AssemblyVersion>2.0.0.0</AssemblyVersion>
386 <Member MemberName="Right">
387 <MemberSignature Language="C#" Value="Right" />
388 <MemberType>Field</MemberType>
390 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
393 <since version=".NET 2.0" />
395 <attribution license="cc4" from="Microsoft" modified="false" />
396 <para>Aligns the text on the right side of the clipping area.</para>
400 <AssemblyVersion>2.0.0.0</AssemblyVersion>
403 <Member MemberName="RightToLeft">
404 <MemberSignature Language="C#" Value="RightToLeft" />
405 <MemberType>Field</MemberType>
407 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
410 <since version=".NET 2.0" />
412 <attribution license="cc4" from="Microsoft" modified="false" />
413 <para>Displays the text from right to left.</para>
417 <AssemblyVersion>2.0.0.0</AssemblyVersion>
420 <Member MemberName="SingleLine">
421 <MemberSignature Language="C#" Value="SingleLine" />
422 <MemberType>Field</MemberType>
424 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
427 <since version=".NET 2.0" />
429 <attribution license="cc4" from="Microsoft" modified="false" />
430 <para>Displays the text in a single line.</para>
434 <AssemblyVersion>2.0.0.0</AssemblyVersion>
437 <Member MemberName="TextBoxControl">
438 <MemberSignature Language="C#" Value="TextBoxControl" />
439 <MemberType>Field</MemberType>
441 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
444 <since version=".NET 2.0" />
446 <attribution license="cc4" from="Microsoft" modified="false" />
447 <para>Specifies the text should be formatted for display on a <see cref="T:System.Windows.Forms.TextBox" /> control.</para>
451 <AssemblyVersion>2.0.0.0</AssemblyVersion>
454 <Member MemberName="Top">
455 <MemberSignature Language="C#" Value="Top" />
456 <MemberType>Field</MemberType>
458 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
461 <since version=".NET 2.0" />
463 <attribution license="cc4" from="Microsoft" modified="false" />
464 <para>Aligns the text on the top of the bounding rectangle.</para>
468 <AssemblyVersion>2.0.0.0</AssemblyVersion>
471 <Member MemberName="VerticalCenter">
472 <MemberSignature Language="C#" Value="VerticalCenter" />
473 <MemberType>Field</MemberType>
475 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
478 <since version=".NET 2.0" />
480 <attribution license="cc4" from="Microsoft" modified="false" />
481 <para>Centers the text vertically, within the bounding rectangle.</para>
485 <AssemblyVersion>2.0.0.0</AssemblyVersion>
488 <Member MemberName="WordBreak">
489 <MemberSignature Language="C#" Value="WordBreak" />
490 <MemberType>Field</MemberType>
492 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
495 <since version=".NET 2.0" />
497 <attribution license="cc4" from="Microsoft" modified="false" />
498 <para>Breaks the text at the end of a word.</para>
502 <AssemblyVersion>2.0.0.0</AssemblyVersion>
505 <Member MemberName="WordEllipsis">
506 <MemberSignature Language="C#" Value="WordEllipsis" />
507 <MemberType>Field</MemberType>
509 <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
512 <since version=".NET 2.0" />
514 <attribution license="cc4" from="Microsoft" modified="false" />
515 <para>Trims the line to the nearest word and an ellipsis is placed at the end of a trimmed line.</para>
519 <AssemblyVersion>2.0.0.0</AssemblyVersion>